From 945ce9037b678447f0a3322a1ba669856d0b9468 Mon Sep 17 00:00:00 2001 From: xiaoxu qi Date: Tue, 26 May 2020 17:44:39 +0800 Subject: [PATCH 001/318] enable trenton package in prod (#9582) Co-authored-by: Xiaoxu Qi --- .azure-pipelines/SDKAutomation.yml | 3 +++ 1 file changed, 3 insertions(+) diff --git a/.azure-pipelines/SDKAutomation.yml b/.azure-pipelines/SDKAutomation.yml index 6e481cdb9139..4ffe19244ebd 100644 --- a/.azure-pipelines/SDKAutomation.yml +++ b/.azure-pipelines/SDKAutomation.yml @@ -69,6 +69,7 @@ jobs: -e SPEC_REPO \ -e PR_NUMBER \ -e SDK_REPO_NAME \ + -e AZURE_DEVOPS_EXT_PAT \ sdk-automation:latest npm start env: BLOB_STORAGE_NAME: $(blob-storage-name) @@ -76,4 +77,6 @@ jobs: GITHUB_COMMENT_AUTHOR_NAME: $(github-comment-author-name) GITHUBAPP_ID: $(githubapp-id) GITHUBAPP_PRIVATE_KEY: $(githubapp-private-key) + AZURE_DEVOPS_EXT_PAT: $(azure-devops-ext-pat) + BUILD_ID: $(Build.BuildId) displayName: SDK Automation From 38ade55ee0e65dd4d1ecc4184d4c72f043bb77bf Mon Sep 17 00:00:00 2001 From: Saif Kayani Date: Tue, 26 May 2020 18:47:31 -0700 Subject: [PATCH 002/318] [Hub Generated] Review request for Microsoft.ManagedServices to add version preview/2020-02-01-preview (#8913) * Adds base for updating Microsoft.ManagedServices from version stable/2019-09-01 to version 2020-02-01-preview * Updates readme * Updates API version in new specs and examples * Added all changes from PR 1138 to a new API version folder * Removed readOnly: true from multiFactorAuthProvider * Added principalIdDisplayName and delegatedRoleDefinitionsId to Authorization object + changed description of maximumActivationDuration to reflect ISO 8601 format * Made changes reflecting Chris Eggert's suggestions * Fixed camel case mistake * Fixed registrationDefinitionIdParameter references * Adds base for updating Microsoft.ManagedServices from version stable/2019-09-01 to version 2020-02-01-preview * Updates readme * Updates API version in new specs and examples * Updated read.md * Fixed wrong tag in readme --- .../DeleteRegistrationAssignment.json | 12 + .../DeleteRegistrationDefinition.json | 11 + .../GetMarketplaceRegistrationDefinition.json | 35 + ...GetMarketplaceRegistrationDefinitions.json | 39 + .../examples/GetOperations.json | 22 + .../examples/GetRegistrationAssignment.json | 58 + .../examples/GetRegistrationAssignments.json | 59 + .../examples/GetRegistrationDefinition.json | 46 + .../examples/GetRegistrationDefinitions.json | 49 + .../examples/PutRegistrationAssignment.json | 36 + .../examples/PutRegistrationDefinition.json | 113 ++ .../2020-02-01-preview/managedservices.json | 1038 +++++++++++++++++ .../resource-manager/readme.md | 13 +- 13 files changed, 1529 insertions(+), 2 deletions(-) create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/DeleteRegistrationAssignment.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/DeleteRegistrationDefinition.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinition.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinitions.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetOperations.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationAssignment.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationAssignments.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationDefinition.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationDefinitions.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/PutRegistrationAssignment.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/PutRegistrationDefinition.json create mode 100644 specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/DeleteRegistrationAssignment.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/DeleteRegistrationAssignment.json new file mode 100644 index 000000000000..02d3c023e459 --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/DeleteRegistrationAssignment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscription/0afefe50-734e-4610-8a82-a144ahf49dea", + "registrationAssignmentId": "26c128c2-fefa-4340-9bb1-6e081c90ada2", + "api-version": "2020-02-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "202": {} + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/DeleteRegistrationDefinition.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/DeleteRegistrationDefinition.json new file mode 100644 index 000000000000..e7831c2f9b58 --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/DeleteRegistrationDefinition.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "scope": "subscription/0afefe50-734e-4610-8a82-a144ahf49dea", + "registrationDefinitionId": "26c128c2-fefa-4340-9bb1-6e081c90ada2", + "api-version": "2020-02-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinition.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinition.json new file mode 100644 index 000000000000..d85e52a4f545 --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinition.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "scope": "subscription/0afefe50-734e-4610-8a82-a144ahf49dea", + "marketplaceIdentifier": "publisher.product.planName.version", + "api-version": "2020-02-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "Test", + "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc", + "registrationDefinitionName": "DefinitionName", + "authorizations": [ + { + "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc", + "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" + } + ], + "provisioningState": "Succeeded", + "managedByTenantName": "Test Tenant" + }, + "plan": { + "name": "addesai-plan", + "product": "test", + "publisher": "marketplace-test", + "version": "1.0.0" + }, + "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2", + "type": "Microsoft.ManagedServices/registrationDefinitions", + "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2" + } + } + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinitions.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinitions.json new file mode 100644 index 000000000000..59623715d529 --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinitions.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "scope": "subscription/0afefe50-734e-4610-8a82-a144ahf49dea", + "$filter": "planIdentifier eq 'publisher.offerIdentifier.planName.version'", + "api-version": "2020-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "Test", + "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc", + "registrationDefinitionName": "DefinitionName", + "authorizations": [ + { + "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc", + "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" + } + ], + "provisioningState": "Succeeded", + "managedByTenantName": "Test Tenant" + }, + "plan": { + "name": "addesai-plan", + "product": "test", + "publisher": "marketplace-test", + "version": "1.0.0" + }, + "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2", + "type": "Microsoft.ManagedServices/registrationDefinitions", + "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2" + } + ] + } + } + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetOperations.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetOperations.json new file mode 100644 index 000000000000..38e936efc87d --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetOperations.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ManagedServices/registrationDefinitions/read", + "display": { + "provider": "Microsoft Managed Services", + "resource": "Managed Services Registration Definition", + "operation": "List Managed Services Registration Definitions", + "description": "Retrieves a list of Managed Services registration definitions." + } + } + ] + } + } + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationAssignment.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationAssignment.json new file mode 100644 index 000000000000..415424960bf8 --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationAssignment.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "scope": "subscription/0afefe50-734e-4610-8a82-a144ahf49dea", + "registrationAssignmentId": "26c128c2-fefa-4340-9bb1-6e081c90ada2", + "api-version": "2020-02-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "registrationDefinitionId": "/subscriptions/0afefe50-734e-4610-8c82-a144aff49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-8e081c90ada2", + "provisioningState": "Succeeded", + "registrationDefinition": { + "properties": { + "description": "Test", + "managedByTenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "registrationDefinitionName": "DefinitionName", + "authorizations": [ + { + "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc", + "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" + } + ], + "eligibleAuthorizations": [ + { + "justInTimeAccessPolicy": { + "multiFactorAuthProvider": "Azure", + "maximumActivationDuration": "PT8H" + }, + "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2", + "principalIdDisplayName": "Support User", + "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e" + } + ], + "provisioningState": "Succeeded", + "manageeTenantId": "01c0bcd5-4f47-4e4b-b492-418b7e2a8854", + "manageeTenantName": "test_test_aad_SbtFhyGiLHPFm", + "managedByTenantName": "Contoso Corp." + }, + "plan": { + "name": "addesai-plan", + "product": "test", + "publisher": "marketplace-test", + "version": "1.0.0" + }, + "id": "/subscriptions/0afefe50-734e-4610-8c82-a144aff49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-8e081c90ada2", + "type": "Microsoft.ManagedServices/registrationDefinitions", + "name": "26c128c2-fefa-4340-9bb1-8e081c90ada2" + } + }, + "id": "/subscriptions/0afefe50-734e-4610-8c82-a144aff49dea/providers/Microsoft.ManagedServices/registrationAssignments/484a7d5f-9729-4b87-bc9b-26610985a013", + "type": "Microsoft.ManagedServices/registrationAssignments", + "name": "484a7d5f-9729-4b87-bc9b-26610985a013" + } + } + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationAssignments.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationAssignments.json new file mode 100644 index 000000000000..83d264d3de1c --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "scope": "subscription/0afefe50-734e-4610-8a82-a144ahf49dea", + "api-version": "2020-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "registrationDefinitionId": "/subscriptions/0afefe50-734e-4610-8c82-a144aff49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-8e081c90ada2", + "provisioningState": "Succeeded", + "registrationDefinition": { + "properties": { + "description": "Test", + "registrationDefinitionName": "DefinitionName", + "authorizations": [ + { + "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc", + "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" + } + ], + "eligibleAuthorizations": [ + { + "principalId": "700bddf4-2c3b-4cd1-bb02-6a2c622524f4", + "roleDefinitionId": "8e3af657-a8ff-443c-a75c-2fe8c4bcb635", + "justInTimeAccessPolicy": { + "multiFactorAuthProvider": "Azure", + "maximumActivationDuration": "PT8H" + } + } + ], + "provisioningState": "Succeeded", + "manageeTenantId": "01c0bcd5-4f47-4e4b-b492-418b7e2a8854", + "manageeTenantName": "test_test_aad_SbtFhyGiLHPFm", + "managedByTenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "managedByTenantName": "Contoso Corp." + }, + "plan": { + "name": "addesai-plan", + "product": "test", + "publisher": "marketplace-test", + "version": "1.0.0" + }, + "id": "/subscriptions/0afefe50-734e-4610-8c82-a144aff49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-8e081c90ada2", + "type": "Microsoft.ManagedServices/registrationDefinitions", + "name": "26c128c2-fefa-4340-9bb1-8e081c90ada2" + } + }, + "id": "/subscriptions/0afefe50-734e-4610-8c82-a144aff49dea/providers/Microsoft.ManagedServices/registrationAssignments/484a7d5f-9729-4b87-bc9b-26610985a013", + "type": "Microsoft.ManagedServices/registrationAssignments", + "name": "484a7d5f-9729-4b87-bc9b-26610985a013" + } + ] + } + } + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationDefinition.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationDefinition.json new file mode 100644 index 000000000000..d44d61718a6d --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationDefinition.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "scope": "subscription/0afefe50-734e-4610-8a82-a144ahf49dea", + "registrationDefinitionId": "26c128c2-fefa-4340-9bb1-6e081c90ada2", + "api-version": "2020-02-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "Test", + "registrationDefinitionName": "DefinitionName", + "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc", + "authorizations": [ + { + "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc", + "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" + } + ], + "eligibleAuthorizations": [ + { + "justInTimeAccessPolicy": { + "multiFactorAuthProvider": "Azure", + "maximumActivationDuration": "PT8H" + }, + "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2", + "principalIdDisplayName": "Support User", + "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e" + } + ], + "provisioningState": "Succeeded", + "managedByTenantName": "Test Tenant" + }, + "plan": { + "name": "addesai-plan", + "product": "test", + "publisher": "marketplace-test", + "version": "1.0.0" + }, + "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2", + "type": "Microsoft.ManagedServices/registrationDefinitions", + "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2" + } + } + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationDefinitions.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationDefinitions.json new file mode 100644 index 000000000000..d8b63c6d0417 --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetRegistrationDefinitions.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscription/0afefe50-734e-4610-8a82-a144ahf49dea", + "api-version": "2020-02-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "Test", + "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc", + "registrationDefinitionName": "DefinitionName", + "authorizations": [ + { + "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc", + "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" + } + ], + "eligibleAuthorizations": [ + { + "justInTimeAccessPolicy": { + "multiFactorAuthProvider": "Azure", + "maximumActivationDuration": "PT8H" + }, + "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2", + "principalIdDisplayName": "Support User", + "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e" + } + ], + "provisioningState": "Succeeded", + "managedByTenantName": "Test Tenant" + }, + "plan": { + "name": "addesai-plan", + "product": "test", + "publisher": "marketplace-test", + "version": "1.0.0" + }, + "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2", + "type": "Microsoft.ManagedServices/registrationDefinitions", + "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2" + } + ] + } + } + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/PutRegistrationAssignment.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/PutRegistrationAssignment.json new file mode 100644 index 000000000000..3f47187f397a --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/PutRegistrationAssignment.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "scope": "subscription/0afefe50-734e-4610-8a82-a144ahf49dea", + "registrationAssignmentId": "26c128c2-fefa-4340-9bb1-6e081c90ada2", + "api-version": "2020-02-01-preview", + "requestBody": { + "properties": { + "registrationDefinitionId": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "registrationDefinitionId": "/subscriptions/0afefe50-734e-4610-8c82-a144aff49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-8e081c90ada2", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/0afefe50-734e-4610-8c82-a144aff49dea/providers/Microsoft.ManagedServices/registrationAssignments/484a7d5f-9729-4b87-bc9b-26610985a013", + "type": "Microsoft.ManagedServices/registrationAssignments", + "name": "484a7d5f-9729-4b87-bc9b-26610985a013" + } + }, + "201": { + "body": { + "properties": { + "registrationDefinitionId": "/subscriptions/0afefe50-734e-4610-8c82-a144aff49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-8e081c90ada2", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/0afefe50-734e-4610-8c82-a144aff49dea/providers/Microsoft.ManagedServices/registrationAssignments/484a7d5f-9729-4b87-bc9b-26610985a013", + "type": "Microsoft.ManagedServices/registrationAssignments", + "name": "484a7d5f-9729-4b87-bc9b-26610985a013" + } + } + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/PutRegistrationDefinition.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/PutRegistrationDefinition.json new file mode 100644 index 000000000000..3f38948f3565 --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/PutRegistrationDefinition.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "scope": "subscription/0afefe50-734e-4610-8a82-a144ahf49dea", + "registrationDefinitionId": "26c128c2-fefa-4340-9bb1-6e081c90ada2", + "api-version": "2020-02-01-preview", + "requestBody": { + "properties": { + "registrationDefinitionName": "DefinitionName", + "description": "Tes1t", + "managedByTenantId": "83abe5cd-bcc3-441a-bd86-e6a75360cecc", + "authorizations": [ + { + "principalId": "f98d86a2-4cc4-4e9d-ad47-b3e80a1bcdfc", + "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" + } + ], + "eligibleAuthorizations": [ + { + "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2", + "principalIdDisplayName": "Support User", + "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e", + "justInTimeAccessPolicy": { + "multiFactorAuthProvider": "Azure", + "maximumActivationDuration": "PT8H" + } + } + ] + }, + "plan": { + "name": "addesai-plan", + "product": "test", + "publisher": "marketplace-test", + "version": "1.0.0" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "Test", + "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc", + "registrationDefinitionName": "DefinitionName", + "authorizations": [ + { + "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc", + "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" + } + ], + "eligibleAuthorizations": [ + { + "justInTimeAccessPolicy": { + "multiFactorAuthProvider": "Azure", + "maximumActivationDuration": "PT8H" + }, + "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2", + "principalIdDisplayName": "Support User", + "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e" + } + ], + "provisioningState": "Succeeded", + "managedByTenantName": "Test Tenant" + }, + "plan": { + "name": "addesai-plan", + "product": "test", + "publisher": "marketplace-test", + "version": "1.0.0" + }, + "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2", + "type": "Microsoft.ManagedServices/registrationDefinitions", + "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2" + } + }, + "201": { + "body": { + "properties": { + "description": "Test", + "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc", + "registrationDefinitionName": "DefinitionName", + "authorizations": [ + { + "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc", + "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" + } + ], + "eligibleAuthorizations": [ + { + "justInTimeAccessPolicy": { + "multiFactorAuthProvider": "Azure", + "maximumActivationDuration": "PT8H" + }, + "principalId": "3e0ed8c6-e902-4fc5-863c-e3ddbb2ae2a2", + "principalIdDisplayName": "Support User", + "roleDefinitionId": "ae349356-3a1b-4a5e-921d-050484c6347e" + } + ], + "provisioningState": "Succeeded", + "managedByTenantName": "Test Tenant" + }, + "plan": { + "name": "addesai-plan", + "product": "test", + "publisher": "marketplace-test", + "version": "1.0.0" + }, + "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2", + "type": "Microsoft.ManagedServices/registrationDefinitions", + "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2" + } + } + } +} diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json new file mode 100644 index 000000000000..b3a19710450b --- /dev/null +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json @@ -0,0 +1,1038 @@ +{ + "swagger": "2.0", + "info": { + "title": "ManagedServicesClient", + "version": "2020-02-01-preview", + "description": "Specification for ManagedServices." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/{scope}/providers/Microsoft.ManagedServices/registrationDefinitions/{registrationDefinitionId}": { + "get": { + "tags": [ + "RegistrationDefinitions" + ], + "operationId": "RegistrationDefinitions_Get", + "description": "Gets the registration definition details.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/RegistrationDefinitionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the complete registration definition with plan details.", + "schema": { + "$ref": "#/definitions/RegistrationDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registration Definition": { + "$ref": "./examples/GetRegistrationDefinition.json" + } + } + }, + "delete": { + "tags": [ + "RegistrationDefinitions" + ], + "operationId": "RegistrationDefinitions_Delete", + "description": "Deletes the registration definition.", + "parameters": [ + { + "$ref": "#/parameters/RegistrationDefinitionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + } + ], + "responses": { + "200": { + "description": "OK - The registration definition is deleted." + }, + "204": { + "description": "No Content- The registration definition does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registration Definition": { + "$ref": "./examples/DeleteRegistrationDefinition.json" + } + } + }, + "put": { + "tags": [ + "RegistrationDefinitions" + ], + "operationId": "RegistrationDefinitions_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Creates or updates a registration definition.", + "parameters": [ + { + "$ref": "#/parameters/RegistrationDefinitionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "name": "requestBody", + "in": "body", + "required": true, + "description": "The parameters required to create new registration definition.", + "schema": { + "$ref": "#/definitions/RegistrationDefinition" + } + } + ], + "responses": { + "200": { + "description": "Ok - Returns information about the updated registration definition.", + "schema": { + "$ref": "#/definitions/RegistrationDefinition" + } + }, + "201": { + "description": "Created - Returns information about the created registration definition.", + "schema": { + "$ref": "#/definitions/RegistrationDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put Registration Definition": { + "$ref": "./examples/PutRegistrationDefinition.json" + } + } + } + }, + "/{scope}/providers/Microsoft.ManagedServices/registrationAssignments/{registrationAssignmentId}": { + "get": { + "tags": [ + "RegistrationAssignments" + ], + "operationId": "RegistrationAssignments_Get", + "description": "Gets the details of specified registration assignment.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/RegistrationAssignmentIdParameter" + }, + { + "$ref": "#/parameters/ExpandRegistrationDefinition" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the registration assignment.", + "schema": { + "$ref": "#/definitions/RegistrationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registration Assignment": { + "$ref": "./examples/GetRegistrationAssignment.json" + } + } + }, + "delete": { + "tags": [ + "RegistrationAssignments" + ], + "operationId": "RegistrationAssignments_Delete", + "x-ms-long-running-operation": true, + "description": "Deletes the specified registration assignment.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/RegistrationAssignmentIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - The registration assignment is deleted." + }, + "202": { + "description": "Accepted - The registration assignment deletion operation is accepted." + }, + "204": { + "description": "No Content- The registration assignment does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Registration Assignment": { + "$ref": "./examples/DeleteRegistrationAssignment.json" + } + } + }, + "put": { + "tags": [ + "RegistrationAssignments" + ], + "operationId": "RegistrationAssignments_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Creates or updates a registration assignment.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/RegistrationAssignmentIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "requestBody", + "in": "body", + "required": true, + "description": "The parameters required to create new registration assignment.", + "schema": { + "$ref": "#/definitions/RegistrationAssignment" + } + } + ], + "responses": { + "200": { + "description": "Ok - Returns information about the updated registration assignment.", + "schema": { + "$ref": "#/definitions/RegistrationAssignment" + } + }, + "201": { + "description": "Created - Returns information about the created registration assignment.", + "schema": { + "$ref": "#/definitions/RegistrationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Put Registration Assignment": { + "$ref": "./examples/PutRegistrationAssignment.json" + } + } + } + }, + "/{scope}/providers/Microsoft.ManagedServices/registrationDefinitions": { + "get": { + "tags": [ + "RegistrationDefinitions" + ], + "operationId": "RegistrationDefinitions_List", + "description": "Gets a list of the registration definitions.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns a list of the registration definitions.", + "schema": { + "$ref": "#/definitions/RegistrationDefinitionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Registration Definitions": { + "$ref": "./examples/GetRegistrationDefinitions.json" + } + } + } + }, + "/{scope}/providers/Microsoft.ManagedServices/registrationAssignments": { + "get": { + "tags": [ + "RegistrationAssignments" + ], + "operationId": "RegistrationAssignments_List", + "description": "Gets a list of the registration assignments.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/ExpandRegistrationDefinition" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns a list of the registration assignments.", + "schema": { + "$ref": "#/definitions/RegistrationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Registration Assignments": { + "$ref": "./examples/GetRegistrationAssignments.json" + } + } + } + }, + "/{scope}/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions": { + "get": { + "tags": [ + "MarketplaceRegistrationDefinitions" + ], + "operationId": "MarketplaceRegistrationDefinitions_List", + "description": "Gets a list of the marketplace registration definitions for the marketplace identifier.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/Filter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns a list of the marketplace registration definitions.", + "schema": { + "$ref": "#/definitions/MarketplaceRegistrationDefinitionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Registration Definitions": { + "$ref": "./examples/GetMarketplaceRegistrationDefinitions.json" + } + } + } + }, + "/{scope}/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/{marketplaceIdentifier}": { + "get": { + "tags": [ + "MarketplaceRegistrationDefinitions" + ], + "operationId": "MarketplaceRegistrationDefinitions_Get", + "description": "Get the marketplace registration definition for the marketplace identifier.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/MarketplaceIdentifier" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the details of the marketplace registration definition.", + "schema": { + "$ref": "#/definitions/RegistrationDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registration Definitions": { + "$ref": "./examples/GetMarketplaceRegistrationDefinition.json" + } + } + } + }, + "/providers/Microsoft.ManagedServices/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Gets a list of the operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns a list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Registration Operations": { + "$ref": "./examples/GetOperations.json" + } + } + } + } + }, + "definitions": { + "RegistrationDefinition": { + "properties": { + "properties": { + "description": "Properties of a registration definition.", + "$ref": "#/definitions/RegistrationDefinitionProperties" + }, + "plan": { + "description": "Plan details for the managed services.", + "$ref": "#/definitions/Plan" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified path of the registration definition." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the registration definition." + } + }, + "x-ms-azure-resource": true, + "type": "object", + "description": "Registration definition." + }, + "RegistrationDefinitionProperties": { + "properties": { + "description": { + "type": "string", + "description": "Description of the registration definition." + }, + "authorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/Authorization" + }, + "description": "Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role." + }, + "eligibleAuthorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/EligibleAuthorization" + }, + "description": "Eligible PIM authorization tuple containing principal id of the user/security group or service principal, id of the built-in role, and just-in-time access policy setting" + }, + "registrationDefinitionName": { + "type": "string", + "description": "Name of the registration definition." + }, + "managedByTenantId": { + "type": "string", + "description": "Id of the managedBy tenant." + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Current state of the registration definition.", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "managedByTenantName": { + "readOnly": true, + "type": "string", + "description": "Name of the managedBy tenant." + } + }, + "required": [ + "managedByTenantId", + "authorizations" + ], + "type": "object", + "description": "Properties of a registration definition." + }, + "RegistrationDefinitionList": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RegistrationDefinition" + }, + "description": "List of registration definitions." + }, + "nextLink": { + "description": "Link to next page of registration definitions.", + "type": "string", + "readOnly": true + } + }, + "description": "List of registration definitions." + }, + "RegistrationAssignment": { + "properties": { + "properties": { + "description": "Properties of a registration assignment.", + "$ref": "#/definitions/RegistrationAssignmentProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The fully qualified path of the registration assignment." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the registration assignment." + } + }, + "x-ms-azure-resource": true, + "type": "object", + "description": "Registration assignment." + }, + "RegistrationAssignmentProperties": { + "properties": { + "registrationDefinitionId": { + "type": "string", + "description": "Fully qualified path of the registration definition." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Current state of the registration assignment.", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "registrationDefinition": { + "readOnly": true, + "properties": { + "properties": { + "properties": { + "description": { + "type": "string", + "description": "Description of the registration definition." + }, + "authorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/Authorization" + }, + "description": "Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role." + }, + "eligibleAuthorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/EligibleAuthorization" + }, + "description": "Eligible PIM authorization tuple containing principal id of the user/security group or service principal, id of the built-in role, and just-in-time access policy setting" + }, + "registrationDefinitionName": { + "type": "string", + "description": "Name of the registration definition." + }, + "provisioningState": { + "type": "string", + "description": "Current state of the registration definition.", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "manageeTenantId": { + "type": "string", + "description": "Id of the home tenant." + }, + "manageeTenantName": { + "type": "string", + "description": "Name of the home tenant." + }, + "managedByTenantId": { + "type": "string", + "description": "Id of the managedBy tenant." + }, + "managedByTenantName": { + "type": "string", + "description": "Name of the managedBy tenant." + } + }, + "description": "Properties of registration definition inside registration assignment." + }, + "plan": { + "description": "Plan details for the managed services.", + "$ref": "#/definitions/Plan" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified path of the registration definition." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource (Microsoft.ManagedServices/registrationDefinitions)." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the registration definition." + } + }, + "type": "object", + "description": "Registration definition inside registration assignment." + } + }, + "required": [ + "registrationDefinitionId" + ], + "type": "object", + "description": "Properties of a registration assignment." + }, + "RegistrationAssignmentList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RegistrationAssignment" + }, + "description": "List of registration assignments." + }, + "nextLink": { + "description": "Link to next page of registration assignments.", + "type": "string", + "readOnly": true + } + }, + "description": "List of registration assignments." + }, + "MarketplaceRegistrationDefinitionList": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RegistrationDefinition" + }, + "description": "List of marketplace registration definitions." + }, + "nextLink": { + "description": "Link to next page of marketplace registration definitions.", + "type": "string", + "readOnly": true + } + }, + "description": "List of marketplace registration definitions." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "The plan name." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "The product code." + }, + "version": { + "type": "string", + "description": "The plan's version." + } + }, + "required": [ + "name", + "publisher", + "product", + "version" + ], + "type": "object", + "description": "Plan details for the managed services." + }, + "Operation": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{operation}" + }, + "display": { + "readOnly": true, + "description": "The object that represents the operation.", + "properties": { + "provider": { + "type": "string", + "description": "Service provider: Microsoft.ManagedServices" + }, + "resource": { + "type": "string", + "description": "Resource on which the operation is performed: Registration definition, registration assignment etc." + }, + "operation": { + "type": "string", + "description": "Operation type: Read, write, delete, etc." + }, + "description": { + "type": "string", + "description": "Description of the operation." + } + } + } + }, + "type": "object", + "description": "Object that describes a single Microsoft.ManagedServices operation." + }, + "OperationList": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Microsoft.ManagedServices operations." + } + }, + "type": "object", + "description": "List of the operations." + }, + "Authorization": { + "properties": { + "principalId": { + "type": "string", + "description": "Principal Id of the security group/service principal/user that would be assigned permissions to the projected subscription" + }, + "principalIdDisplayName": { + "type": "string", + "description": "Display name of the principal Id." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition identifier. This role will define all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role." + }, + "delegatedRoleDefinitionIds": { + "type": "array", + "description": "The delegatedRoleDefinitionIds field is required when the roleDefinitionId refers to the User Access Administrator Role. It is the list of role definition ids which define all the permissions that the user in the authorization can assign to other security groups/service principals/users.", + "items": { + "format": "uuid", + "type": "string" + } + } + }, + "required": [ + "principalId", + "roleDefinitionId" + ], + "type": "object", + "description": "Authorization tuple containing principal Id (of user/service principal/security group) and role definition id." + }, + "EligibleAuthorization": { + "properties": { + "principalId": { + "type": "string", + "description": "Principal Id of the security group/service principal/user that would be delegated permissions to the projected subscription" + }, + "principalIdDisplayName": { + "type": "string", + "description": "Display name of the principal Id." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition identifier. This role will delegate all the permissions that the security group/service principal/user must have on the projected subscription. This role cannot be an owner role." + }, + "justInTimeAccessPolicy": { + "description": "Just-in-time access policy setting.", + "$ref": "#/definitions/JustInTimeAccessPolicy" + } + }, + "required": [ + "principalId", + "roleDefinitionId" + ], + "type": "object", + "description": "Eligible authorization tuple containing principle Id (of user/service principal/security group), role definition id, and the just-in-time access setting." + }, + "JustInTimeAccessPolicy": { + "properties": { + "multiFactorAuthProvider": { + "type": "string", + "description": "MFA provider.", + "enum": [ + "Azure", + "None" + ], + "x-ms-enum": { + "name": "MultiFactorAuthProvider", + "modelAsString": true + } + }, + "maximumActivationDuration": { + "type": "string", + "format": "duration", + "description": "Maximum access duration in ISO 8601 format. The default value is \"PT8H\"." + } + }, + "required": [ + "multiFactorAuthProvider" + ], + "type": "object", + "description": "Just-in-time access policy setting." + }, + "ErrorResponse": { + "properties": { + "error": { + "readOnly": true, + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message indicating why the operation failed." + } + }, + "required": [ + "code", + "message" + ], + "type": "object", + "description": "Error response indicates Azure Resource Manager is not able to process the incoming request. The reason is provided in the error message." + } + }, + "description": "Error response." + } + }, + "parameters": { + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true, + "type": "string", + "description": "Scope of the resource." + }, + "MarketplaceIdentifier": { + "name": "marketplaceIdentifier", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "type": "string", + "description": "Market place identifer. Expected Formats - {publisher}.{product[-preview]}.{planName}.{version} or {publisher}.{product[-preview]}.{planName} or {publisher}.{product[-preview]} or {publisher})." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "RegistrationAssignmentIdParameter": { + "name": "registrationAssignmentId", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "type": "string", + "description": "Guid of the registration assignment." + }, + "RegistrationDefinitionIdParameter": { + "name": "registrationDefinitionId", + "in": "path", + "required": true, + "x-ms-parameter-location": "method", + "type": "string", + "description": "Guid of the registration definition." + }, + "ExpandRegistrationDefinition": { + "name": "$expandRegistrationDefinition", + "in": "query", + "x-ms-parameter-location": "method", + "type": "boolean", + "description": "Tells whether to return registration definition details also along with registration assignment details." + }, + "Filter": { + "name": "$filter", + "in": "query", + "x-ms-parameter-location": "method", + "type": "string", + "description": "The filter query parameter. Might be used to filter marketplace registration definition by plan identifier, publisher, version etc." + } + } +} diff --git a/specification/managedservices/resource-manager/readme.md b/specification/managedservices/resource-manager/readme.md index c2f452c2dade..69b69f935c8e 100644 --- a/specification/managedservices/resource-manager/readme.md +++ b/specification/managedservices/resource-manager/readme.md @@ -26,18 +26,27 @@ These are the global settings for the ManagedServices API. ``` yaml openapi-type: arm -tag: package-2019-09 +tag: package-2020-02-preview ``` +### Tag: package-2020-02-preview + +These settings apply only when `--tag=package-2020-02-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-02-preview' +input-file: + - Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json +``` ### Tag: package-2019-09 These settings apply only when `--tag=package-2019-09` is specified on the command line. -```yaml $(tag) == 'package-2019-09' +``` yaml $(tag) == 'package-2019-09' input-file: - Microsoft.ManagedServices/stable/2019-09-01/managedservices.json ``` + ### Tag: package-2019-06 These settings apply only when `--tag=package-2019-06` is specified on the command line. From 85666f532ba7787ec596be86747afad166705f69 Mon Sep 17 00:00:00 2001 From: azuresdkci Date: Wed, 27 May 2020 01:48:47 +0000 Subject: [PATCH 003/318] regenerated all-api-versions --- specification/managedservices/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/managedservices/resource-manager/readme.md b/specification/managedservices/resource-manager/readme.md index 69b69f935c8e..5273c2568abc 100644 --- a/specification/managedservices/resource-manager/readme.md +++ b/specification/managedservices/resource-manager/readme.md @@ -126,6 +126,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json - $(this-folder)/Microsoft.ManagedServices/stable/2019-09-01/managedservices.json - $(this-folder)/Microsoft.ManagedServices/stable/2019-06-01/managedservices.json - $(this-folder)/Microsoft.ManagedServices/preview/2019-04-01-preview/managedservices.json From 12529c93c4f484363335e44610daa7333864127f Mon Sep 17 00:00:00 2001 From: Lakshmi Priya Sekar Date: Tue, 26 May 2020 18:51:56 -0700 Subject: [PATCH 004/318] Add reboot parameters. (#9426) * Add reboot parameters. * Add examples and remove required on rebootType. * Fix prettier errors. --- .../examples/RedisCacheForceReboot.json | 6 +++++- .../2019-07-01/examples/RedisCacheGet.json | 9 ++++++--- .../Microsoft.Cache/preview/2019-07-01/redis.json | 15 ++++++++++++--- 3 files changed, 23 insertions(+), 7 deletions(-) diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/examples/RedisCacheForceReboot.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/examples/RedisCacheForceReboot.json index e0d664658354..8012f8ae115c 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/examples/RedisCacheForceReboot.json +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/examples/RedisCacheForceReboot.json @@ -6,7 +6,11 @@ "subscriptionId": "subid", "parameters": { "shardId": 0, - "rebootType": "AllNodes" + "rebootType": "AllNodes", + "ports": [ + 13000, + 15001 + ] } }, "responses": { diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/examples/RedisCacheGet.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/examples/RedisCacheGet.json index 3c0f3dc90c12..4169f729b99c 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/examples/RedisCacheGet.json +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/examples/RedisCacheGet.json @@ -35,15 +35,18 @@ "instances": [ { "sslPort": 15000, - "nonSslPort": 13000 + "nonSslPort": 13000, + "isMaster": true }, { "sslPort": 15001, - "nonSslPort": 13001 + "nonSslPort": 13001, + "isMaster": false }, { "sslPort": 15002, - "nonSslPort": 13002 + "nonSslPort": 13002, + "isMaster": false } ] } diff --git a/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/redis.json b/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/redis.json index 98d3ebe7adc0..fc67ab980b18 100644 --- a/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/redis.json +++ b/specification/redis/resource-manager/Microsoft.Cache/preview/2019-07-01/redis.json @@ -1796,6 +1796,11 @@ "type": "integer", "format": "int32", "description": "If clustering is enabled, the Shard ID of Redis Instance" + }, + "isMaster": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the instance is a master node." } }, "description": "Details of single instance of redis." @@ -1856,11 +1861,15 @@ "type": "integer", "format": "int32", "description": "If clustering is enabled, the ID of the shard to be rebooted." + }, + "ports": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "A list of redis instances to reboot, specified by per-instance SSL ports or non-SSL ports." } }, - "required": [ - "rebootType" - ], "description": "Specifies which Redis node(s) to reboot." }, "ExportRDBParameters": { From cccb41a7e2a0d52e480d94944efc09c26d4e488f Mon Sep 17 00:00:00 2001 From: Xiaoyun Ding Date: Wed, 27 May 2020 10:06:16 +0800 Subject: [PATCH 005/318] Azure Spring Cloud: Support API to enable/disable MSI (#8966) * Azure Spring Cloud: Support API to enable/disable MSI * Fix issue Co-authored-by: Xiaoyun Ding --- .../2019-05-01-preview/appplatform.json | 29 +++++++++++++++++++ .../examples/Apps_CreateOrUpdate.json | 11 +++++++ .../2019-05-01-preview/examples/Apps_Get.json | 5 ++++ .../examples/Apps_List.json | 5 ++++ .../examples/Apps_Update.json | 15 ++++++++++ 5 files changed, 65 insertions(+) diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json index 0e2bb009dc76..77f3b8fb53e2 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json @@ -2309,6 +2309,31 @@ } } }, + "ManagedIdentityProperties": { + "description": "Managed identity properties retrieved from ARM request headers.", + "type": "object", + "properties": { + "type": { + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned,UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "principalId": { + "type": "string" + }, + "tenantId": { + "type": "string" + } + } + }, "Sku": { "description": "Sku of Azure Spring Cloud", "required": [ @@ -2598,6 +2623,10 @@ "description": "Properties of the App resource", "x-ms-client-flatten": false }, + "identity": { + "$ref": "#/definitions/ManagedIdentityProperties", + "description": "The Managed Identity type of the app resource" + }, "location": { "description": "The GEO location of the application, always the same with its parent resource", "type": "string" diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_CreateOrUpdate.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_CreateOrUpdate.json index 8145e8e44747..be7ae73efb86 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_CreateOrUpdate.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_CreateOrUpdate.json @@ -15,6 +15,7 @@ "mountPath": "mypersistentdisk" } }, + "identity": null, "location": "eastus" }, "api-version": "2019-05-01-preview", @@ -44,6 +45,11 @@ } }, "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned", + "principalId": "principalid", + "tenantId": "tenantid" + }, "location": "eastus", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", "name": "myapp" @@ -69,6 +75,11 @@ } }, "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned", + "principalId": "principalid", + "tenantId": "tenantid" + }, "location": "eastus", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", "name": "myapp" diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Get.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Get.json index abdcd6fbd998..d939253e293a 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Get.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Get.json @@ -27,6 +27,11 @@ } }, "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned", + "principalId": "principalid", + "tenantId": "tenantid" + }, "location": "eastus", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", "name": "myapp" diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_List.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_List.json index 0e9002ad0c77..2d5263ba9412 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_List.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_List.json @@ -28,6 +28,11 @@ } }, "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned", + "principalId": "principalid", + "tenantId": "tenantid" + }, "location": "eastus", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", "name": "myapp" diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Update.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Update.json index 2ad43819f26f..d54122ac471b 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Update.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/examples/Apps_Update.json @@ -15,6 +15,11 @@ "mountPath": "mypersistentdisk" } }, + "identity": { + "type": "SystemAssigned", + "principalId": null, + "tenantId": null + }, "location": "eastus" }, "api-version": "2019-05-01-preview", @@ -44,6 +49,11 @@ } }, "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned", + "principalId": "principalid", + "tenantId": "tenantid" + }, "location": "eastus", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", "name": "myapp" @@ -69,6 +79,11 @@ } }, "type": "Microsoft.AppPlatform/Spring/apps", + "identity": { + "type": "SystemAssigned", + "principalId": "principalid", + "tenantId": "tenantid" + }, "location": "eastus", "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.AppPlatform/Spring/myservice/apps/myapp", "name": "myapp" From fc44ee327ea1ef5ea3cb999e9c54c4198dd10b27 Mon Sep 17 00:00:00 2001 From: Junbo Wang Date: Wed, 27 May 2020 10:33:46 +0800 Subject: [PATCH 006/318] [Azure SignalR service]Support Private Link and add new api-version (#9377) * Run prettier * Adding new apiVersion 2020-05-01 and support PrivateLink * Using the same schema for SignalR PUT api * No changes, to trigger pipeline build * Using shared definition to avoid duplication * resolve comments * fix avocado * Removing legacy file --- custom-words.txt | 2 + .../2020-05-01/examples/Operations_List.json | 25 + ...nalRPrivateEndpointConnections_Delete.json | 18 + ...SignalRPrivateEndpointConnections_Get.json | 29 + ...nalRPrivateEndpointConnections_Update.json | 45 + .../SignalRPrivateLinkResources_List.json | 31 + .../SignalR_CheckNameAvailability.json | 20 + .../examples/SignalR_CreateOrUpdate.json | 278 +++ .../2020-05-01/examples/SignalR_Delete.json | 17 + .../2020-05-01/examples/SignalR_Get.json | 106 + .../examples/SignalR_ListByResourceGroup.json | 109 ++ .../examples/SignalR_ListBySubscription.json | 108 + .../2020-05-01/examples/SignalR_ListKeys.json | 18 + .../examples/SignalR_RegenerateKey.json | 25 + .../2020-05-01/examples/SignalR_Restart.json | 17 + .../2020-05-01/examples/SignalR_Update.json | 178 ++ .../2020-05-01/examples/Usages_List.json | 36 + .../stable/2020-05-01/signalr.json | 1741 +++++++++++++++++ .../signalr/resource-manager/readme.go.md | 10 + .../signalr/resource-manager/readme.java.md | 16 +- .../signalr/resource-manager/readme.md | 26 +- .../signalr/resource-manager/readme.ruby.md | 11 + 22 files changed, 2861 insertions(+), 5 deletions(-) create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Operations_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateLinkResources_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CheckNameAvailability.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListByResourceGroup.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListBySubscription.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListKeys.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_RegenerateKey.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Restart.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Usages_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json diff --git a/custom-words.txt b/custom-words.txt index 3a5c2da39997..1c26a569001a 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1173,6 +1173,7 @@ randint Rankable ratelimit ravbhatnagar +rawwebsockets rawxml rbac rdbms @@ -1254,6 +1255,7 @@ resourcename resourceregion resourcetype Responsys +RESTAPI restoreheartbeat Restproxy restype diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Operations_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Operations_List.json new file mode 100644 index 000000000000..d43346e00368 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SignalRService/SignalR/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.SignalRService", + "resource": "SignalR", + "operation": "Manage SignalR (read-only)", + "description": "View the SignalR's settings and configurations in the management portal or through API" + }, + "properties": {} + } + ], + "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..f9c6b18ec351 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..afdb580d1bba --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..1fa8b532aac5 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateEndpointConnections_Update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "parameters": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + } + }, + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateLinkResources_List.json new file mode 100644 index 000000000000..90120de37bab --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalRPrivateLinkResources_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "signalr", + "requiredMembers": [ + "signalr" + ], + "requiredZoneNames": [ + "privatelink.service.signalr.net" + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/privateLinkResources", + "name": "signalr", + "type": "privateLinkResources" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CheckNameAvailability.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CheckNameAvailability.json new file mode 100644 index 000000000000..a330b6b9ca3f --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "eastus", + "parameters": { + "type": "Microsoft.SignalRService/SignalR", + "name": "my-signalr-service" + }, + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The leaf is already used by other people" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CreateOrUpdate.json new file mode 100644 index 000000000000..3eb1a78ba38b --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_CreateOrUpdate.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "capacity": 1 + }, + "properties": { + "hostNamePrefix": null, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": "*", + "eventPattern": "connect,disconnect", + "categoryPattern": "*", + "urlTemplate": "https://example.com/chat/api/connect" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "hostNamePrefix": "mysignalrservice", + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + }, + "201": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "hostNamePrefix": "mysignalrservice", + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Delete.json new file mode 100644 index 000000000000..d9e03852aebb --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Get.json new file mode 100644 index 000000000000..2c7bdf651621 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Get.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "hostNamePrefix": "mysignalrservice", + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListByResourceGroup.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListByResourceGroup.json new file mode 100644 index 000000000000..f862bb2cfa40 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListByResourceGroup.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "hostNamePrefix": "mysignalrservice", + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListBySubscription.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListBySubscription.json new file mode 100644 index 000000000000..1ed24a8269e7 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListBySubscription.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "hostNamePrefix": "mysignalrservice", + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListKeys.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListKeys.json new file mode 100644 index 000000000000..8932231e33c4 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_ListKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "primaryKey": "primaryAccessKey", + "secondaryKey": "secondaryAccessKey", + "primaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;Version=1.0", + "secondaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;Version=1.0" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_RegenerateKey.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_RegenerateKey.json new file mode 100644 index 000000000000..0fb7ffb871bb --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_RegenerateKey.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "parameters": { + "keyType": "Primary" + }, + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "201": { + "body": { + "primaryKey": "primaryAccessKey", + "secondaryKey": "secondaryAccessKey", + "primaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;Version=1.0;", + "secondaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;Version=1.0;" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Restart.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Restart.json new file mode 100644 index 000000000000..d9e03852aebb --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Restart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Update.json new file mode 100644 index 000000000000..29a1ef2fd73f --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/SignalR_Update.json @@ -0,0 +1,178 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "capacity": 1 + }, + "properties": { + "hostNamePrefix": null, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": "*", + "eventPattern": "connect,disconnect", + "categoryPattern": "*", + "urlTemplate": "https://example.com/chat/api/connect" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "hostNamePrefix": "mysignalrservice", + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com" + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Usages_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Usages_List.json new file mode 100644 index 000000000000..ae2279860df6 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/examples/Usages_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "location": "eastus", + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage1", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage1", + "localizedValue": "Usage1" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage2", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage2", + "localizedValue": "Usage2" + }, + "unit": "Count" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json new file mode 100644 index 000000000000..844d2f52801c --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/stable/2020-05-01/signalr.json @@ -0,0 +1,1741 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-05-01", + "title": "SignalRManagementClient", + "description": "REST API for Azure SignalR Service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Checks that the SignalR name is valid and is not already in use.", + "operationId": "SignalR_CheckNameAvailability", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the region", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the operation.", + "required": false, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_CheckNameAvailability": { + "$ref": "./examples/SignalR_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "SignalR_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SignalR services in the subscription.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalR_ListBySubscription": { + "$ref": "./examples/SignalR_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "SignalR_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SignalR services in a resourceGroup.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalR_ListByResourceGroup": { + "$ref": "./examples/SignalR_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified private endpoint connection associated with a SignalR resource.", + "operationId": "SignalRPrivateEndpointConnections_Get", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the SignalR resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Get": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Update the state of specified private endpoint connection associated with a SignalR resource.", + "operationId": "SignalRPrivateEndpointConnections_Update", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the SignalR resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The resource of private endpoint and its properties.", + "required": false, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Update": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Update.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete the specified private endpoint connection associated with a SignalR resource.", + "operationId": "SignalRPrivateEndpointConnections_Delete", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the SignalR resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "202": { + "description": "Success" + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Delete": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the private link resources that need to be created for a SignalR resource.", + "operationId": "SignalRPrivateLinkResources_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRPrivateLinkResources_List": { + "$ref": "./examples/SignalRPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Get the access keys of the SignalR resource.", + "operationId": "SignalR_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes SignalR service access keys.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_ListKeys": { + "$ref": "./examples/SignalR_ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "SignalR_RegenerateKey", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": false, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "201": { + "description": "Created and an async operation is executing in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalR_RegenerateKey": { + "$ref": "./examples/SignalR_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the SignalR service and its properties.", + "operationId": "SignalR_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding SignalR service.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_Get": { + "$ref": "./examples/SignalR_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create a new SignalR service and update an exiting SignalR service.", + "operationId": "SignalR_CreateOrUpdate", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": false, + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a SignalR service.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "201": { + "description": "Created. The response describes the new service and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalR_CreateOrUpdate": { + "$ref": "./examples/SignalR_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Operation to delete a SignalR service.", + "operationId": "SignalR_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalR_Delete": { + "$ref": "./examples/SignalR_Delete.json" + } + } + }, + "patch": { + "tags": [ + "SignalR" + ], + "description": "Operation to update an exiting SignalR service.", + "operationId": "SignalR_Update", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the update operation", + "required": false, + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a SignalR service.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalR_Update": { + "$ref": "./examples/SignalR_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Operation to restart a SignalR service.", + "operationId": "SignalR_Restart", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalR_Restart": { + "$ref": "./examples/SignalR_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List usage quotas for Azure SignalR service by location.", + "operationId": "Usages_List", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the location like \"eastus\"", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the usage quotas of a subscription in specified region.", + "schema": { + "$ref": "#/definitions/SignalRUsageList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usages_List": { + "$ref": "./examples/Usages_List.json" + } + } + } + } + }, + "definitions": { + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "Operation": { + "description": "REST API operation supported by SignalR resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "If the operation is a data action. (for data plane rbac)", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The object that describes the operation." + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Extra properties for the operation.", + "x-ms-client-flatten": false + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications." + } + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + }, + "logSpecifications": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + } + } + }, + "LogSpecification": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the log.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Specifications of the Dimension of metrics.", + "type": "object", + "properties": { + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "ErrorResponse": { + "description": "Contains information about an API error.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorResponseBody", + "description": "Describes a particular API error with an error code and a message." + } + } + }, + "ErrorResponseBody": { + "description": "Describes a particular API error with an error code and a message.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "An error code that describes the error condition more precisely than an HTTP status code. \r\nCan be used to programmatically handle specific error cases.", + "type": "string" + }, + "message": { + "description": "A message that describes the error in detail and provides debugging information.", + "type": "string" + }, + "target": { + "description": "The target of the particular error (for example, the name of the property in error).", + "type": "string" + }, + "details": { + "description": "Contains nested errors that are related to this error.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + } + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "type", + "name" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Should be always \"Microsoft.SignalRService/SignalR\".", + "type": "string" + }, + "name": { + "description": "The SignalR service name to validate. e.g.\"my-signalR-name-here\"", + "type": "string" + } + } + }, + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } + } + }, + "SignalRResourceList": { + "description": "Object that includes an array of SignalR services and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of SignalR services", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRResource": { + "description": "A class represent a SignalR service resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The billing information of the resource.(e.g. Free, Standard)" + }, + "properties": { + "$ref": "#/definitions/SignalRProperties", + "description": "Settings used to provision or configure the resource", + "x-ms-client-flatten": true + }, + "kind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of the service - e.g. \"SignalR\", or \"RawWebSockets\" for \"Microsoft.SignalRService/SignalR\"", + "x-ms-mutability": [ + "read", + "create" + ] + } + } + }, + "ServiceKind": { + "description": "The kind of the service - e.g. \"SignalR\", or \"RawWebSockets\" for \"Microsoft.SignalRService/SignalR\"", + "enum": [ + "SignalR", + "RawWebSockets" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Resource": { + "description": "The core properties of ARM resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ResourceSku": { + "description": "The billing information of the SignalR resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1", + "type": "string" + }, + "tier": { + "$ref": "#/definitions/SignalRSkuTier", + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead." + }, + "size": { + "description": "Optional string. For future use.", + "type": "string" + }, + "family": { + "description": "Optional string. For future use.", + "type": "string" + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. The unit count of SignalR resource. 1 by default.\r\n\r\nIf present, following values are allowed:\r\n Free: 1\r\n Standard: 1,2,5,10,20,50,100", + "type": "integer" + } + } + }, + "SignalRSkuTier": { + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRSkuTier", + "modelAsString": true + } + }, + "SignalRProperties": { + "description": "A class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SignalRCreateOrUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "externalIP": { + "description": "The publicly accessible IP of the SignalR service.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "FQDN of the SignalR service instance. Format: xxx.service.signalr.net", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessible port of the SignalR service which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessible port of the SignalR service which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + }, + "version": { + "description": "Version of the SignalR resource. Probably you need the same or higher version of client SDKs.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the SignalR resource.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + } + } + }, + "ProvisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "SignalRCreateOrUpdateProperties": { + "description": "Settings used to provision or configure the resource.", + "type": "object", + "properties": { + "hostNamePrefix": { + "description": "Prefix for the hostName of the SignalR service. Retained for future use.\r\nThe hostname will be of format: <hostNamePrefix>.service.signalr.net.", + "type": "string" + }, + "features": { + "description": "List of SignalR featureFlags. e.g. ServiceMode.\r\n\r\nFeatureFlags that are not included in the parameters for the update operation will not be modified.\r\nAnd the response will only include featureFlags that are explicitly set. \r\nWhen a featureFlag is not explicitly set, SignalR service will use its globally default value. \r\nBut keep in mind, the default value doesn't mean \"false\". It varies in terms of different FeatureFlags.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRFeature" + } + }, + "cors": { + "$ref": "#/definitions/SignalRCorsSettings", + "description": "Cross-Origin Resource Sharing (CORS) settings." + }, + "upstream": { + "$ref": "#/definitions/ServerlessUpstreamSettings", + "description": "Upstream settings when the Azure SignalR is in server-less mode." + }, + "networkACLs": { + "$ref": "#/definitions/SignalRNetworkACLs", + "description": "Network ACLs" + } + } + }, + "SignalRFeature": { + "description": "Feature of a SignalR resource, which controls the SignalR runtime behavior.", + "required": [ + "flag", + "value" + ], + "type": "object", + "properties": { + "flag": { + "$ref": "#/definitions/FeatureFlags", + "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively." + }, + "value": { + "description": "Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "properties": { + "description": "Optional properties related to this feature.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "FeatureFlags": { + "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.", + "enum": [ + "ServiceMode", + "EnableConnectivityLogs", + "EnableMessagingLogs" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureFlags", + "modelAsString": true + } + }, + "SignalRCorsSettings": { + "description": "Cross-Origin Resource Sharing (CORS) settings.", + "type": "object", + "properties": { + "allowedOrigins": { + "description": "Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use \"*\" to allow all. If omitted, allow all by default.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ServerlessUpstreamSettings": { + "description": "The settings for the Upstream when the Azure SignalR is in server-less mode.", + "type": "object", + "properties": { + "templates": { + "description": "Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.", + "type": "array", + "items": { + "$ref": "#/definitions/UpstreamTemplate" + } + } + } + }, + "SignalRNetworkACLs": { + "description": "Network ACLs for SignalR", + "type": "object", + "properties": { + "defaultAction": { + "$ref": "#/definitions/ACLAction", + "description": "Default action when no other rule matches" + }, + "publicNetwork": { + "$ref": "#/definitions/NetworkACL", + "description": "ACL for requests from public network" + }, + "privateEndpoints": { + "description": "ACLs for requests from private endpoints", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointACL" + } + } + } + }, + "ACLAction": { + "description": "Default action when no other rule matches", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "ACLAction", + "modelAsString": true + } + }, + "UpstreamTemplate": { + "description": "Upstream template item settings. It defines the Upstream URL of the incoming requests.\r\nThe template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.", + "required": [ + "urlTemplate" + ], + "type": "object", + "properties": { + "hubPattern": { + "description": "Gets or sets the matching pattern for hub names. If not set, it matches any hub.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any hub name\r\n 2. Combine multiple hubs with \",\", for example \"hub1,hub2\", it matches \"hub1\" and \"hub2\"\r\n 3. The single hub name, for example, \"hub1\", it matches \"hub1\"", + "type": "string" + }, + "eventPattern": { + "description": "Gets or sets the matching pattern for event names. If not set, it matches any event.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any event name\r\n 2. Combine multiple events with \",\", for example \"connect,disconnect\", it matches event \"connect\" and \"disconnect\"\r\n 3. The single event name, for example, \"connect\", it matches \"connect\"", + "type": "string" + }, + "categoryPattern": { + "description": "Gets or sets the matching pattern for category names. If not set, it matches any category.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any category name\r\n 2. Combine multiple categories with \",\", for example \"connections,messages\", it matches category \"connections\" and \"messages\"\r\n 3. The single category name, for example, \"connections\", it matches the category \"connections\"", + "type": "string" + }, + "urlTemplate": { + "description": "Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.\r\nFor example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.", + "type": "string" + } + } + }, + "NetworkACL": { + "description": "Network ACL", + "type": "object", + "properties": { + "allow": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + } + }, + "deny": { + "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + } + } + } + }, + "SignalRRequestType": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "enum": [ + "ClientConnection", + "ServerConnection", + "RESTAPI" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRRequestType", + "modelAsString": true + } + }, + "PrivateEndpointACL": { + "description": "ACL for a private endpoint", + "required": [ + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkACL" + } + ], + "properties": { + "name": { + "description": "Name of the private endpoint connection", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection to SignalR resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the private endpoint connection", + "x-ms-client-flatten": true + } + } + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the private endpoint connection", + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "Private endpoint associated with the private endpoint connection" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "Connection state" + } + } + }, + "PrivateEndpoint": { + "description": "Private endpoint", + "type": "object", + "properties": { + "id": { + "description": "Full qualified Id of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Connection state of the private endpoint connection", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "description": "The reason for approval/rejection of the connection.", + "type": "string" + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStatus": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateLinkResourceList": { + "description": "Contains a list of AzSignalR.Models.Response.PrivateLink.PrivateLinkResource and a possible link to query more results", + "type": "object", + "properties": { + "value": { + "description": "List of PrivateLinkResource", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "Private link resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of a private link resource", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Private link resource properties", + "type": "object", + "properties": { + "groupId": { + "description": "Group Id of the private link resource", + "type": "string" + }, + "requiredMembers": { + "description": "Required members of the private link resource", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "Required private DNS zone names", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SignalRKeys": { + "description": "A class represents the access keys of SignalR service.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string" + }, + "primaryConnectionString": { + "description": "SignalR connection string constructed via the primaryKey", + "type": "string" + }, + "secondaryConnectionString": { + "description": "SignalR connection string constructed via the secondaryKey", + "type": "string" + } + } + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType", + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive)." + } + } + }, + "KeyType": { + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + }, + "SignalRUsageList": { + "description": "Object that includes an array of SignalR resource usages and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of SignalR usages", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRUsage" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRUsage": { + "description": "Object that describes a specific usage of SignalR resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/SignalRUsageName", + "description": "Localizable String object containing the name and a localized value." + }, + "unit": { + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", + "type": "string" + } + } + }, + "SignalRUsageName": { + "description": "Localizable String object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "The identifier of the usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name of the usage.", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SignalRServiceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the SignalR resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/signalr/resource-manager/readme.go.md b/specification/signalr/resource-manager/readme.go.md index f84c87f6866a..c7fed8130266 100644 --- a/specification/signalr/resource-manager/readme.go.md +++ b/specification/signalr/resource-manager/readme.go.md @@ -15,6 +15,7 @@ go: batch: - tag: package-2018-03-01-preview - tag: package-2018-10-01 + - tag: package-2020-05-01 ``` ### Tag: package-2018-03-01-preview and go @@ -34,3 +35,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-05-01' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-05-01/$(namespace) +``` diff --git a/specification/signalr/resource-manager/readme.java.md b/specification/signalr/resource-manager/readme.java.md index b6b8cbf12242..332c4a397833 100644 --- a/specification/signalr/resource-manager/readme.java.md +++ b/specification/signalr/resource-manager/readme.java.md @@ -18,6 +18,20 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-signalr batch: - tag: package-2018-03-01-preview - tag: package-2018-10-01 + - tag: package-2020-05-01 +``` + +### Tag: package-2020-05-01 and java + +These settings apply only when `--tag=package-2020-05-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-05-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.signalr.v2020_05_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/signalr/mgmt-v2020_05_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2018-10-01 and java @@ -44,4 +58,4 @@ java: output-folder: $(azure-libraries-for-java-folder)/sdk/signalr/mgmt-v2018_03_01_preview regenerate-manager: true generate-interface: true -``` \ No newline at end of file +``` diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index dd35a4918a1f..807ff01765c9 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the SignalR API. ``` yaml openapi-type: arm -tag: package-2018-10-01 +tag: package-2020-05-01 ``` ### Suppression @@ -41,10 +41,27 @@ directive: from: signalr.json where: $.definitions.Dimension.properties.toBeExportedForShoebox reason: The boolean properties 'toBeExportedForShoebox' is defined by Geneva metrics. - - suppress: PutRequestResponseScheme + - suppress: EnumInsteadOfBoolean + from: signalr.json + where: $.definitions.Operation.properties.isDataAction + reason: The boolean properties 'isDataAction' is a standard property for Azuer Operatoins. + - suppress: TrackedResourceListByImmediateParent + reason: Another list APIs naming approach is used over the specs + - suppress: AvoidNestedProperties from: signalr.json - where: $.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}"].put - reason: The schema of the PUT request body is a superset of the GET response body, we have a PATCH operation to make the resource updatable + where: + - $.definitions.SignalRFeature.properties.properties + - $.definitions.PrivateEndpointConnection.properties.properties + reason: The 'properties' is a user-defined dictionary, cannot be flattened. +``` + +### Tag: package-2020-05-01 + +These settings apply only when `--tag=package-2020-05-01` is specified on the command line. + +``` yaml $(tag) == 'package-2020-05-01' +input-file: +- Microsoft.SignalRService/stable/2020-05-01/signalr.json ``` ### Tag: package-2018-10-01 @@ -123,6 +140,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.SignalRService/stable/2020-05-01/signalr.json - $(this-folder)/Microsoft.SignalRService/stable/2018-10-01/signalr.json - $(this-folder)/Microsoft.SignalRService/preview/2018-03-01-preview/signalr.json diff --git a/specification/signalr/resource-manager/readme.ruby.md b/specification/signalr/resource-manager/readme.ruby.md index 39b11888ae39..b10560ba58b6 100644 --- a/specification/signalr/resource-manager/readme.ruby.md +++ b/specification/signalr/resource-manager/readme.ruby.md @@ -14,6 +14,17 @@ azure-arm: true batch: - tag: package-2018-03-01-preview - tag: package-2018-10-01 + - tag: package-2020-05-01 +``` + +### Tag: package-2020-05-01 and ruby + +These settings apply only when `--tag=package-2020-05-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-05-01' && $(ruby) +namespace: "Azure::Signalr::Mgmt::V2020_05_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_signalr/lib ``` ### Tag: package-2018-10-01 and ruby From b2c0ba89681fee48d789a96bd7d5d3c026e55b27 Mon Sep 17 00:00:00 2001 From: chunyu3 Date: Wed, 27 May 2020 11:23:54 +0800 Subject: [PATCH 007/318] add readme file for alertsmanagement (#9578) * update package name and output folder in readme.typescript.md * add trenton readme file for alertsmanagement * update override for type --- .../resource-manager/readme.trenton.md | 47 +++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 specification/alertsmanagement/resource-manager/readme.trenton.md diff --git a/specification/alertsmanagement/resource-manager/readme.trenton.md b/specification/alertsmanagement/resource-manager/readme.trenton.md new file mode 100644 index 000000000000..06e42501cc61 --- /dev/null +++ b/specification/alertsmanagement/resource-manager/readme.trenton.md @@ -0,0 +1,47 @@ +## overrides + +These settings apply only when `--trenton` is specified on the command line. +``` yaml $(trenton) +overrides: + - where: + resource: "*" + set: + - NeedSeparated: false + - where: + resource: "ActionRules" + property: "properties" + set: + - GoFieldName: "Properties" + - where: + resource: "ActionRules" + method: "Update" + property: "properties" + set: + - GoFieldName: "PatchProperties" + - where: + property: "type" + set: + - Hidden: true + - where: + resource: "ActionRules" + property: "/actionRule/properties/type" + set: + - Hidden: false + - where: + resource: "ActionRules" + property: "scopeType" + set: + - EnumValues/0/GoEnumMemberName: "ScopeTypeResourceGroup" + - EnumValues/1/GoEnumMemberName: "ScopeTypeResource" +``` +## trenton + +These settings apply only when `--trenton` is specified on the command line. + +``` yaml $(trenton) +trenton: + cli-name: alertsManagement + package-name: alertsmanagement +clear-output-folder: true +output-folder: $(trenton-output-folder)/alertsmanagement +``` From 4812f3bc68ff4870417d796909475a3160944954 Mon Sep 17 00:00:00 2001 From: xiaoxu qi Date: Wed, 27 May 2020 11:29:31 +0800 Subject: [PATCH 008/318] Get buildID for package version (#9594) Co-authored-by: Xiaoxu Qi --- .azure-pipelines/SDKAutomation.yml | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/.azure-pipelines/SDKAutomation.yml b/.azure-pipelines/SDKAutomation.yml index 4ffe19244ebd..d119dafbe8d1 100644 --- a/.azure-pipelines/SDKAutomation.yml +++ b/.azure-pipelines/SDKAutomation.yml @@ -23,6 +23,7 @@ jobs: BLOB_STORAGE_PREFIX: sdkautomation-pipeline SPEC_REPO: $(Build.Repository.Name) PR_NUMBER: $(System.PullRequest.PullRequestNumber) + BUILD_ID: $(Build.BuildId) strategy: matrix: Net: @@ -70,6 +71,7 @@ jobs: -e PR_NUMBER \ -e SDK_REPO_NAME \ -e AZURE_DEVOPS_EXT_PAT \ + -e BUILD_ID \ sdk-automation:latest npm start env: BLOB_STORAGE_NAME: $(blob-storage-name) @@ -78,5 +80,4 @@ jobs: GITHUBAPP_ID: $(githubapp-id) GITHUBAPP_PRIVATE_KEY: $(githubapp-private-key) AZURE_DEVOPS_EXT_PAT: $(azure-devops-ext-pat) - BUILD_ID: $(Build.BuildId) displayName: SDK Automation From f27186977ec809223fee052e6c2fa4c529695677 Mon Sep 17 00:00:00 2001 From: jbuls <48029054+jbuls@users.noreply.github.com> Date: Tue, 26 May 2020 20:33:16 -0700 Subject: [PATCH 009/318] Changes for EA invoice scenarios (#9508) * Added invoice download APIs. Added billing account-level invoice APIs for supporting EA invoices. * Fixed billing subscription invoice download scope * Added invoice rebillDetails * Reduced changes to those for supporting EA invoices * Reduced changes to those for supporting EA invoices 2 * Reduced changes to those for supporting EA invoices 3 * PR feedback * Added Cleared value for invoice status. * Changed invoice status Cleared to Void * Removed documents/source property from invoice example --- .../preview/2019-10-01-preview/billing.json | 85 ++++++++++++++++++- .../examples/BillingAccountInvoice.json | 81 ++++++++++++++++++ 2 files changed, 164 insertions(+), 2 deletions(-) create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountInvoice.json diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json index 474087d42ac9..9ef0b0294a0d 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json @@ -1604,7 +1604,7 @@ } }, "operationId": "Invoices_ListByBillingAccount", - "description": "Lists the invoices for a billing account for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "description": "Lists the invoices for a billing account for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -1643,6 +1643,45 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}": { + "get": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "EnterpriseAgreementInvoice": { + "$ref": "./examples/BillingAccountInvoice.json" + } + }, + "operationId": "Invoices_GetBillingAccountInvoice", + "description": "Gets an invoice by billing account name and ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/invoiceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices/{invoiceName}/pricesheet/default/download": { "post": { "tags": [ @@ -6245,7 +6284,8 @@ "enum": [ "Due", "OverDue", - "Paid" + "Paid", + "Void" ], "readOnly": true, "x-ms-enum": { @@ -6359,6 +6399,11 @@ "description": "The ID of the subscription for which the invoice is generated.", "type": "string", "readOnly": true + }, + "rebillDetails": { + "description": "Rebill details of an Enterprise Agreement invoice.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InvoiceRebillDetails" } } }, @@ -6402,6 +6447,34 @@ } } }, + "InvoiceRebillDetails": { + "description": "The rebill details of an invoice.", + "properties": { + "rebillDocumentType": { + "description": "The type of the document generated when an Enterprise Agreement invoice is rebilled.", + "type": "string", + "enum": [ + "Credit", + "Rebill", + "Original" + ], + "x-ms-enum": { + "name": "rebillDocumentType", + "modelAsString": true + } + }, + "rebilledInvoiceId": { + "description": "The ID of the invoice generated when an Enterprise Agreement invoice is rebilled.", + "type": "string", + "readOnly": true + }, + "latestInvoiceId": { + "description": "The ID of the latest invoice generated when an Enterprise Agreement invoice is rebilled.", + "type": "string", + "readOnly": true + } + } + }, "Document": { "description": "The properties of a document.", "properties": { @@ -6424,6 +6497,14 @@ "description": "Document URL.", "type": "string", "readOnly": true + }, + "documentNumbers": { + "description": "Document numbers for an Enterprise Agreement invoice.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } } } }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountInvoice.json new file mode 100644 index 000000000000..f79c4ce4b71e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountInvoice.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "invoiceName": "{invoiceName}" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}", + "name": "{invoiceName}", + "type": "Microsoft.Billing/billingAccounts/invoices", + "properties": { + "dueDate": "2018-01-16T17:32:28Z", + "invoiceDate": "2018-01-01T17:32:28Z", + "status": "Due", + "amountDue": { + "currency": "USD", + "value": 16.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 15.46 + }, + "creditAmount": { + "currency": "USD", + "value": 2.00 + }, + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0.00 + }, + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 0.00 + }, + "totalAmount": { + "currency": "USD", + "value": 16.53 + }, + "invoicePeriodStartDate": "2018-01-01T17:32:28Z", + "invoicePeriodEndDate": "2018-01-15T17:32:28Z", + "isMonthlyInvoice": false, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "billingProfileDisplayName": "Contoso Operations Billing", + "purchaseOrderNumber": "123456", + "documents": [ + { + "kind": "Invoice", + "url": "https://microsoft.com/invoice.pdf" + }, + { + "kind": "TaxReceipt", + "url": "https://microsoft.com/taxDoc.pdf" + } + ], + "payments": [ + { + "date": "2018-01-14T17:32:28Z", + "paymentType": "credited", + "amount": { + "currency": "USD", + "value": 2.00 + }, + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa" + } + ] + } + } + } + } +} From 6d6071db4d94e48fc0f2130ed01858ae51a8c875 Mon Sep 17 00:00:00 2001 From: giromm2ms <52413295+giromm2ms@users.noreply.github.com> Date: Wed, 27 May 2020 08:56:06 +0300 Subject: [PATCH 010/318] documentation updates (#9583) * documentation updates * Reverting user impersonate value --- ...SecureScoreControlDefinitions_example.json | 2 +- ...ntrolDefinitions_subscription_example.json | 2 +- .../GetSecureScoresSingle_example.json | 2 +- ...rolsForNameWithExpand_builtin_example.json | 2 +- .../ListSecureScores_example.json | 2 +- .../2020-01-01-preview/secureScore.json | 64 +++++++++---------- 6 files changed, 37 insertions(+), 37 deletions(-) diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json index d80f8690a49c..6556847ce39e 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json @@ -33,7 +33,7 @@ "sourceType": "BuiltIn" }, "displayName": "Apply adaptive application control", - "description": "This control contains recommendations regarding enable of adaptive application control", + "description": "This control contains recommendations regarding enabling adaptive application control", "maxScore": 3, "assessmentDefinitions": [ { diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json index bd7565f01793..899b522bce20 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json @@ -58,7 +58,7 @@ "sourceType": "BuiltIn" }, "displayName": "Apply adaptive application control", - "description": "This control contains recommendations regarding enable of adaptive application control", + "description": "This control contains recommendations regarding enabling adaptive application control", "maxScore": 3, "assessmentDefinitions": [ { diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json index f543777c76e2..58c0d683cb8c 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/GetSecureScoresSingle_example.json @@ -11,7 +11,7 @@ "name": "ascScore", "type": "Microsoft.Security/secureScores", "properties": { - "displayName": "Asc Score", + "displayName": "ASC score", "score": { "max": 13, "current": 3 diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json index aec26c1a6e20..99b0d5df2e2e 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json @@ -106,7 +106,7 @@ "sourceType": "BuiltIn" }, "displayName": "Apply adaptive application control", - "description": "This control contains recommendations regarding enable of adaptive application control", + "description": "This control contains recommendations regarding enabling adaptive application control", "maxScore": 3, "assessmentDefinitions": [ { diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScores_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScores_example.json index ebe793feb7dc..c9fc267708c1 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScores_example.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/secureScores/ListSecureScores_example.json @@ -12,7 +12,7 @@ "name": "ascScore", "type": "Microsoft.Security/secureScores", "properties": { - "displayName": "Asc Score", + "displayName": "ASC score", "score": { "max": 13, "current": 3.5 diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json index ed64e7a0096f..7d2ebe1a4e0c 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json @@ -42,9 +42,9 @@ } }, "tags": [ - "Secure Scores" + "Secure Score" ], - "description": "Get secure scores on all your initiatives inside a scope", + "description": "List secure scores for all your Security Center initiatives within your current scope.", "operationId": "SecureScores_List", "parameters": [ { @@ -81,9 +81,9 @@ } }, "tags": [ - "Secure Scores" + "Secure Score" ], - "description": "Get secure score for a specific initiatives inside a scope", + "description": "Get secure score for a specific initiative within your current scope. For the ASC Default initiative, use 'ascScore'.", "operationId": "SecureScores_Get", "parameters": [ { @@ -115,17 +115,17 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/secureScores/{secureScoreName}/secureScoreControls": { "get": { "x-ms-examples": { - "List secure score's controls level for the specified name": { + "Get security controls and their current score for the specified initiative": { "$ref": "./examples/secureScores/ListSecureScoreControlsForName_builtin_example.json" }, - "Get secure score's controls level for the specified name with expand parameter (builtin)": { + "Get security controls and their current score for the specified initiative with the expand parameter": { "$ref": "./examples/secureScores/ListSecureScoreControlsForNameWithExpand_builtin_example.json" } }, "tags": [ - "Secure Scores" + "Secure Score" ], - "description": "Get all secure score controls on specific initiatives inside a scope", + "description": "Get all security controls for a specific initiative within a scope", "operationId": "SecureScoreControls_ListBySecureScore", "parameters": [ { @@ -168,9 +168,9 @@ } }, "tags": [ - "Secure Scores" + "Secure Score Controls" ], - "description": "Get all secure score controls on specific initiatives inside a scope", + "description": "Get all security controls within a scope", "operationId": "SecureScoreControls_List", "parameters": [ { @@ -205,15 +205,15 @@ "/providers/Microsoft.Security/secureScoreControlDefinitions": { "get": { "x-ms-examples": { - "List secure score controls definition": { + "List security controls definition": { "$ref": "./examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_example.json" } }, "tags": [ - "Secure Score Controls Definition" + "Secure Score Control Definitions" ], - "description": "Get definition information on all secure score controls", - "operationId": "secureScoreControlDefinitions_List", + "description": "List the available security controls, their assessments, and the max score", + "operationId": "SecureScoreControlDefinitions_List", "parameters": [ { "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" @@ -241,14 +241,14 @@ "/subscriptions/{subscriptionId}/providers/Microsoft.Security/secureScoreControlDefinitions": { "get": { "x-ms-examples": { - "List secure score controls definition by subscription": { + "List security controls definition by subscription": { "$ref": "./examples/secureScoreControlDefinitions/ListSecureScoreControlDefinitions_subscription_example.json" } }, "tags": [ - "Secure Score Controls Definition" + "Secure Score Control Definitions" ], - "description": "Get definition information on all secure score controls in subscription level", + "description": "For a specified subscription, list the available security controls, their assessments, and the max score", "operationId": "SecureScoreControlDefinitions_ListBySubscription", "parameters": [ { @@ -281,7 +281,7 @@ "definitions": { "SecureScoresList": { "type": "object", - "description": "Page of a secure scores list", + "description": "List of secure scores", "properties": { "value": { "description": "Collection of secure scores in this page", @@ -322,7 +322,7 @@ "type": "object", "properties": { "displayName": { - "description": "User friendly display name of the secure score item", + "description": "The initiative’s name", "readOnly": true, "type": "string" }, @@ -340,7 +340,7 @@ "type": "object", "properties": { "max": { - "description": "Maximum score applicable", + "description": "Maximum score available", "readOnly": true, "type": "integer", "format": "int32", @@ -348,7 +348,7 @@ "exclusiveMinimum": false }, "current": { - "description": "Actual score", + "description": "Current score", "readOnly": true, "type": "number", "format": "double", @@ -382,11 +382,11 @@ } }, "SecureScoreControlList": { - "description": "Page of a secure score controls list", + "description": "List of security controls", "type": "object", "properties": { "value": { - "description": "Collection of secure score controls in this page", + "description": "Collection of security controls in this page", "readOnly": true, "type": "array", "items": { @@ -401,7 +401,7 @@ } }, "SecureScoreControlDetails": { - "description": "Secure score control (calculated) object", + "description": "Details of the security control, its score, and the health status of the relevant resources.", "type": "object", "properties": { "properties": { @@ -453,11 +453,11 @@ } }, "secureScoreControlDefinitionList": { - "description": "Page of a secure score controls definition list", + "description": "List of security controls definition", "type": "object", "properties": { "value": { - "description": "Collection of secure score controls definition in this page", + "description": "Collection of security controls definition in this page", "readOnly": true, "type": "array", "items": { @@ -472,7 +472,7 @@ } }, "SecureScoreControlDefinitionItem": { - "description": "Secure Score Control's Definition information", + "description": "Information about the security control.", "type": "object", "properties": { "properties": { @@ -487,7 +487,7 @@ ] }, "SecureScoreControlDefinitionItemProperties": { - "description": "Secure Score Control Definition Properties", + "description": "Security Control Definition Properties.", "type": "object", "properties": { "displayName": { @@ -516,19 +516,19 @@ "$ref": "#/definitions/SecureScoreControlDefinitionSource" }, "assessmentDefinitions": { - "description": "array of assessments metadata IDs that are included in this control", + "description": "Array of assessments metadata IDs that are included in this security control", "readOnly": true, "$ref": "../../../common/v1/types.json#/definitions/AzureResourceLinks" } } }, "SecureScoreControlDefinitionSource": { - "description": "representing the source of the control", + "description": "The type of the security control (For example, BuiltIn)", "readOnly": true, "type": "object", "properties": { "sourceType": { - "description": "BuiltIn if the control is built-in from Azure Security Center managed assessments, Custom (Future) if the assessment based on custom Azure Policy definition, CustomerManaged (future) for customers who build their own controls", + "description": "The type of security control (for example, BuiltIn)", "type": "string", "enum": [ "BuiltIn", @@ -579,7 +579,7 @@ "in": "path", "required": true, "type": "string", - "description": "The secure score initiative name", + "description": "The initiative name. For the ASC Default initiative, use 'ascScore' as in the sample request below.", "x-ms-parameter-location": "method" } } From 2759146e2e05f740e92adb7b2f9fe6e45c417d27 Mon Sep 17 00:00:00 2001 From: sarajang <37909871+sarajang@users.noreply.github.com> Date: Wed, 27 May 2020 00:40:17 -0700 Subject: [PATCH 011/318] Add readme.md for typescript sdk generation (#9339) --- .../datashare/resource-manager/readme.typescript.md | 13 +++++++++++++ 1 file changed, 13 insertions(+) create mode 100644 specification/datashare/resource-manager/readme.typescript.md diff --git a/specification/datashare/resource-manager/readme.typescript.md b/specification/datashare/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..e2a649c02539 --- /dev/null +++ b/specification/datashare/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + azure-arm: true + package-name: "@azure/arm-datashare" + output-folder: "$(typescript-sdks-folder)/sdk/datashare/arm-datashare" + clear-output-folder: true + generate-metadata: true +``` From 4b3625672784e15be3f4b371f0220dae430bad96 Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Wed, 27 May 2020 15:59:49 +0800 Subject: [PATCH 012/318] Update links in PULL_REQUEST_TEMPLATE.md (#9529) * Update links * Default unchecked --- .github/PULL_REQUEST_TEMPLATE.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index 408cffef6ef6..b8293d9af7b5 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,10 +2,10 @@ ### Contribution checklist: -- [ ] I have reviewed the [documentation](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/202/Overall-Process-of-AME-Onboarding) for the workflow. -- [ ] [Validation tools](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/84/Swagger-Validation-tools) were run on swagger spec(s) and have all been fixed in this PR. [How to fix?](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/ci-fix.md) +- [ ] I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow. +- [ ] [Validation tools](https://aka.ms/swaggertools) were run on swagger spec(s) and have all been fixed in this PR. [How to fix?](https://aka.ms/ci-fix) -If any further question about AME onboarding or validation tools, please view the [FAQ](https://github.com/Azure/azure-rest-api-specs/blob/master/documentation/FAQ.md). +If any further question about AME onboarding or validation tools, please view the [FAQ](https://aka.ms/faqinprreview). ### ARM API Review Checklist - [ ] Service team MUST add the "**WaitForARMFeedback**" label if the management plane API changes fall into one of the below categories. @@ -17,4 +17,4 @@ If any further question about AME onboarding or validation tools, please view th Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs. - [ ] If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them. -Please follow the link to find more details on [API review process]( https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/212/Swagger-PR-Review). +Please follow the link to find more details on [API review process](https://aka.ms/SwaggerPRReview). From e751ef181eb38eb5c529b6dc77a1cf4e4a37dc77 Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Wed, 27 May 2020 16:23:15 +0800 Subject: [PATCH 013/318] Update specificationRepositoryConfiguration.json (#9345) --- specificationRepositoryConfiguration.json | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specificationRepositoryConfiguration.json b/specificationRepositoryConfiguration.json index 7bcfe9c0e212..a9d5a82a7098 100644 --- a/specificationRepositoryConfiguration.json +++ b/specificationRepositoryConfiguration.json @@ -21,7 +21,8 @@ }, "azure-sdk-for-python": { "integrationRepository": "AzureSDKAutomation/azure-sdk-for-python", - "mainRepository": "Azure/azure-sdk-for-python" + "mainRepository": "Azure/azure-sdk-for-python", + "mainBranch": "release/v3" }, "azure-cli-extensions": { "integrationRepository": "AzureSDKAutomation/azure-cli-extensions", From bc408fd7652bc661f6a5605e1c28afad1457d0ae Mon Sep 17 00:00:00 2001 From: Theodore Chang Date: Wed, 27 May 2020 05:27:39 -0400 Subject: [PATCH 014/318] Creating Labeler for Compute Updates (#9554) * Create label.yml * Create pr-labeler.yml * Update pr-labeler.yml * Update pr-labeler.yml * Rename pr-labeler.yml to labeler.yml * Update and rename label.yml to labelr.yml * Update labeler.yml * Update labelr.yml * Rename labelr.yml to labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * Update labeler.yml * labeler for compute update * Update labeler.yml * Rename labeler.yml to ComputeReviewLabeler.yml * Update and rename labeler.yml to computeReviewLabeler.yml * Rename ComputeReviewLabeler.yml to computeReviewLabeler.yml * Update CODEOWNERS --- .github/computeReviewLabeler.yml | 3 +++ .github/workflows/computeReviewLabeler.yml | 12 ++++++++++++ CODEOWNERS | 2 ++ 3 files changed, 17 insertions(+) create mode 100644 .github/computeReviewLabeler.yml create mode 100644 .github/workflows/computeReviewLabeler.yml diff --git a/.github/computeReviewLabeler.yml b/.github/computeReviewLabeler.yml new file mode 100644 index 000000000000..131556674c2c --- /dev/null +++ b/.github/computeReviewLabeler.yml @@ -0,0 +1,3 @@ +computeReview: +- 'specification/compute/*' +- 'specification/compute/**/*' diff --git a/.github/workflows/computeReviewLabeler.yml b/.github/workflows/computeReviewLabeler.yml new file mode 100644 index 000000000000..67c75fdaf6de --- /dev/null +++ b/.github/workflows/computeReviewLabeler.yml @@ -0,0 +1,12 @@ +name: Compute Labeler +on: +- pull_request + +jobs: + label: + runs-on: ubuntu-latest + steps: + - uses: actions/labeler@v2 + with: + repo-token: "${{ secrets.GITHUB_TOKEN }}" + configuration-path: .github/computeReviewLabeler.yml diff --git a/CODEOWNERS b/CODEOWNERS index dee3983a317b..d81b5416321b 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -76,3 +76,5 @@ /specification/trafficmanager/ @allencal @hrkulkarmsft /specification/web/ @lukaszstem @naveedaz @nking92 /profile/ @shahabhijeet +/.github/computeReviewLabeler.yml @grizzlytheodore +/.github/workflows/computeReviewLabeler.yml @grizzlytheodore From 24b7cfd781768714e3fa16bcf36f9ad9c2dc0fe0 Mon Sep 17 00:00:00 2001 From: Frank Gao <4760010+gtxistxgao@users.noreply.github.com> Date: Wed, 27 May 2020 02:48:32 -0700 Subject: [PATCH 015/318] Dev containerservice microsoft.container service 2020 04 01 (#9484) * Adds base for updating Microsoft.ContainerService from version stable/2020-03-01 to version 2020-04-01 * Updates readme * Updates API version in new specs and examples * Support Node Image Version (#8865) * Add deprecated field to ContainerService GetAccessProfile 2020/04/01 API swagger (#9083) * Remove Low option from 04-01 API version (#9084) * Add a max surge upgrade setting (#9331) * [AKS] Apply patch from 0301 API version to 0401 (#9412) Co-authored-by: Xiaofang Zhang Co-authored-by: ruchikaguptaa Co-authored-by: Paul Miller Co-authored-by: Marwan Ahmed --- .../examples/AgentPoolsCreate_Spot.json | 84 + .../examples/AgentPoolsCreate_Update.json | 86 + .../2020-04-01/examples/AgentPoolsDelete.json | 13 + .../2020-04-01/examples/AgentPoolsGet.json | 29 + ...entPoolsGetAgentPoolAvailableVersions.json | 32 + .../examples/AgentPoolsGetUpgradeProfile.json | 28 + .../2020-04-01/examples/AgentPoolsList.json | 29 + .../ManagedClustersCreate_Update.json | 249 ++ .../examples/ManagedClustersDelete.json | 12 + .../examples/ManagedClustersGet.json | 96 + .../ManagedClustersGetAccessProfile.json | 22 + .../ManagedClustersGetUpgradeProfile.json | 49 + .../examples/ManagedClustersList.json | 65 + .../ManagedClustersListByResourceGroup.json | 66 + ...edClustersListClusterCredentialResult.json | 20 + .../ManagedClustersResetAADProfile.json | 18 + ...dClustersResetServicePrincipalProfile.json | 16 + ...agedClustersRotateClusterCertificates.json | 12 + .../examples/ManagedClustersUpdateTags.json | 68 + .../stable/2020-04-01/managedClusters.json | 2613 +++++++++++++++++ .../resource-manager/readme.go.md | 11 + .../resource-manager/readme.java.md | 14 + .../resource-manager/readme.md | 27 +- .../resource-manager/readme.python.md | 12 + 24 files changed, 3670 insertions(+), 1 deletion(-) create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsCreate_Spot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGetAccessProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersListClusterCredentialResult.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersResetServicePrincipalProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersRotateClusterCertificates.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..bee43cf83fe6 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..e651a428325f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..b1cc407c97ef --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..5f45d3a1d359 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..f5030d56cbe8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..fdddcbaf8d98 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..2790bd1676f8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPoolsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..a0b14bbe8a20 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,249 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..d1ca56789c89 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..51cd895d5dbf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGet.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..b8684d2d7adf --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "kubeConfig1" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..4bfc5b558f3f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..2cfd288fc78e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..ff5aa73e5873 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersListClusterCredentialResult.json new file mode 100644 index 000000000000..875612fc19b0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersListClusterCredentialResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "credentialValue1" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..53ea2a956c86 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..b360bdbfc241 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..d1ca56789c89 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..8e4bd9677042 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json new file mode 100644 index 000000000000..ec625d6070a4 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json @@ -0,0 +1,2613 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2020-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "managedClusters" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "description": "Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "description": "Lists managed clusters in the specified subscription and resource group. The operation returns properties of each managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets upgrade profile for a managed cluster.", + "description": "Gets the details of the upgrade profile for a managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name. **WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/en-us/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/en-us/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Gets cluster admin credential of a managed cluster.", + "description": "Gets cluster admin credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Gets cluster user credential of a managed cluster.", + "description": "Gets cluster user credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Gets cluster monitoring user credential of a managed cluster.", + "description": "Gets cluster monitoring user credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "description": "Gets the details of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "description": "Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "Parameters supplied to the Create or Update a Managed Cluster operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "description": "Updates a managed cluster with the specified tags.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "description": "Deletes the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "description": "Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the agent pool.", + "description": "Gets the details of the agent pool by managed cluster and resource group.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool.", + "description": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "Parameters supplied to the Create or Update an agent pool operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool.", + "description": "Deletes the agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets upgrade profile for an agent pool.", + "description": "Gets the details of the upgrade profile for an agent pool with a specified resource group and managed cluster name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported versions for the specified agent pool.", + "description": "Gets a list of supported versions for the specified agent pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset Service Principal Profile of a managed cluster.", + "description": "Update the service principal Profile for a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset AAD Profile of a managed cluster.", + "description": "Update the AAD Profile for a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "Parameters supplied to the Reset AAD Profile operation for a Managed Cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotate certificates of a managed cluster.", + "description": "Rotate certificates of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "OperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Compute Operation Value Display." + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "OperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 1023, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ContainerServiceStorageProfile": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceStorageProfileTypes", + "modelAsString": true + }, + "enum": [ + "StorageAccount", + "ManagedDisks" + ], + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "ContainerServiceVnetSubnetID": { + "type": "string", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "ContainerServiceVMSize": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceVMSizeTypes", + "modelAsString": true + }, + "description": "Size of agent VMs.", + "enum": [ + "Standard_A1", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2", + "Standard_A2_v2", + "Standard_A2m_v2", + "Standard_A3", + "Standard_A4", + "Standard_A4_v2", + "Standard_A4m_v2", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A8_v2", + "Standard_A8m_v2", + "Standard_A9", + "Standard_B2ms", + "Standard_B2s", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D11", + "Standard_D11_v2", + "Standard_D11_v2_Promo", + "Standard_D12", + "Standard_D12_v2", + "Standard_D12_v2_Promo", + "Standard_D13", + "Standard_D13_v2", + "Standard_D13_v2_Promo", + "Standard_D14", + "Standard_D14_v2", + "Standard_D14_v2_Promo", + "Standard_D15_v2", + "Standard_D16_v3", + "Standard_D16s_v3", + "Standard_D1_v2", + "Standard_D2", + "Standard_D2_v2", + "Standard_D2_v2_Promo", + "Standard_D2_v3", + "Standard_D2s_v3", + "Standard_D3", + "Standard_D32_v3", + "Standard_D32s_v3", + "Standard_D3_v2", + "Standard_D3_v2_Promo", + "Standard_D4", + "Standard_D4_v2", + "Standard_D4_v2_Promo", + "Standard_D4_v3", + "Standard_D4s_v3", + "Standard_D5_v2", + "Standard_D5_v2_Promo", + "Standard_D64_v3", + "Standard_D64s_v3", + "Standard_D8_v3", + "Standard_D8s_v3", + "Standard_DS1", + "Standard_DS11", + "Standard_DS11_v2", + "Standard_DS11_v2_Promo", + "Standard_DS12", + "Standard_DS12_v2", + "Standard_DS12_v2_Promo", + "Standard_DS13", + "Standard_DS13-2_v2", + "Standard_DS13-4_v2", + "Standard_DS13_v2", + "Standard_DS13_v2_Promo", + "Standard_DS14", + "Standard_DS14-4_v2", + "Standard_DS14-8_v2", + "Standard_DS14_v2", + "Standard_DS14_v2_Promo", + "Standard_DS15_v2", + "Standard_DS1_v2", + "Standard_DS2", + "Standard_DS2_v2", + "Standard_DS2_v2_Promo", + "Standard_DS3", + "Standard_DS3_v2", + "Standard_DS3_v2_Promo", + "Standard_DS4", + "Standard_DS4_v2", + "Standard_DS4_v2_Promo", + "Standard_DS5_v2", + "Standard_DS5_v2_Promo", + "Standard_E16_v3", + "Standard_E16s_v3", + "Standard_E2_v3", + "Standard_E2s_v3", + "Standard_E32-16s_v3", + "Standard_E32-8s_v3", + "Standard_E32_v3", + "Standard_E32s_v3", + "Standard_E4_v3", + "Standard_E4s_v3", + "Standard_E64-16s_v3", + "Standard_E64-32s_v3", + "Standard_E64_v3", + "Standard_E64s_v3", + "Standard_E8_v3", + "Standard_E8s_v3", + "Standard_F1", + "Standard_F16", + "Standard_F16s", + "Standard_F16s_v2", + "Standard_F1s", + "Standard_F2", + "Standard_F2s", + "Standard_F2s_v2", + "Standard_F32s_v2", + "Standard_F4", + "Standard_F4s", + "Standard_F4s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_F8", + "Standard_F8s", + "Standard_F8s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS4-4", + "Standard_GS4-8", + "Standard_GS5", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H16", + "Standard_H16m", + "Standard_H16mr", + "Standard_H16r", + "Standard_H8", + "Standard_H8m", + "Standard_L16s", + "Standard_L32s", + "Standard_L4s", + "Standard_L8s", + "Standard_M128-32ms", + "Standard_M128-64ms", + "Standard_M128ms", + "Standard_M128s", + "Standard_M64-16ms", + "Standard_M64-32ms", + "Standard_M64ms", + "Standard_M64s", + "Standard_NC12", + "Standard_NC12s_v2", + "Standard_NC12s_v3", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC24rs_v2", + "Standard_NC24rs_v3", + "Standard_NC24s_v2", + "Standard_NC24s_v3", + "Standard_NC6", + "Standard_NC6s_v2", + "Standard_NC6s_v3", + "Standard_ND12s", + "Standard_ND24rs", + "Standard_ND24s", + "Standard_ND6s", + "Standard_NV12", + "Standard_NV24", + "Standard_NV6" + ] + }, + "ManagedClusterServicePrincipalProfile": { + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ContainerServiceMasterProfile": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "enum": [ + 1, + 3, + 5 + ], + "x-ms-enum": { + "name": "Count", + "modelAsString": false + }, + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", + "default": 1 + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the master pool." + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "firstConsecutiveStaticIP": { + "type": "string", + "description": "FirstConsecutiveStaticIP used to specify the first static ip of masters.", + "default": "10.240.255.5" + }, + "storageProfile": { + "$ref": "#/definitions/ContainerServiceStorageProfile", + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FQDN for the master pool." + } + }, + "required": [ + "dnsPrefix", + "vmSize" + ], + "description": "Profile for the container service master." + }, + "ManagedClusterAgentPoolProfileProperties": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 0, + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive). The default value is 1. ", + "default": 1 + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "Maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "type": { + "$ref": "#/definitions/AgentPoolType", + "description": "AgentPoolType represents types of an agent pool" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode", + "description": "AgentPoolMode represents mode of an agent pool" + }, + "orchestratorVersion": { + "type": "string", + "description": "Version of orchestrator specified when creating the managed cluster." + }, + "nodeImageVersion": { + "type": "string", + "description": "Version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType." + }, + "enableNodePublicIP": { + "type": "boolean", + "description": "Enable public IP for nodes" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "description": "ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "description": "SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Agent pool tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Agent pool node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + } + }, + "required": [ + "vmSize", + "count" + ], + "description": "Properties for the container service agent pool profile." + }, + "ManagedClusterAgentPoolProfile": { + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + }, + { + "properties": { + "name": { + "type": "string", + "description": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + } + } + ], + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true + }, + "description": "AgentPoolType represents types of an agent pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true + }, + "description": "AgentPoolMode represents mode of an agent pool." + }, + "AgentPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "properties": { + "maxSurge": { + "type": "string", + "description": "Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default" + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Windows VMs.", + "pattern": "^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$" + }, + "adminPassword": { + "type": "string", + "description": "The administrator password to use for Windows VMs.", + "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\\^&\\*\\(\\)])[a-zA-Z\\d!@#$%\\^&\\*\\(\\)]{12,123}$" + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the container service cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true + }, + "description": "Network plugin used for building Kubernetes network." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico", + "azure" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true + }, + "description": "Network policy used for building Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true + }, + "description": "Network mode used for building Kubernetes network." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "dockerBridgeCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "172.17.0.1/16", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true + }, + "default": "loadBalancer", + "description": "The outbound (egress) routing method." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true + }, + "description": "The load balancer sku for the managed cluster." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + } + }, + "description": "Profile of network configuration." + }, + "ManagedClusterLoadBalancerProfile": { + "properties": { + "managedOutboundIPs": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "Desired number of allocated SNAT ports per VM. Allowed values must be in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values must be in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for diagnostics on the container service VMs." + } + }, + "description": "Profile for diagnostics on the container service cluster.", + "required": [ + "vmDiagnostics" + ] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ManagedClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + } + } + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "description": "Version of Kubernetes specified when creating the managed cluster." + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix specified when creating the managed cluster." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FQDN for the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "FQDN of private cluster." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "description": "Properties of the agent pool." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "Profile for Linux VMs in the container service cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "Profile for Windows VMs in the container service cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "Profile of managed cluster add-on." + }, + "nodeResourceGroup": { + "type": "string", + "description": "Name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(PREVIEW) Whether to enable Kubernetes Pod security policy." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "Profile of network configuration." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "Profile of Azure Active Directory configuration." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string" + }, + "scan-interval": { + "type": "string" + }, + "scale-down-delay-after-add": { + "type": "string" + }, + "scale-down-delay-after-delete": { + "type": "string" + }, + "scale-down-delay-after-failure": { + "type": "string" + }, + "scale-down-unneeded-time": { + "type": "string" + }, + "scale-down-unready-time": { + "type": "string" + }, + "scale-down-utilization-threshold": { + "type": "string" + }, + "max-graceful-termination-sec": { + "type": "string" + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "Access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." + }, + "identityProfile": { + "additionalProperties": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + }, + "description": "Identities associated with the cluster." + } + }, + "description": "Properties of the managed cluster." + }, + "ManagedClusterAPIServerAccessProfile": { + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Authorized IP Ranges to kubernetes API server." + }, + "enablePrivateCluster": { + "type": "boolean", + "description": "Whether to create the cluster as a private cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "description": "The type of identity used for the managed cluster. Type 'SystemAssigned' will use an implicitly created identity in master components and an auto-created user assigned identity in MC_ resource group in agent nodes. Type 'None' will not use MSI for the managed cluster, service principal will be used instead.", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "properties": { + "resourceId": { + "type": "string", + "description": "The resource id of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client id of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object id of the user assigned identity." + } + } + }, + "ManagedClusterAccessProfile": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "name": { + "type": "string", + "description": "Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "ContainerServiceOSTypes", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAADProfile": { + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "The client AAD application ID." + }, + "serverAppID": { + "type": "string", + "description": "The server AAD application ID." + }, + "serverAppSecret": { + "type": "string", + "description": "The server AAD application secret." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "description": "AADProfile specifies attributes for Azure Active Directory integration." + }, + "ManagedClusterAddonProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "Properties of upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "Properties of agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "osType": { + "$ref": "#/definitions/OSType", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "ContainerServiceOSTypes", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "LatestNodeImageVersion is the latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the agent pool available versions." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the agent pool available versions." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool available versions." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true + }, + "description": "ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true + }, + "description": "ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete." + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "description": "SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand." + }, + "CredentialResults": { + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list of credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "properties": { + "name": { + "type": "string", + "description": "Name of a managed cluster SKU.", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of a managed cluster SKU.", + "enum": [ + "Paid", + "Free" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/readme.go.md b/specification/containerservice/resource-manager/readme.go.md index abc52e7c79b7..0e97d488f974 100644 --- a/specification/containerservice/resource-manager/readme.go.md +++ b/specification/containerservice/resource-manager/readme.go.md @@ -12,6 +12,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-04 - tag: package-2020-03 - tag: package-2020-02 - tag: package-2020-01 @@ -31,6 +32,16 @@ batch: - tag: package-2017-07 ``` +### Tag: package-2020-04 and go + +These settings apply only when `--package-2020-04 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2020-04' && $(go) +namespace: containerservice +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-04-01/$(namespace) +``` + ### Tag: package-2020-03 and go These settings apply only when `--package-2020-03 --go` is specified on the command line. diff --git a/specification/containerservice/resource-manager/readme.java.md b/specification/containerservice/resource-manager/readme.java.md index bbb60e7a0feb..4f496925aa45 100644 --- a/specification/containerservice/resource-manager/readme.java.md +++ b/specification/containerservice/resource-manager/readme.java.md @@ -23,6 +23,20 @@ batch: - tag: package-2020-01 - tag: package-2020-02 - tag: package-2020-03 + - tag: package-2020-04 +``` + +### Tag: package-2020-04 and java + +These settings apply only when `--tag=package-2020-04` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2020_04_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2020_04_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2020-03 and java diff --git a/specification/containerservice/resource-manager/readme.md b/specification/containerservice/resource-manager/readme.md index aa5d14dc6729..3b25efeec43a 100644 --- a/specification/containerservice/resource-manager/readme.md +++ b/specification/containerservice/resource-manager/readme.md @@ -34,10 +34,21 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-2020-03 +tag: package-2020-04 ``` +### Tag: package-2020-04 + +These settings apply only when `--tag=package-2020-04` is specified on the command line. + +```yaml $(tag) == 'package-2020-04' +input-file: + - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json + - Microsoft.ContainerService/stable/2017-07-01/containerService.json + - Microsoft.ContainerService/stable/2019-08-01/location.json + - Microsoft.ContainerService/stable/2020-04-01/managedClusters.json +``` ### Tag: package-2020-03 These settings apply only when `--tag=package-2020-03` is specified on the command line. @@ -235,6 +246,19 @@ input-file: - Microsoft.ContainerService/stable/2017-07-01/containerService.json ``` +### Tag: package-2020-04-01-only + +These settings apply only when `--tag=package-2020-04-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2020-04-01-only' +input-file: +- Microsoft.ContainerService/stable/2020-04-01/managedClusters.json +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile + reason: Cluster-autoscaler settings are not camel-cased +``` + ### Tag: package-2020-03-01-only These settings apply only when `--tag=package-2020-03-01-only` is specified on the command line. @@ -511,6 +535,7 @@ input-file: - $(this-folder)/Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json - $(this-folder)/Microsoft.ContainerService/stable/2017-07-01/containerService.json - $(this-folder)/Microsoft.ContainerService/stable/2019-08-01/location.json + - $(this-folder)/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json - $(this-folder)/Microsoft.ContainerService/stable/2020-03-01/managedClusters.json - $(this-folder)/Microsoft.ContainerService/stable/2020-02-01/managedClusters.json - $(this-folder)/Microsoft.ContainerService/stable/2020-01-01/managedClusters.json diff --git a/specification/containerservice/resource-manager/readme.python.md b/specification/containerservice/resource-manager/readme.python.md index bd7887b9243c..9b8f710a5632 100644 --- a/specification/containerservice/resource-manager/readme.python.md +++ b/specification/containerservice/resource-manager/readme.python.md @@ -18,6 +18,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2020-04-01-only - tag: package-2020-03-01-only - tag: package-2020-02-01-only - tag: package-2020-01-01-only @@ -36,6 +37,17 @@ batch: - tag: package-2017-07-only-extended ``` +### Tag: package-2020-04-01-only and python + +These settings apply only when `--tag=package-2020-04-01-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-04-01-only' && $(python) +python: + namespace: azure.mgmt.containerservice.v2020_04_01 + output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_04_01 +``` + ### Tag: package-2020-03-01-only and python These settings apply only when `--tag=package-2020-03-01-only --python` is specified on the command line. From aad8a360e27b1811a4ecbe64ee898d25b44693a6 Mon Sep 17 00:00:00 2001 From: Yoram Singer <37076505+yoramsinger@users.noreply.github.com> Date: Wed, 27 May 2020 13:38:43 +0300 Subject: [PATCH 016/318] =?UTF-8?q?Remove=20ISO8601=20date=20format,=20ad?= =?UTF-8?q?=20current=20implementation=20uses=20another=20fo=E2=80=A6=20(#?= =?UTF-8?q?9591)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Remove ISO8601 date format, ad current implementation uses another format and it breaks CLI. * One more date format change --- .../preview/2020-03-01-preview/AvailableServiceTiers.json | 1 - .../preview/2020-03-01-preview/Workspaces.json | 2 -- 2 files changed, 3 deletions(-) diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/AvailableServiceTiers.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/AvailableServiceTiers.json index cb97364675dd..7605661754f4 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/AvailableServiceTiers.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/AvailableServiceTiers.json @@ -128,7 +128,6 @@ "lastSkuUpdate": { "readOnly": true, "type": "string", - "format": "date-time", "description": "Time when the sku was last updated for the workspace. Returned for the Capacity Reservation Service Tier." } } diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/Workspaces.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/Workspaces.json index ba83bc703b01..1328a4d68255 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/Workspaces.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/Workspaces.json @@ -383,7 +383,6 @@ }, "lastSkuUpdate": { "type": "string", - "format": "date-time", "description": "The last time when the sku was updated.", "readOnly": true } @@ -403,7 +402,6 @@ }, "quotaNextResetTime": { "type": "string", - "format": "date-time", "description": "The time when the quota will be rest.", "readOnly": true }, From 9fbd7199905db53e7f3615532d417d50261655d8 Mon Sep 17 00:00:00 2001 From: animeshseth90 <64622013+animeshseth90@users.noreply.github.com> Date: Wed, 27 May 2020 16:42:20 -0700 Subject: [PATCH 017/318] [Hub Generated] Review request for Microsoft.AzureActiveDirectory to add version preview/2020-05-01-preview (#9458) * New Readme Config File * New Go Language Readme Config File * New Typescript Language Readme Config File * New Python Language Readme Config File * New C# Language Readme Config File * New Ruby Language Readme Config File * New Swagger Spec File * New Swagger Example Spec File * making changes * Fixing errors * Fixing errors * Fixing build errors * Fixing pretty print * Adding Examples to the swagger review * Fixing semantic issues * removing code * removing required flags * Fixing Lint issues * Fixing Lint issues * Fixing build failures * Fixing build errors * grammer error fix * PR comments * fixing build * Fixing build errors * Fixing grammer * PR comments * Failing Validation Co-authored-by: animesh --- custom-words.txt | 2 + .../preview/2020-05-01-preview/cpim.json | 505 ++++++++++++++++++ .../examples/GuestUsagesCreate.json | 29 + .../examples/GuestUsagesDelete.json | 11 + .../examples/GuestUsagesGet.json | 22 + .../examples/GuestUsagesResourceGroupGet.json | 23 + .../examples/GuestUsagesSubscriptionGet.json | 22 + .../examples/GuestUsagesUpdate.json | 29 + .../examples/OperationsList.json | 87 +++ .../cpim/resource-manager/readme.csharp.md | 15 + .../cpim/resource-manager/readme.go.md | 19 + specification/cpim/resource-manager/readme.md | 79 +++ .../cpim/resource-manager/readme.python.md | 21 + .../cpim/resource-manager/readme.ruby.md | 19 + .../resource-manager/readme.typescript.md | 13 + 15 files changed, 896 insertions(+) create mode 100644 specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/cpim.json create mode 100644 specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesCreate.json create mode 100644 specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesDelete.json create mode 100644 specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesGet.json create mode 100644 specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesResourceGroupGet.json create mode 100644 specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesSubscriptionGet.json create mode 100644 specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesUpdate.json create mode 100644 specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/OperationsList.json create mode 100644 specification/cpim/resource-manager/readme.csharp.md create mode 100644 specification/cpim/resource-manager/readme.go.md create mode 100644 specification/cpim/resource-manager/readme.md create mode 100644 specification/cpim/resource-manager/readme.python.md create mode 100644 specification/cpim/resource-manager/readme.ruby.md create mode 100644 specification/cpim/resource-manager/readme.typescript.md diff --git a/custom-words.txt b/custom-words.txt index 1c26a569001a..6cdb3e767da0 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -330,6 +330,8 @@ costcenter costinsights costmanagement Couchbase +cpim +CPIM creatable createconsumergroup createorupdate diff --git a/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/cpim.json b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/cpim.json new file mode 100644 index 000000000000..4cb75c38c8d9 --- /dev/null +++ b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/cpim.json @@ -0,0 +1,505 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-05-01-preview", + "title": "cpim", + "description": "CPIM Service Client " + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.AzureActiveDirectory/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "operations_list": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "Lists the operations available from this provider.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Describe the result of a successful operation.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages/{resourceName}": { + "put": { + "operationId": "GuestUsages_Create", + "tags": [ + "GuestUsages" + ], + "x-ms-examples": { + "GuestUsages_Create": { + "$ref": "./examples/GuestUsagesCreate.json" + } + }, + "summary": "Creates a Guest Usages resource", + "description": "Creates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "Resource", + "in": "body", + "description": "Guest Usages resource to be created", + "schema": { + "$ref": "#/definitions/GuestUsagesResource" + } + } + ], + "responses": { + "200": { + "description": "The request was successful and the resource was created successfully", + "schema": { + "$ref": "#/definitions/GuestUsagesResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "operationId": "GuestUsages_Update", + "tags": [ + "GuestUsages" + ], + "x-ms-examples": { + "GuestUsages_Update": { + "$ref": "./examples/GuestUsagesUpdate.json" + } + }, + "summary": "Updates a Guest Usages resource", + "description": "Updates a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "ResourcePatch", + "in": "body", + "description": "Guest Usages Resource to be updated", + "schema": { + "$ref": "#/definitions/GuestUsagesResourcePatch" + } + } + ], + "responses": { + "200": { + "description": "Guest Usages Resource Successfully Updated", + "schema": { + "$ref": "#/definitions/GuestUsagesResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "GuestUsages_Delete", + "tags": [ + "GuestUsages" + ], + "x-ms-examples": { + "GuestUsages_Delete": { + "$ref": "./examples/GuestUsagesDelete.json" + } + }, + "summary": "Deletes a Guest Usages resource", + "description": "Deletes a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Guest Usages Resource Successfully Deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "operationId": "GuestUsages_Get", + "tags": [ + "GuestUsages" + ], + "x-ms-examples": { + "GuestUsages_Get": { + "$ref": "./examples/GuestUsagesGet.json" + } + }, + "summary": "Gets a Guest Usages resource", + "description": "Gets a Guest Usages resource for the Microsoft.AzureActiveDirectory resource provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Guest Usages resource successfully retrieved", + "schema": { + "$ref": "#/definitions/GuestUsagesResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureActiveDirectory/guestUsages": { + "get": { + "operationId": "GuestUsages_ListBySubscription", + "tags": [ + "GuestUsages" + ], + "x-ms-examples": { + "GuestUsagesSubscription_List": { + "$ref": "./examples/GuestUsagesSubscriptionGet.json" + } + }, + "summary": "Gets Guest Usages resources under a subscription", + "description": "Gets Guest Usages resources under a subscription for the Microsoft.AzureActiveDirectory resource provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of Guest Usages resources under the subscription successfully retrieved.", + "schema": { + "$ref": "#/definitions/GuestUsagesResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureActiveDirectory/guestUsages": { + "get": { + "operationId": "GuestUsages_ListByResourceGroup", + "tags": [ + "GuestUsages" + ], + "x-ms-examples": { + "GuestUsagesResourceGroup_List": { + "$ref": "./examples/GuestUsagesResourceGroupGet.json" + } + }, + "summary": "Gets Guest Usages resources under resource group", + "description": "Gets Guest Usages resources under a resource group for the Microsoft.AzureActiveDirectory resource provider", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "List of Guest Usages resources under the resourceGroup successfully retrieved.", + "schema": { + "$ref": "#/definitions/GuestUsagesResourceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + } + }, + "definitions": { + "Operation": { + "description": "Microsoft.AzureActiveDirectory REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.AzureActiveDirectory.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: GuestUsages, etc.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Friendly name of the operation", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of listing operations for the resourceProvider", + "properties": { + "value": { + "description": "List of cpim service operations supported by the Microsoft.AzureActiveDirectory resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "GuestUsagesResourceProperties": { + "description": "Guest Usages Resource Properties", + "type": "object", + "properties": { + "tenantId": { + "type": "string", + "description": "An identifier for the tenant for which the resource is being created" + } + } + }, + "GuestUsagesResource": { + "description": "Guest Usages Resource", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "An identifier that represents the Guest Usages resource." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the Guest Usages resource." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The type of the Guest Usages resource." + }, + "location": { + "type": "string", + "description": "Location of the Guest Usages resource.", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional resource provisioning properties." + }, + "properties": { + "$ref": "#/definitions/GuestUsagesResourceProperties", + "x-ms-client-flatten": true, + "description": "The Guest Usages Resource Properties" + } + }, + "x-ms-azure-resource": true + }, + "GuestUsagesResourcePatch": { + "description": "Guest Usages Resource for Patch", + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional resource provisioning properties." + } + } + }, + "GuestUsagesResourceList": { + "description": "The collection of guest usages resources", + "properties": { + "value": { + "description": "List of guest usages resources", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/GuestUsagesResource" + } + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response for a resource management request." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The Azure subscription ID. This is a GUID-formatted string (e.g. 00000000-0000-0000-0000-000000000000)" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to be used with the HTTP request." + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The initial domain name of the AAD tenant.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesCreate.json b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesCreate.json new file mode 100644 index 000000000000..36b8bc0a602a --- /dev/null +++ b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesCreate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "contosoResourceGroup", + "api-version": "2020-05-01-preview", + "resourceName": "contoso.onmicrosoft.com", + "resource": { + "location": "United States", + "name": "contoso.onmicrosoft.com", + "properties": { + "tenantId": "c963dd1a-9174-4c23-8bae-733d7f955492" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/guestUsages/contoso.onmicrosoft.com", + "name": "contoso.onmicrosoft.com", + "location": "United States", + "tags": {}, + "type": "Microsoft.AzureActiveDirectory/GuestUsages", + "properties": { + "tenantId": "c963dd1a-9174-4c23-8bae-733d7f955492" + } + } + } + } +} diff --git a/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesDelete.json b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesDelete.json new file mode 100644 index 000000000000..8415b530431c --- /dev/null +++ b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesDelete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "contosoResourceGroup", + "api-version": "2020-05-01-preview", + "resourceName": "contoso.onmicrosoft.com" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesGet.json b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesGet.json new file mode 100644 index 000000000000..cda45ac3aada --- /dev/null +++ b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "contosoResourceGroup", + "api-version": "2020-05-01-preview", + "resourceName": "contoso.onmicrosoft.com" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/guestUsages/contoso.onmicrosoft.com", + "name": "contoso.onmicrosoft.com", + "location": "United States", + "tags": {}, + "type": "Microsoft.AzureActiveDirectory/GuestUsages", + "properties": { + "tenantId": "c963dd1a-9174-4c23-8bae-733d7f955492" + } + } + } + } +} diff --git a/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesResourceGroupGet.json b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesResourceGroupGet.json new file mode 100644 index 000000000000..de84a5d09ada --- /dev/null +++ b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesResourceGroupGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "contosoResourceGroup", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/guestUsages/contoso.onmicrosoft.com", + "name": "contoso.onmicrosoft.com", + "location": "United States", + "tags": {}, + "type": "Microsoft.AzureActiveDirectory/GuestUsages", + "properties": { + "tenantId": "c963dd1a-9174-4c23-8bae-733d7f955492" + } + } + ] + } + } +} diff --git a/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesSubscriptionGet.json b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesSubscriptionGet.json new file mode 100644 index 000000000000..d1a324772802 --- /dev/null +++ b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesSubscriptionGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/guestUsages/contoso.onmicrosoft.com", + "name": "contoso.onmicrosoft.com", + "location": "United States", + "tags": {}, + "type": "Microsoft.AzureActiveDirectory/GuestUsages", + "properties": { + "tenantId": "c963dd1a-9174-4c23-8bae-733d7f955492" + } + } + ] + } + } +} diff --git a/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesUpdate.json b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesUpdate.json new file mode 100644 index 000000000000..08af270ba0a9 --- /dev/null +++ b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/GuestUsagesUpdate.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "contosoResourceGroup", + "api-version": "2020-05-01-preview", + "resourceName": "contoso.onmicrosoft.com", + "resource": { + "tags": { + "additionalProperty1": "additionalValue1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/contosoResourceGroup/providers/Microsoft.AzureActiveDirectory/guestUsages/contoso.onmicrosoft.com", + "name": "contoso.onmicrosoft.com", + "location": "United States", + "tags": { + "additionalProperty1": "additionalValue1" + }, + "type": "Microsoft.AzureActiveDirectory/GuestUsages", + "properties": { + "tenantId": "c963dd1a-9174-4c23-8bae-733d7f955492" + } + } + } + } +} diff --git a/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/OperationsList.json b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/OperationsList.json new file mode 100644 index 000000000000..6c14cad4c445 --- /dev/null +++ b/specification/cpim/resource-manager/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/examples/OperationsList.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "resourceGroupName": "cpimClient", + "api-version": "2020-05-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.AzureActiveDirectory/register/action", + "display": { + "provider": "Microsoft.AzureActiveDirectory", + "resource": "Microsoft.AzureActiveDirectory Resource Provider", + "operation": "Registers the Microsoft.AzureActiveDirectory Resource Provider", + "description": "Registers the Microsoft.AzureActiveDirectory Resource Provider" + } + }, + { + "name": "Microsoft.AzureActiveDirectory/guestUsages/read", + "display": { + "provider": "Microsoft.AzureActiveDirectory", + "resource": "GuestUsagesResource", + "operation": "read", + "description": "Read call for Guest Usages Resource" + } + }, + { + "name": "Microsoft.AzureActiveDirectory/guestUsages/write", + "display": { + "provider": "Microsoft.AzureActiveDirectory", + "resource": "GuestUsagesResource", + "operation": "write", + "description": "Create or Update call for Guest Usages Resource" + } + }, + { + "name": "Microsoft.AzureActiveDirectory/guestUsages/delete", + "display": { + "provider": "Microsoft.AzureActiveDirectory", + "resource": "GuestUsagesResource", + "operation": "delete", + "description": "Delete call for Guest Usages Resource" + } + }, + { + "name": "Microsoft.AzureActiveDirectory/b2cDirectories/read", + "display": { + "provider": "Microsoft.AzureActiveDirectory", + "resource": "GuestUsagesResource", + "operation": "read", + "description": "Read call for Guest Usages Resource" + } + }, + { + "name": "Microsoft.AzureActiveDirectory/b2cDirectories/write", + "display": { + "provider": "Microsoft.AzureActiveDirectory", + "resource": "GuestUsagesResource", + "operation": "write", + "description": "Create or Update call for Guest Usages Resource" + } + }, + { + "name": "Microsoft.AzureActiveDirectory/b2cDirectories/delete", + "display": { + "provider": "Microsoft.AzureActiveDirectory", + "resource": "GuestUsagesResource", + "operation": "delete", + "description": "Delete call for Guest Usages Resource" + } + }, + { + "name": "Microsoft.AzureActiveDirectory/checkNameAvailability", + "display": { + "provider": "Microsoft.AzureActiveDirectory", + "resource": "Check Name Availability", + "operation": "Get Check Name Availability", + "description": "Check if resource name is available." + } + } + ] + } + } + } +} diff --git a/specification/cpim/resource-manager/readme.csharp.md b/specification/cpim/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..38a02cf78765 --- /dev/null +++ b/specification/cpim/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.AzureActiveDirectory + output-folder: $(csharp-sdks-folder)/cpim/management/Microsoft.AzureActiveDirectory/GeneratedProtocol +``` diff --git a/specification/cpim/resource-manager/readme.go.md b/specification/cpim/resource-manager/readme.go.md new file mode 100644 index 000000000000..11bd72613e44 --- /dev/null +++ b/specification/cpim/resource-manager/readme.go.md @@ -0,0 +1,19 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true +``` + +### Tag: package-2020-05-01-preview and go + +These settings apply only when `--tag=package-2020-05-01-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2020-05-01-preview' && $(go) +namespace: Microsoft.AzureActiveDirectory +output-folder: $(go-sdks-folder)/cpim/Generated +``` diff --git a/specification/cpim/resource-manager/readme.md b/specification/cpim/resource-manager/readme.md new file mode 100644 index 000000000000..6c1d5fc4b761 --- /dev/null +++ b/specification/cpim/resource-manager/readme.md @@ -0,0 +1,79 @@ +# cpim + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for cpim. + +## 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 cpim. + +```yaml +openapi-type: arm +tag: package-2020-05-01-preview +``` + +### Tag: package-2020-05-01-preview + +These settings apply only when `--tag=package-2020-05-01-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-05-01-preview' +input-file: + - Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/cpim.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_cpim'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.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/cpim/resource-manager/readme.python.md b/specification/cpim/resource-manager/readme.python.md new file mode 100644 index 000000000000..9b05d3b50643 --- /dev/null +++ b/specification/cpim/resource-manager/readme.python.md @@ -0,0 +1,21 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.AzureActiveDirectory + package-name: cpim + package-version: 2020-05-01-preview + clear-output-folder: true +``` + +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/cpim +``` diff --git a/specification/cpim/resource-manager/readme.ruby.md b/specification/cpim/resource-manager/readme.ruby.md new file mode 100644 index 000000000000..bf0a94227dc2 --- /dev/null +++ b/specification/cpim/resource-manager/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: azure_mgmt_cpim +package-version: 2020-05-01-preview +azure-arm: true +``` + +### Tag: package-2020-05-01-preview and ruby + +These settings apply only when `--tag=package-2020-05-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-05-01-preview' && $(ruby) +namespace: Microsoft.AzureActiveDirectory +output-folder: $(ruby-sdks-folder)/cpim +``` diff --git a/specification/cpim/resource-manager/readme.typescript.md b/specification/cpim/resource-manager/readme.typescript.md new file mode 100644 index 000000000000..ccbd03da212a --- /dev/null +++ b/specification/cpim/resource-manager/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "cpim" + output-folder: "$(typescript-sdks-folder)/packages/cpim" + payload-flattening-threshold: 1 + generate-metadata: true +``` From 91294a48037aab7aec079d96f9b91e3140033000 Mon Sep 17 00:00:00 2001 From: azuresdkci Date: Wed, 27 May 2020 23:43:51 +0000 Subject: [PATCH 018/318] regenerated all-api-versions --- specification/cpim/resource-manager/readme.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) diff --git a/specification/cpim/resource-manager/readme.md b/specification/cpim/resource-manager/readme.md index 6c1d5fc4b761..d9bdf7941d0a 100644 --- a/specification/cpim/resource-manager/readme.md +++ b/specification/cpim/resource-manager/readme.md @@ -77,3 +77,28 @@ See configuration in [readme.typescript.md](./readme.typescript.md) ## CSharp See configuration in [readme.csharp.md](./readme.csharp.md) + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.AzureActiveDirectory/preview/2020-05-01-preview/cpim.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` + From f1f5980e98d9ea258cbfb0816120ed797faea2e1 Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Thu, 28 May 2020 10:02:53 +0800 Subject: [PATCH 019/318] Cli onboard desktopvirtualization (#9531) * cli validation for desktopvirtualization * WIP * rename filter * correct example * rename extension * revert host-pool PATCH example * add expiredTime in RegistrationInfoPatch Co-authored-by: Changlong Liu --- .../desktopvirtualization.json | 5 +++++ .../examples/HostPool_Create.json | 6 +++--- .../examples/HostPool_Update.json | 1 + .../resource-manager/readme.az.md | 10 +++++++++ .../resource-manager/readme.cli.md | 9 ++++++++ .../resource-manager/readme.md | 21 ++++++++++--------- .../resource-manager/readme.python.md | 8 +++---- 7 files changed, 43 insertions(+), 17 deletions(-) diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json index 3af397de4739..621a229ef503 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json @@ -2398,6 +2398,11 @@ "description": "Represents a RegistrationInfo definition.", "type": "object", "properties": { + "expirationTime": { + "format": "date-time", + "type": "string", + "description": "Expiration time of registration token." + }, "registrationTokenOperation": { "enum": [ "Delete", diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json index 7ea677d137e4..66b79818e853 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json @@ -19,7 +19,7 @@ "maxSessionLimit": 999999, "loadBalancerType": "BreadthFirst", "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", + "expirationTime": "2020-10-01T14:01:54.9571247Z", "registrationTokenOperation": "Update" }, "ssoContext": "KeyVaultPath" @@ -48,7 +48,7 @@ "validationEnvironment": null, "ring": null, "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", + "expirationTime": "2020-10-01T14:01:54.9571247Z", "token": "token", "registrationTokenOperation": "Update" }, @@ -77,7 +77,7 @@ "validationEnvironment": null, "ring": null, "registrationInfo": { - "expirationTime": "2008-09-22T14:01:54.9571247Z", + "expirationTime": "2020-10-01T14:01:54.9571247Z", "token": "token", "registrationTokenOperation": "Update" }, diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json index 6eb8e05ee4ce..0993e2d985a4 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json @@ -17,6 +17,7 @@ "loadBalancerType": "BreadthFirst", "personalDesktopAssignmentType": "Automatic", "registrationInfo": { + "expirationTime": "2020-10-01T15:01:54.9571247Z", "registrationTokenOperation": "Update" }, "ssoContext": "KeyVaultPath" diff --git a/specification/desktopvirtualization/resource-manager/readme.az.md b/specification/desktopvirtualization/resource-manager/readme.az.md index 59b298c1cc19..c4e10f818618 100644 --- a/specification/desktopvirtualization/resource-manager/readme.az.md +++ b/specification/desktopvirtualization/resource-manager/readme.az.md @@ -9,4 +9,14 @@ az: namespace: azure.mgmt.desktopvirtualization az-output-folder: $(azure-cli-extension-folder)/src/desktopvirtualization python-sdk-output-folder: "$(az-output-folder)/azext_desktopvirtualization/vendored_sdks/desktopvirtualization" + +directive: + - where: + group: desktopvirtualization host-pool + set: + group: desktopvirtualization hostpool + - where: + group: desktopvirtualization application-group + set: + group: desktopvirtualization applicationgroup ``` diff --git a/specification/desktopvirtualization/resource-manager/readme.cli.md b/specification/desktopvirtualization/resource-manager/readme.cli.md index 3add0b924943..1f10535c86f8 100644 --- a/specification/desktopvirtualization/resource-manager/readme.cli.md +++ b/specification/desktopvirtualization/resource-manager/readme.cli.md @@ -5,4 +5,13 @@ These settings don't need to apply `--cli` on the command line. ``` yaml $(cli) cli: cli-name: desktopvirtualization + cli-directive: + - where: + group: (ActiveApplications|Applications|ApplicationgroupAssignments|Desktops|SessionHosts|StartMenuItems|UserSessions) + hidden: true + # - where: + # group: ApplicationGroups + # op: ListByResourceGroup + # param: \$filter + # name: list-filter ``` diff --git a/specification/desktopvirtualization/resource-manager/readme.md b/specification/desktopvirtualization/resource-manager/readme.md index f925aac285c5..9a9b9ebd94d0 100644 --- a/specification/desktopvirtualization/resource-manager/readme.md +++ b/specification/desktopvirtualization/resource-manager/readme.md @@ -74,6 +74,7 @@ swagger-to-sdk: - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_desktop_virtualization'] + - repo: azure-cli-extensions ``` ## C# @@ -110,16 +111,16 @@ AutoRest V3 generators require the use of `--tag=all-api-versions` to select api This block is updated by an automatic script. Edits may be lost! -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json - - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json - - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json - +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json + - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json + - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json + ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/desktopvirtualization/resource-manager/readme.python.md b/specification/desktopvirtualization/resource-manager/readme.python.md index 9714d4109d0b..454b0737ac27 100644 --- a/specification/desktopvirtualization/resource-manager/readme.python.md +++ b/specification/desktopvirtualization/resource-manager/readme.python.md @@ -10,18 +10,18 @@ python: azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION payload-flattening-threshold: 2 - namespace: azure.mgmt.DesktopVirtualization - package-name: azure-mgmt-DesktopVirtualization + namespace: azure.mgmt.desktopvirtualization + package-name: azure-mgmt-desktopvirtualization package-version: 0.2.0 clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' python: no-namespace-folders: true - output-folder: $(python-sdks-folder)/azure-mgmt-DesktopVirtualization/azure/mgmt/DesktopVirtualization + output-folder: $(python-sdks-folder)/azure-mgmt-desktopvirtualization/azure/mgmt/desktopvirtualization ``` ``` yaml $(python) && $(python-mode) == 'create' python: basic-setup-py: true - output-folder: $(python-sdks-folder)/azure-mgmt-DesktopVirtualization + output-folder: $(python-sdks-folder)/azure-mgmt-desktopvirtualization ``` From e76ff74cfa8852da8d95d74f9b0c71cbc53936bb Mon Sep 17 00:00:00 2001 From: azuresdkci Date: Thu, 28 May 2020 02:04:14 +0000 Subject: [PATCH 020/318] regenerated all-api-versions --- .../resource-manager/readme.md | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/desktopvirtualization/resource-manager/readme.md b/specification/desktopvirtualization/resource-manager/readme.md index 9a9b9ebd94d0..3864f213f6b1 100644 --- a/specification/desktopvirtualization/resource-manager/readme.md +++ b/specification/desktopvirtualization/resource-manager/readme.md @@ -111,16 +111,16 @@ AutoRest V3 generators require the use of `--tag=all-api-versions` to select api This block is updated by an automatic script. Edits may be lost! -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json - - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json - - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json - +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json + - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json + - $(this-folder)/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json + ``` If there are files that should not be in the `all-api-versions` set, From 4ac35f9546c0420114b361cf11dad5b922a6c15e Mon Sep 17 00:00:00 2001 From: Anirban Sarkar <33848291+asarkar84@users.noreply.github.com> Date: Wed, 27 May 2020 19:30:50 -0700 Subject: [PATCH 021/318] BillingRP - Introducing the stable version (#9541) * BillingRP swagger * Changes for the GA version Changes for the GA version * Incorporated review comments Incorporated review comments * Fixed Prettier Check failures Fixed Prettier Check failures * Fixed Prettier Check failures Fixed Prettier Check failures * Added BillingSubscription patch Added BillingSubscription patch Co-authored-by: Anirban Sarkar --- .../stable/2020-05-01/billing.json | 6076 +++++++++++++++++ .../2020-05-01/examples/AddressInvalid.json | 36 + .../2020-05-01/examples/AddressValid.json | 28 + .../2020-05-01/examples/AgreementByName.json | 36 + .../AgreementsListByBillingAccount.json | 59 + .../AvailableBalanceByBillingProfile.json | 22 + .../2020-05-01/examples/BillingAccount.json | 22 + .../examples/BillingAccountInvoicesList.json | 150 + .../BillingAccountPermissionsList.json | 39 + .../BillingAccountRoleAssignment.json | 25 + .../BillingAccountRoleAssignmentDelete.json | 25 + .../BillingAccountRoleAssignmentList.json | 42 + .../BillingAccountRoleDefinition.json | 47 + .../BillingAccountRoleDefinitionsList.json | 127 + .../examples/BillingAccountWithExpand.json | 159 + .../examples/BillingAccountsList.json | 50 + .../BillingAccountsListWithExpand.json | 337 + ...ntsListWithExpandForEnrollmentDetails.json | 107 + .../2020-05-01/examples/BillingProfile.json | 52 + .../BillingProfilePermissionsList.json | 40 + .../BillingProfileRoleAssignment.json | 26 + .../BillingProfileRoleAssignmentDelete.json | 26 + .../BillingProfileRoleAssignmentList.json | 43 + .../BillingProfileRoleDefinition.json | 48 + .../BillingProfileRoleDefinitionsList.json | 83 + .../examples/BillingProfileWithExpand.json | 71 + .../BillingProfilesListByBillingAccount.json | 95 + .../BillingProfilesListWithExpand.json | 133 + .../2020-05-01/examples/BillingProperty.json | 34 + .../examples/BillingSubscription.json | 36 + .../examples/BillingSubscriptionInvoice.json | 55 + .../BillingSubscriptionInvoiceDownload.json | 21 + .../BillingSubscriptionInvoicesList.json | 79 + ...lingSubscriptionsListByBillingAccount.json | 89 + ...lingSubscriptionsListByBillingProfile.json | 90 + .../BillingSubscriptionsListByCustomer.json | 69 + ...lingSubscriptionsListByInvoiceSection.json | 91 + .../stable/2020-05-01/examples/Customer.json | 21 + .../examples/CustomerPermissionsList.json | 27 + .../2020-05-01/examples/CustomerPolicy.json | 19 + .../examples/CustomerWithExpand.json | 38 + .../CustomersListByBillingAccount.json | 34 + .../CustomersListByBillingProfile.json | 35 + .../2020-05-01/examples/Instruction.json | 22 + .../InstructionsListByBillingProfile.json | 35 + .../stable/2020-05-01/examples/Invoice.json | 83 + .../2020-05-01/examples/InvoiceById.json | 82 + .../2020-05-01/examples/InvoiceDownload.json | 20 + .../2020-05-01/examples/InvoiceSection.json | 25 + .../InvoiceSectionPermissionsList.json | 41 + .../InvoiceSectionRoleAssignment.json | 27 + .../InvoiceSectionRoleAssignmentDelete.json | 27 + .../InvoiceSectionRoleAssignmentList.json | 44 + .../InvoiceSectionRoleDefinition.json | 49 + .../InvoiceSectionRoleDefinitionsList.json | 84 + .../InvoiceSectionsListByBillingProfile.json | 41 + ...ceSectionsListWithCreateSubPermission.json | 35 + .../InvoicesListByBillingProfile.json | 161 + .../examples/MoveBillingSubscription.json | 42 + .../2020-05-01/examples/MoveProduct.json | 49 + .../stable/2020-05-01/examples/Policy.json | 21 + .../stable/2020-05-01/examples/Product.json | 39 + .../ProductsListByBillingAccount.json | 70 + .../ProductsListByBillingProfile.json | 71 + .../examples/ProductsListByCustomer.json | 75 + .../ProductsListByInvoiceSection.json | 71 + .../examples/PutBillingProfile.json | 76 + .../2020-05-01/examples/PutInstruction.json | 29 + .../examples/PutInvoiceSection.json | 40 + .../examples/TransactionsListByInvoice.json | 124 + .../examples/UpdateBillingAccount.json | 53 + .../examples/UpdateBillingProperty.json | 39 + .../examples/UpdateBillingSubscription.json | 41 + .../examples/UpdateCustomerPolicy.json | 24 + .../2020-05-01/examples/UpdatePolicy.json | 28 + .../2020-05-01/examples/UpdateProduct.json | 44 + .../examples/ValidateProductMoveFailure.json | 21 + .../examples/ValidateProductMoveSuccess.json | 17 + .../ValidateSubscriptionMoveFailure.json | 21 + .../ValidateSubscriptionMoveSuccess.json | 17 + .../billing/resource-manager/readme.go.md | 10 + .../billing/resource-manager/readme.md | 26 +- .../billing/resource-manager/readme.ruby.md | 10 + 83 files changed, 10575 insertions(+), 1 deletion(-) create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressInvalid.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressValid.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AvailableBalanceByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountInvoicesList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountPermissionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentDelete.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinition.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinitionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountWithExpand.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpand.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpandForEnrollmentDetails.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilePermissionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentDelete.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinition.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinitionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileWithExpand.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListWithExpand.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProperty.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscription.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoicesList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Customer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPermissionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPolicy.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerWithExpand.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Instruction.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InstructionsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Invoice.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionPermissionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentDelete.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinition.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinitionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListWithCreateSubPermission.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoicesListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveBillingSubscription.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveProduct.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Policy.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutBillingProfile.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInstruction.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInvoiceSection.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/TransactionsListByInvoice.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingProperty.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingSubscription.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateCustomerPolicy.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdatePolicy.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateProduct.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveFailure.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveSuccess.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveFailure.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveSuccess.json diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json new file mode 100644 index 000000000000..96398ed362ae --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json @@ -0,0 +1,6076 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-05-01", + "title": "BillingManagementClient", + "description": "Billing client provides access to billing resources for Azure subscriptions." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Billing/billingAccounts": { + "get": { + "tags": [ + "BillingAccounts" + ], + "x-ms-examples": { + "BillingAccountsList": { + "$ref": "./examples/BillingAccountsList.json" + }, + "BillingAccountsListWithExpand": { + "$ref": "./examples/BillingAccountsListWithExpand.json" + }, + "BillingAccountsListWithExpandForEnrollmentDetails": { + "$ref": "./examples/BillingAccountsListWithExpandForEnrollmentDetails.json" + } + }, + "operationId": "BillingAccounts_List", + "description": "Lists the billing accounts that a user has access to.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the soldTo, invoice sections and billing profiles.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}": { + "get": { + "tags": [ + "BillingAccounts" + ], + "x-ms-examples": { + "BillingAccounts": { + "$ref": "./examples/BillingAccount.json" + }, + "BillingAccountWithExpand": { + "$ref": "./examples/BillingAccountWithExpand.json" + } + }, + "operationId": "BillingAccounts_Get", + "description": "Gets a billing account by its ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the soldTo, invoice sections and billing profiles.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "BillingAccounts" + ], + "operationId": "BillingAccounts_Update", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Updates the properties of a billing account. Currently, displayName and address can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "x-ms-examples": { + "UpdateBillingAccount": { + "$ref": "./examples/UpdateBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BillingAccountUpdateRequest" + }, + "description": "Request parameters that are provided to the update billing account operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingAccount" + } + }, + "202": { + "description": "Accepted. Billing account update is in progress." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/listInvoiceSectionsWithCreateSubscriptionPermission": { + "post": { + "tags": [ + "BillingAccounts" + ], + "x-ms-examples": { + "InvoiceSectionsListWithCreateSubPermission": { + "$ref": "./examples/InvoiceSectionsListWithCreateSubPermission.json" + } + }, + "operationId": "BillingAccounts_ListInvoiceSectionsByCreateSubscriptionPermission", + "description": "Lists the invoice sections for which the user has permission to create Azure subscriptions. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InvoiceSectionListWithCreateSubPermissionResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/validateAddress": { + "post": { + "tags": [ + "Address" + ], + "x-ms-examples": { + "AddressValid": { + "$ref": "./examples/AddressValid.json" + }, + "AddressInvalid": { + "$ref": "./examples/AddressInvalid.json" + } + }, + "operationId": "Address_Validate", + "description": "Validates an address. Use the operation to validate an address before using it as soldTo or a billTo address.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "address", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AddressDetails" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateAddressResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default": { + "get": { + "tags": [ + "AvailableBalances" + ], + "operationId": "AvailableBalances_Get", + "description": "The available credit balance for a billing profile. This is the balance that can be used for pay now to settle due or past due invoices. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "AvailableBalanceByBillingProfile": { + "$ref": "./examples/AvailableBalanceByBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AvailableBalance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions": { + "get": { + "tags": [ + "Instructions" + ], + "operationId": "Instructions_ListByBillingProfile", + "description": "Lists the instructions by billing profile id.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "InstructionsListByBillingProfile": { + "$ref": "./examples/InstructionsListByBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InstructionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/{instructionName}": { + "get": { + "tags": [ + "Instructions" + ], + "x-ms-examples": { + "Instruction": { + "$ref": "./examples/Instruction.json" + } + }, + "operationId": "Instructions_Get", + "description": "Get the instruction by name. These are custom billing instructions and are only applicable for certain customers.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/instructionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Instruction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Instructions" + ], + "operationId": "Instructions_Put", + "description": "Creates or updates an instruction. These are custom billing instructions and are only applicable for certain customers.", + "x-ms-examples": { + "PutInstruction": { + "$ref": "./examples/PutInstruction.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/instructionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Instruction" + }, + "description": "The new instruction." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Instruction" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles": { + "get": { + "tags": [ + "BillingProfiles" + ], + "x-ms-examples": { + "BillingProfilesListByBillingAccount": { + "$ref": "./examples/BillingProfilesListByBillingAccount.json" + }, + "BillingProfilesListWithExpand": { + "$ref": "./examples/BillingProfilesListWithExpand.json" + } + }, + "operationId": "BillingProfiles_ListByBillingAccount", + "description": "Lists the billing profiles that a user has access to. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the invoice sections.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}": { + "get": { + "tags": [ + "BillingProfiles" + ], + "x-ms-examples": { + "BillingProfile": { + "$ref": "./examples/BillingProfile.json" + }, + "BillingProfileWithExpand": { + "$ref": "./examples/BillingProfileWithExpand.json" + } + }, + "operationId": "BillingProfiles_Get", + "description": "Gets a billing profile by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the invoice sections.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "BillingProfiles" + ], + "operationId": "BillingProfiles_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Creates or updates a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", + "x-ms-examples": { + "CreateBillingProfile": { + "$ref": "./examples/PutBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BillingProfile" + }, + "description": "The new or updated billing profile." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingProfile" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Retry-After": { + "description": "Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds.", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/customers": { + "get": { + "tags": [ + "Customers" + ], + "x-ms-examples": { + "CustomersListByBillingAccount": { + "$ref": "./examples/CustomersListByBillingProfile.json" + } + }, + "operationId": "Customers_ListByBillingProfile", + "description": "Lists the customers that are billed to a billing profile. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "name": "$search", + "description": "Used for searching customers by their name. Any customer with name containing the search text will be included in the response", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter the list of customers.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections": { + "get": { + "tags": [ + "InvoiceSections" + ], + "x-ms-examples": { + "InvoiceSectionsListByBillingProfile": { + "$ref": "./examples/InvoiceSectionsListByBillingProfile.json" + } + }, + "operationId": "InvoiceSections_ListByBillingProfile", + "description": "Lists the invoice sections that a user has access to. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InvoiceSectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}": { + "get": { + "tags": [ + "InvoiceSections" + ], + "x-ms-examples": { + "InvoiceSection": { + "$ref": "./examples/InvoiceSection.json" + } + }, + "operationId": "InvoiceSections_Get", + "description": "Gets an invoice section by its ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InvoiceSection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "InvoiceSections" + ], + "operationId": "InvoiceSections_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Creates or updates an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "x-ms-examples": { + "PutInvoiceSection": { + "$ref": "./examples/PutInvoiceSection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InvoiceSection" + }, + "description": "The new or updated invoice section." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InvoiceSection" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Retry-After": { + "description": "Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds.", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers": { + "get": { + "tags": [ + "Customers" + ], + "x-ms-examples": { + "CustomersListByBillingAccount": { + "$ref": "./examples/CustomersListByBillingAccount.json" + } + }, + "operationId": "Customers_ListByBillingAccount", + "description": "Lists the customers that are billed to a billing account. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "name": "$search", + "description": "Used for searching customers by their name. Any customer with name containing the search text will be included in the response", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$filter", + "description": "May be used to filter the list of customers.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}": { + "get": { + "tags": [ + "Customers" + ], + "x-ms-examples": { + "Customer": { + "$ref": "./examples/Customer.json" + }, + "CustomerWithExpand": { + "$ref": "./examples/CustomerWithExpand.json" + } + }, + "operationId": "Customers_Get", + "description": "Gets a customer by its ID. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/customerNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand enabledAzurePlans and resellers", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Customer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermissions" + ], + "x-ms-examples": { + "BillingProfilePermissionsList": { + "$ref": "./examples/CustomerPermissionsList.json" + } + }, + "operationId": "BillingPermissions_ListByCustomer", + "description": "Lists the billing permissions the caller has for a customer.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/customerNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPermissionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/billingSubscriptions": { + "get": { + "tags": [ + "BillingSubscriptions" + ], + "operationId": "BillingSubscriptions_ListByCustomer", + "description": "Lists the subscriptions for a customer. The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "BillingSubscriptionsListByCustomer": { + "$ref": "./examples/BillingSubscriptionsListByCustomer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/customerNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/products": { + "get": { + "tags": [ + "Products" + ], + "operationId": "Products_ListByCustomer", + "description": "Lists the products for a customer. These don't include products billed based on usage.The operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "ProductsListByInvoiceSection": { + "$ref": "./examples/ProductsListByCustomer.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/customerNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices": { + "get": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "BillingAccountInvoicesList": { + "$ref": "./examples/BillingAccountInvoicesList.json" + } + }, + "operationId": "Invoices_ListByBillingAccount", + "description": "Lists the invoices for a billing account for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "name": "periodStartDate", + "description": "The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format.", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "periodEndDate", + "description": "The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format.", + "in": "query", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InvoiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoices": { + "get": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "InvoicesListByBillingProfile": { + "$ref": "./examples/InvoicesListByBillingProfile.json" + } + }, + "operationId": "Invoices_ListByBillingProfile", + "description": "Lists the invoices for a billing profile for a given start date and end date. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "name": "periodStartDate", + "description": "The start date to fetch the invoices. The date should be specified in MM-DD-YYYY format.", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "periodEndDate", + "description": "The end date to fetch the invoices. The date should be specified in MM-DD-YYYY format.", + "in": "query", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InvoiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}": { + "get": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "Invoice": { + "$ref": "./examples/Invoice.json" + } + }, + "operationId": "Invoices_Get", + "description": "Gets an invoice by billing account name and ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/invoiceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/default/invoices/{invoiceName}": { + "get": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "Invoice": { + "$ref": "./examples/InvoiceById.json" + } + }, + "operationId": "Invoices_GetById", + "description": "Gets an invoice by ID. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/invoiceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/download": { + "post": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "InvoiceDownload": { + "$ref": "./examples/InvoiceDownload.json" + } + }, + "operationId": "Invoices_DownloadInvoice", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download an invoice. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/invoiceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions": { + "get": { + "tags": [ + "BillingSubscriptions" + ], + "operationId": "BillingSubscriptions_ListByBillingAccount", + "description": "Lists the subscriptions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "BillingSubscriptionsListByBillingAccount": { + "$ref": "./examples/BillingSubscriptionsListByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices": { + "get": { + "tags": [ + "Invoices" + ], + "operationId": "Invoices_ListByBillingSubscription", + "description": "Lists the invoices for a subscription.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "BillingSubscriptionsListByBillingAccount": { + "$ref": "./examples/BillingSubscriptionInvoicesList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "periodStartDate", + "description": "Invoice period start date.", + "in": "query", + "required": true, + "type": "string" + }, + { + "name": "periodEndDate", + "description": "Invoice period end date.", + "in": "query", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/InvoiceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}": { + "get": { + "tags": [ + "Invoices" + ], + "operationId": "Invoices_GetBySubscriptionAndInvoiceId", + "description": "Gets an invoice by subscription ID and invoice ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "BillingSubscriptionsListByBillingAccount": { + "$ref": "./examples/BillingSubscriptionInvoice.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/invoiceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Invoice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/{subscriptionId}/invoices/{invoiceName}/download": { + "post": { + "tags": [ + "Invoices" + ], + "x-ms-examples": { + "BillingSubscriptionInvoiceDownload": { + "$ref": "./examples/BillingSubscriptionInvoiceDownload.json" + } + }, + "operationId": "Invoices_DownloadBillingSubscriptionInvoice", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Gets a URL to download an invoice.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/invoiceNameParameter" + }, + { + "name": "downloadToken", + "description": "Download token with document source and document ID.", + "in": "query", + "required": true, + "type": "string" + } + ], + "responses": { + "202": { + "description": "Accepted.", + "headers": { + "Location": { + "description": "GET this URL to retrieve the status of the asynchronous operation.", + "type": "string" + }, + "Retry-After": { + "description": "The amount of delay to use while the status of the operation is checked. The value is expressed in seconds.", + "type": "string" + } + } + }, + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DownloadUrl" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingSubscriptions": { + "get": { + "tags": [ + "BillingSubscriptions" + ], + "operationId": "BillingSubscriptions_ListByBillingProfile", + "description": "Lists the subscriptions that are billed to a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "BillingSubscriptionsListByBillingProfile": { + "$ref": "./examples/BillingSubscriptionsListByBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingSubscriptions": { + "get": { + "tags": [ + "BillingSubscriptions" + ], + "operationId": "BillingSubscriptions_ListByInvoiceSection", + "description": "Lists the subscriptions that are billed to an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "BillingSubscriptionsListByInvoiceSection": { + "$ref": "./examples/BillingSubscriptionsListByInvoiceSection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingSubscriptionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}": { + "get": { + "tags": [ + "BillingSubscriptions" + ], + "operationId": "BillingSubscriptions_Get", + "description": "Gets a subscription by its ID. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement and Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "BillingSubscription": { + "$ref": "./examples/BillingSubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingSubscription" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "BillingSubscriptions" + ], + "operationId": "BillingSubscriptions_Update", + "description": "Updates the properties of a billing subscription. Currently, cost center can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "x-ms-examples": { + "UpdateBillingProperty": { + "$ref": "./examples/UpdateBillingSubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BillingSubscription" + }, + "description": "Request parameters that are provided to the update billing subscription operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingSubscription" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}/move": { + "post": { + "description": "Moves a subscription's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "operationId": "BillingSubscriptions_Move", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "MoveBillingSubscription": { + "$ref": "./examples/MoveBillingSubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TransferBillingSubscriptionRequestProperties" + }, + "description": "Request parameters that are provided to the move subscription operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingSubscription" + } + }, + "202": { + "description": "Accepted. Billing Subscription transfer is in progress.", + "headers": { + "Location": { + "description": "Location URI to poll for result.", + "type": "string" + }, + "Retry-After": { + "description": "Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds.", + "type": "integer" + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}/validateMoveEligibility": { + "post": { + "x-ms-examples": { + "SubscriptionMoveValidateSuccess": { + "$ref": "./examples/ValidateSubscriptionMoveSuccess.json" + }, + "SubscriptionMoveValidateFailure": { + "$ref": "./examples/ValidateSubscriptionMoveFailure.json" + } + }, + "operationId": "BillingSubscriptions_ValidateMove", + "description": "Validates if a subscription's charges can be moved to a new invoice section. This operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TransferBillingSubscriptionRequestProperties" + }, + "description": "Request parameters that are provided to the validate move eligibility operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateSubscriptionTransferEligibilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products": { + "get": { + "tags": [ + "Products" + ], + "operationId": "Products_ListByBillingAccount", + "description": "Lists the products for a billing account. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "ProductsListByBillingAccount": { + "$ref": "./examples/ProductsListByBillingAccount.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/products": { + "get": { + "tags": [ + "Products" + ], + "operationId": "Products_ListByBillingProfile", + "description": "Lists the products for a billing profile. These don't include products billed based on usage. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement or Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "ProductsListByBillingProfile": { + "$ref": "./examples/ProductsListByBillingProfile.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/products": { + "get": { + "tags": [ + "Products" + ], + "operationId": "Products_ListByInvoiceSection", + "description": "Lists the products for an invoice section. These don't include products billed based on usage. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "ProductsListByInvoiceSection": { + "$ref": "./examples/ProductsListByInvoiceSection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter by product type. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'. Tag filter is a key value pair string where key and value are separated by a colon (:).", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ProductsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}": { + "get": { + "tags": [ + "Products" + ], + "operationId": "Products_Get", + "description": "Gets a product by ID. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "Product": { + "$ref": "./examples/Product.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/productNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Products" + ], + "operationId": "Products_Update", + "description": "Updates the properties of a Product. Currently, auto renew can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "x-ms-examples": { + "UpdateBillingProperty": { + "$ref": "./examples/UpdateProduct.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/productNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Product" + }, + "description": "Request parameters that are provided to the update product operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/move": { + "post": { + "tags": [ + "Products" + ], + "operationId": "Products_Move", + "description": "Moves a product's charges to a new invoice section. The new invoice section must belong to the same billing profile as the existing invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "MoveProduct": { + "$ref": "./examples/MoveProduct.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/productNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TransferProductRequestProperties" + }, + "description": "Request parameters that are provided to the move product operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Product" + } + }, + "202": { + "description": "Accepted", + "headers": { + "Location": { + "description": "Location URI to poll for result", + "type": "string" + }, + "Retry-After": { + "description": "Recommended time to wait before making another request to check the status of the operation. The time is specified in seconds.", + "type": "integer" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/products/{productName}/validateMoveEligibility": { + "post": { + "x-ms-examples": { + "SubscriptionMoveValidateSuccess": { + "$ref": "./examples/ValidateProductMoveSuccess.json" + }, + "SubscriptionMoveValidateFailure": { + "$ref": "./examples/ValidateProductMoveFailure.json" + } + }, + "operationId": "Products_ValidateMove", + "description": "Validates if a product's charges can be moved to a new invoice section. This operation is supported only for products that are purchased with a recurring charge and for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/productNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TransferProductRequestProperties" + }, + "description": "Request parameters that are provided to the validate move eligibility operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateProductTransferEligibilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/transactions": { + "get": { + "tags": [ + "Transactions" + ], + "operationId": "Transactions_ListByInvoice", + "description": "Lists the transactions for an invoice. Transactions include purchases, refunds and Azure usage charges.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "TransactionsListByInvoice": { + "$ref": "./examples/TransactionsListByInvoice.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/invoiceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/TransactionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default": { + "get": { + "tags": [ + "Policies" + ], + "operationId": "Policies_GetByBillingProfile", + "description": "Lists the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "PolicyByBillingProfile": { + "$ref": "./examples/Policy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Policy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Policies" + ], + "operationId": "Policies_Update", + "description": "Updates the policies for a billing profile. This operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "x-ms-examples": { + "UpdatePolicy": { + "$ref": "./examples/UpdatePolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Policy" + }, + "description": "Request parameters that are provided to the update policies operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Policy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default": { + "get": { + "tags": [ + "Policies" + ], + "operationId": "Policies_GetByCustomer", + "description": "Lists the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "PolicyByCustomer": { + "$ref": "./examples/CustomerPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/customerNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomerPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Policies" + ], + "operationId": "Policies_UpdateCustomer", + "description": "Updates the policies for a customer. This operation is supported only for billing accounts with agreement type Microsoft Partner Agreement.", + "x-ms-examples": { + "UpdateCustomer": { + "$ref": "./examples/UpdateCustomerPolicy.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/customerNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CustomerPolicy" + }, + "description": "Request parameters that are provided to the update policies operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CustomerPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default": { + "get": { + "tags": [ + "BillingProperties" + ], + "operationId": "BillingProperty_Get", + "description": "Get the billing properties for a subscription. This operation is not supported for billing accounts with agreement type Enterprise Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "x-ms-examples": { + "BillingProperty": { + "$ref": "./examples/BillingProperty.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingProperty" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "BillingProperties" + ], + "operationId": "BillingProperty_Update", + "description": "Updates the billing property of a subscription. Currently, cost center can be updated. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "x-ms-examples": { + "UpdateBillingProperty": { + "$ref": "./examples/UpdateBillingProperty.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BillingProperty" + }, + "description": "Request parameters that are provided to the update billing property operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingProperty" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists the available billing REST API operations.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermissions" + ], + "x-ms-examples": { + "BillingAccountPermissionsList": { + "$ref": "./examples/BillingAccountPermissionsList.json" + } + }, + "operationId": "BillingPermissions_ListByBillingAccount", + "description": "Lists the billing permissions the caller has on a billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPermissionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermissions" + ], + "x-ms-examples": { + "InvoiceSectionPermissionsList": { + "$ref": "./examples/InvoiceSectionPermissionsList.json" + } + }, + "operationId": "BillingPermissions_ListByInvoiceSections", + "description": "Lists the billing permissions the caller has on an invoice section.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPermissionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermissions" + ], + "x-ms-examples": { + "BillingProfilePermissionsList": { + "$ref": "./examples/BillingProfilePermissionsList.json" + } + }, + "operationId": "BillingPermissions_ListByBillingProfile", + "description": "Lists the billing permissions the caller has on a billing profile.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPermissionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "BillingAccountRoleDefinition": { + "$ref": "./examples/BillingAccountRoleDefinition.json" + } + }, + "operationId": "BillingRoleDefinitions_GetByBillingAccount", + "description": "Gets the definition for a role on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingRoleDefinitionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{billingRoleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "InvoiceSectionRoleDefinition": { + "$ref": "./examples/InvoiceSectionRoleDefinition.json" + } + }, + "operationId": "BillingRoleDefinitions_GetByInvoiceSection", + "description": "Gets the definition for a role on an invoice section. The operation is supported only for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + }, + { + "$ref": "#/parameters/billingRoleDefinitionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{billingRoleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "BillingProfileRoleDefinition": { + "$ref": "./examples/BillingProfileRoleDefinition.json" + } + }, + "operationId": "BillingRoleDefinitions_GetByBillingProfile", + "description": "Gets the definition for a role on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/billingRoleDefinitionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "BillingAccountRoleDefinitionsList": { + "$ref": "./examples/BillingAccountRoleDefinitionsList.json" + } + }, + "operationId": "BillingRoleDefinitions_ListByBillingAccount", + "description": "Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "InvoiceSectionRoleDefinitionsList": { + "$ref": "./examples/InvoiceSectionRoleDefinitionsList.json" + } + }, + "operationId": "BillingRoleDefinitions_ListByInvoiceSection", + "description": "Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "BillingProfileRoleDefinitionsList": { + "$ref": "./examples/BillingProfileRoleDefinitionsList.json" + } + }, + "operationId": "BillingRoleDefinitions_ListByBillingProfile", + "description": "Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "get": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "BillingAccountRoleAssignment": { + "$ref": "./examples/BillingAccountRoleAssignment.json" + } + }, + "operationId": "BillingRoleAssignments_GetByBillingAccount", + "description": "Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "BillingAccountRoleAssignmentDelete": { + "$ref": "./examples/BillingAccountRoleAssignmentDelete.json" + } + }, + "operationId": "BillingRoleAssignments_DeleteByBillingAccount", + "description": "Deletes a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "get": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "InvoiceSectionRoleAssignment": { + "$ref": "./examples/InvoiceSectionRoleAssignment.json" + } + }, + "operationId": "BillingRoleAssignments_GetByInvoiceSection", + "description": "Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "InvoiceSectionRoleAssignmentDelete": { + "$ref": "./examples/InvoiceSectionRoleAssignmentDelete.json" + } + }, + "operationId": "BillingRoleAssignments_DeleteByInvoiceSection", + "description": "Deletes a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "get": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "BillingProfileRoleAssignment": { + "$ref": "./examples/BillingProfileRoleAssignment.json" + } + }, + "operationId": "BillingRoleAssignments_GetByBillingProfile", + "description": "Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "BillingProfileRoleAssignmentDelete": { + "$ref": "./examples/BillingProfileRoleAssignmentDelete.json" + } + }, + "operationId": "BillingRoleAssignments_DeleteByBillingProfile", + "description": "Deletes a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "BillingAccountRoleAssignmentList": { + "$ref": "./examples/BillingAccountRoleAssignmentList.json" + } + }, + "operationId": "BillingRoleAssignments_ListByBillingAccount", + "description": "Lists the role assignments for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "InvoiceSectionRoleAssignmentList": { + "$ref": "./examples/InvoiceSectionRoleAssignmentList.json" + } + }, + "operationId": "BillingRoleAssignments_ListByInvoiceSection", + "description": "Lists the role assignments for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "BillingProfileRoleAssignmentList": { + "$ref": "./examples/BillingProfileRoleAssignmentList.json" + } + }, + "operationId": "BillingRoleAssignments_ListByBillingProfile", + "description": "Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements": { + "get": { + "tags": [ + "Agreements" + ], + "x-ms-examples": { + "AgreementsListByBillingAccount": { + "$ref": "./examples/AgreementsListByBillingAccount.json" + } + }, + "operationId": "Agreements_ListByBillingAccount", + "description": "Lists the agreements for a billing account.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the participants.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AgreementListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}": { + "get": { + "tags": [ + "Agreements" + ], + "x-ms-examples": { + "AgreementByName": { + "$ref": "./examples/AgreementByName.json" + } + }, + "operationId": "Agreements_Get", + "description": "Gets an agreement by ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/billing/" + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/agreementNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the participants.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Agreement" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "CustomerListResult": { + "description": "The list of customers.", + "properties": { + "value": { + "description": "The list of customers.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Customer" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Customer": { + "description": "A partner's customer.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The customer.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomerProperties" + } + } + }, + "CustomerProperties": { + "description": "The properties of a customer.", + "properties": { + "billingProfileId": { + "description": "The ID of the billing profile for the invoice section.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile for the invoice section.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "The name of the customer.", + "type": "string" + }, + "enabledAzurePlans": { + "description": "Azure plans enabled for the customer.", + "type": "array", + "items": { + "$ref": "#/definitions/AzurePlan" + } + }, + "resellers": { + "description": "The list of resellers for which an Azure plan is enabled for the customer.", + "type": "array", + "items": { + "$ref": "#/definitions/Reseller" + } + } + } + }, + "ValidateAddressResponse": { + "type": "object", + "description": "Result of the address validation", + "properties": { + "status": { + "description": "status of the address validation.", + "$ref": "#/definitions/AddressValidationStatus" + }, + "suggestedAddresses": { + "description": "The list of suggested addresses.", + "type": "array", + "items": { + "$ref": "#/definitions/AddressDetails" + } + }, + "validationMessage": { + "description": "Validation error message.", + "type": "string" + } + } + }, + "AddressValidationStatus": { + "type": "string", + "description": "Status of the address validation.", + "enum": [ + "Valid", + "Invalid" + ], + "x-ms-enum": { + "name": "addressValidationStatus", + "modelAsString": true + } + }, + "TransferProductRequestProperties": { + "description": "The properties of the product to initiate a transfer.", + "properties": { + "destinationInvoiceSectionId": { + "type": "string", + "description": "The destination invoice section id." + } + } + }, + "TransferBillingSubscriptionRequestProperties": { + "type": "object", + "description": "Request parameters to transfer billing subscription.", + "required": [ + "destinationInvoiceSectionId" + ], + "properties": { + "destinationInvoiceSectionId": { + "type": "string", + "description": "The destination invoice section id." + } + } + }, + "ValidateSubscriptionTransferEligibilityResult": { + "type": "object", + "description": "Result of the transfer eligibility validation.", + "properties": { + "isMoveEligible": { + "description": "Specifies whether the subscription is eligible to be transferred.", + "type": "boolean", + "readOnly": true + }, + "errorDetails": { + "description": "Validation error details.", + "$ref": "#/definitions/ValidateSubscriptionTransferEligibilityError" + } + } + }, + "ValidateSubscriptionTransferEligibilityError": { + "type": "object", + "description": "Error details of the transfer eligibility validation", + "properties": { + "code": { + "description": "Error code for the product transfer validation.", + "$ref": "#/definitions/SubscriptionTransferValidationErrorCode" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "details": { + "description": "Detailed error message explaining the error.", + "type": "string" + } + } + }, + "SubscriptionTransferValidationErrorCode": { + "type": "string", + "description": "Error code of the transfer validation response.", + "enum": [ + "InvalidSource", + "SubscriptionNotActive", + "InsufficientPermissionOnSource", + "InsufficientPermissionOnDestination", + "DestinationBillingProfilePastDue", + "SubscriptionTypeNotSupported", + "CrossBillingAccountNotAllowed", + "NotAvailableForDestinationMarket" + ], + "x-ms-enum": { + "name": "subscriptionTransferValidationErrorCode", + "modelAsString": true + } + }, + "BillingAccountListResult": { + "description": "The list of billing accounts.", + "properties": { + "value": { + "description": "The list of billing accounts.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BillingAccount" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BillingAccount": { + "description": "A billing account.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The properties of the billing account.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingAccountProperties" + } + } + }, + "BillingAccountProperties": { + "description": "The properties of the billing account.", + "properties": { + "displayName": { + "description": "The billing account name.", + "type": "string" + }, + "soldTo": { + "description": "The address of the individual or organization that is responsible for the billing account.", + "$ref": "#/definitions/AddressDetails" + }, + "agreementType": { + "description": "The type of agreement.", + "type": "string", + "enum": [ + "MicrosoftCustomerAgreement", + "EnterpriseAgreement", + "MicrosoftOnlineServicesProgram", + "MicrosoftPartnerAgreement" + ], + "readOnly": true, + "x-ms-enum": { + "name": "AgreementType", + "modelAsString": true + } + }, + "accountType": { + "description": "The type of customer.", + "type": "string", + "enum": [ + "Enterprise", + "Individual", + "Partner" + ], + "readOnly": true, + "x-ms-enum": { + "name": "AccountType", + "modelAsString": true + } + }, + "accountStatus": { + "description": "The current status of the billing account.", + "type": "string", + "enum": [ + "Active", + "Deleted", + "Disabled", + "Expired", + "Transferred", + "Extended", + "Terminated" + ], + "readOnly": true, + "x-ms-enum": { + "name": "AccountStatus", + "modelAsString": true + } + }, + "billingProfiles": { + "description": "The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand.", + "$ref": "#/definitions/BillingProfilesOnExpand" + }, + "enrollmentDetails": { + "description": "The details about the associated legacy enrollment. By default this is not populated, unless it's specified in $expand.", + "$ref": "#/definitions/Enrollment", + "readOnly": true + }, + "departments": { + "description": "The departments associated to the enrollment.", + "type": "array", + "items": { + "$ref": "#/definitions/Department" + } + }, + "enrollmentAccounts": { + "description": "The accounts associated to the enrollment.", + "type": "array", + "items": { + "$ref": "#/definitions/EnrollmentAccount" + } + }, + "hasReadAccess": { + "description": "Indicates whether user has read access to the billing account.", + "type": "boolean", + "readOnly": true + } + } + }, + "BillingProfilesOnExpand": { + "description": "The billing profiles associated with the billing account. By default this is not populated, unless it's specified in $expand.", + "properties": { + "hasMoreResults": { + "description": "Indicates whether there are more billing profiles than the ones listed in this collection. The collection lists a maximum of 50 billing profiles. To get all billing profiles, use the list billing profiles API.", + "type": "boolean", + "readOnly": true + }, + "value": { + "description": "The billing profiles associated with the billing account.", + "type": "array", + "items": { + "$ref": "#/definitions/BillingProfile" + } + } + } + }, + "BillingAccountUpdateRequest": { + "description": "The request properties of the billing account that can be updated.", + "properties": { + "properties": { + "description": "A billing property.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingAccountProperties" + } + } + }, + "BillingProperty": { + "description": "A billing property.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "A billing property.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingPropertyProperties" + } + } + }, + "BillingPropertyProperties": { + "description": "The billing property.", + "properties": { + "accountAdminNotificationEmailAddress": { + "description": "The email address on which the account admin gets all Azure notifications.", + "type": "string", + "readOnly": true + }, + "billingTenantId": { + "description": "The Azure AD tenant ID of the billing account for the subscription.", + "type": "string", + "readOnly": true + }, + "billingAccountId": { + "description": "The ID of the billing account to which the subscription is billed.", + "type": "string", + "readOnly": true + }, + "billingAccountDisplayName": { + "description": "The name of the billing account to which the subscription is billed.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The ID of the billing profile to which the subscription is billed.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile to which the subscription is billed.", + "type": "string", + "readOnly": true + }, + "billingProfileStatus": { + "description": "The status of the billing profile.", + "enum": [ + "Active", + "Disabled", + "Warned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileStatus", + "modelAsString": true + } + }, + "billingProfileStatusReasonCode": { + "description": "Reason for the specified billing profile status.", + "enum": [ + "PastDue", + "SpendingLimitReached", + "SpendingLimitExpired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileStatusReasonCode", + "modelAsString": true + } + }, + "billingProfileSpendingLimit": { + "description": "The billing profile spending limit.", + "enum": [ + "Off", + "On" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileSpendingLimit", + "modelAsString": true + } + }, + "costCenter": { + "description": "The cost center applied to the subscription.", + "type": "string" + }, + "invoiceSectionId": { + "description": "The ID of the invoice section to which the subscription is billed.", + "type": "string", + "readOnly": true + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section to which the subscription is billed.", + "type": "string", + "readOnly": true + }, + "isAccountAdmin": { + "description": "Indicates whether user is the account admin.", + "type": "boolean", + "readOnly": true + }, + "productId": { + "description": "The product ID of the Azure plan.", + "type": "string", + "readOnly": true + }, + "productName": { + "description": "The product name of the Azure plan.", + "type": "string", + "readOnly": true + }, + "skuId": { + "description": "The sku ID of the Azure plan for the subscription.", + "type": "string", + "readOnly": true + }, + "skuDescription": { + "description": "The sku description of the Azure plan for the subscription.", + "type": "string", + "readOnly": true + } + } + }, + "Enrollment": { + "description": "The properties of an enrollment.", + "properties": { + "startDate": { + "description": "The start date of the enrollment.", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The end date of the enrollment.", + "type": "string", + "format": "date-time" + }, + "currency": { + "description": "The billing currency for the enrollment.", + "type": "string", + "readOnly": true + }, + "channel": { + "description": "The channel type of the enrollment.", + "type": "string", + "readOnly": true + }, + "policies": { + "description": "The policies for Enterprise Agreement enrollments.", + "$ref": "#/definitions/EnrollmentPolicies", + "readOnly": true + }, + "language": { + "description": "The language for the enrollment.", + "type": "string", + "readOnly": true + }, + "countryCode": { + "description": "The country code of the enrollment.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The current status of the enrollment.", + "type": "string", + "readOnly": true + }, + "billingCycle": { + "description": "The billing cycle for the enrollment.", + "type": "string", + "readOnly": true + } + } + }, + "EnrollmentPolicies": { + "description": "The policies for Enterprise Agreement enrollments.", + "properties": { + "accountOwnerViewCharges": { + "description": "The policy that controls whether Account Owners can view charges.", + "type": "boolean", + "readOnly": true + }, + "departmentAdminViewCharges": { + "description": "The policy that controls whether Department Administrators can view charges.", + "type": "boolean", + "readOnly": true + }, + "marketplacesEnabled": { + "description": "The policy that controls whether Azure marketplace purchases are allowed in the enrollment.", + "type": "boolean", + "readOnly": true + }, + "reservedInstancesEnabled": { + "description": "The policy that controls whether Azure reservation purchases are allowed in the enrollment.", + "type": "boolean", + "readOnly": true + } + } + }, + "Department": { + "description": "A department.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "A department.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/DepartmentProperties" + } + } + }, + "DepartmentProperties": { + "description": "The properties of a department.", + "properties": { + "departmentName": { + "description": "The name of the department.", + "type": "string" + }, + "costCenter": { + "description": "The cost center associated with the department.", + "type": "string" + }, + "status": { + "description": "The status of the department.", + "type": "string" + }, + "enrollmentAccounts": { + "description": "Associated enrollment accounts. By default this is not populated, unless it's specified in $expand.", + "type": "array", + "items": { + "$ref": "#/definitions/EnrollmentAccount" + } + } + } + }, + "EnrollmentAccount": { + "description": "An enrollment account.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The properties of an enrollment account.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnrollmentAccountProperties" + } + } + }, + "EnrollmentAccountProperties": { + "description": "The properties of an enrollment account.", + "properties": { + "accountName": { + "description": "The name of the enrollment account.", + "type": "string" + }, + "costCenter": { + "description": "The cost center associated with the enrollment account.", + "type": "string" + }, + "accountOwner": { + "description": "The owner of the enrollment account.", + "type": "string" + }, + "status": { + "description": "The status of the enrollment account.", + "type": "string" + }, + "startDate": { + "description": "The start date of the enrollment account.", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The end date of the enrollment account.", + "type": "string", + "format": "date-time" + }, + "department": { + "description": "Associated department. By default this is not populated, unless it's specified in $expand.", + "$ref": "#/definitions/Department" + } + } + }, + "InstructionListResult": { + "description": "The list of billing instructions used during invoice generation.", + "properties": { + "value": { + "description": "The list of billing instructions used during invoice generation.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Instruction" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BillingProfileListResult": { + "description": "The list of billing profiles.", + "properties": { + "value": { + "description": "The list of billing profiles.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BillingProfile" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BillingProfile": { + "description": "A billing profile.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The properties of the billing profile.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingProfileProperties" + } + } + }, + "Instruction": { + "description": "An instruction.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "A billing instruction used during invoice generation.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InstructionProperties" + } + } + }, + "InstructionProperties": { + "description": "A billing instruction used during invoice generation.", + "required": [ + "amount", + "startDate", + "endDate" + ], + "properties": { + "amount": { + "description": "The amount budgeted for this billing instruction.", + "type": "number" + }, + "startDate": { + "description": "The date this billing instruction goes into effect.", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The date this billing instruction is no longer in effect.", + "type": "string", + "format": "date-time" + }, + "creationDate": { + "description": "The date this billing instruction was created.", + "type": "string", + "format": "date-time" + } + } + }, + "BillingProfileCreationRequest": { + "description": "The request parameters for creating a new billing profile.", + "properties": { + "displayName": { + "description": "The name of the billing profile.", + "type": "string" + }, + "poNumber": { + "description": "The purchase order name that will appear on the invoices generated for the billing profile.", + "type": "string" + }, + "billTo": { + "description": "The address of the individual or organization that is responsible for the billing profile.", + "$ref": "#/definitions/AddressDetails" + }, + "invoiceEmailOptIn": { + "description": "Flag controlling whether the invoices for the billing profile are sent through email.", + "type": "boolean" + }, + "enabledAzurePlans": { + "description": "Enabled azure plans for the billing profile.", + "type": "array", + "items": { + "$ref": "#/definitions/AzurePlan" + } + } + } + }, + "BillingProfileProperties": { + "description": "The properties of the billing profile.", + "properties": { + "displayName": { + "description": "The name of the billing profile.", + "type": "string" + }, + "poNumber": { + "description": "The purchase order name that will appear on the invoices generated for the billing profile.", + "type": "string" + }, + "billTo": { + "description": "Billing address.", + "$ref": "#/definitions/AddressDetails" + }, + "invoiceEmailOptIn": { + "description": "Flag controlling whether the invoices for the billing profile are sent through email.", + "type": "boolean" + }, + "invoiceDay": { + "description": "The day of the month when the invoice for the billing profile is generated.", + "type": "integer", + "readOnly": true + }, + "currency": { + "description": "The currency in which the charges for the billing profile are billed.", + "type": "string", + "readOnly": true + }, + "enabledAzurePlans": { + "description": "Information about the enabled azure plans.", + "type": "array", + "items": { + "$ref": "#/definitions/AzurePlan" + } + }, + "invoiceSections": { + "description": "The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand.", + "$ref": "#/definitions/InvoiceSectionsOnExpand" + }, + "hasReadAccess": { + "description": "Indicates whether user has read access to the billing profile.", + "type": "boolean", + "readOnly": true + }, + "systemId": { + "description": "The system generated unique identifier for a billing profile.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the billing profile.", + "enum": [ + "Active", + "Disabled", + "Warned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileStatus", + "modelAsString": true + } + }, + "statusReasonCode": { + "description": "Reason for the specified billing profile status.", + "enum": [ + "PastDue", + "SpendingLimitReached", + "SpendingLimitExpired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StatusReasonCode", + "modelAsString": true + } + }, + "spendingLimit": { + "description": "The billing profile spending limit.", + "enum": [ + "Off", + "On" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SpendingLimit", + "modelAsString": true + } + } + } + }, + "InvoiceSectionsOnExpand": { + "description": "The invoice sections associated to the billing profile. By default this is not populated, unless it's specified in $expand.", + "properties": { + "hasMoreResults": { + "description": "Indicates whether there are more invoice sections than the ones listed in this collection. The collection lists a maximum of 50 invoice sections. To get all invoice sections, use the list invoice sections API.", + "type": "boolean", + "readOnly": true + }, + "value": { + "description": "The invoice sections associated to the billing profile.", + "type": "array", + "items": { + "$ref": "#/definitions/InvoiceSection" + } + } + } + }, + "AddressDetails": { + "description": "Address details.", + "required": [ + "addressLine1", + "country" + ], + "properties": { + "firstName": { + "description": "First name.", + "type": "string" + }, + "lastName": { + "description": "Last name.", + "type": "string" + }, + "companyName": { + "description": "Company name.", + "type": "string" + }, + "addressLine1": { + "description": "Address line 1.", + "type": "string" + }, + "addressLine2": { + "description": "Address line 2.", + "type": "string" + }, + "addressLine3": { + "description": "Address line 3.", + "type": "string" + }, + "city": { + "description": "Address city.", + "type": "string" + }, + "district": { + "description": "Address district.", + "type": "string" + }, + "region": { + "description": "Address region.", + "type": "string" + }, + "country": { + "description": "Country code uses ISO2, 2-digit format.", + "type": "string" + }, + "postalCode": { + "description": "Postal code.", + "type": "string" + }, + "email": { + "description": "Email address.", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number.", + "type": "string" + } + } + }, + "InvoiceSectionCreationRequest": { + "description": "The properties of the invoice section.", + "properties": { + "displayName": { + "description": "The name of the invoice section.", + "type": "string" + } + } + }, + "InvoiceSectionListResult": { + "description": "The list of invoice sections.", + "properties": { + "value": { + "description": "The list of invoice sections.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/InvoiceSection" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "InvoiceSection": { + "description": "An invoice section.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The properties of an invoice section.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InvoiceSectionProperties" + } + } + }, + "InvoiceSectionProperties": { + "description": "The properties of an invoice section.", + "properties": { + "displayName": { + "description": "The name of the invoice section.", + "type": "string" + }, + "labels": { + "type": "object", + "description": "Dictionary of metadata associated with the invoice section.", + "additionalProperties": { + "type": "string" + }, + "maxItems": 1000 + }, + "systemId": { + "description": "The system generated unique identifier for an invoice section.", + "type": "string", + "readOnly": true + } + } + }, + "InvoiceSectionListWithCreateSubPermissionResult": { + "type": "object", + "description": "The list of invoice section properties with create subscription permission.", + "properties": { + "value": { + "description": "The list of invoice section properties with create subscription permission.", + "type": "array", + "items": { + "$ref": "#/definitions/InvoiceSectionWithCreateSubPermission" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "InvoiceSectionWithCreateSubPermission": { + "description": "Invoice section properties with create subscription permission.", + "properties": { + "invoiceSectionId": { + "description": "The ID of the invoice section.", + "type": "string", + "readOnly": true + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section.", + "type": "string", + "readOnly": true + }, + "invoiceSectionSystemId": { + "description": "The system generated unique identifier for an invoice section.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The ID of the billing profile for the invoice section.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile for the invoice section.", + "type": "string", + "readOnly": true + }, + "billingProfileStatus": { + "description": "The status of the billing profile.", + "enum": [ + "Active", + "Disabled", + "Warned" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "BillingProfileStatus", + "modelAsString": true + } + }, + "billingProfileStatusReasonCode": { + "description": "Reason for the specified billing profile status.", + "enum": [ + "PastDue", + "SpendingLimitReached", + "SpendingLimitExpired" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "StatusReasonCodeForBillingProfile", + "modelAsString": true + } + }, + "billingProfileSpendingLimit": { + "description": "The billing profile spending limit.", + "enum": [ + "Off", + "On" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "SpendingLimitForBillingProfile", + "modelAsString": true + } + }, + "billingProfileSystemId": { + "description": "The system generated unique identifier for a billing profile.", + "type": "string", + "readOnly": true + }, + "enabledAzurePlans": { + "description": "Enabled azure plans for the associated billing profile.", + "type": "array", + "items": { + "$ref": "#/definitions/AzurePlan" + } + } + } + }, + "AzurePlan": { + "description": "Details of the Azure plan.", + "properties": { + "skuId": { + "description": "The sku id.", + "type": "string" + }, + "skuDescription": { + "description": "The sku description.", + "type": "string", + "readOnly": true + } + } + }, + "DownloadUrl": { + "description": "A secure URL that can be used to download a an entity until the URL expires.", + "properties": { + "expiryTime": { + "description": "The time in UTC when the download URL will expire.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "url": { + "description": "The URL to the PDF file.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "Reseller": { + "description": "Details of the reseller.", + "properties": { + "resellerId": { + "description": "The MPN ID of the reseller.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The name of the reseller.", + "type": "string", + "readOnly": true + } + } + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "x-ms-azure-resource": true + }, + "InvoiceListResult": { + "description": "The list of invoices.", + "properties": { + "value": { + "description": "The list of invoices.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Invoice" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Invoice": { + "description": "An invoice.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "An invoice.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InvoiceProperties" + } + } + }, + "InvoiceProperties": { + "description": "The properties of the invoice.", + "properties": { + "dueDate": { + "description": "The due date for the invoice.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "invoiceDate": { + "description": "The date when the invoice was generated.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "status": { + "description": "The current status of the invoice.", + "type": "string", + "enum": [ + "Due", + "OverDue", + "Paid" + ], + "readOnly": true, + "x-ms-enum": { + "name": "InvoiceStatus", + "modelAsString": true + } + }, + "amountDue": { + "description": "The amount due as of now.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "azurePrepaymentApplied": { + "description": "The amount of Azure prepayment applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "billedAmount": { + "description": "The total charges for the invoice billing period.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "creditAmount": { + "description": "The total refund for returns and cancellations during the invoice billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "freeAzureCreditApplied": { + "description": "The amount of free Azure credits applied to the charges. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "subTotal": { + "description": "The pre-tax amount due. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "taxAmount": { + "description": "The amount of tax charged for the billing period. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "totalAmount": { + "description": "The amount due when the invoice was generated. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "invoicePeriodStartDate": { + "description": "The start date of the billing period for which the invoice is generated.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "invoicePeriodEndDate": { + "description": "The end date of the billing period for which the invoice is generated.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "invoiceType": { + "description": "Invoice type.", + "enum": [ + "AzureService", + "AzureMarketplace", + "AzureSupport" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InvoiceType", + "modelAsString": true + } + }, + "isMonthlyInvoice": { + "description": "Specifies if the invoice is generated as part of monthly invoicing cycle or not. This field is applicable to billing accounts with agreement type Microsoft Customer Agreement.", + "type": "boolean", + "readOnly": true + }, + "billingProfileId": { + "description": "The ID of the billing profile for which the invoice is generated.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile for which the invoice is generated.", + "type": "string", + "readOnly": true + }, + "purchaseOrderNumber": { + "description": "An optional purchase order number for the invoice.", + "type": "string", + "readOnly": true + }, + "documents": { + "description": "List of documents available to download such as invoice and tax receipt.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Document" + } + }, + "payments": { + "description": "List of payments.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PaymentProperties" + } + }, + "subscriptionId": { + "description": "The ID of the subscription for which the invoice is generated.", + "type": "string", + "readOnly": true + } + } + }, + "PaymentProperties": { + "description": "The properties of a payment.", + "properties": { + "paymentType": { + "description": "The type of payment.", + "type": "string", + "readOnly": true + }, + "amount": { + "description": "The paid amount.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "date": { + "description": "The date when the payment was made.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "paymentMethodFamily": { + "description": "The family of payment method.", + "type": "string", + "enum": [ + "Credits", + "CheckWire", + "CreditCard", + "None" + ], + "x-ms-enum": { + "name": "PaymentMethodFamily", + "modelAsString": true + } + }, + "paymentMethodType": { + "description": "The type of payment method.", + "type": "string", + "readOnly": true + } + } + }, + "Document": { + "description": "The properties of a document.", + "properties": { + "kind": { + "description": "The type of the document.", + "type": "string", + "enum": [ + "Invoice", + "VoidNote", + "TaxReceipt", + "CreditNote" + ], + "readOnly": true, + "x-ms-enum": { + "name": "DocumentType", + "modelAsString": true + } + }, + "url": { + "description": "Document URL.", + "type": "string", + "readOnly": true + }, + "source": { + "description": "The source of the document. ENF for Brazil and DRS for rest of the world.", + "type": "string", + "enum": [ + "DRS", + "ENF" + ], + "readOnly": true, + "x-ms-enum": { + "name": "DocumentSource", + "modelAsString": true + } + } + } + }, + "ProductsListResult": { + "description": "The list of products. It contains a list of available product summaries in reverse chronological order by purchase date.", + "properties": { + "value": { + "description": "The list of products.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Product" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Product": { + "description": "A product.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProductProperties", + "title": "Product properties" + } + } + }, + "ProductProperties": { + "description": "The properties of a product.", + "properties": { + "autoRenew": { + "description": "Indicates whether auto renewal is turned on or off for a product.", + "type": "string", + "enum": [ + "Off", + "On" + ], + "x-ms-enum": { + "name": "AutoRenew", + "modelAsString": true + } + }, + "displayName": { + "description": "The display name of the product.", + "type": "string", + "readOnly": true + }, + "purchaseDate": { + "description": "The date when the product was purchased.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "productTypeId": { + "description": "The ID of the type of product.", + "type": "string", + "readOnly": true + }, + "productType": { + "description": "The description of the type of product.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The current status of the product.", + "type": "string", + "enum": [ + "Active", + "Inactive", + "PastDue", + "Expiring", + "Expired", + "Disabled", + "Cancelled", + "AutoRenew" + ], + "x-ms-enum": { + "name": "ProductStatusType", + "modelAsString": true + } + }, + "endDate": { + "description": "The date when the product will be renewed or canceled.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "billingFrequency": { + "description": "The frequency at which the product will be billed.", + "type": "string", + "enum": [ + "OneTime", + "Monthly", + "UsageBased" + ], + "x-ms-enum": { + "name": "BillingFrequency", + "modelAsString": true + } + }, + "lastCharge": { + "description": "The last month charges.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "lastChargeDate": { + "description": "The date of the last charge.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "quantity": { + "description": "The quantity purchased for the product.", + "type": "number", + "readOnly": true + }, + "skuId": { + "description": "The sku ID of the product.", + "type": "string", + "readOnly": true + }, + "skuDescription": { + "description": "The sku description of the product.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The id of the tenant in which the product is used.", + "type": "string", + "readOnly": true + }, + "availabilityId": { + "description": "The availability of the product.", + "type": "string", + "readOnly": true + }, + "invoiceSectionId": { + "description": "The ID of the invoice section to which the product is billed.", + "type": "string", + "readOnly": true + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section to which the product is billed.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The ID of the billing profile to which the product is billed.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile to which the product is billed.", + "type": "string", + "readOnly": true + }, + "customerId": { + "description": "The ID of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.", + "type": "string", + "readOnly": true + }, + "customerDisplayName": { + "description": "The name of the customer for whom the product was purchased. The field is applicable only for Microsoft Partner Agreement billing account.", + "type": "string", + "readOnly": true + }, + "reseller": { + "description": "Reseller for this product.", + "readOnly": true, + "$ref": "#/definitions/Reseller" + } + } + }, + "ValidateProductTransferEligibilityResult": { + "type": "object", + "description": "Result of the product transfer eligibility validation.", + "properties": { + "isMoveEligible": { + "description": "Specifies whether the transfer is eligible or not.", + "type": "boolean", + "readOnly": true + }, + "errorDetails": { + "description": "Validation error details.", + "$ref": "#/definitions/ValidateProductTransferEligibilityError" + } + } + }, + "ValidateProductTransferEligibilityError": { + "type": "object", + "description": "Error details of the product transfer eligibility validation.", + "properties": { + "code": { + "description": "Error code for the product transfer validation.", + "$ref": "#/definitions/ProductTransferValidationErrorCode" + }, + "message": { + "description": "The error message.", + "type": "string" + }, + "details": { + "description": "Detailed error message explaining the error.", + "type": "string" + } + } + }, + "ProductTransferValidationErrorCode": { + "type": "string", + "description": "Error code of the transfer validation response.", + "enum": [ + "InvalidSource", + "ProductNotActive", + "InsufficientPermissionOnSource", + "InsufficientPermissionOnDestination", + "DestinationBillingProfilePastDue", + "ProductTypeNotSupported", + "CrossBillingAccountNotAllowed", + "NotAvailableForDestinationMarket", + "OneTimePurchaseProductTransferNotAllowed" + ], + "x-ms-enum": { + "name": "ProductTransferValidationErrorCode", + "modelAsString": true + } + }, + "BillingSubscriptionsListResult": { + "description": "The list of billing subscriptions.", + "properties": { + "value": { + "description": "The list of billing subscriptions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BillingSubscription" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BillingSubscription": { + "description": "A billing subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingSubscriptionProperties", + "title": "Billing subscription properties" + } + } + }, + "BillingSubscriptionProperties": { + "description": "The billing properties of a subscription.", + "properties": { + "displayName": { + "description": "The name of the subscription.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "The ID of the subscription.", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "subscriptionBillingStatus": { + "description": "The current billing status of the subscription.", + "type": "string", + "enum": [ + "Active", + "Inactive", + "Abandoned", + "Deleted", + "Warning" + ], + "x-ms-enum": { + "name": "BillingSubscriptionStatusType", + "modelAsString": true + } + }, + "lastMonthCharges": { + "description": "The last month charges.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "monthToDateCharges": { + "description": "The current month to date charges.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "billingProfileId": { + "description": "The ID of the billing profile to which the subscription is billed.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile to which the subscription is billed.", + "type": "string", + "readOnly": true + }, + "costCenter": { + "description": "The cost center applied to the subscription.", + "type": "string" + }, + "customerId": { + "description": "The ID of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account.", + "type": "string", + "readOnly": true + }, + "customerDisplayName": { + "description": "The name of the customer for whom the subscription was created. The field is applicable only for Microsoft Partner Agreement billing account.", + "type": "string", + "readOnly": true + }, + "invoiceSectionId": { + "description": "The ID of the invoice section to which the subscription is billed.", + "type": "string", + "readOnly": true + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section to which the subscription is billed.", + "type": "string", + "readOnly": true + }, + "reseller": { + "description": "Reseller for this subscription.", + "readOnly": true, + "$ref": "#/definitions/Reseller" + }, + "skuId": { + "description": "The sku ID of the Azure plan for the subscription.", + "type": "string" + }, + "skuDescription": { + "description": "The sku description of the Azure plan for the subscription.", + "type": "string", + "readOnly": true + } + } + }, + "EnrollmentAccountContext": { + "description": "The enrollment account context", + "properties": { + "costCenter": { + "description": "The cost center associated with the enrollment account.", + "type": "string" + }, + "startDate": { + "description": "The start date of the enrollment account.", + "type": "string", + "format": "date-time" + }, + "endDate": { + "description": "The end date of the enrollment account.", + "type": "string", + "format": "date-time" + }, + "enrollmentAccountName": { + "description": "The ID of the enrollment account.", + "type": "string" + } + } + }, + "TransactionListResult": { + "description": "The list of transactions.", + "properties": { + "value": { + "description": "The list of transactions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Transaction" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Transaction": { + "description": "A transaction.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TransactionProperties", + "title": "Transaction properties" + } + } + }, + "TransactionProperties": { + "description": "The properties of a transaction.", + "properties": { + "kind": { + "type": "string", + "description": "The kind of transaction. Options are all or reservation.", + "enum": [ + "all", + "reservation" + ], + "x-ms-enum": { + "name": "TransactionTypeKind", + "modelAsString": true + } + }, + "date": { + "description": "The date of transaction.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "invoice": { + "description": "Invoice on which the transaction was billed or 'pending' if the transaction is not billed.", + "type": "string", + "readOnly": true + }, + "invoiceId": { + "description": "The ID of the invoice on which the transaction was billed. This field is only applicable for transactions which are billed.", + "type": "string", + "readOnly": true + }, + "orderId": { + "description": "The order ID of the reservation. The field is only applicable for transaction of kind reservation.", + "type": "string", + "readOnly": true + }, + "orderName": { + "description": "The name of the reservation order. The field is only applicable for transactions of kind reservation.", + "type": "string", + "readOnly": true + }, + "productFamily": { + "description": "The family of the product for which the transaction took place.", + "type": "string", + "readOnly": true + }, + "productTypeId": { + "description": "The ID of the product type for which the transaction took place.", + "type": "string", + "readOnly": true + }, + "productType": { + "description": "The type of the product for which the transaction took place.", + "type": "string", + "readOnly": true + }, + "productDescription": { + "description": "The description of the product for which the transaction took place.", + "type": "string", + "readOnly": true + }, + "transactionType": { + "description": "The type of transaction.", + "type": "string", + "enum": [ + "Purchase", + "Usage Charge" + ], + "x-ms-enum": { + "name": "ReservationType", + "modelAsString": true + } + }, + "transactionAmount": { + "description": "The charge associated with the transaction.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "quantity": { + "description": "The quantity purchased in the transaction.", + "type": "integer", + "readOnly": true + }, + "invoiceSectionId": { + "description": "The ID of the invoice section which will be billed for the transaction.", + "type": "string", + "readOnly": true + }, + "invoiceSectionDisplayName": { + "description": "The name of the invoice section which will be billed for the transaction.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "The ID of the billing profile which will be billed for the transaction.", + "type": "string", + "readOnly": true + }, + "billingProfileDisplayName": { + "description": "The name of the billing profile which will be billed for the transaction.", + "type": "string", + "readOnly": true + }, + "customerId": { + "description": "The ID of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account.", + "type": "string", + "readOnly": true + }, + "customerDisplayName": { + "description": "The name of the customer for which the transaction took place. The field is applicable only for Microsoft Partner Agreement billing account.", + "type": "string", + "readOnly": true + }, + "subscriptionId": { + "description": "The ID of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation.", + "type": "string", + "readOnly": true + }, + "subscriptionName": { + "description": "The name of the subscription that was used for the transaction. The field is only applicable for transaction of kind reservation.", + "type": "string", + "readOnly": true + }, + "azurePlan": { + "description": "The type of azure plan of the subscription that was used for the transaction.", + "type": "string", + "readOnly": true + }, + "azureCreditApplied": { + "description": "The amount of any Azure credits automatically applied to this transaction.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "billingCurrency": { + "description": "The ISO 4217 code for the currency in which this transaction is billed.", + "type": "string", + "readOnly": true + }, + "discount": { + "description": "The percentage discount, if any, applied to this transaction.", + "type": "number", + "readOnly": true + }, + "effectivePrice": { + "description": "The price of the product after applying any discounts.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "exchangeRate": { + "description": "The exchange rate used to convert charged amount to billing currency, if applicable.", + "type": "number", + "readOnly": true + }, + "marketPrice": { + "description": "The retail price of the product.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "pricingCurrency": { + "description": "The ISO 4217 code for the currency in which the product is priced.", + "type": "string", + "readOnly": true + }, + "servicePeriodStartDate": { + "description": "The date of the purchase of the product, or the start date of the month in which usage started.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "servicePeriodEndDate": { + "description": "The end date of the product term, or the end date of the month in which usage ended.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "subTotal": { + "description": "The pre-tax charged amount for the transaction.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "tax": { + "description": "The tax amount applied to the transaction.", + "readOnly": true, + "$ref": "#/definitions/Amount" + }, + "unitOfMeasure": { + "description": "The unit of measure used to bill for the product. For example, compute services are billed per hour.", + "type": "string", + "readOnly": true + }, + "units": { + "description": "The number of units used for a given product.", + "type": "number", + "readOnly": true + }, + "unitType": { + "description": "The description for the unit of measure for a given product.", + "type": "string", + "readOnly": true + } + } + }, + "Policy": { + "description": "A policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PolicyProperties", + "title": "Policy properties" + } + } + }, + "PolicyProperties": { + "description": "The properties of a policy.", + "properties": { + "marketplacePurchases": { + "description": "The policy that controls whether Azure marketplace purchases are allowed for a billing profile.", + "type": "string", + "enum": [ + "AllAllowed", + "OnlyFreeAllowed", + "NotAllowed" + ], + "x-ms-enum": { + "name": "MarketplacePurchasesPolicy", + "modelAsString": true + } + }, + "reservationPurchases": { + "description": "The policy that controls whether Azure reservation purchases are allowed for a billing profile.", + "type": "string", + "enum": [ + "Allowed", + "NotAllowed" + ], + "x-ms-enum": { + "name": "ReservationPurchasesPolicy", + "modelAsString": true + } + }, + "viewCharges": { + "description": "The policy that controls whether users with Azure RBAC access to a subscription can view its charges.", + "type": "string", + "enum": [ + "Allowed", + "NotAllowed" + ], + "x-ms-enum": { + "name": "ViewChargesPolicy", + "modelAsString": true + } + } + } + }, + "CustomerPolicy": { + "description": "The customer's Policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/CustomerPolicyProperties", + "title": "Customer Policy properties" + } + } + }, + "CustomerPolicyProperties": { + "description": "The properties of a customer's policy.", + "properties": { + "viewCharges": { + "description": "The policy that controls whether the users in customer's organization can view charges at pay-as-you-go prices.", + "type": "string", + "enum": [ + "Allowed", + "NotAllowed" + ], + "x-ms-enum": { + "name": "ViewCharges", + "modelAsString": true + } + } + } + }, + "AvailableBalance": { + "description": "The latest Azure credit balance. This is the balance available for pay now.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailableBalanceProperties", + "title": "Available balance properties" + } + } + }, + "AvailableBalanceProperties": { + "description": "The properties of available balance.", + "properties": { + "amount": { + "description": "Balance amount.", + "readOnly": true, + "$ref": "#/definitions/Amount" + } + } + }, + "Amount": { + "description": "The amount.", + "properties": { + "currency": { + "description": "The currency for the amount value.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "Amount value.", + "type": "number" + } + } + }, + "Operation": { + "description": "A Billing REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Billing.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed such as invoice and billing subscription.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type such as read, write and delete.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "OperationListResult": { + "description": "The list of billing operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "The list of billing operations supported by the Microsoft.Billing resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "BillingRoleAssignmentListResult": { + "description": "The list of role assignments.", + "properties": { + "value": { + "description": "The list of role assignments.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BillingRoleAssignment": { + "description": "The role assignment", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The properties of the role assignment.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingRoleAssignmentProperties" + } + } + }, + "BillingRoleAssignmentProperties": { + "description": "The properties of the role assignment.", + "properties": { + "createdOn": { + "description": "The date the role assignment was created.", + "type": "string", + "readOnly": true + }, + "createdByPrincipalTenantId": { + "description": "The tenant Id of the user who created the role assignment.", + "type": "string", + "readOnly": true + }, + "createdByPrincipalId": { + "description": "The principal Id of the user who created the role assignment.", + "type": "string", + "readOnly": true + }, + "createdByUserEmailAddress": { + "description": "The email address of the user who created the role assignment.", + "type": "string", + "readOnly": true + }, + "principalId": { + "description": "The principal id of the user to whom the role was assigned.", + "type": "string", + "readOnly": true + }, + "principalTenantId": { + "description": "The principal tenant id of the user to whom the role was assigned.", + "type": "string", + "readOnly": true + }, + "roleDefinitionId": { + "description": "The ID of the role definition.", + "type": "string", + "readOnly": true + }, + "scope": { + "description": "The scope at which the role was assigned.", + "type": "string", + "readOnly": true + }, + "userAuthenticationType": { + "description": "The authentication type.", + "type": "string", + "readOnly": true + }, + "userEmailAddress": { + "description": "The email address of the user.", + "type": "string", + "readOnly": true + } + } + }, + "BillingRoleDefinitionListResult": { + "description": "The list of role definitions.", + "properties": { + "value": { + "description": "The role definitions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BillingRoleDefinition": { + "description": "The properties of a role definition.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The properties of the a role definition.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingRoleDefinitionProperties" + } + } + }, + "BillingRoleDefinitionProperties": { + "description": "The properties of the a role definition.", + "properties": { + "description": { + "description": "The role description", + "type": "string", + "readOnly": true + }, + "permissions": { + "description": "The billingPermissions the role has", + "type": "array", + "items": { + "$ref": "#/definitions/BillingPermissionsProperties" + } + }, + "roleName": { + "description": "The name of the role", + "type": "string", + "readOnly": true + } + } + }, + "BillingPermissionsListResult": { + "description": "Result of list billingPermissions a caller has on a billing account.", + "properties": { + "value": { + "description": "The list of billingPermissions a caller has on a billing account.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BillingPermissionsProperties" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BillingPermissionsProperties": { + "description": "The set of allowed action and not allowed actions a caller has on a billing account", + "type": "object", + "properties": { + "actions": { + "description": "The set of actions that the caller is allowed to perform.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Action" + } + }, + "notActions": { + "description": "The set of actions that the caller is not allowed to perform.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/NotAction" + } + } + } + }, + "AgreementListResult": { + "description": "Result of listing agreements.", + "properties": { + "value": { + "description": "The list of agreements.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Agreement" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Agreement": { + "description": "An agreement.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The properties of an agreement.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/AgreementProperties" + } + } + }, + "AgreementProperties": { + "description": "The properties of an agreement.", + "properties": { + "agreementLink": { + "description": "The URL to download the agreement.", + "type": "string", + "readOnly": true + }, + "category": { + "type": "string", + "description": "The category of the agreement signed by a customer.", + "readOnly": true, + "enum": [ + "MicrosoftCustomerAgreement", + "AffiliatePurchaseTerms", + "Other" + ], + "x-ms-enum": { + "name": "category", + "modelAsString": true + } + }, + "acceptanceMode": { + "type": "string", + "description": "The mode of acceptance for an agreement.", + "readOnly": true, + "enum": [ + "ClickToAccept", + "ESignEmbedded", + "ESignOffline" + ], + "x-ms-enum": { + "name": "acceptanceMode", + "modelAsString": true + } + }, + "effectiveDate": { + "description": "The date from which the agreement is effective.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "expirationDate": { + "description": "The date when the agreement expires.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "participants": { + "description": "The list of participants that participates in acceptance of an agreement.", + "type": "array", + "items": { + "$ref": "#/definitions/Participants" + } + }, + "status": { + "description": "The current status of the agreement.", + "type": "string", + "readOnly": true + } + } + }, + "Participants": { + "description": "The details about a participant.", + "properties": { + "status": { + "description": "The acceptance status of the participant.", + "type": "string", + "readOnly": true + }, + "statusDate": { + "description": "The date when the status got changed.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "email": { + "description": "The email address of the participant.", + "type": "string", + "readOnly": true + } + } + }, + "Action": { + "description": "The action the caller is allowed to perform.", + "type": "string", + "readOnly": true + }, + "NotAction": { + "description": "The set of actions that the caller is not allowed to perform.", + "type": "string", + "readOnly": true + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The version of the API to be used with the client request. The current version is 2020-05-01." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The ID that uniquely identifies an Azure subscription.", + "required": true, + "type": "string" + }, + "billingAccountNameParameter": { + "name": "billingAccountName", + "in": "path", + "description": "The ID that uniquely identifies a billing account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "invoiceSectionNameParameter": { + "name": "invoiceSectionName", + "in": "path", + "description": "The ID that uniquely identifies an invoice section.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountNameParameter": { + "name": "enrollmentAccountName", + "in": "path", + "description": "The ID that uniquely identifies an enrollment account.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "departmentNameParameter": { + "name": "departmentName", + "in": "path", + "description": "The ID that uniquely identifies a department.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "instructionNameParameter": { + "name": "instructionName", + "in": "path", + "description": "Instruction Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingProfileNameParameter": { + "name": "billingProfileName", + "in": "path", + "description": "The ID that uniquely identifies a billing profile.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "operationIdParameter": { + "name": "operationId", + "in": "path", + "description": "Operation Id.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingRoleDefinitionNameParameter": { + "name": "billingRoleDefinitionName", + "in": "path", + "description": "The ID that uniquely identifies a role definition.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingRoleAssignmentNameParameter": { + "name": "billingRoleAssignmentName", + "in": "path", + "description": "The ID that uniquely identifies a role assignment.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "invoiceNameParameter": { + "name": "invoiceName", + "in": "path", + "description": "The ID that uniquely identifies an invoice.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "productNameParameter": { + "name": "productName", + "in": "path", + "description": "The ID that uniquely identifies a product.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "agreementNameParameter": { + "name": "agreementName", + "in": "path", + "description": "The ID that uniquely identifies an agreement.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "transactionNameParameter": { + "name": "transactionName", + "in": "path", + "description": "The ID that uniquely identifies a transaction.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "customerNameParameter": { + "name": "customerName", + "in": "path", + "description": "The ID that uniquely identifies a customer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressInvalid.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressInvalid.json new file mode 100644 index 000000000000..d65cc255d3f3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressInvalid.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "address": { + "addressLine1": "1 Test", + "city": "bellevue", + "region": "wa", + "postalCode": "12345", + "country": "us" + } + }, + "responses": { + "200": { + "body": { + "status": "Invalid", + "suggestedAddresses": [ + { + "country": "US", + "region": "WA", + "city": "Bellevue", + "addressLine1": "1 Test Address", + "postalCode": "98052" + }, + { + "country": "US", + "region": "WA", + "city": "Bellevue", + "addressLine1": "1 Test Address", + "postalCode": "12345-0000" + } + ], + "validationMessage": "Invalid address" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressValid.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressValid.json new file mode 100644 index 000000000000..8f56faee38da --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AddressValid.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "address": { + "addressLine1": "1 Test Address", + "city": "bellevue", + "region": "wa", + "postalCode": "12345", + "country": "us" + } + }, + "responses": { + "200": { + "body": { + "status": "Valid", + "suggestedAddresses": [ + { + "country": "US", + "region": "WA", + "city": "Bellevue", + "addressLine1": "1 Test Address", + "postalCode": "12345-0000" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.json new file mode 100644 index 000000000000..0b7f7f2c21c5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementByName.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "agreementName": "{agreementName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/{agreementName}", + "name": "{agreementName}", + "type": "Microsoft.Billing/billingAccounts/agreements", + "properties": { + "agreementLink": "https://agreementuri1.com", + "category": "MicrosoftCustomerAgreement", + "acceptanceMode": "ClickToAccept", + "effectiveDate": "2018-12-05T00:00:00Z", + "expirationDate": "2018-12-05T00:00:00Z", + "participants": [ + { + "status": "Accepted", + "statusDate": "2018-11-01T00:00:00Z", + "email": "abc@contoso.com" + }, + { + "status": "Declined", + "statusDate": "2018-11-02T00:00:00Z", + "email": "xyz@contoso.com" + } + ], + "status": "Published" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementsListByBillingAccount.json new file mode 100644 index 000000000000..9be6ba760cbc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AgreementsListByBillingAccount.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/Agreement1", + "name": "Agreement1", + "type": "Microsoft.Billing/billingAccounts/agreements", + "properties": { + "agreementLink": "https://agreementuri1.com", + "category": "MicrosoftCustomerAgreement", + "acceptanceMode": "ClickToAccept", + "effectiveDate": "2018-12-05T00:00:00Z", + "expirationDate": "2018-12-05T00:00:00Z", + "participants": [ + { + "status": "Accepted", + "statusDate": "2018-11-01T00:00:00Z", + "email": "abc@contoso.com" + }, + { + "status": "Declined", + "statusDate": "2018-11-02T00:00:00Z", + "email": "xtz@contoso.com" + } + ], + "status": "Published" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements/Agreement2", + "name": "Agreement2", + "type": "Microsoft.Billing/billingAccounts/agreements", + "properties": { + "agreementLink": "https://agreementuri2.com", + "category": "MicrosoftCustomerAgreement", + "acceptanceMode": "ESignEmbedded", + "effectiveDate": "2018-12-05T00:00:00Z", + "expirationDate": "2018-12-05T00:00:00Z", + "participants": [ + { + "status": "Unknown", + "statusDate": "2018-11-01T00:00:00Z", + "email": "abc@contoso.com" + } + ], + "status": "PendingSignature" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AvailableBalanceByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AvailableBalanceByBillingProfile.json new file mode 100644 index 000000000000..03063a39e8d0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/AvailableBalanceByBillingProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/availableBalance/default", + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/availableBalance", + "properties": { + "amount": { + "currency": "USD", + "value": 500.00 + } + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccount.json new file mode 100644 index 000000000000..30462b5d9d7e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccount.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}", + "name": "{billingAccountName}", + "type": "Microsoft.Billing/billingAccounts", + "properties": { + "displayName": "Test Account", + "agreementType": "MicrosoftCustomerAgreement", + "accountStatus": "Active", + "accountType": "Enterprise", + "hasReadAccess": true + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountInvoicesList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountInvoicesList.json new file mode 100644 index 000000000000..843c4e2bc85a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountInvoicesList.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "periodStartDate": "2018-01-01", + "periodEndDate": "2018-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383723", + "name": "1383723", + "type": "Microsoft.Billing/billingAccounts/invoices", + "properties": { + "dueDate": "2018-01-16T17:32:28Z", + "invoiceDate": "2018-01-01T17:32:28Z", + "status": "Due", + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "creditAmount": { + "currency": "USD", + "value": 1.00 + }, + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0.00 + }, + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 0.00 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + }, + "invoicePeriodStartDate": "2018-01-01T17:32:28Z", + "invoicePeriodEndDate": "2018-01-15T17:32:28Z", + "isMonthlyInvoice": false, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso Operations Billing", + "purchaseOrderNumber": "123456", + "documents": [ + { + "kind": "Invoice", + "url": "https://microsoft.com/invoice.pdf", + "source": "DRS" + } + ], + "payments": [ + { + "date": "2018-01-14T17:32:28Z", + "paymentType": "credited", + "amount": { + "currency": "USD", + "value": 1.00 + }, + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa" + } + ] + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383724", + "name": "1383724", + "type": "Microsoft.Billing/billingAccounts/invoices", + "properties": { + "dueDate": "2018-03-01T17:32:28Z", + "invoiceDate": "2018-02-01T17:32:28Z", + "status": "PastDue", + "amountDue": { + "currency": "USD", + "value": 16.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 15.46 + }, + "creditAmount": { + "currency": "USD", + "value": 2.00 + }, + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0.00 + }, + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 0.00 + }, + "totalAmount": { + "currency": "USD", + "value": 16.53 + }, + "invoicePeriodStartDate": "2018-02-01T17:32:28Z", + "invoicePeriodEndDate": "2018-02-28T17:32:28Z", + "isMonthlyInvoice": true, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso Operations Billing", + "purchaseOrderNumber": "123456", + "documents": [ + { + "kind": "TaxReceipt", + "url": "https://microsoft.com/taxreceipt.pdf", + "source": "DRS" + } + ], + "payments": [ + { + "date": "2018-01-14T17:32:28Z", + "paymentType": "credited", + "amount": { + "currency": "USD", + "value": 2.00 + }, + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountPermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountPermissionsList.json new file mode 100644 index 000000000000..27bb3da53918 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountPermissionsList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000009", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "20000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignment.json new file mode 100644 index 000000000000..17693c2027f8 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignment.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingRoleAssignmentName": "{billingRoleAssignmentId}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2018-06-21T21:34:12.2363515+00:00", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentDelete.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentDelete.json new file mode 100644 index 000000000000..2d1a0b6bdc87 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingRoleAssignmentName": "{billingRoleAssignmentName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments", + "properties": { + "createdOn": "2018-06-21T21:34:12.2363515+00:00", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentList.json new file mode 100644 index 000000000000..9d4e484d6671 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleAssignmentList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2018-06-21T21:34:12.2363515+00:00", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2018-06-21T21:58:19.9073876+00:00", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "b1839933-b3ac-42ca-8112-d29c43f3ab47", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinition.json new file mode 100644 index 000000000000..9912b5ea4a17 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinition.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingRoleDefinitionName": "{billingRoleDefinitionName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}", + "name": "{billingRoleDefinitionName}", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the billing account.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "20000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000009", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000010", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000008" + ], + "notActions": [] + } + ], + "roleName": "Billing acount owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinitionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinitionsList.json new file mode 100644 index 000000000000..1ccbc73a3065 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountRoleDefinitionsList.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "name": "10000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the billing account.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "20000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000009", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000010", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000008" + ], + "notActions": [] + } + ], + "roleName": "Billing account owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000001", + "name": "10000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role give the user all permissions except access management rights to the billing account.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000009", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000010", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000008" + ], + "notActions": [] + } + ], + "roleName": "Billing account contributor" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000002", + "name": "10000000-aaaa-bbbb-cccc-100000000002", + "properties": { + "description": "The Reader role gives the user read only access to the billing account.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000003", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000010", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000008" + ], + "notActions": [] + } + ], + "roleName": "Billing account reader" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000003", + "name": "10000000-aaaa-bbbb-cccc-100000000003", + "properties": { + "description": "The Signatory role can sign agreements on behalf of the customer.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003" + ], + "notActions": [] + } + ], + "roleName": "Signatory" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountWithExpand.json new file mode 100644 index 000000000000..fc45287d5e7a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountWithExpand.json @@ -0,0 +1,159 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "$expand": "soldTo,billingProfiles,billingProfiles/invoiceSections" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}", + "name": "{billingAccountName}", + "type": "Microsoft.Billing/billingAccounts", + "properties": { + "displayName": "Test Account 1", + "agreementType": "MicrosoftCustomerAgreement", + "accountStatus": "Active", + "soldTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address", + "addressLine2": "Test Address", + "addressLine3": "Test Address", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "accountType": "Enterprise", + "billingProfiles": { + "hasMoreResults": true, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "name": "11000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "BillingProfile1", + "billTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "1XXX-11XX-XX1-XXXX-XXX", + "status": "Warned", + "statusReasonCode": "PastDue", + "spendingLimit": "On", + "invoiceSections": { + "hasMoreResults": true, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/invoiceSectionId1", + "name": "invoiceSectionId1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName1", + "labels": { + "pcCode": "A123456", + "costCategory": "Support" + }, + "systemId": "9XXX-11XX-XX1-XXXX-XXX" + } + } + ] + } + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001", + "name": "11000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "BillingProfile2", + "billTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "2XXX-22XX-XX1-XXXX-XXX", + "status": "Active", + "spendingLimit": "Off", + "invoiceSections": { + "hasMoreResults": true, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001/invoiceSections/invoiceSectionId2", + "name": "invoiceSectionId2", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName2", + "labels": { + "pcCode": "Z223456", + "costCategory": "Marketing" + }, + "systemId": "9XXX-22XX-XX1-XXXX-XXX" + } + } + ] + } + } + } + ] + }, + "hasReadAccess": true + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsList.json new file mode 100644 index 000000000000..ca8792baf70d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts", + "properties": { + "displayName": "Test Account 1", + "agreementType": "MicrosoftCustomerAgreement", + "accountStatus": "Active", + "accountType": "Enterprise", + "hasReadAccess": true + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000", + "name": "10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts", + "properties": { + "displayName": "Test Account 2", + "agreementType": "MicrosoftCustomerAgreement", + "accountStatus": "Active", + "soldTo": null, + "accountType": "Enterprise", + "hasReadAccess": true + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/20000000-0000-0000-0000-000000000002_00000000-0000-0000-0000-000000000000", + "name": "20000000-0000-0000-0000-000000000002_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts", + "properties": { + "displayName": "Test Account 3", + "agreementType": "MicrosoftCustomerAgreement", + "accountStatus": "Active", + "accountType": "Enterprise", + "hasReadAccess": true + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpand.json new file mode 100644 index 000000000000..840377864089 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpand.json @@ -0,0 +1,337 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "$expand": "soldTo,billingProfiles,billingProfiles/invoiceSections" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts", + "properties": { + "displayName": "Test Account 1", + "agreementType": "MicrosoftCustomerAgreement", + "accountStatus": "Active", + "soldTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address", + "addressLine2": "Test Address", + "addressLine3": "Test Address", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "accountType": "Enterprise", + "billingProfiles": { + "hasMoreResults": true, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000", + "name": "11000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "BillingProfile1", + "billTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "1XXX-11XX-XX1-XXXX-XXX", + "status": "Warned", + "statusReasonCode": "PastDue", + "spendingLimit": "On", + "invoiceSections": { + "hasMoreResults": false, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/invoiceSectionId1", + "name": "invoiceSectionId1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName1", + "labels": { + "pcCode": "A123456", + "costCategory": "Support" + }, + "systemId": "9XXX-11XX-XX1-XXXX-XXX" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/invoiceSectionId2", + "name": "invoiceSectionId2", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName2", + "labels": { + "pcCode": "B223456", + "costCategory": "Finance" + }, + "systemId": "9XXX-22XX-XX1-XXXX-XXX" + } + } + ] + } + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000001", + "name": "11000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "BillingProfile2", + "billTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "2XXX-22XX-XX1-XXXX-XXX", + "status": "Active", + "spendingLimit": "Off", + "invoiceSections": { + "hasMoreResults": false, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000001/invoiceSections/invoiceSectionId11", + "name": "invoiceSectionId11", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName11", + "labels": { + "pcCode": "Z223456", + "costCategory": "Marketing" + }, + "systemId": "9XXX-33XX-XX1-XXXX-XXX" + } + } + ] + } + } + } + ] + }, + "hasReadAccess": true + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000", + "name": "10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts", + "properties": { + "displayName": "Test Account 2", + "agreementType": "MicrosoftCustomerAgreement", + "accountStatus": "Active", + "soldTo": null, + "accountType": "Enterprise", + "billingProfiles": { + "hasMoreResults": true, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000004", + "name": "11000000-0000-0000-0000-000000000004", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "BillingProfile3", + "billTo": { + "companyName": "Contoso Test", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "3XXX-33XX-XX1-XXXX-XXX", + "status": "Warned", + "statusReasonCode": "PastDue", + "spendingLimit": "On", + "invoiceSections": { + "hasMoreResults": true, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000004/invoiceSections/invoiceSectionId3", + "name": "invoiceSectionId3", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName3", + "labels": { + "pcCode": "C123456", + "costCategory": "Support" + }, + "systemId": "9XXX-44XX-XX1-XXXX-XXX" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000004/invoiceSections/invoiceSectionId4", + "name": "invoiceSectionId4", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName4", + "labels": { + "pcCode": "D123456", + "costCategory": "Marketing" + }, + "systemId": "9XXX-55XX-XX1-XXXX-XXX" + } + } + ] + } + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000005", + "name": "11000000-0000-0000-0000-000000000005", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "BillingProfile4", + "billTo": { + "companyName": "Contoso Test", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "4XXX-44XX-XX1-XXXX-XXX", + "status": "Warned", + "statusReasonCode": "PastDue", + "spendingLimit": "On", + "invoiceSections": { + "hasMoreResults": true, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000005/invoiceSections/invoiceSectionId5", + "name": "invoiceSectionId5", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName5", + "labels": { + "pcCode": "E123456", + "costCategory": "Finance" + }, + "systemId": "9XXX-66XX-XX1-XXXX-XXX" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/10000000-0000-0000-0000-000000000001_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000005/invoiceSections/invoiceSectionId6", + "name": "invoiceSectionId6", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName6", + "labels": { + "pcCode": "O123456", + "costCategory": "Support" + }, + "systemId": "9XXX-77XX-XX1-XXXX-XXX" + } + } + ] + } + } + } + ] + }, + "hasReadAccess": true + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpandForEnrollmentDetails.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpandForEnrollmentDetails.json new file mode 100644 index 000000000000..a546b96ac97f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingAccountsListWithExpandForEnrollmentDetails.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "$expand": "enrollmentDetails,departments,enrollmentAccounts" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/7645820", + "name": "7645820", + "type": "Microsoft.Billing/billingAccounts", + "properties": { + "agreementType": "EnterpriseAgreement", + "soldTo": { + "addressLine1": "Test Address", + "addressLine2": "Test Address", + "addressLine3": "Test Address", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US" + }, + "enrollmentDetails": { + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z", + "currency": "USD", + "channel": "EaDirect", + "language": "en", + "countryCode": "US", + "status": "Active", + "billingCycle": "Monthly", + "policies": { + "accountOwnerViewCharges": true, + "departmentAdminViewCharges": true, + "marketplacesEnabled": true, + "reservedInstancesEnabled": true + } + }, + "departments": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/departmentId1", + "name": "departmentId1", + "type": "Microsoft.Billing/departments", + "properties": { + "departmentName": "departmentName1", + "costCenter": "C1", + "status": "Active" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/departmentId2", + "name": "departmentId2", + "type": "Microsoft.Billing/departments", + "properties": { + "departmentName": "departmentName2", + "costCenter": "C4", + "status": "Active" + } + } + ], + "enrollmentAccounts": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/accountId0", + "name": "accountId0", + "type": "Microsoft.Billing/enrollmentAccounts", + "properties": { + "accountName": "AccountName0", + "costCenter": "C0", + "status": "Active", + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/accountId1", + "name": "accountId1", + "type": "Microsoft.Billing/enrollmentAccounts", + "properties": { + "accountName": "AccountName1", + "costCenter": "C4", + "status": "Active", + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/accountId2", + "name": "accountId2", + "type": "Microsoft.Billing/enrollmentAccounts", + "properties": { + "accountName": "AccountName2", + "costCenter": "C4", + "status": "Active", + "startDate": "2018-05-01T17:32:28Z", + "endDate": "2019-05-31T17:32:28Z" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfile.json new file mode 100644 index 000000000000..a8dcf52150fa --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfile.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "name": "{billingProfileName}", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "Billing Profile1", + "billTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "1XXX-11XX-XX1-XXXX-XXX", + "status": "Warned", + "statusReasonCode": "PastDue", + "spendingLimit": "On" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilePermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilePermissionsList.json new file mode 100644 index 000000000000..131dcb9aeff1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilePermissionsList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000009", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "20000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignment.json new file mode 100644 index 000000000000..6de1eb19bc72 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignment.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "billingRoleAssignmentName": "{billingRoleAssignmentName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2018-06-21T21:58:19.9073876+00:00", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentDelete.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentDelete.json new file mode 100644 index 000000000000..417086394bb9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "billingRoleAssignmentName": "{billingRoleAssignmentName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2018-06-21T21:58:19.9073876+00:00", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.json new file mode 100644 index 000000000000..d550705d7a17 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleAssignmentList.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2018-06-21T21:34:12.2363515+00:00", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "name": "10000000-aaaa-bbbb-cccc-100000000000_00000000-0000-0000-0000-000000000000", + "properties": { + "createdOn": "2018-06-21T21:58:19.9073876+00:00", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "b1839933-b3ac-42ca-8112-d29c43f3ab47", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinition.json new file mode 100644 index 000000000000..ddbac23b4fdc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinition.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "billingRoleDefinitionName": "{billingRoleDefinitionName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/{billingRoleDefinitionName}", + "name": "{billingRoleDefinitionName}", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the billing profile.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "20000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000009", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000010", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000008" + ], + "notActions": [] + } + ], + "roleName": "Billing profile owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinitionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinitionsList.json new file mode 100644 index 000000000000..0437df534f06 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileRoleDefinitionsList.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "name": "10000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the billing profile.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "20000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000009", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000010", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000008" + ], + "notActions": [] + } + ], + "roleName": "Billing profile owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000001", + "name": "10000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role give the user all permissions except access management rights to the billing profile.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000009", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000010", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000008" + ], + "notActions": [] + } + ], + "roleName": "Billing profile contributor" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileWithExpand.json new file mode 100644 index 000000000000..ef48d861b956 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfileWithExpand.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "$expand": "invoiceSections" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "name": "{billingProfileName}", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "Billing Profile1", + "billTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "1XXX-11XX-XX1-XXXX-XXX", + "status": "Warned", + "statusReasonCode": "PastDue", + "spendingLimit": "On", + "invoiceSections": { + "hasMoreResults": false, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/invoiceSectionId1", + "name": "invoiceSectionId1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName1", + "labels": { + "pcCode": "A123456", + "costCategory": "Support" + }, + "systemId": "9XXX-11XX-XX1-XXXX-XXX" + } + } + ] + } + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListByBillingAccount.json new file mode 100644 index 000000000000..d3d8175d403d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListByBillingAccount.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "name": "11000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "BillingProfile1", + "billTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "1XXX-11XX-XX1-XXXX-XXX", + "status": "Warned", + "statusReasonCode": "PastDue", + "spendingLimit": "On" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001", + "name": "11000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "BillingProfile2", + "billTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "2XXX-22XX-XX1-XXXX-XXX", + "status": "Active", + "spendingLimit": "Off" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListWithExpand.json new file mode 100644 index 000000000000..85a10f54a285 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProfilesListWithExpand.json @@ -0,0 +1,133 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "$expand": "invoiceSections" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "name": "11000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "BillingProfile1", + "billTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "1XXX-11XX-XX1-XXXX-XXX", + "status": "Warned", + "statusReasonCode": "PastDue", + "spendingLimit": "On", + "invoiceSections": { + "hasMoreResults": false, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/invoiceSectionId1", + "name": "invoiceSectionId1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName1", + "labels": { + "pcCode": "A123456", + "costCategory": "Support" + }, + "systemId": "9XXX-11XX-XX1-XXXX-XXX" + } + } + ] + } + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001", + "name": "11000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "BillingProfile2", + "billTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address1", + "addressLine2": "Test Address2", + "addressLine3": "Test Address3", + "city": "City", + "postalCode": "00000", + "region": "WA", + "country": "US", + "email": "abc@contoso.com", + "phoneNumber": "000-000-0000" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "2XXX-22XX-XX1-XXXX-XXX", + "status": "Warned", + "statusReasonCode": "PastDue", + "spendingLimit": "On", + "invoiceSections": { + "hasMoreResults": false, + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000001/invoiceSections/invoiceSectionId2", + "name": "invoiceSectionId2", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSectionName2", + "labels": { + "pcCode": "Z223456", + "costCategory": "Marketing" + }, + "systemId": "9XXX-22XX-XX1-XXXX-XXX" + } + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProperty.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProperty.json new file mode 100644 index 000000000000..70e263978a92 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingProperty.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "{subscriptionId}" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default", + "name": "default", + "type": "Microsoft.Billing/billingProperty", + "properties": { + "accountAdminNotificationEmailAddress": "test@contoso.com", + "billingTenantId": "90000000-0000-0000-0000-000000000011", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000", + "billingAccountDisplayName": "My Account", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileStatus": "Warned", + "billingProfileStatusReasonCode": "PastDue", + "billingProfileSpendingLimit": "On", + "costCenter": "1010", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoice section", + "isAccountAdmin": true, + "productId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000/products/44000000-0000-0000-0000-000000000000", + "productName": "Standard Dev", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscription.json new file mode 100644 index 000000000000..82f9307e93a9 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscription.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "subscriptionId": "{subscriptionId}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}", + "name": "{subscriptionId}", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "My Subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 5000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 600 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json new file mode 100644 index 000000000000..84718dc27df1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoice.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "{subscriptionId}", + "invoiceName": "{invoiceName}" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724", + "name": "1383724", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "properties": { + "dueDate": "2018-03-01T17:32:28Z", + "invoiceDate": "2018-02-01T17:32:28Z", + "status": "Paid", + "amountDue": { + "currency": "USD", + "value": 2000.00 + }, + "billedAmount": { + "currency": "USD", + "value": 2000.00 + }, + "invoicePeriodStartDate": "2018-02-01T17:32:28Z", + "invoicePeriodEndDate": "2018-02-30T17:32:28Z", + "invoiceType": "AzureMarketplace", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso Operations Billing", + "purchaseOrderNumber": "123456", + "documents": [ + { + "kind": "Invoice", + "url": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724/download", + "source": "DRS" + } + ], + "payments": [ + { + "date": "2018-01-14T17:32:28Z", + "paymentType": "credited", + "amount": { + "currency": "USD", + "value": 2000.00 + }, + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa" + } + ], + "subscriptionId": "55000000-0000-0000-0000-000000000011" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json new file mode 100644 index 000000000000..226bfa9ef63e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoiceDownload.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "{subscriptionId}", + "invoiceName": "{invoiceName}", + "downloadToken": "DRS_12345" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/default/billingSubscriptions/11000000-0000-0000-0000-000000000000/operationResults/invoiceDownload_11000000-0000-0000-0000-000000000000?api-version=2020-05-01", + "Retry-After": "10" + } + }, + "200": { + "body": { + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sig=sp=r" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoicesList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoicesList.json new file mode 100644 index 000000000000..7fabd49c628b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionInvoicesList.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "{subscriptionId}", + "periodStartDate": "2018-01-01", + "periodEndDate": "2018-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383723", + "name": "1383723", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "properties": { + "dueDate": "2018-01-16T17:32:28Z", + "invoiceDate": "2018-01-01T17:32:28Z", + "status": "Due", + "amountDue": { + "currency": "USD", + "value": 2000.00 + }, + "invoicePeriodStartDate": "2018-01-01T17:32:28Z", + "invoicePeriodEndDate": "2018-01-15T17:32:28Z", + "invoiceType": "AzureServices", + "purchaseOrderNumber": "123456", + "subscriptionId": "55000000-0000-0000-0000-000000000011" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724", + "name": "1383724", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions/invoices", + "properties": { + "dueDate": "2018-03-01T17:32:28Z", + "invoiceDate": "2018-02-01T17:32:28Z", + "status": "Paid", + "amountDue": { + "currency": "USD", + "value": 2000.00 + }, + "billedAmount": { + "currency": "USD", + "value": 2000.00 + }, + "invoicePeriodStartDate": "2018-02-01T17:32:28Z", + "invoicePeriodEndDate": "2018-02-30T17:32:28Z", + "invoiceType": "AzureMarketplace", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso Operations Billing", + "purchaseOrderNumber": "123456", + "documents": [ + { + "kind": "Invoice", + "url": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingSubscriptions/11000000-0000-0000-0000-000000000000/invoices/1383724/download", + "source": "DRS" + } + ], + "payments": [ + { + "date": "2018-01-14T17:32:28Z", + "paymentType": "credited", + "amount": { + "currency": "USD", + "value": 2000.00 + }, + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa" + } + ], + "subscriptionId": "55000000-0000-0000-0000-000000000011" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingAccount.json new file mode 100644 index 000000000000..93283f3627e2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingAccount.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/90000000-0000-0000-0000-000000000000", + "name": "90000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "My subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 5000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 600 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/90000000-0000-0000-0000-000000000001", + "name": "90000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "Test subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-6b96d3f2", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 1000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 400 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/90000000-0000-0000-0000-000000000002", + "name": "90000000-0000-0000-0000-000000000002", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "Dev Subscription", + "subscriptionId": "6b96d3f2-4a9d-9008-912f-f87744185aa3", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 6000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 900 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json new file mode 100644 index 000000000000..ac88af9bc396 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByBillingProfile.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1", + "name": "billingSubscriptionId1", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "My subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 5000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 600 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2", + "name": "billingSubscriptionId2", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "Test subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-6b96d3f2", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 1000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 400 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId3", + "name": "billingSubscriptionId3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "Dev Subscription", + "subscriptionId": "6b96d3f2-4a9d-9008-912f-f87744185aa3", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 6000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 900 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.json new file mode 100644 index 000000000000..966ab091b901 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByCustomer.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "customerName": "{customerName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1", + "name": "billingSubscriptionId1", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "My subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 5000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 600.00 + }, + "costCenter": "ABC1234", + "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}", + "customerDisplayName": "Customer1", + "reseller": { + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", + "description": "Reseller1" + }, + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2", + "name": "billingSubscriptionId2", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "Test subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-6b96d3f2", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 1000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 400 + }, + "costCenter": "ABC1234", + "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}", + "customerDisplayName": "Customer1", + "reseller": { + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", + "description": "Reseller3" + }, + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByInvoiceSection.json new file mode 100644 index 000000000000..b2f82cede0d2 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/BillingSubscriptionsListByInvoiceSection.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "invoiceSectionName": "{invoiceSectionName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId1", + "name": "billingSubscriptionId1", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "My subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 5000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 600 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId2", + "name": "billingSubscriptionId2", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "Test subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-6b96d3f2", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 1000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 400 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/billinSubscriptionId3", + "name": "billingSubscriptionId3", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "Dev Subscription", + "subscriptionId": "6b96d3f2-4a9d-9008-912f-f87744185aa3", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 6000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 900 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Customer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Customer.json new file mode 100644 index 000000000000..69251765abd1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Customer.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "customerName": "{customerName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}", + "name": "{customerName}", + "type": "Microsoft.Billing/billingAccounts/customers", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso Operations Billing", + "displayName": "customer1" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPermissionsList.json new file mode 100644 index 000000000000..9227b211a749 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPermissionsList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "customerName": "{customerName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000009", + "30000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPolicy.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPolicy.json new file mode 100644 index 000000000000..601f3d77477e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerPolicy.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "customerName": "{customerName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default", + "name": "default", + "type": "Microsoft.Billing/billingAccounts/customers/policies", + "properties": { + "viewCharges": "Allowed" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerWithExpand.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerWithExpand.json new file mode 100644 index 000000000000..59bb6cd2dc4d --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomerWithExpand.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "customerName": "{customerName}", + "$expand": "enabledAzurePlans,resellers" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}", + "name": "{customerName}", + "type": "Microsoft.Billing/billingAccounts/customers", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso Operations Billing", + "displayName": "customerName1", + "enabledAzurePlans": [ + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "resellers": [ + { + "resellerId": "89e87bdf-a2a2-4687-925f-4c18b27bccfd", + "description": "Reseller1" + }, + { + "resellerId": "3b65b5a8-bd4f-4084-90e9-e1bd667a2b19", + "description": "Reseller2" + } + ] + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingAccount.json new file mode 100644 index 000000000000..5cf414465d11 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingAccount.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/22000000-0000-0000-0000-000000000000", + "name": "22000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/customers", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso Operations Billing", + "displayName": "customer1" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/22000000-0000-0000-0000-000000000011", + "name": "22000000-0000-0000-0000-000000000011", + "type": "Microsoft.Billing/billingAccounts/customers", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso Operations Billing", + "displayName": "customer2" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingProfile.json new file mode 100644 index 000000000000..a7eb9a6bd73e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/CustomersListByBillingProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/22000000-0000-0000-0000-000000000000", + "name": "22000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/customers", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso Operations Billing", + "displayName": "customer1" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/22000000-0000-0000-0000-000000000011", + "name": "22000000-0000-0000-0000-000000000011", + "type": "Microsoft.Billing/billingAccounts/customers", + "properties": { + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso Operations Billing", + "displayName": "customer2" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Instruction.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Instruction.json new file mode 100644 index 000000000000..9b4093430abe --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Instruction.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "instructionName": "{instructionName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/{instructionName}", + "name": "{instructionName}", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/instructions", + "properties": { + "amount": 5000.0, + "startDate": "2019-12-30T21:26:47.997Z", + "endDate": "2020-12-30T21:26:47.997Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InstructionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InstructionsListByBillingProfile.json new file mode 100644 index 000000000000..ab48e69d2cb5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InstructionsListByBillingProfile.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/TO1:CLIN001", + "name": "TO1:CLIN001", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/instructions", + "properties": { + "amount": 5000.0, + "startDate": "2019-12-30T21:26:47.997Z", + "endDate": "2020-12-30T21:26:47.997Z" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/TO1:CLIN002", + "name": "TO1:CLIN002", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/instructions", + "properties": { + "amount": 2000.0, + "startDate": "2019-12-30T21:26:47.997Z", + "endDate": "2020-12-30T21:26:47.997Z" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Invoice.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Invoice.json new file mode 100644 index 000000000000..a956b6a06d95 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Invoice.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "invoiceName": "{invoiceName}" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}", + "name": "{invoiceName}", + "type": "Microsoft.Billing/billingAccounts/invoices", + "properties": { + "dueDate": "2018-01-16T17:32:28Z", + "invoiceDate": "2018-01-01T17:32:28Z", + "status": "Due", + "amountDue": { + "currency": "USD", + "value": 16.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 15.46 + }, + "creditAmount": { + "currency": "USD", + "value": 2.00 + }, + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0.00 + }, + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 0.00 + }, + "totalAmount": { + "currency": "USD", + "value": 16.53 + }, + "invoicePeriodStartDate": "2018-01-01T17:32:28Z", + "invoicePeriodEndDate": "2018-01-15T17:32:28Z", + "isMonthlyInvoice": false, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "billingProfileDisplayName": "Contoso Operations Billing", + "purchaseOrderNumber": "123456", + "documents": [ + { + "kind": "Invoice", + "url": "https://microsoft.com/invoice.pdf", + "source": "DRS" + }, + { + "kind": "TaxReceipt", + "url": "https://microsoft.com/taxDoc.pdf", + "source": "DRS" + } + ], + "payments": [ + { + "date": "2018-01-14T17:32:28Z", + "paymentType": "credited", + "amount": { + "currency": "USD", + "value": 2.00 + }, + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa" + } + ] + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json new file mode 100644 index 000000000000..54b50a2366a0 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceById.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "invoiceName": "{invoiceName}" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}", + "name": "{invoiceName}", + "type": "Microsoft.Billing/billingAccounts/invoices", + "properties": { + "dueDate": "2018-01-16T17:32:28Z", + "invoiceDate": "2018-01-01T17:32:28Z", + "status": "Due", + "amountDue": { + "currency": "USD", + "value": 16.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 15.46 + }, + "creditAmount": { + "currency": "USD", + "value": 2.00 + }, + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0.00 + }, + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 0.00 + }, + "totalAmount": { + "currency": "USD", + "value": 16.53 + }, + "invoicePeriodStartDate": "2018-01-01T17:32:28Z", + "invoicePeriodEndDate": "2018-01-15T17:32:28Z", + "isMonthlyInvoice": false, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "billingProfileDisplayName": "Contoso Operations Billing", + "purchaseOrderNumber": "123456", + "documents": [ + { + "kind": "Invoice", + "url": "https://microsoft.com/invoice.pdf", + "source": "DRS" + }, + { + "kind": "TaxReceipt", + "url": "https://microsoft.com/taxDoc.pdf", + "source": "DRS" + } + ], + "payments": [ + { + "date": "2018-01-14T17:32:28Z", + "paymentType": "credited", + "amount": { + "currency": "USD", + "value": 2.00 + }, + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa" + } + ] + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json new file mode 100644 index 000000000000..a06d8a863789 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "invoiceName": "{invoiceName}" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/{invoiceName}/operationResults/invoiceDownload_11000000-0000-0000-0000-000000000000?api-version=2020-05-01", + "Retry-After": "10" + } + }, + "200": { + "body": { + "url": "https://myaccount.blob.core.windows.net/invoices/1383724.pdf?sv=2019-02-02&sr=b&sp=r" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSection.json new file mode 100644 index 000000000000..c751111a6438 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSection.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "invoiceSectionName": "{invoiceSectionName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "name": "{invoiceSectionName}", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSection1", + "labels": { + "pcCode": "A123456", + "costCategory": "Support" + }, + "systemId": "XX1X-XXAA-XXX-ZZZ" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionPermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionPermissionsList.json new file mode 100644 index 000000000000..d948b9bf01b4 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionPermissionsList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "invoiceSectionName": "{invoiceSectionName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000015", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000009", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "20000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000008", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000010", + "30000000-aaaa-bbbb-cccc-200000000001" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignment.json new file mode 100644 index 000000000000..d5788f6c9243 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignment.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "invoiceSectionName": "{invoiceSectionName}", + "billingRoleAssignmentName": "{billingRoleAssignmentName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2018-06-21T21:34:12.2363515+00:00", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentDelete.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentDelete.json new file mode 100644 index 000000000000..d5788f6c9243 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentDelete.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "invoiceSectionName": "{invoiceSectionName}", + "billingRoleAssignmentName": "{billingRoleAssignmentName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2018-06-21T21:34:12.2363515+00:00", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentList.json new file mode 100644 index 000000000000..bc1c0400589f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleAssignmentList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "invoiceSectionName": "{invoiceSectionName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "name": "10000000-aaaa-bbbb-cccc-100000000000_6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "properties": { + "createdOn": "2018-06-21T21:34:12.2363515+00:00", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "name": "10000000-aaaa-bbbb-cccc-100000000000_b1839933-b3ac-42ca-8112-d29c43f3ab47", + "properties": { + "createdOn": "2018-06-21T21:58:19.9073876+00:00", + "scope": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "10000000-aaaa-bbbb-cccc-3fd5ff9d6aa1", + "principalId": "6fd330f6-7d26-4aff-b9cf-7bd699f965b9", + "principalTenantId": "10000000-aaaa-bbbb-cccc-2d7cd011db47", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/50000000-aaaa-bbbb-cccc-100000000002" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinition.json new file mode 100644 index 000000000000..47ebe75b139f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinition.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "invoiceSectionName": "{invoiceSectionName}", + "billingRoleDefinitionName": "{billingRoleDefinitionName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/{billingRoleDefinitionName}", + "name": "{billingRoleDefinitionName}", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the invoice section.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "20000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000009", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000010", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000008" + ], + "notActions": [] + } + ], + "roleName": "Invoice section owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinitionsList.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinitionsList.json new file mode 100644 index 000000000000..735412e49a6b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionRoleDefinitionsList.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "invoiceSectionName": "{invoiceSectionName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000000", + "name": "10000000-aaaa-bbbb-cccc-100000000000", + "properties": { + "description": "The Owner role gives the user all permissions including access management rights to the invoice section.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000000", + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "20000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000000", + "40000000-aaaa-bbbb-cccc-200000000000", + "30000000-aaaa-bbbb-cccc-200000000009", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000010", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000008" + ], + "notActions": [] + } + ], + "roleName": "Invoice section owner" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions/10000000-aaaa-bbbb-cccc-100000000001", + "name": "10000000-aaaa-bbbb-cccc-100000000001", + "properties": { + "description": "The Contributor role give the user all permissions except access management rights to the invoice section.", + "permissions": [ + { + "actions": [ + "10000000-aaaa-bbbb-cccc-200000000008", + "10000000-aaaa-bbbb-cccc-200000000001", + "10000000-aaaa-bbbb-cccc-200000000002", + "10000000-aaaa-bbbb-cccc-200000000003", + "10000000-aaaa-bbbb-cccc-200000000006", + "10000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000009", + "20000000-aaaa-bbbb-cccc-200000000002", + "30000000-aaaa-bbbb-cccc-200000000015", + "30000000-aaaa-bbbb-cccc-200000000004", + "30000000-aaaa-bbbb-cccc-200000000007", + "30000000-aaaa-bbbb-cccc-200000000001", + "30000000-aaaa-bbbb-cccc-200000000010", + "40000000-aaaa-bbbb-cccc-200000000007", + "40000000-aaaa-bbbb-cccc-200000000006", + "40000000-aaaa-bbbb-cccc-200000000008" + ], + "notActions": [] + } + ], + "roleName": "Invoice section contributor" + }, + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListByBillingProfile.json new file mode 100644 index 000000000000..e3bda0d87fb7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListByBillingProfile.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "name": "22000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSection1", + "labels": { + "pcCode": "A123456", + "costCategory": "Support" + }, + "systemId": "XX1X-XXAA-XXX-ZZZ" + } + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000011", + "name": "22000000-0000-0000-0000-000000000011", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSection2", + "labels": { + "pcCode": "Z223456", + "costCategory": "Marketing" + }, + "systemId": "YY1X-BBAA-XXX-ZZZ" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListWithCreateSubPermission.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListWithCreateSubPermission.json new file mode 100644 index 000000000000..26aea84f6b4b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceSectionsListWithCreateSubPermission.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "invoiceSection1", + "invoiceSectionSystemId": "9XXX-11XX-XX1-XXXX-XXX", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileStatus": "Warned", + "billingProfileStatusReasonCode": "PastDue", + "billingProfileSpendingLimit": "On", + "billingProfileSystemId": "1XXX-11XX-XX1-XXXX-XXX", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoicesListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoicesListByBillingProfile.json new file mode 100644 index 000000000000..f2dd0ffc9c42 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoicesListByBillingProfile.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "periodStartDate": "2018-01-01", + "periodEndDate": "2018-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383723", + "name": "1383723", + "type": "Microsoft.Billing/billingAccounts/invoices", + "properties": { + "dueDate": "2018-01-16T17:32:28Z", + "invoiceDate": "2018-01-01T17:32:28Z", + "status": "Due", + "amountDue": { + "currency": "USD", + "value": 8.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 25.46 + }, + "creditAmount": { + "currency": "USD", + "value": 1.00 + }, + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0.00 + }, + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 0.00 + }, + "totalAmount": { + "currency": "USD", + "value": 7.53 + }, + "invoicePeriodStartDate": "2018-01-01T17:32:28Z", + "invoicePeriodEndDate": "2018-01-15T17:32:28Z", + "isMonthlyInvoice": false, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "billingProfileDisplayName": "Contoso Operations Billing", + "purchaseOrderNumber": "123456", + "documents": [ + { + "kind": "Invoice", + "url": "https://microsoft.com/invoice.pdf", + "source": "DRS" + }, + { + "kind": "TaxReceipt", + "url": "https://microsoft.com/taxDoc.pdf", + "source": "DRS" + } + ], + "payments": [ + { + "date": "2018-01-14T17:32:28Z", + "paymentType": "credited", + "amount": { + "currency": "USD", + "value": 1.00 + }, + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa" + } + ] + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/1383724", + "name": "1383724", + "type": "Microsoft.Billing/billingAccounts/invoices", + "properties": { + "dueDate": "2018-03-01T17:32:28Z", + "invoiceDate": "2018-01-01T17:32:28Z", + "status": "Due", + "amountDue": { + "currency": "USD", + "value": 16.53 + }, + "billedAmount": { + "currency": "USD", + "value": 33.99 + }, + "azurePrepaymentApplied": { + "currency": "USD", + "value": 15.46 + }, + "creditAmount": { + "currency": "USD", + "value": 2.00 + }, + "freeAzureCreditApplied": { + "currency": "USD", + "value": 0.00 + }, + "subTotal": { + "currency": "USD", + "value": 33.99 + }, + "taxAmount": { + "currency": "USD", + "value": 0.00 + }, + "totalAmount": { + "currency": "USD", + "value": 16.53 + }, + "invoicePeriodStartDate": "2018-02-01T17:32:28Z", + "invoicePeriodEndDate": "2018-02-28T17:32:28Z", + "isMonthlyInvoice": true, + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "billingProfileDisplayName": "Contoso Operations Billing", + "purchaseOrderNumber": "123456", + "documents": [ + { + "kind": "Invoice", + "url": "https://microsoft.com/invoice.pdf", + "source": "DRS" + }, + { + "kind": "TaxReceipt", + "url": "https://microsoft.com/taxDoc.pdf", + "source": "DRS" + } + ], + "payments": [ + { + "date": "2018-01-14T17:32:28Z", + "paymentType": "credited", + "amount": { + "currency": "USD", + "value": 2.00 + }, + "paymentMethodFamily": "CreditCard", + "paymentMethodType": "visa" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveBillingSubscription.json new file mode 100644 index 000000000000..91fbf144a862 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveBillingSubscription.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "subscriptionId": "{subscriptionId}", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "displayName": "My Subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 5000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 600 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationResults/moveBillingSubscription_11000000-0000-0000-0000-000000000000:22000000-0000-0000-0000-000000000000:{subscriptionId}:44000000-0000-0000-0000-000000000055:10000000-0000-0000-0000-000000000001?api-version=2020-05-01", + "Retry-After": "30" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveProduct.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveProduct.json new file mode 100644 index 000000000000..78387257995c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/MoveProduct.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "productName": "{productName}", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}" + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}/products/{productName}", + "name": "{productName}", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "On", + "productTypeId": "A12345", + "productType": "Subscription", + "displayName": "Test Product", + "status": "Active", + "purchaseDate": "2018-05-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 5000.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "billingFrequency": "Monthly", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce", + "availabilityId": "AvailabilityId1", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{newBillingProfileName}/invoiceSections/{newInvoiceSectionName}", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing" + } + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/operationResults/44000000-0000-0000-0000-000000000000?api-version=2020-05-01", + "Retry-After": "60", + "OData-EntityId": "44000000-0000-0000-0000-000000000000" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Policy.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Policy.json new file mode 100644 index 000000000000..f625de03e3d1 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Policy.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default", + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies", + "properties": { + "marketplacePurchases": "AllAllowed", + "reservationPurchases": "Allowed", + "viewCharges": "Allowed" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json new file mode 100644 index 000000000000..5a2061c7b298 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/Product.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "productName": "{productName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/{productName}", + "name": "{productName}", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "On", + "productTypeId": "A12345", + "productType": "Subscription", + "displayName": "AIP Dev", + "status": "Active", + "purchaseDate": "2018-05-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 5000.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "billingFrequency": "Monthly", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce", + "availabilityId": "AvailabilityId1", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingAccount.json new file mode 100644 index 000000000000..764393d75c29 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingAccount.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "On", + "productTypeId": "A12345", + "productType": "Reservation", + "displayName": "Eng Reservation (1a13s21awe)", + "status": "Active", + "purchaseDate": "2018-05-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 5000.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce", + "availabilityId": "AvailabilityId1", + "billingFrequency": "OneTime", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001", + "name": "10000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "On", + "productTypeId": "A12345", + "productType": "Azure subscription", + "displayName": "Engineering Email", + "status": "Active", + "purchaseDate": "2018-04-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 5000.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce", + "availabilityId": "AvailabilityId1", + "billingFrequency": "Monthly", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingProfile.json new file mode 100644 index 000000000000..67a72146df6b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByBillingProfile.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "On", + "productTypeId": "A12345", + "productType": "Reservation", + "displayName": "Eng Reservation (1a13s21awe)", + "status": "Active", + "purchaseDate": "2018-05-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 5000.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce", + "availabilityId": "AvailabilityId1", + "billingFrequency": "OneTime", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001", + "name": "10000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "On", + "productTypeId": "A12345", + "productType": "Azure subscription", + "displayName": "Engineering Email", + "status": "Active", + "purchaseDate": "2018-04-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 5000.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce", + "availabilityId": "AvailabilityId1", + "billingFrequency": "Monthly", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.json new file mode 100644 index 000000000000..ff18e2fdfe07 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByCustomer.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "customerName": "{customerName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "On", + "productTypeId": "A12345", + "productType": "Reservation", + "displayName": "Eng Reservation (1a13s21awe)", + "status": "Active", + "purchaseDate": "2018-05-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 5000.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "billingFrequency": "OneTime", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce", + "availabilityId": "AvailabilityId1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}", + "customerDisplayName": "Customer 1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "reseller": { + "resellerId": "2c917292-b7bc-42f2-99a2-e498b9087c06", + "description": "Reseller1" + } + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001", + "name": "10000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "On", + "productTypeId": "A12345", + "productType": "Azure subscription", + "displayName": "Engineering Email", + "status": "Active", + "purchaseDate": "2018-04-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 500.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "billingFrequency": "Monthly", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce", + "availabilityId": "AvailabilityId1", + "customerId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}", + "customerDisplayName": "Customer 1", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByInvoiceSection.json new file mode 100644 index 000000000000..d2a538072eea --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ProductsListByInvoiceSection.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "invoiceSectionName": "{invoiceSectionName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "On", + "productTypeId": "A12345", + "productType": "Reservation", + "displayName": "Eng Reservation (1a13s21awe)", + "status": "Active", + "purchaseDate": "2018-05-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 5000.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "billingFrequency": "OneTime", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce", + "availabilityId": "AvailabilityId1", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/10000000-0000-0000-0000-000000000001", + "name": "10000000-0000-0000-0000-000000000001", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "On", + "productTypeId": "A12345", + "productType": "Azure subscription", + "displayName": "Engineering Email", + "status": "Active", + "purchaseDate": "2018-04-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 500.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "billingFrequency": "Monthly", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "availabilityId": "AvailabilityId1", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutBillingProfile.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutBillingProfile.json new file mode 100644 index 000000000000..34cd9b1a3b3a --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutBillingProfile.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "parameters": { + "properties": { + "displayName": "Finance", + "billTo": { + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address 1", + "city": "Redmond", + "postalCode": "12345", + "region": "WA", + "country": "US" + }, + "enabledAzurePlans": [ + { + "skuId": "0001" + }, + { + "skuId": "0002" + } + ], + "invoiceEmailOptIn": true, + "poNumber": "ABC12345" + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationResults/putBillingProfile_00000000-0000-0000-0000-000000000000?api-version=2020-05-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/billingProfileId1", + "name": "billingProfileId1", + "type": "Microsoft.Billing/billingAccounts/billingProfiles", + "properties": { + "displayName": "Finance", + "billTo": { + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address 1", + "city": "Redmond", + "postalCode": "12345", + "region": "WA", + "country": "US" + }, + "currency": "USD", + "enabledAzurePlans": [ + { + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + }, + { + "skuId": "0002", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + ], + "invoiceDay": 5, + "invoiceEmailOptIn": true, + "poNumber": "ABC12345", + "hasReadAccess": true, + "systemId": "1XXX-11XX-XX1-XXXX-XXX", + "status": "Active", + "spendingLimit": "Off" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInstruction.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInstruction.json new file mode 100644 index 000000000000..a140f1b32e61 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInstruction.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "instructionName": "{instructionName}", + "parameters": { + "properties": { + "amount": 5000.0, + "startDate": "2019-12-30T21:26:47.997Z", + "endDate": "2020-12-30T21:26:47.997Z" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/instructions/{instructionName}", + "name": "{instructionName}", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/instructions", + "properties": { + "amount": 5000.0, + "startDate": "2019-12-30T21:26:47.997Z", + "endDate": "2020-12-30T21:26:47.997Z" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInvoiceSection.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInvoiceSection.json new file mode 100644 index 000000000000..363ccd587a07 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/PutInvoiceSection.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "invoiceSectionName": "{invoiceSectionName}", + "parameters": { + "properties": { + "displayName": "invoiceSection1", + "labels": { + "pcCode": "A123456", + "costCategory": "Support" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationResults/putInvoiceSection_00000000-0000-0000-0000-000000000000?api-version=2020-05-01", + "Retry-After": "60" + } + }, + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "name": "{invoiceSectionName}", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/invoiceSections", + "properties": { + "displayName": "invoiceSection1", + "labels": { + "pcCode": "A123456", + "costCategory": "Support" + }, + "systemId": "XX1X-XXAA-XXX-ZZZ" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/TransactionsListByInvoice.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/TransactionsListByInvoice.json new file mode 100644 index 000000000000..3cd3d055db94 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/TransactionsListByInvoice.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "invoiceName": "{invoiceName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/transactions/41000000-0000-0000-0000-000000000000", + "name": "41000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/transactions", + "properties": { + "kind": "all", + "date": "2018-05-01T00:00:00Z", + "invoice": "2344233", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/invoices/2344233", + "productFamily": "Storage", + "productTypeId": "A12345", + "productType": "VM Instance", + "productDescription": "Standard D1, US West 3", + "transactionType": "Purchase", + "transactionAmount": { + "currency": "USD", + "value": 5000.00 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "billingProfileDisplayName": "Contoso operations billing", + "azurePlan": "Microsoft Azure Plan for DevTest", + "azureCreditApplied": { + "currency": "USD", + "value": 2000.00 + }, + "billingCurrency": "USD", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10.00 + }, + "exchangeRate": 1, + "marketPrice": { + "currency": "USD", + "value": 20.00 + }, + "pricingCurrency": "USD", + "quantity": 1, + "servicePeriodStartDate": "2018-05-01T00:00:00Z", + "servicePeriodEndDate": "2018-09-30T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 4500.00 + }, + "tax": { + "currency": "USD", + "value": 500.00 + }, + "unitOfMeasure": "1 Minute", + "units": 11.25, + "unitType": "1 Runtime Minute" + } + }, + { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/transactions/51000000-0000-0000-0000-000000000000", + "name": "51000000-0000-0000-0000-000000000000", + "type": "Microsoft.Billing/billingAccounts/transactions", + "properties": { + "kind": "all", + "date": "2018-04-01T00:00:00Z", + "invoice": "pending", + "productFamily": "Storage", + "productTypeId": "A12345", + "productType": "VM Instance", + "productDescription": "Standard Support", + "transactionType": "Cancel", + "transactionAmount": { + "currency": "USD", + "value": 50.00 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}", + "billingProfileDisplayName": "Contoso operations billing", + "azurePlan": "Microsoft Azure Plan for DevTest", + "azureCreditApplied": { + "currency": "USD", + "value": 20.00 + }, + "billingCurrency": "USD", + "discount": 0.1, + "effectivePrice": { + "currency": "USD", + "value": 10.00 + }, + "exchangeRate": 1, + "marketPrice": { + "currency": "USD", + "value": 20.00 + }, + "pricingCurrency": "USD", + "quantity": 1, + "servicePeriodStartDate": "2018-05-01T00:00:00Z", + "servicePeriodEndDate": "2018-09-30T00:00:00Z", + "subTotal": { + "currency": "USD", + "value": 45.00 + }, + "tax": { + "currency": "USD", + "value": 5.00 + }, + "unitOfMeasure": "1 Minute", + "units": 1.25, + "unitType": "1 Runtime Minute" + } + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.json new file mode 100644 index 000000000000..fa0dca4f26c5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingAccount.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "parameters": { + "properties": { + "displayName": "Test Account", + "soldTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address 1", + "city": "Redmond", + "postalCode": "12345", + "region": "WA", + "country": "US" + } + } + } + }, + "responses": { + "202": { + "headers": { + "Location": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/operationStatus/65e1f2bf-c31c-4b89-a599-25d9d4172af9?api-version=2020-05-01", + "Retry-After": "10" + } + }, + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}", + "name": "{billingAccountName}", + "type": "Microsoft.Billing/billingAccounts", + "properties": { + "displayName": "Test Account", + "agreementType": "MicrosoftCustomerAgreement", + "accountStatus": "Active", + "accountType": "Enterprise", + "hasReadAccess": true, + "soldTo": { + "companyName": "Contoso", + "firstName": "Test", + "lastName": "User", + "addressLine1": "Test Address 1", + "city": "Redmond", + "postalCode": "12345", + "region": "WA", + "country": "US" + } + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingProperty.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingProperty.json new file mode 100644 index 000000000000..564cea55db9e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingProperty.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "{subscriptionId}", + "parameters": { + "properties": { + "costCenter": "1010" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingProperty/default", + "name": "default", + "type": "Microsoft.Billing/billingProperty", + "properties": { + "accountAdminNotificationEmailAddress": "test@contoso.com", + "billingTenantId": "90000000-0000-0000-0000-000000000011", + "billingAccountId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000", + "billingAccountDisplayName": "My Account", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "billingProfileStatus": "Warned", + "billingProfileStatusReasonCode": "PastDue", + "billingProfileSpendingLimit": "On", + "costCenter": "1010", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoice section", + "isAccountAdmin": true, + "productId": "/providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-000000000000_00000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000/products/44000000-0000-0000-0000-000000000000", + "productName": "Standard Dev", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan for DevTest" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingSubscription.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingSubscription.json new file mode 100644 index 000000000000..9b4bc71b63f3 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateBillingSubscription.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "subscriptionId": "{subscriptionId}", + "parameters": { + "properties": { + "costCenter": "ABC1234" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/billingSubscriptions/{subscriptionId}", + "name": "{subscriptionId}", + "type": "Microsoft.Billing/billingAccounts/billingSubscriptions", + "properties": { + "displayName": "My Subscription", + "subscriptionId": "6b96d3f2-9008-4a9d-912f-f87744185aa3", + "subscriptionBillingStatus": "Active", + "lastMonthCharges": { + "currency": "USD", + "value": 5000.00 + }, + "monthToDateCharges": { + "currency": "USD", + "value": 600 + }, + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000/invoiceSections/22000000-0000-0000-0000-000000000000", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing", + "costCenter": "ABC1234", + "skuId": "0001", + "skuDescription": "Microsoft Azure Plan" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateCustomerPolicy.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateCustomerPolicy.json new file mode 100644 index 000000000000..c014d2859aaa --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateCustomerPolicy.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "customerName": "{customerName}", + "parameters": { + "properties": { + "viewCharges": "NotAllowed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/customers/{customerName}/policies/default", + "name": "default", + "type": "Microsoft.Billing/billingAccounts/customers/policies", + "properties": { + "viewCharges": "NotAllowed" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdatePolicy.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdatePolicy.json new file mode 100644 index 000000000000..c85677e85d94 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdatePolicy.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}", + "parameters": { + "properties": { + "marketplacePurchases": "OnlyFreeAllowed", + "reservationPurchases": "NotAllowed", + "viewCharges": "Allowed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/policies/default", + "name": "default", + "type": "Microsoft.Billing/billingAccounts/billingProfiles/policies", + "properties": { + "marketplacePurchases": "OnlyFreeAllowed", + "reservationPurchases": "NotAllowed", + "viewCharges": "Allowed" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateProduct.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateProduct.json new file mode 100644 index 000000000000..5d1beb7bafc5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/UpdateProduct.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "productName": "{productName}", + "parameters": { + "properties": { + "autoRenew": "Off" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/BillingAccounts/{billingAccountName}/products/{productName}", + "name": "{productName}", + "type": "Microsoft.Billing/billingAccounts/products", + "properties": { + "autoRenew": "Off", + "productTypeId": "A12345", + "productType": "Subscription", + "displayName": "AIP Dev", + "status": "Active", + "purchaseDate": "2018-05-01T17:32:28Z", + "lastCharge": { + "currency": "USD", + "value": 5000.00 + }, + "lastChargeDate": "2018-06-15T17:32:28Z", + "billingFrequency": "Monthly", + "quantity": 4, + "skuId": "0001", + "skuDescription": "Enterprise Agreement Development", + "tenantId": "515a6d36-aaf8-4ca2-a5e8-c45deb0c5cce", + "availabilityId": "AvailabilityId1", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}", + "invoiceSectionDisplayName": "Contoso operations invoiceSection", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/11000000-0000-0000-0000-000000000000", + "billingProfileDisplayName": "Contoso operations billing" + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveFailure.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveFailure.json new file mode 100644 index 000000000000..bd75b901d431 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveFailure.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "productName": "{productName}", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}" + } + }, + "responses": { + "200": { + "body": { + "isMoveEligible": false, + "errorDetails": { + "code": "ProductTypeNotSupported", + "message": "Product '{productName}' is not allowed to be transferred." + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveSuccess.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveSuccess.json new file mode 100644 index 000000000000..12669b188250 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateProductMoveSuccess.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "productName": "{productName}", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}" + } + }, + "responses": { + "200": { + "body": { + "isMoveEligible": true + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveFailure.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveFailure.json new file mode 100644 index 000000000000..baadfc3441da --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveFailure.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "subscriptionId": "{subscriptionId}", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}" + } + }, + "responses": { + "200": { + "body": { + "isMoveEligible": false, + "errorDetails": { + "code": "SubscriptionNotActive", + "message": "Invoice Sections can only be changed for active subscriptions." + } + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveSuccess.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveSuccess.json new file mode 100644 index 000000000000..7fe8119fa29f --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/ValidateSubscriptionMoveSuccess.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "billingAccountName": "{billingAccountName}", + "subscriptionId": "{subscriptionId}", + "parameters": { + "destinationInvoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{newInvoiceSectionName}" + } + }, + "responses": { + "200": { + "body": { + "isMoveEligible": true + } + } + } +} diff --git a/specification/billing/resource-manager/readme.go.md b/specification/billing/resource-manager/readme.go.md index 73acea981762..da6a9bb03011 100644 --- a/specification/billing/resource-manager/readme.go.md +++ b/specification/billing/resource-manager/readme.go.md @@ -13,12 +13,22 @@ go: ### Go multi-api ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-05 - tag: package-2018-11-preview - tag: package-2018-03-preview - tag: package-2017-04-preview - tag: package-2017-02-preview ``` +### Tag: package-2020-05 and go + +These settings apply only when `--tag=package-2020-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-05' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-05/$(namespace) +``` + ### Tag: package-2018-11-preview and go These settings apply only when `--tag=package-2018-11-preview --go` is specified on the command line. diff --git a/specification/billing/resource-manager/readme.md b/specification/billing/resource-manager/readme.md index 8bb331f5cb59..31988a610128 100644 --- a/specification/billing/resource-manager/readme.md +++ b/specification/billing/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the Billing API. ``` yaml openapi-type: arm -tag: package-2019-10-preview +tag: package-2020-05 +``` + +### Tag: package-2020-05 + +These settings apply only when `--tag=package-2020-05` is specified on the command line. + +``` yaml $(tag) == 'package-2020-05' +input-file: +- Microsoft.Billing/stable/2020-05-01/billing.json ``` ### Tag: package-2019-10-preview @@ -133,6 +142,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-billing ``` yaml $(java) && $(multiapi) batch: + - tag: package-2020-05 - tag: package-2019-10-preview - tag: package-2018-11-preview - tag: package-2018-03-preview @@ -140,6 +150,19 @@ batch: - tag: package-2017-02-preview ``` +### Tag: package-2020-05 and java + +These settings apply only when `--tag=package-2020-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.billing.v2020_05_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/billing/mgmt-v2020_05_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2019-10-preview and java These settings apply only when `--tag=package-2019-10-preview --java` is specified on the command line. @@ -219,6 +242,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.Billing/stable/2020-05-01/billing.json - $(this-folder)/Microsoft.Billing/preview/2019-10-01-preview/billing.json - $(this-folder)/Microsoft.Billing/preview/2018-11-01-preview/billing.json - $(this-folder)/Microsoft.Billing/preview/2018-03-01-preview/billing.json diff --git a/specification/billing/resource-manager/readme.ruby.md b/specification/billing/resource-manager/readme.ruby.md index 1aa6339d90ab..fcb9843607a5 100644 --- a/specification/billing/resource-manager/readme.ruby.md +++ b/specification/billing/resource-manager/readme.ruby.md @@ -16,6 +16,16 @@ batch: - tag: package-2017-02-preview ``` +### Tag: package-2020-05 and ruby + +These settings apply only when `--tag=package-2020-05 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-05' && $(ruby) +namespace: "Azure::Billing::Mgmt::V2020_05" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_billing/lib +``` + ### Tag: package-2017-04-preview and ruby These settings apply only when `--tag=package-2017-04-preview --ruby` is specified on the command line. From 77c1eee540b1ba5f1024bec0324589fb71056a66 Mon Sep 17 00:00:00 2001 From: Youssef Shahin Date: Wed, 27 May 2020 19:56:20 -0700 Subject: [PATCH 022/318] Speaker Recognition v2 (#9587) * Speaker Recognition v2 Split service into 2 APIs; Speaker Identification and Speaker Verification * Spelling mistakes fixed * Prettier run * add item name * Remove go support for now will add it later when we figure out the issue --- .../preview/v2.0/Identification.json | 831 ++++++++++ .../v2.0/examples/createEnrollment.json | 114 ++ .../preview/v2.0/examples/createProfile.json | 95 ++ .../preview/v2.0/examples/deleteProfile.json | 48 + .../preview/v2.0/examples/fetchProfile.json | 71 + .../v2.0/examples/identifySingleSpeaker.json | 99 ++ .../preview/v2.0/examples/listProfiles.json | 75 + .../preview/v2.0/examples/resetProfile.json | 59 + .../Identification/readme.md | 67 + .../Identification/readme.nodejs.md | 14 + .../Identification/readme.python.md | 26 + .../Identification/readme.typescript.md | 12 + .../preview/v2.0/Verification.json | 1408 +++++++++++++++++ .../preview/v2.0/examples/deleteProfile.json | 48 + .../preview/v2.0/examples/phrases.json | 63 + .../preview/v2.0/examples/resetProfile.json | 59 + .../textDependentCreateEnrollment.json | 115 ++ .../examples/textDependentCreateProfile.json | 95 ++ .../examples/textDependentFetchProfile.json | 71 + .../examples/textDependentListProfiles.json | 75 + .../textIndependentCreateEnrollment.json | 114 ++ .../textIndependentCreateProfile.json | 95 ++ .../examples/textIndependentFetchProfile.json | 71 + .../examples/textIndependentListProfiles.json | 75 + .../preview/v2.0/examples/verify.json | 86 + .../SpeakerRecognition/Verification/readme.md | 67 + .../Verification/readme.nodejs.md | 14 + .../Verification/readme.python.md | 26 + .../Verification/readme.typescript.md | 12 + 29 files changed, 4005 insertions(+) create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/Identification.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createEnrollment.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createProfile.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/deleteProfile.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/fetchProfile.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/identifySingleSpeaker.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/listProfiles.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/resetProfile.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.nodejs.md create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.python.md create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.typescript.md create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/Verification.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/deleteProfile.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/phrases.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/resetProfile.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateEnrollment.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateProfile.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentFetchProfile.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentListProfiles.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateEnrollment.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateProfile.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentFetchProfile.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentListProfiles.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/verify.json create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.nodejs.md create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.python.md create mode 100644 specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.typescript.md diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/Identification.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/Identification.json new file mode 100644 index 000000000000..d5476d4178cc --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/Identification.json @@ -0,0 +1,831 @@ +{ + "swagger": "2.0", + "info": { + "title": "Speaker Identification API", + "version": "2.0", + "description": "This API is currently available in:\n\n* West US - westus.api.cognitive.microsoft.com" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/speaker/identification/v2.0", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "apiKeyHeader": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "profileIdParam": { + "in": "path", + "name": "profileId", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false, + "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}$", + "description": "Unique identifier for profile id (guid).", + "x-ms-parameter-location": "method" + }, + "localeParam": { + "in": "path", + "name": "locale", + "required": true, + "type": "string", + "x-nullable": false, + "pattern": "^[a-zA-Z]{2}-?[a-zA-Z]{2}$", + "description": "A combination of language code and country code.", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ProfileId": { + "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}$", + "description": "Unique identifier for profile id (guid).", + "example": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "format": "uuid", + "x-nullable": false + }, + "Locale": { + "type": "string", + "pattern": "^[a-zA-Z]{2}-?[a-zA-Z]{2}$", + "x-nullable": false, + "description": "Language identifier consisting of a combination of language code and country code.", + "example": "en-US" + }, + "EnrollmentStatus": { + "type": "string", + "description": "Status representing the current state of the profile. Available values are:\n* Enrolling: profile has no voice print and not ready for recognition requests.\n* Training: voice print of profile is being created and can’t be used for recognition at the moment.\n* Enrolled: profile has a voice print and ready for recognition requests.", + "enum": [ + "Enrolling", + "Training", + "Enrolled" + ], + "x-ms-enum": { + "name": "TrainingStatusType", + "modelAsString": false + }, + "example": "Enrolling" + }, + "CreatedDateTime": { + "type": "string", + "description": "Profile creation datetime.", + "example": "2015-04-23T18:25:43.41Z" + }, + "LastUpdatedDateTime": { + "type": "string", + "description": "Last datetime when the profile was updated.", + "example": "2015-04-23T19:34:51.52Z" + }, + "EnrollmentsCount": { + "type": "integer", + "description": "Number of enrolment audios accepted for this profile.", + "example": 1 + }, + "EnrollmentsLength": { + "type": "number", + "description": "Total length of enrollment audios accepted for this profile in seconds.", + "example": 1.83 + }, + "EnrollmentsSpeechLength": { + "type": "number", + "description": "Summation of pure speech (which is the amount of audio after removing silence and non-speech segments) across all profile enrollments in seconds.", + "example": 1.35 + }, + "RemainingEnrollmentsSpeechLength": { + "type": "number", + "description": "Amount of pure speech (which is the amount of audio after removing silence and non-speech segments) needed to complete profile enrollment in seconds.", + "example": 18.65 + }, + "ModelVersion": { + "type": "string", + "pattern": "^\\d{4}-\\d{2}-\\d{2}$", + "description": "Date specifying the model assigned to this profile. Format is yyyy-mm-dd. If profile has no enrollments, this value will be empty.", + "example": "2019-12-05" + }, + "LocaleInfo": { + "description": "Speaker profile locale", + "required": [ + "locale" + ], + "properties": { + "locale": { + "$ref": "#/definitions/Locale" + } + } + }, + "TiProfileInfoList": { + "description": "Text-Independent Speaker profile info list", + "properties": { + "profiles": { + "items": { + "$ref": "#/definitions/TiProfileInfo" + } + }, + "@nextLink": { + "type": "string", + "example": "https://{Endpoint}/text-independent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5" + } + } + }, + "TiProfileInfo": { + "description": "Text-Independent Speaker profile info", + "properties": { + "profileId": { + "$ref": "#/definitions/ProfileId" + }, + "locale": { + "$ref": "#/definitions/Locale" + }, + "enrollmentStatus": { + "$ref": "#/definitions/EnrollmentStatus" + }, + "createdDateTime": { + "$ref": "#/definitions/CreatedDateTime" + }, + "lastUpdatedDateTime": { + "$ref": "#/definitions/LastUpdatedDateTime" + }, + "enrollmentsCount": { + "$ref": "#/definitions/EnrollmentsCount" + }, + "enrollmentsLength": { + "$ref": "#/definitions/EnrollmentsLength" + }, + "enrollmentsSpeechLength": { + "$ref": "#/definitions/EnrollmentsSpeechLength" + }, + "remainingEnrollmentsSpeechLength": { + "$ref": "#/definitions/RemainingEnrollmentsSpeechLength" + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion" + } + } + }, + "TiEnrollmentInfo": { + "description": "Speaker profile enrollment info", + "properties": { + "profileId": { + "$ref": "#/definitions/ProfileId" + }, + "enrollmentStatus": { + "$ref": "#/definitions/EnrollmentStatus" + }, + "enrollmentsCount": { + "$ref": "#/definitions/EnrollmentsCount" + }, + "enrollmentsLength": { + "$ref": "#/definitions/EnrollmentsLength" + }, + "enrollmentsSpeechLength": { + "$ref": "#/definitions/EnrollmentsSpeechLength" + }, + "remainingEnrollmentsSpeechLength": { + "$ref": "#/definitions/RemainingEnrollmentsSpeechLength" + }, + "audioLength": { + "type": "number", + "description": "This enrolment audio length in seconds.", + "example": 1.83 + }, + "audioSpeechLength": { + "type": "number", + "description": "This enrollment audio pure speech (which is the amount of audio after removing silence and non-speech segments) length in seconds.", + "example": 1.35 + } + } + }, + "IdentifiedSingleSpeakerInfo": { + "properties": { + "identifiedProfile": { + "description": "Object containing data of identified profile.", + "$ref": "#/definitions/IdentifyInfo" + }, + "profilesRanking": { + "description": "Object containing data of the top 5 profiles (including identified profile) sorted in descending order by score.", + "items": { + "$ref": "#/definitions/IdentifyInfo" + }, + "example": [ + { + "profileId": "111f427c-3791-468f-b709-fcef7660fff9", + "score": 0.63 + }, + { + "profileId": "3669fa29-1bf3-45ad-beea-6b348d058d7e", + "score": 0.49 + }, + { + "profileId": "0e196cd9-32d5-4883-8631-54a0e7c7cb3d", + "score": 0.4 + }, + { + "profileId": "726e57d9-04e0-4214-b482-7f786fa83560", + "score": 0.1 + }, + { + "profileId": "f95189fd-1bf5-4485-9c2e-e5897e0c98ca", + "score": 0.03 + } + ] + } + } + }, + "IdentifyInfo": { + "description": "Identified speaker info", + "properties": { + "profileId": { + "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}$", + "description": "ID of identified of profile. If no candidate is identified as the right speaker, the value is set to empty GUID.", + "example": "111f427c-3791-468f-b709-fcef7660fff9", + "format": "uuid", + "x-nullable": false + }, + "score": { + "type": "number", + "description": "A float number indicating the similarity between input audio and targeted voice print. This number must be between 0 and 1. A higher number means higher similarity.", + "example": 0.63 + } + } + }, + "Error": { + "required": [ + "error" + ], + "properties": { + "error": { + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "NotFound": { + "description": "NotFound - Requested profile doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "x-ms-error-response": true + }, + "Unauthorized": { + "description": "Request is not authorized. Make sure subscription key is included and valid.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "x-ms-error-response": true + }, + "RateLimit": { + "description": "Rate limit is exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "x-ms-error-response": true + }, + "ServerError": { + "description": "Internal Server Error.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + }, + "x-ms-error-response": true + } + }, + "paths": { + "/text-independent/profiles": { + "post": { + "description": "Creates a new speaker profile with specified locale.\nOne subscription can create 10,000 speaker profiles at most.", + "operationId": "TextIndependent_CreateProfile", + "summary": "Create Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/createProfile.json" + } + }, + "tags": [ + "text-independent" + ], + "parameters": [ + { + "in": "body", + "name": "profileInfo", + "description": "Provide following detail info when creating a new profile.\nFields | Description\n------- | ------------\nlocale | Locale for the language of this speaker profile. A complete supported locale list is here:
  • **en-US**
  • **es-ES**
  • **fr-FR**
  • **zh-CN**
  • **de-DE**
  • **en-GB**
  • **en-AU**
  • **en-CA**
  • **fr-CA**
  • **it-IT**
  • **es-MX**
  • **ja-JP**
  • **pt-BR**
  • **en-IN**
", + "schema": { + "$ref": "#/definitions/LocaleInfo" + } + } + ], + "responses": { + "201": { + "description": "Speaker profile created successfully. GUID is returned to reference the created profile.", + "headers": { + "Location": { + "type": "string", + "description": "url location of new resource" + } + }, + "schema": { + "$ref": "#/definitions/TiProfileInfo" + } + }, + "400": { + "description": "Bad Request\n* InvalidRequest - Request body is missing.\n* InvalidRequest - Invalid JSON format.\n* InvalidRequest - Locale parameter is missing.\n* InvalidArgument - Invalid locale value. Supported locales are {comma-separated list of locales}.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Request body is missing." + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "403": { + "description": "Forbidden - Maximum allowed number of profiles is 10,000.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "Forbidden", + "message": "Maximum allowed number of profiles is 10,000." + } + } + }, + "x-ms-error-response": true + }, + "415": { + "description": "UnsupportedMediaType - Unsupported media type. Only 'application/JSON' is accepted.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'application/JSON' is accepted." + } + } + }, + "x-ms-error-response": true + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + }, + "get": { + "x-ms-pageable": { + "nextLinkName": "@nextLink", + "itemName": "profiles" + }, + "description": "Retrieves a set of profiles.\nProfiles are sorted alphabetically by ProfileId", + "operationId": "TextIndependent_ListProfiles", + "summary": "List Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/listProfiles.json" + } + }, + "tags": [ + "text-independent" + ], + "parameters": [ + { + "in": "query", + "name": "$top", + "description": "The number of profiles to return. Default is 100 and the maximum is 500", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TiProfileInfoList" + } + }, + "400": { + "description": "Bad Request\n* InvalidArgument - Invalid $top parameter value. Value should be positive integer in the range [1, 500].\n* InvalidArgument - Invalid $continuationToken value. $continuationToken must be generated form a prior API call.\n* InvalidArgument - $filter parameter is not supported.\n* InvalidArgument - $skip parameter is not supported.\n* InvalidArgument - $orderBy parameter is not supported.\n* InvalidArgument - $delta parameter is not supported.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidArgument", + "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]" + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-independent/profiles/{profileId}": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "get": { + "description": "Retrieves a single profile by ID.", + "operationId": "TextIndependent_GetProfile", + "summary": "Retrieve Single Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/fetchProfile.json" + } + }, + "tags": [ + "text-independent" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TiProfileInfo" + } + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + }, + "delete": { + "description": "Deletes an existing profile.", + "operationId": "TextIndependent_DeleteProfile", + "summary": "Delete Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/deleteProfile.json" + } + }, + "tags": [ + "text-independent" + ], + "responses": { + "204": { + "description": "OK" + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-independent/profiles/{profileId}/reset": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "post": { + "description": "Resets existing profile to its original creation state. The reset operation does the following:\n* Updates enrollmentStatus to Enrolling.\n* Updates lastUpdatedDateTime.\n* Updates enrollmentsCount to 0.\n* Updates enrollmentsLength to 0.\n* Updates enrollmentsSpeechLength to 0.\n* Updates remainingEnrollmentsSpeechLength to the required number.\n* Removes all associated enrollments from storage.\n* Removes chosen passphrase association.\n* Resets value of modelVersion.", + "operationId": "TextIndependent_ResetProfile", + "summary": "Reset Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/resetProfile.json" + } + }, + "tags": [ + "text-independent" + ], + "responses": { + "204": { + "description": "OK" + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-independent/profiles/{profileId}/enrollments": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "post": { + "description": "Adds an enrollment to existing profile.\nIf the minimum number of requested enrollment audios is reached, a voice print is created.\nIf the voice print was created before, it gets recreated from all existing enrollment audios including the new one.\n\nLimitations:\n* Minimum audio input length per request is **1 second**\n* Maximum audio input length per request is **120 seconds**\n* Minimum total effective speech length (excluding silence and other non-speech frames) for creating a voiceprint is **20 seconds**\n This limitation can be disabled by setting ignoreMinLength to **true**.\n\n* Maximum total audio input length allowed for creating a voiceprint is **300 seconds**\n* Minimum audio Signal-to-noise ratio (SNR) is **0dB**", + "operationId": "TextIndependent_CreateEnrollment", + "summary": "Enroll Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/createEnrollment.json" + } + }, + "tags": [ + "text-independent" + ], + "consumes": [ + "audio/wav; codecs=audio/pcm" + ], + "parameters": [ + { + "in": "query", + "name": "ignoreMinLength", + "type": "boolean", + "description": "If true, a voice print will be created immediately for this profile regardless of how much speech is supplied or stored. Default is false." + }, + { + "name": "audioData", + "in": "body", + "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.", + "required": true, + "schema": { + "type": "object", + "format": "file" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/TiEnrollmentInfo" + } + }, + "400": { + "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length per enrollment request is 120 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length per enrollment request is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is 16Khz 16bit Mono PCM.\n* InvalidArgument - Invalid ignoreMinLength parameter value. Valid values are \"true\" and \"false\".\n* InvalidRequest - Minimum audio Signal-to-noise ratio (SNR) is 0dB\n* InvalidRequest - Audio is too noisy. The minimum allowed Signal-to-noise ratio (SNR) is 0dB.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Audio is too noisy." + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "403": { + "description": "Forbidden\n* InvalidRequest - Maximum allowed length across all profile enrollments is 300 seconds.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Maximum allowed length across all profile enrollments is 300 seconds." + } + } + }, + "x-ms-error-response": true + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "409": { + "description": "Conflict\n* Conflict - Sending concurrent requests on same profile is not allowed.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "Conflict", + "message": "Sending concurrent requests on same profile is not allowed." + } + } + }, + "x-ms-error-response": true + }, + "415": { + "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "x-ms-error-response": true + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-independent/profiles/identifySingleSpeaker": { + "post": { + "description": "Identifies who is speaking in input audio among a list of candidate profiles.\n\nLimitations:\n* Minimum audio input length is **1 second**\n* Maximum audio input length is **120 seconds**\n* Minimum candidate speakers count is **1**\n* Maximum candidate speakers count is **50**\n* Minimum effective speech length (excluding silence and other non-speech frames) is **4 seconds**\n This limitation can be disabled by setting \"ignoreMinLength\" to **true**.\n\n* Minimum audio Signal-to-noise ratio (SNR) is **0dB**", + "operationId": "TextIndependent_IdentifySingleSpeaker", + "summary": "Identify Single Speaker Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/identifySingleSpeaker.json" + } + }, + "tags": [ + "text-independent" + ], + "consumes": [ + "audio/wav; codecs=audio/pcm" + ], + "parameters": [ + { + "in": "query", + "name": "profileIds", + "type": "string", + "required": true, + "description": "Comma-delimited profile IDs. Maximum supported number is 50 IDs." + }, + { + "in": "query", + "name": "ignoreMinLength", + "type": "boolean", + "description": "If true, the minimum amount of speech needed for identification is skipped. Default is false." + }, + { + "name": "audioData", + "in": "body", + "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.", + "required": true, + "schema": { + "type": "object", + "format": "file" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IdentifiedSingleSpeakerInfo" + } + }, + "400": { + "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length per recognition request is 120 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length per recognition request is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is 16Khz 16bit Mono PCM.\n* InvalidArgument - Invalid ignoreMinLength parameter value. Valid values are \"true\" and \"false\".\n* InvalidArgument - Invalid profileIds parameter value. It should be comma-delimited list of IDs containing at least one ID.\n* InvalidRequest - profileIds parameter is missing. It should be comma-delimited list of IDs containing at least one ID.\n* InvalidRequest - Invalid group of profiles. Profiles must have the same locale.\n* InvalidRequest - Maximum number of profiles allowed per request is 50.\n* InvalidRequest - Minimum audio Signal-to-noise ratio (SNR) is 0dB\n* InvalidRequest - Profile is not enrolled.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Profile is not enrolled." + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "415": { + "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "x-ms-error-response": true + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + } + }, + "tags": [] +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createEnrollment.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createEnrollment.json new file mode 100644 index 000000000000..b7eb28955a51 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createEnrollment.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "audio/wav; codecs=audio/pcm", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "audioData": "{binary file date}" + }, + "responses": { + "201": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "enrollmentStatus": "Enrolling", + "enrollmentsCount": 1, + "enrollmentsLength": 1.83, + "enrollmentsSpeechLength": 1.35, + "remainingEnrollmentsSpeechLength": 18.65, + "audioLength": 1.83, + "audioSpeechLength": 1.35 + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Audio is too noisy." + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "403": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Maximum allowed length across all profile enrollments is 300 seconds." + } + } + }, + "404": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "409": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Conflict", + "message": "Sending concurrent requests on same profile is not allowed." + } + } + }, + "415": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createProfile.json new file mode 100644 index 000000000000..f20460a77a87 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/createProfile.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileInfo": { + "locale": "en-us" + } + }, + "responses": { + "201": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "locale": "en-US", + "enrollmentStatus": "Enrolling", + "createdDateTime": "2015-04-23T18:25:43.41Z", + "lastUpdatedDateTime": "2015-04-23T18:25:43.41Z", + "enrollmentsCount": 0, + "enrollmentsLength": 0, + "enrollmentsSpeechLength": 0, + "remainingEnrollmentsSpeechLength": 20, + "modelVersion": "2019-12-05" + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Request body is missing." + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "403": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Forbidden", + "message": "Maximum allowed number of profiles is 10,000." + } + } + }, + "415": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'application/JSON' is accepted." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/deleteProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/deleteProfile.json new file mode 100644 index 000000000000..1af07b0b1a4f --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/deleteProfile.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f" + }, + "responses": { + "204": { + "headers": { + "Content-Type": "application/json" + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/fetchProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/fetchProfile.json new file mode 100644 index 000000000000..5ab27b08d95f --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/fetchProfile.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "locale": "en-US", + "enrollmentStatus": "Enrolling", + "createdDateTime": "2015-04-23T18:25:43.41Z", + "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z", + "enrollmentsCount": 1, + "enrollmentsLength": 1.83, + "enrollmentsSpeechLength": 1.35, + "remainingEnrollmentsSpeechLength": 18.65, + "modelVersion": "2019-12-05" + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "404": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/identifySingleSpeaker.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/identifySingleSpeaker.json new file mode 100644 index 000000000000..927ec1be8ab0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/identifySingleSpeaker.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "audio/wav; codecs=audio/pcm", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileIds": "3669fa29-1bf3-45ad-beea-6b348d058d7e,111f427c-3791-468f-b709-fcef7660fff9,0e196cd9-32d5-4883-8631-54a0e7c7cb3d,0e196cd9-32d5-4883-8631-54a0e7c7cb3d,726e57d9-04e0-4214-b482-7f786fa83560,f95189fd-1bf5-4485-9c2e-e5897e0c98ca", + "audioData": "{binary file date}" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "identifiedProfile": { + "profileId": "111f427c-3791-468f-b709-fcef7660fff9", + "score": 0.63 + }, + "profilesRanking": [ + { + "profileId": "111f427c-3791-468f-b709-fcef7660fff9", + "score": 0.63 + }, + { + "profileId": "3669fa29-1bf3-45ad-beea-6b348d058d7e", + "score": 0.49 + }, + { + "profileId": "0e196cd9-32d5-4883-8631-54a0e7c7cb3d", + "score": 0.4 + }, + { + "profileId": "726e57d9-04e0-4214-b482-7f786fa83560", + "score": 0.1 + }, + { + "profileId": "f95189fd-1bf5-4485-9c2e-e5897e0c98ca", + "score": 0.03 + } + ] + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Profile is not enrolled." + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "415": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/listProfiles.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/listProfiles.json new file mode 100644 index 000000000000..1e6916cfd8e0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/listProfiles.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profiles": [ + { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "locale": "en-US", + "enrollmentStatus": "Enrolling", + "createdDateTime": "2015-04-23T18:25:43.41Z", + "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z", + "enrollmentsCount": 1, + "enrollmentsLength": 1.83, + "enrollmentsSpeechLength": 1.35, + "remainingEnrollmentsSpeechLength": 18.65, + "modelVersion": "2019-12-05" + } + ], + "@nextLink": "https://{Endpoint}/text-independent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5" + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidArgument", + "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]" + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/resetProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/resetProfile.json new file mode 100644 index 000000000000..83389ad8eb82 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/preview/v2.0/examples/resetProfile.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f" + }, + "responses": { + "204": { + "headers": { + "Content-Type": "application/json" + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "404": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md new file mode 100644 index 000000000000..9f3e28757065 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md @@ -0,0 +1,67 @@ +# Cognitive Services Speaker Recognition SDKs + +> see https://aka.ms/autorest + +Configuration for generating Speaker Verification SDK. + +``` yaml +tag: identification_2_0_preview +add-credentials: true +openapi-type: data-plane +``` + +The current release for the Authoring Endpoint is `identification_2_0_preview`. + +# Releases + +## Identification 2.0 +These settings apply only when `--tag=identification_2_0_preview` is specified on the command line. + +``` yaml $(tag) == 'identification_2_0_preview' +input-file: preview/v2.0/Identification.json +``` + +--- + +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +### CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + sync-methods: None + license-header: MICROSOFT_MIT_NO_VERSION + azure-arm: false + namespace: Microsoft.Azure.CognitiveServices.speech.speaker.identification + output-folder: $(csharp-sdks-folder)/CognitiveServices/speech.speaker.identification/src/Generated + clear-output-folder: true +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.cognitiveservices.speech.speaker.identification + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/speech/speaker/identification + with-optional-parameters: true + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.nodejs.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.nodejs.md new file mode 100644 index 000000000000..8e7f4305b148 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + package-name: azure-cognitiveservices-speech-speaker-identification + output-folder: $(node-sdks-folder)/lib/services/speech/speaker/identification + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.python.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.python.md new file mode 100644 index 000000000000..f80705467b9c --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.python.md @@ -0,0 +1,26 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.speech.speaker.identification + package-name: azure-cognitiveservices-speech-speaker + clear-output-folder: true + +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/cognitiveservices/speech/speaker/identification +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-speech-speaker +``` diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.typescript.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.typescript.md new file mode 100644 index 000000000000..f7fae2db4c68 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-speaker-identification" + output-folder: "$(typescript-sdks-folder)/sdk/cognitiveservices/cognitiveservices-speaker-identification" + azure-arm: false + generate-metadata: true +``` diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/Verification.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/Verification.json new file mode 100644 index 000000000000..2530e8f3ea1c --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/Verification.json @@ -0,0 +1,1408 @@ +{ + "swagger": "2.0", + "info": { + "title": "Speaker Verification API", + "version": "2.0", + "description": "This API is currently available in:\n\n* West US - westus.api.cognitive.microsoft.com" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}/speaker/verification/v2.0", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "apiKeyHeader": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header" + } + }, + "security": [ + { + "apiKeyHeader": [] + } + ], + "parameters": { + "Endpoint": { + "name": "Endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "x-ms-parameter-location": "client", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + }, + "profileIdParam": { + "in": "path", + "name": "profileId", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false, + "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}$", + "description": "Unique identifier for profile id (guid).", + "x-ms-parameter-location": "method" + }, + "localeParam": { + "in": "path", + "name": "locale", + "required": true, + "type": "string", + "x-nullable": false, + "pattern": "^[a-zA-Z]{2}-?[a-zA-Z]{2}$", + "description": "A combination of language code and country code.", + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "ProfileId": { + "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}$", + "description": "Unique identifier for profile id (guid).", + "format": "uuid", + "x-nullable": false, + "example": "49a36324-fc4b-4387-aa06-090cfbf0064f" + }, + "Locale": { + "type": "string", + "pattern": "^[a-zA-Z]{2}-?[a-zA-Z]{2}$", + "description": "Language identifier consisting of a combination of language code and country code.", + "x-nullable": false, + "example": "en-US" + }, + "EnrollmentStatus": { + "type": "string", + "description": "Status representing the current state of the profile. Available values are:\n* Enrolling: profile has no voice print and not ready for recognition requests.\n* Training: voice print of profile is being created and can’t be used for recognition at the moment.\n* Enrolled: profile has a voice print and ready for recognition requests.", + "enum": [ + "Enrolling", + "Training", + "Enrolled" + ], + "x-ms-enum": { + "name": "TrainingStatusType", + "modelAsString": false + }, + "example": "Enrolling" + }, + "CreatedDateTime": { + "type": "string", + "description": "Profile creation datetime.", + "example": "2015-04-23T18:25:43.41Z" + }, + "LastUpdatedDateTime": { + "type": "string", + "description": "Last datetime when the profile was updated.", + "example": "2015-04-23T19:34:51.52Z" + }, + "EnrollmentsCount": { + "type": "integer", + "description": "Number of enrolment audios accepted for this profile.", + "example": 1 + }, + "EnrollmentsLength": { + "type": "number", + "description": "Total length of enrollment audios accepted for this profile in seconds.", + "example": 1.83 + }, + "EnrollmentsSpeechLength": { + "type": "number", + "description": "Summation of pure speech (which is the amount of audio after removing silence and non-speech segments) across all profile enrollments in seconds.", + "example": 1.35 + }, + "RemainingEnrollmentsCount": { + "type": "integer", + "description": "Number of enrollment audios needed to complete profile enrollment.", + "example": 2 + }, + "RemainingEnrollmentsSpeechLength": { + "type": "number", + "description": "Amount of pure speech (which is the amount of audio after removing silence and non-speech segments) needed to complete profile enrollment in seconds.", + "example": 18.65 + }, + "ModelVersion": { + "type": "string", + "pattern": "^\\d{4}-\\d{2}-\\d{2}$", + "description": "Date specifying the model assigned to this profile. Format is yyyy-mm-dd. If profile has no enrollments, this value will be empty.", + "example": "2019-12-05" + }, + "LocaleInfo": { + "description": "Speaker profile locale", + "properties": { + "locale": { + "$ref": "#/definitions/Locale" + } + } + }, + "TdProfileInfoList": { + "description": "Text-Dependent Speaker profile info list", + "properties": { + "profiles": { + "items": { + "$ref": "#/definitions/TdProfileInfo" + } + }, + "@nextLink": { + "type": "string", + "example": "https://{Endpoint}/text-dependent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5" + } + } + }, + "TdProfileInfo": { + "description": "Text-Dependent Speaker profile info", + "properties": { + "profileId": { + "$ref": "#/definitions/ProfileId" + }, + "locale": { + "$ref": "#/definitions/Locale" + }, + "enrollmentStatus": { + "$ref": "#/definitions/EnrollmentStatus" + }, + "createdDateTime": { + "$ref": "#/definitions/CreatedDateTime" + }, + "lastUpdatedDateTime": { + "$ref": "#/definitions/LastUpdatedDateTime" + }, + "enrollmentsCount": { + "$ref": "#/definitions/EnrollmentsCount" + }, + "enrollmentsLength": { + "$ref": "#/definitions/EnrollmentsLength" + }, + "enrollmentsSpeechLength": { + "$ref": "#/definitions/EnrollmentsSpeechLength" + }, + "remainingEnrollmentsCount": { + "$ref": "#/definitions/RemainingEnrollmentsCount" + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion" + } + } + }, + "TdEnrollmentInfo": { + "description": "Text-Dependent Speaker profile enrollment info", + "properties": { + "profileId": { + "$ref": "#/definitions/ProfileId" + }, + "enrollmentStatus": { + "$ref": "#/definitions/EnrollmentStatus" + }, + "enrollmentsCount": { + "$ref": "#/definitions/EnrollmentsCount" + }, + "enrollmentsLength": { + "$ref": "#/definitions/EnrollmentsLength" + }, + "enrollmentsSpeechLength": { + "$ref": "#/definitions/EnrollmentsSpeechLength" + }, + "remainingEnrollmentsCount": { + "$ref": "#/definitions/RemainingEnrollmentsCount" + }, + "passPhrase": { + "type": "string", + "description": "Passphrase associated with this enrollment.", + "example": "my voice is my passport verify me" + }, + "audioLength": { + "type": "number", + "description": "This enrolment audio length in seconds.", + "example": 1.83 + }, + "audioSpeechLength": { + "type": "number", + "description": "This enrollment audio pure speech (which is the amount of audio after removing silence and non-speech segments) length in seconds.", + "example": 1.35 + } + } + }, + "TiProfileInfoList": { + "description": "Text-Independent Speaker profile info list", + "properties": { + "profiles": { + "items": { + "$ref": "#/definitions/TiProfileInfo" + } + }, + "@nextLink": { + "type": "string", + "example": "https://{Endpoint}/text-independent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5" + } + } + }, + "TiProfileInfo": { + "description": "Text-Independent Speaker profile info", + "properties": { + "profileId": { + "$ref": "#/definitions/ProfileId" + }, + "locale": { + "$ref": "#/definitions/Locale" + }, + "enrollmentStatus": { + "$ref": "#/definitions/EnrollmentStatus" + }, + "createdDateTime": { + "$ref": "#/definitions/CreatedDateTime" + }, + "lastUpdatedDateTime": { + "$ref": "#/definitions/LastUpdatedDateTime" + }, + "enrollmentsCount": { + "$ref": "#/definitions/EnrollmentsCount" + }, + "enrollmentsLength": { + "$ref": "#/definitions/EnrollmentsLength" + }, + "enrollmentsSpeechLength": { + "$ref": "#/definitions/EnrollmentsSpeechLength" + }, + "remainingEnrollmentsSpeechLength": { + "$ref": "#/definitions/RemainingEnrollmentsSpeechLength" + }, + "modelVersion": { + "$ref": "#/definitions/ModelVersion" + } + } + }, + "TiEnrollmentInfo": { + "description": "Text-Independent Speaker profile enrollment info", + "properties": { + "profileId": { + "$ref": "#/definitions/ProfileId" + }, + "enrollmentStatus": { + "$ref": "#/definitions/EnrollmentStatus" + }, + "enrollmentsCount": { + "$ref": "#/definitions/EnrollmentsCount" + }, + "enrollmentsLength": { + "$ref": "#/definitions/EnrollmentsLength" + }, + "enrollmentsSpeechLength": { + "$ref": "#/definitions/EnrollmentsSpeechLength" + }, + "remainingEnrollmentsSpeechLength": { + "$ref": "#/definitions/RemainingEnrollmentsSpeechLength" + }, + "audioLength": { + "type": "number", + "description": "This enrolment audio length in seconds.", + "example": 1.83 + }, + "audioSpeechLength": { + "type": "number", + "description": "This enrollment audio pure speech (which is the amount of audio after removing silence and non-speech segments) length in seconds.", + "example": 1.35 + } + } + }, + "RecognitionInfo": { + "description": "Speaker recognition result", + "properties": { + "recognitionResult": { + "type": "string", + "description": "Does audio belong to targeted profile?", + "enum": [ + "accept", + "reject" + ], + "x-ms-enum": { + "name": "ResultType", + "modelAsString": false + }, + "example": "Accept" + }, + "score": { + "type": "number", + "description": "A float number indicating the similarity between input audio and targeted voice print. This number must be between 0 and 1. A higher number means higher similarity.", + "example": 0.63 + } + } + }, + "Error": { + "description": "Speaker error message", + "required": [ + "error" + ], + "properties": { + "error": { + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + } + } + } + } + } + }, + "responses": { + "NotFound": { + "description": "NotFound - Requested profile doesn't exist", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "x-ms-error-response": true + }, + "Unauthorized": { + "description": "Request is not authorized. Make sure subscription key is included and valid.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "x-ms-error-response": true + }, + "RateLimit": { + "description": "Rate limit is exceeded.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "x-ms-error-response": true + }, + "ServerError": { + "description": "Internal Server Error.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + }, + "x-ms-error-response": true + } + }, + "paths": { + "/text-dependent/profiles": { + "post": { + "description": "Create a new speaker profile with specified locale.\nOne subscription can create 10,000 speaker profiles at most.", + "operationId": "TextDependent_CreateProfile", + "summary": "Create Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/textDependentCreateProfile.json" + } + }, + "tags": [ + "text-dependent" + ], + "parameters": [ + { + "in": "body", + "name": "profileInfo", + "description": "Provide following detail info when creating a new profile.\nFields | Description\n------- | ------------\nlocale | Locale for the language of this speaker profile. A complete supported locale list is here:
  • **en-US**
", + "schema": { + "required": [ + "locale" + ], + "$ref": "#/definitions/LocaleInfo" + } + } + ], + "responses": { + "201": { + "description": "Speaker profile created successfully. GUID is returned to reference the created profile.", + "headers": { + "Location": { + "type": "string", + "description": "url location of new resource" + } + }, + "schema": { + "$ref": "#/definitions/TdProfileInfo" + } + }, + "400": { + "description": "Bad Request\n* InvalidRequest - Request body is missing.\n* InvalidRequest - Invalid JSON format.\n* InvalidRequest - Locale parameter is missing.\n* InvalidArgument - Invalid locale value. Supported locales are {comma-separated list of locales}.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Request body is missing." + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "403": { + "description": "Forbidden - Maximum allowed number of profiles is 10,000.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "Forbidden", + "message": "Maximum allowed number of profiles is 10,000." + } + } + }, + "x-ms-error-response": true + }, + "415": { + "description": "UnsupportedMediaType - Unsupported media type. Only 'application/JSON' is accepted.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'application/JSON' is accepted." + } + } + }, + "x-ms-error-response": true + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + }, + "get": { + "x-ms-pageable": { + "nextLinkName": "@nextLink", + "itemName": "profiles" + }, + "description": "Retrieves a set of profiles.\nProfiles are sorted alphabetically by ProfileId", + "operationId": "TextDependent_ListProfiles", + "summary": "List Profiles", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/textDependentListProfiles.json" + } + }, + "tags": [ + "text-dependent" + ], + "parameters": [ + { + "in": "query", + "name": "$top", + "description": "The number of profiles to return. Default is 100 and the maximum is 500", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TdProfileInfoList" + } + }, + "400": { + "description": "Bad Request\n* InvalidArgument - Invalid $top parameter value. Value should be positive integer in the range [1, 500].\n* InvalidArgument - Invalid $continuationToken value. $continuationToken must be generated form a prior API call.\n* InvalidArgument - $filter parameter is not supported.\n* InvalidArgument - $skip parameter is not supported.\n* InvalidArgument - $orderBy parameter is not supported.\n* InvalidArgument - $delta parameter is not supported.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidArgument", + "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]" + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-dependent/profiles/{profileId}": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "get": { + "description": "Retrieves a single profile by ID.", + "operationId": "TextDependent_GetProfile", + "summary": "Retrieve Single Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/textDependentFetchProfile.json" + } + }, + "tags": [ + "text-dependent" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TdProfileInfo" + } + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + }, + "delete": { + "description": "Deletes an existing profile.", + "operationId": "TextDependent_DeleteProfile", + "summary": "Delete Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/deleteProfile.json" + } + }, + "tags": [ + "text-dependent" + ], + "responses": { + "204": { + "description": "OK" + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-dependent/profiles/{profileId}/reset": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "post": { + "description": "Resets existing profile to its original creation state. The reset operation does the following:\n* Updates enrollmentStatus to Enrolling.\n* Updates lastUpdatedDateTime.\n* Updates enrollmentsCount to 0.\n* Updates enrollmentsLength to 0.\n* Updates enrollmentsSpeechLength to 0.\n* Updates remainingEnrollmentsCount to the initial required number.\n* Removes all associated enrollments from storage.\n* Removes chosen passphrase association.\n* Resets value of modelVersion.", + "operationId": "TextDependent_ResetProfile", + "summary": "Reset Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/resetProfile.json" + } + }, + "tags": [ + "text-dependent" + ], + "responses": { + "204": { + "description": "OK" + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-dependent/profiles/{profileId}/enrollments": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "post": { + "description": "Adds an enrollment to existing profile.\nIf the minimum number of requested enrollment audios is reached, a voice print is created.\nIf the voice print was created before, it gets recreated from all existing enrollment audios including the new one.\n\nLimitations:\n* Minimum audio input length per request is **1 second**\n* Maximum audio input length per request is **10 seconds**\n* Minimum number of enrollments for creating a voiceprint is **3**\n* Maximum number of enrollments for creating a voiceprint is **50**\n* Minimum audio Signal-to-noise ratio (SNR) is **10dB**\n\nConstraints:\n* First enrollment must match an existing passphrase.\n* All enrollments after the first one, must use the same passphrase used in the first enrollment.", + "operationId": "TextDependent_CreateEnrollment", + "summary": "Enroll Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/textDependentCreateEnrollment.json" + } + }, + "tags": [ + "text-dependent" + ], + "consumes": [ + "audio/wav; codecs=audio/pcm" + ], + "parameters": [ + { + "name": "audioData", + "in": "body", + "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.", + "required": true, + "schema": { + "type": "object", + "format": "file" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/TdEnrollmentInfo" + } + }, + "400": { + "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length is 10 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is WAV 16Khz 16bit Mono PCM.\n* InvalidRequest - Invalid passphrase.\n* InvalidRequest - Audio is too noisy. The minimum allowed Signal-to-noise ratio (SNR) is 10dB.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Audio is too noisy." + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "403": { + "description": "Forbidden\n* InvalidOperation - Maximum allowed number of enrollments per profile is 50.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidOperation", + "message": "Maximum allowed number of enrollments per profile is 50." + } + } + }, + "x-ms-error-response": true + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "409": { + "description": "Conflict\n* Conflict - Sending concurrent requests on same profile is not allowed.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "Conflict", + "message": "Sending concurrent requests on same profile is not allowed." + } + } + }, + "x-ms-error-response": true + }, + "415": { + "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "x-ms-error-response": true + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-dependent/profiles/{profileId}/verify": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "post": { + "description": "Verifies existing profiles against input audio.\n\nLimitations:\n* Minimum audio input length per request is **1 second**\n* Maximum audio input length per request is **10 seconds**\n* Minimum audio Signal-to-noise ratio (SNR) is **10 dB**", + "operationId": "TextDependent_VerifyProfile", + "summary": "Verify Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/verify.json" + } + }, + "tags": [ + "text-dependent" + ], + "consumes": [ + "audio/wav; codecs=audio/pcm" + ], + "parameters": [ + { + "name": "audioData", + "in": "body", + "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.", + "required": true, + "schema": { + "type": "object", + "format": "file" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecognitionInfo" + } + }, + "400": { + "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length is 10 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is 16Khz 16bit Mono PCM.\n* InvalidRequest - Audio is too noisy. The minimum allowed Signal-to-noise ratio (SNR) is 10dB.\n* InvalidRequest - Profile is not enrolled.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Profile is not enrolled." + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "415": { + "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "x-ms-error-response": true + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-dependent/phrases/{locale}": { + "parameters": [ + { + "$ref": "#/parameters/localeParam" + } + ], + "get": { + "description": "Retrieves list of supported passphrases for a specific locale.", + "operationId": "TextDependent_ListPhrases", + "summary": "Pass Phrases", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/phrases.json" + } + }, + "tags": [ + "text-dependent" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "items": { + "type": "string" + }, + "example": [ + "my voice is my passport verify me", + "my voice is stronger than passwords" + ] + } + }, + "400": { + "description": "Bad Request\n* InvalidRequest - Locale parameter is missing.\n* InvalidArgument - Invalid locale value. Supported locales are {comma-separated list of locales}.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Locale parameter is missing." + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-independent/profiles": { + "post": { + "description": "Creates a new speaker profile with specified locale.\nOne subscription can create 10,000 speaker profiles at most.", + "operationId": "TextIndependent_CreateProfile", + "summary": "Create Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/textIndependentCreateProfile.json" + } + }, + "tags": [ + "text-independent" + ], + "parameters": [ + { + "in": "body", + "name": "profileInfo", + "description": "Provide following detail info when creating a new profile.\nFields | Description\n------- | ------------\nlocale | Locale for the language of this speaker profile. A complete supported locale list is here:
  • **en-US**
  • **es-ES**
  • **fr-FR**
  • **zh-CN**
  • **de-DE**
  • **en-GB**
  • **en-AU**
  • **en-CA**
  • **fr-CA**
  • **it-IT**
  • **es-MX**
  • **ja-JP**
  • **pt-BR**
  • **en-IN**
", + "schema": { + "required": [ + "locale" + ], + "$ref": "#/definitions/LocaleInfo" + } + } + ], + "responses": { + "201": { + "description": "Speaker profile created successfully. GUID is returned to reference the created profile.", + "headers": { + "Location": { + "type": "string", + "description": "url location of new resource" + } + }, + "schema": { + "$ref": "#/definitions/TiProfileInfo" + } + }, + "400": { + "description": "Bad Request\n* InvalidRequest - Request body is missing.\n* InvalidRequest - Invalid JSON format.\n* InvalidRequest - Locale parameter is missing.\n* InvalidArgument - Invalid locale value. Supported locales are {comma-separated list of locales}.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Request body is missing." + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "403": { + "description": "Forbidden - Maximum allowed number of profiles is 10,000.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "Forbidden", + "message": "Maximum allowed number of profiles is 10,000." + } + } + }, + "x-ms-error-response": true + }, + "415": { + "description": "UnsupportedMediaType - Unsupported media type. Only 'application/JSON' is accepted.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'application/JSON' is accepted." + } + } + }, + "x-ms-error-response": true + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + }, + "get": { + "x-ms-pageable": { + "nextLinkName": "@nextLink" + }, + "description": "Retrieves a set of profiles.\nProfiles are sorted alphabetically by ProfileId", + "operationId": "TextIndependent_ListProfiles", + "summary": "List Profiles", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/textIndependentListProfiles.json" + } + }, + "tags": [ + "text-independent" + ], + "parameters": [ + { + "in": "query", + "name": "$top", + "description": "The number of profiles to return. Default is 100 and the maximum is 500", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TiProfileInfoList" + } + }, + "400": { + "description": "Bad Request\n* InvalidArgument - Invalid $top parameter value. Value should be positive integer in the range [1, 500].\n* InvalidArgument - Invalid $continuationToken value. $continuationToken must be generated form a prior API call.\n* InvalidArgument - $filter parameter is not supported.\n* InvalidArgument - $skip parameter is not supported.\n* InvalidArgument - $orderBy parameter is not supported.\n* InvalidArgument - $delta parameter is not supported.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidArgument", + "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]" + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-independent/profiles/{profileId}": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "get": { + "description": "Retrieves a single profile by ID.", + "operationId": "TextIndependent_GetProfile", + "summary": "Retrieve Single Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/textIndependentFetchProfile.json" + } + }, + "tags": [ + "text-independent" + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TiProfileInfo" + } + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + }, + "delete": { + "description": "Deletes an existing profile.", + "operationId": "TextIndependent_DeleteProfile", + "summary": "Delete Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/deleteProfile.json" + } + }, + "tags": [ + "text-independent" + ], + "responses": { + "204": { + "description": "OK" + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-independent/profiles/{profileId}/reset": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "post": { + "description": "Resets existing profile to its original creation state. The reset operation does the following:\n* Updates enrollmentStatus to Enrolling.\n* Updates lastUpdatedDateTime.\n* Updates enrollmentsCount to 0.\n* Updates enrollmentsLength to 0.\n* Updates enrollmentsSpeechLength to 0.\n* Updates remainingEnrollmentsSpeechLength to the required number.\n* Removes all associated enrollments from storage.\n* Removes chosen passphrase association.\n* Resets value of modelVersion.", + "operationId": "TextIndependent_ResetProfile", + "summary": "Reset Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/resetProfile.json" + } + }, + "tags": [ + "text-independent" + ], + "responses": { + "204": { + "description": "OK" + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-independent/profiles/{profileId}/enrollments": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "post": { + "description": "Adds enrollments to existing profile.\nIf the minimum number of requested enrollment audios is reached, a voice print is created.\nIf the voice print was created before, it gets recreated from all existing enrollment including the new one.\n\nLimitations:\n* Minimum audio input length per request is **1 second**\n* Maximum audio input length per request is **120 seconds**\n* Minimum total effective speech length (excluding silence and other non-speech frames) for creating a voiceprint is **20 seconds**\n This limitation can be disabled by setting \"ignoreMinLength\" to **true**.\n\n* Maximum total audio input length allowed for creating a voiceprint is **300 seconds**\n* Minimum audio Signal-to-noise ratio (SNR) is **0dB**", + "operationId": "TextIndependent_CreateEnrollment", + "summary": "Enroll Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/textIndependentCreateEnrollment.json" + } + }, + "tags": [ + "text-independent" + ], + "consumes": [ + "audio/wav; codecs=audio/pcm" + ], + "parameters": [ + { + "in": "query", + "name": "ignoreMinLength", + "type": "boolean", + "description": "If true, a voice print will be created immediately for this profile regardless of how much speech is supplied or stored. Default is false." + }, + { + "name": "audioData", + "in": "body", + "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.", + "required": true, + "schema": { + "type": "object", + "format": "file" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/TiEnrollmentInfo" + } + }, + "400": { + "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length per enrollment request is 120 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length per enrollment request is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is 16Khz 16bit Mono PCM.\n* InvalidArgument - Invalid ignoreMinLength parameter value. Valid values are \"true\" and \"false\".\n* InvalidRequest - Audio is too noisy. The minimum allowed Signal-to-noise ratio (SNR) is 0dB.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Audio is too noisy." + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "403": { + "description": "Forbidden\n* InvalidRequest - Maximum allowed length across all profile enrollments is 300 seconds.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Maximum allowed length across all profile enrollments is 300 seconds." + } + } + }, + "x-ms-error-response": true + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "409": { + "description": "Conflict\n* Conflict - Sending concurrent requests on same profile is not allowed.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "Conflict", + "message": "Sending concurrent requests on same profile is not allowed." + } + } + }, + "x-ms-error-response": true + }, + "415": { + "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "x-ms-error-response": true + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + }, + "/text-independent/profiles/{profileId}/verify": { + "parameters": [ + { + "$ref": "#/parameters/profileIdParam" + } + ], + "post": { + "description": "Verifies existing profiles against input audio.\n\nLimitations:\n* Minimum audio input length is **1 second**\n* Maximum audio input length is **120 seconds**\n* Minimum effective speech length (excluding silence and other \"non-speech\" frames) is **4 seconds**\n This limitation can be disabled by setting \"ignoreMinLength\" to **true**.\n* Minimum audio Signal-to-noise ratio (SNR) is **0dB**", + "operationId": "TextIndependent_VerifyProfile", + "summary": "Verify Profile", + "x-ms-examples": { + "Successful Query": { + "$ref": "./examples/verify.json" + } + }, + "tags": [ + "text-independent" + ], + "consumes": [ + "audio/wav; codecs=audio/pcm" + ], + "parameters": [ + { + "in": "query", + "name": "ignoreMinLength", + "type": "boolean", + "description": "If true, a voice print will be created immediately for this profile regardless of how much speech is supplied or stored. Default is false." + }, + { + "name": "audioData", + "in": "body", + "description": "Binary audio file. Supported formats are audio/wav; codecs=audio/pcm. Supports audio up to 5MB.", + "required": true, + "schema": { + "type": "object", + "format": "file" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecognitionInfo" + } + }, + "400": { + "description": "Bad Request\n* InvalidRequest - Invalid audio length. Maximum allowed length per recognition request is 120 seconds.\n* InvalidRequest - Invalid audio length. Minimum allowed length per recognition request is 1 second.\n* InvalidRequest - Invalid audio format. Supported format is 16Khz 16bit Mono PCM.\n* InvalidArgument - Invalid ignoreMinLength parameter value. Valid values are \"true\" and \"false\".\n* InvalidRequest - Profile is not enrolled.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "InvalidRequest", + "message": "Profile is not enrolled." + } + } + }, + "x-ms-error-response": true + }, + "401": { + "$ref": "#/responses/Unauthorized" + }, + "404": { + "$ref": "#/responses/NotFound" + }, + "415": { + "description": "UnsupportedMediaType - Unsupported media type. Only \"audio/wav; codecs=audio/pcm\" is accepted.", + "schema": { + "$ref": "#/definitions/Error" + }, + "examples": { + "application/json": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "x-ms-error-response": true + }, + "429": { + "$ref": "#/responses/RateLimit" + }, + "500": { + "$ref": "#/responses/ServerError" + } + } + } + } + }, + "tags": [] +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/deleteProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/deleteProfile.json new file mode 100644 index 000000000000..1af07b0b1a4f --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/deleteProfile.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f" + }, + "responses": { + "204": { + "headers": { + "Content-Type": "application/json" + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/phrases.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/phrases.json new file mode 100644 index 000000000000..5bfd15a05c0d --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/phrases.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "locale": "en-US", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/json" + }, + "body": [ + "my voice is my passport verify me", + "my voice is stronger than passwords" + ] + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Locale parameter is missing." + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/resetProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/resetProfile.json new file mode 100644 index 000000000000..83389ad8eb82 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/resetProfile.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f" + }, + "responses": { + "204": { + "headers": { + "Content-Type": "application/json" + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "404": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateEnrollment.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateEnrollment.json new file mode 100644 index 000000000000..6208e8e8a0d3 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateEnrollment.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "audio/wav; codecs=audio/pcm", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "audioData": "{binary file date}" + }, + "responses": { + "201": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "enrollmentStatus": "Enrolling", + "enrollmentsCount": 1, + "enrollmentsLength": 1.83, + "enrollmentsSpeechLength": 1.35, + "remainingEnrollmentsCount": 2, + "passPhrase": "my voice is my passport verify me", + "audioLength": 1.83, + "audioSpeechLength": 1.35 + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Audio is too noisy." + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "403": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Maximum allowed length across all profile enrollments is 300 seconds." + } + } + }, + "404": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "409": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Conflict", + "message": "Sending concurrent requests on same profile is not allowed." + } + } + }, + "415": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateProfile.json new file mode 100644 index 000000000000..823a2804f5ee --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentCreateProfile.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileInfo": { + "locale": "en-us" + } + }, + "responses": { + "201": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "locale": "en-US", + "enrollmentStatus": "Enrolling", + "createdDateTime": "2015-04-23T18:25:43.41Z", + "lastUpdatedDateTime": "2015-04-23T18:25:43.41Z", + "enrollmentsCount": 0, + "enrollmentsLength": 0, + "enrollmentsSpeechLength": 0, + "remainingEnrollmentsCount": 3, + "modelVersion": "2019-12-05" + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Request body is missing." + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "403": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Forbidden", + "message": "Maximum allowed number of profiles is 10,000." + } + } + }, + "415": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'application/JSON' is accepted." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentFetchProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentFetchProfile.json new file mode 100644 index 000000000000..a21e8bdf6c5a --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentFetchProfile.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "locale": "en-US", + "enrollmentStatus": "Enrolling", + "createdDateTime": "2015-04-23T18:25:43.41Z", + "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z", + "enrollmentsCount": 1, + "enrollmentsLength": 1.83, + "enrollmentsSpeechLength": 1.35, + "remainingEnrollmentsCount": 2, + "modelVersion": "2019-12-05" + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "404": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentListProfiles.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentListProfiles.json new file mode 100644 index 000000000000..7126a6fc2a2b --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textDependentListProfiles.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profiles": [ + { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "locale": "en-US", + "enrollmentStatus": "Enrolling", + "createdDateTime": "2015-04-23T18:25:43.41Z", + "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z", + "enrollmentsCount": 1, + "enrollmentsLength": 1.83, + "enrollmentsSpeechLength": 1.35, + "remainingEnrollmentsCount": 2, + "modelVersion": "2019-12-05" + } + ], + "@nextLink": "https://{Endpoint}/text-independent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5" + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidArgument", + "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]" + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateEnrollment.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateEnrollment.json new file mode 100644 index 000000000000..b7eb28955a51 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateEnrollment.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "audio/wav; codecs=audio/pcm", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "audioData": "{binary file date}" + }, + "responses": { + "201": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "enrollmentStatus": "Enrolling", + "enrollmentsCount": 1, + "enrollmentsLength": 1.83, + "enrollmentsSpeechLength": 1.35, + "remainingEnrollmentsSpeechLength": 18.65, + "audioLength": 1.83, + "audioSpeechLength": 1.35 + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Audio is too noisy." + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "403": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Maximum allowed length across all profile enrollments is 300 seconds." + } + } + }, + "404": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "409": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Conflict", + "message": "Sending concurrent requests on same profile is not allowed." + } + } + }, + "415": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateProfile.json new file mode 100644 index 000000000000..f20460a77a87 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentCreateProfile.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileInfo": { + "locale": "en-us" + } + }, + "responses": { + "201": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "locale": "en-US", + "enrollmentStatus": "Enrolling", + "createdDateTime": "2015-04-23T18:25:43.41Z", + "lastUpdatedDateTime": "2015-04-23T18:25:43.41Z", + "enrollmentsCount": 0, + "enrollmentsLength": 0, + "enrollmentsSpeechLength": 0, + "remainingEnrollmentsSpeechLength": 20, + "modelVersion": "2019-12-05" + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Request body is missing." + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "403": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Forbidden", + "message": "Maximum allowed number of profiles is 10,000." + } + } + }, + "415": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'application/JSON' is accepted." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentFetchProfile.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentFetchProfile.json new file mode 100644 index 000000000000..5ab27b08d95f --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentFetchProfile.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "locale": "en-US", + "enrollmentStatus": "Enrolling", + "createdDateTime": "2015-04-23T18:25:43.41Z", + "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z", + "enrollmentsCount": 1, + "enrollmentsLength": 1.83, + "enrollmentsSpeechLength": 1.35, + "remainingEnrollmentsSpeechLength": 18.65, + "modelVersion": "2019-12-05" + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "404": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentListProfiles.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentListProfiles.json new file mode 100644 index 000000000000..1e6916cfd8e0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/textIndependentListProfiles.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "application/json", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "profiles": [ + { + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "locale": "en-US", + "enrollmentStatus": "Enrolling", + "createdDateTime": "2015-04-23T18:25:43.41Z", + "lastUpdatedDateTime": "2015-04-23T19:34:51.52Z", + "enrollmentsCount": 1, + "enrollmentsLength": 1.83, + "enrollmentsSpeechLength": 1.35, + "remainingEnrollmentsSpeechLength": 18.65, + "modelVersion": "2019-12-05" + } + ], + "@nextLink": "https://{Endpoint}/text-independent/profiles?$top=35&$continuationToken=U21pdGg1QmVuOTk5" + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidArgument", + "message": "Invalid $top parameter value. Value should be positive integer in the range [1, 500]" + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/verify.json b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/verify.json new file mode 100644 index 000000000000..5a1bf239e46e --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/preview/v2.0/examples/verify.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "Endpoint": "{Endpoint}", + "Content-Type": "audio/wav; codecs=audio/pcm", + "Ocp-Apim-Subscription-Key": "{API key}", + "profileId": "49a36324-fc4b-4387-aa06-090cfbf0064f", + "audioData": "{binary file date}" + }, + "responses": { + "200": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "recognitionResult": "accept", + "score": 0.63 + } + }, + "400": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Profile is not enrolled." + } + } + }, + "401": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Unauthorized", + "message": "Request is not authorized. Make sure subscription key is included and valid." + } + } + }, + "404": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "Not Found", + "message": "Requested profile doesn't exist" + } + } + }, + "415": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "UnsupportedMediaType", + "message": "Unsupported media type. Only 'audio/wav; codecs=audio/pcm' is accepted." + } + } + }, + "429": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "RateLimit", + "message": "Rate limit is exceeded." + } + } + }, + "500": { + "headers": { + "Content-Type": "application/json" + }, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error." + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md new file mode 100644 index 000000000000..e598998bab07 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md @@ -0,0 +1,67 @@ +# Cognitive Services Speaker Recognition SDKs + +> see https://aka.ms/autorest + +Configuration for generating Speaker Verification SDK. + +``` yaml +tag: verification_2_0_preview +add-credentials: true +openapi-type: data-plane +``` + +The current release for the Authoring Endpoint is `verification_2_0_preview`. + +# Releases + +## verification 2.0 +These settings apply only when `--tag=verification_2_0_preview` is specified on the command line. + +``` yaml $(tag) == 'verification_2_0_preview' +input-file: preview/v2.0/Verification.json +``` + +--- + +# Code Generation + + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +``` yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-js + - repo: azure-sdk-for-node +``` + +### CSharp Settings +These settings apply only when `--csharp` is specified on the command line. +``` yaml $(csharp) +csharp: + sync-methods: None + license-header: MICROSOFT_MIT_NO_VERSION + azure-arm: false + namespace: Microsoft.Azure.CognitiveServices.speech.speaker.verification + output-folder: $(csharp-sdks-folder)/CognitiveServices/speech.speaker.verification/src/Generated + clear-output-folder: true +``` + +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.cognitiveservices.speech.speaker.verification + license-header: MICROSOFT_MIT_NO_CODEGEN + payload-flattening-threshold: 1 + output-folder: $(azure-libraries-for-java-folder)/cognitiveservices/data-plane/speech/speaker/verification + with-optional-parameters: true + with-single-async-method: true +``` diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.nodejs.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.nodejs.md new file mode 100644 index 000000000000..d9965af29de6 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.nodejs.md @@ -0,0 +1,14 @@ +## Node.js + +These settings apply only when `--nodejs` is specified on the command line. +Please also specify `--node-sdks-folder=`. + +``` yaml $(nodejs) +nodejs: + package-name: azure-cognitiveservices-speech-speaker-verification + output-folder: $(node-sdks-folder)/lib/services/speech/speaker/verification + azure-arm: false + generate-license-txt: true + generate-package-json: true + generate-readme-md: true +``` diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.python.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.python.md new file mode 100644 index 000000000000..b5418a87b8b1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.python.md @@ -0,0 +1,26 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.cognitiveservices.speech.speaker.verification + package-name: azure-cognitiveservices-speech-speaker + clear-output-folder: true + +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/cognitiveservices/speech/speaker/verification +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/cognitiveservices/azure-cognitiveservices-speech-speaker +``` diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.typescript.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.typescript.md new file mode 100644 index 000000000000..40bebe3609bd --- /dev/null +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.typescript.md @@ -0,0 +1,12 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +``` yaml $(typescript) +typescript: + package-name: "@azure/cognitiveservices-speaker-verification" + output-folder: "$(typescript-sdks-folder)/sdk/cognitiveservices/cognitiveservices-speaker-verification" + azure-arm: false + generate-metadata: true +``` From 0756ece91c818846eadbdd563da0ad8e158802b1 Mon Sep 17 00:00:00 2001 From: azuresdkci Date: Thu, 28 May 2020 02:57:38 +0000 Subject: [PATCH 023/318] regenerated all-api-versions --- .../Identification/readme.md | 25 +++++++++++++++++++ .../SpeakerRecognition/Verification/readme.md | 25 +++++++++++++++++++ 2 files changed, 50 insertions(+) diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md index 9f3e28757065..3b3cb7393249 100644 --- a/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Identification/readme.md @@ -65,3 +65,28 @@ java: with-optional-parameters: true with-single-async-method: true ``` + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/preview/v2.0/Identification.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` + diff --git a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md index e598998bab07..4a6dcd91654b 100644 --- a/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md +++ b/specification/cognitiveservices/data-plane/SpeakerRecognition/Verification/readme.md @@ -65,3 +65,28 @@ java: with-optional-parameters: true with-single-async-method: true ``` + +## Multi-API/Profile support for AutoRest v3 generators + +AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. + +This block is updated by an automatic script. Edits may be lost! + +``` yaml $(tag) == 'all-api-versions' /* autogenerated */ +# include the azure profile definitions from the standard location +require: $(this-folder)/../../../../../profiles/readme.md + +# all the input files across all versions +input-file: + - $(this-folder)/preview/v2.0/Verification.json + +``` + +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. + +``` yaml $(tag) == 'all-api-versions' +#exclude-file: +# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` + From 7cdfd4fbb6b51758a6277e96b3b950ef73aa0061 Mon Sep 17 00:00:00 2001 From: digavino <48699384+digavino@users.noreply.github.com> Date: Wed, 27 May 2020 20:29:22 -0700 Subject: [PATCH 024/318] Update API specs 2020-04-01 (#9383) * Update API specs 2020-04-01 * Fix place * Fix version * Comments * Fix json * copy check files * Include old examples * Copy file over * Add files * Change version * Try reverting 2020-05-01 changes * Revert 2020-05-01 changes to test * Move version to end of file * Revert "Move version to end of file" This reverts commit 1c972299239680a2d350fabc4c177dda16eb9117. * Revert "Revert 2020-05-01 changes to test" This reverts commit ff0936aadbdf0842916fc9390b9395c7b232ad49. * Revert "Try reverting 2020-05-01 changes" This reverts commit f270e0d0e6e4be79bdccea36a6a1b50671354d0d. * Remove extra ``` * revert breaking 2020-05-01 change * Fix case --- .../CheckFrontdoorNameAvailability.json | 18 + ...tdoorNameAvailabilityWithSubscription.json | 19 + .../2020-04-01/examples/FrontdoorCreate.json | 568 ++++ .../2020-04-01/examples/FrontdoorDelete.json | 12 + .../examples/FrontdoorDisableHttps.json | 13 + .../examples/FrontdoorEnableHttps.json | 25 + .../FrontdoorFrontendEndpointGet.json | 25 + .../FrontdoorFrontendEndpointList.json | 28 + .../2020-04-01/examples/FrontdoorGet.json | 214 ++ .../2020-04-01/examples/FrontdoorList.json | 217 ++ .../2020-04-01/examples/FrontdoorListAll.json | 215 ++ .../examples/FrontdoorPurgeContent.json | 18 + .../examples/FrontdoorRulesEngineCreate.json | 281 ++ .../examples/FrontdoorRulesEngineDelete.json | 13 + .../examples/FrontdoorRulesEngineGet.json | 105 + .../examples/FrontdoorRulesEngineList.json | 108 + .../FrontdoorValidateCustomDomain.json | 20 + .../examples/WafListManagedRuleSets.json | 69 + .../2020-04-01/examples/WafListPolicies.json | 130 + .../examples/WafPolicyCreateOrUpdate.json | 492 ++++ .../2020-04-01/examples/WafPolicyDelete.json | 13 + .../2020-04-01/examples/WafPolicyGet.json | 127 + .../stable/2020-04-01/frontdoor.json | 2350 +++++++++++++++++ .../stable/2020-04-01/network.json | 167 ++ .../2020-04-01/webapplicationfirewall.json | 902 +++++++ .../frontdoor/resource-manager/readme.go.md | 10 + .../frontdoor/resource-manager/readme.md | 18 + 27 files changed, 6177 insertions(+) create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckFrontdoorNameAvailability.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckFrontdoorNameAvailabilityWithSubscription.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorCreate.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorDelete.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorDisableHttps.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorEnableHttps.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorFrontendEndpointGet.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorFrontendEndpointList.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorGet.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorList.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorListAll.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorPurgeContent.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineCreate.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineDelete.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineGet.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineList.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorValidateCustomDomain.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafListManagedRuleSets.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafListPolicies.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyCreateOrUpdate.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyDelete.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyGet.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/frontdoor.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/network.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckFrontdoorNameAvailability.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckFrontdoorNameAvailability.json new file mode 100644 index 000000000000..6ed0361df5f9 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckFrontdoorNameAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "checkFrontDoorNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Network/frontDoors" + } + }, + "responses": { + "200": { + "body": { + "nameAvailability": "Unavailable", + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckFrontdoorNameAvailabilityWithSubscription.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckFrontdoorNameAvailabilityWithSubscription.json new file mode 100644 index 000000000000..a75e065770e8 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckFrontdoorNameAvailabilityWithSubscription.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "checkFrontDoorNameAvailabilityInput": { + "name": "sampleName", + "type": "Microsoft.Network/frontDoors/frontendEndpoints" + } + }, + "responses": { + "200": { + "body": { + "nameAvailability": "Unavailable", + "reason": "Name is already in use", + "message": "Name not available" + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorCreate.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorCreate.json new file mode 100644 index 000000000000..252b26e1fa78 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorCreate.json @@ -0,0 +1,568 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1", + "frontDoorParameters": { + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "routingRules": [ + { + "name": "routingRule1", + "properties": { + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default" + } + ], + "acceptedProtocols": [ + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "routeConfiguration": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "backendPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1" + } + }, + "rulesEngine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" + }, + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + } + ], + "healthProbeSettings": [ + { + "name": "healthProbeSettings1", + "properties": { + "path": "/", + "protocol": "Http", + "intervalInSeconds": 120, + "enabledState": "Enabled", + "healthProbeMethod": "HEAD" + } + } + ], + "loadBalancingSettings": [ + { + "name": "loadBalancingSettings1", + "properties": { + "sampleSize": 4, + "successfulSamplesRequired": 2 + } + } + ], + "backendPools": [ + { + "name": "backendPool1", + "properties": { + "backends": [ + { + "address": "w3.contoso.com", + "httpPort": 80, + "httpsPort": 443, + "weight": 1, + "priority": 2 + }, + { + "address": "contoso.com.website-us-west-2.othercloud.net", + "httpPort": 80, + "httpsPort": 443, + "weight": 2, + "priority": 1 + }, + { + "privateLinkAlias": "SQLSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice", + "privateLinkApprovalMessage": "Please approve this request to connect to the Private Link", + "address": "10.0.1.5", + "httpPort": 80, + "httpsPort": 443, + "weight": 1, + "priority": 1 + } + ], + "loadBalancingSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1" + }, + "healthProbeSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1" + } + } + } + ], + "frontendEndpoints": [ + { + "name": "frontendEndpoint1", + "properties": { + "hostName": "www.contoso.com", + "sessionAffinityEnabledState": "Enabled", + "sessionAffinityTtlSeconds": 60, + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + }, + { + "name": "default", + "properties": { + "hostName": "frontDoor1.azurefd.net" + } + } + ], + "backendPoolsSettings": { + "enforceCertificateNameCheck": "Enabled", + "sendRecvTimeoutSeconds": 60 + }, + "enabledState": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1", + "name": "frontDoor1", + "type": "Microsoft.Network/frontDoor", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "routingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1", + "name": "routingRule1", + "properties": { + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default" + } + ], + "acceptedProtocols": [ + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "routeConfiguration": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "customForwardingPath": "", + "forwardingProtocol": "MatchRequest", + "backendPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1" + } + }, + "rulesEngine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" + }, + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + } + ], + "healthProbeSettings": [ + { + "name": "healthProbeSettings1", + "properties": { + "path": "/", + "protocol": "Http", + "intervalInSeconds": 120, + "enabledState": "Enabled", + "healthProbeMethod": "HEAD" + } + } + ], + "loadBalancingSettings": [ + { + "name": "loadBalancingSettings1", + "properties": { + "sampleSize": 4, + "successfulSamplesRequired": 2 + } + } + ], + "backendPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1", + "name": "backendPool1", + "properties": { + "backends": [ + { + "address": "w3.contoso.com", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 2 + }, + { + "address": "contoso.com.website-us-west-2.othercloud.net", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 2, + "priority": 1 + }, + { + "privateLinkAlias": "SQLSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice", + "privateEndpointStatus": "Pending", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "address": "10.0.1.5", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 1 + } + ], + "loadBalancingSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1" + }, + "healthProbeSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1" + } + } + } + ], + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1", + "name": "frontendEndpoint1", + "properties": { + "hostName": "www.contoso.com", + "sessionAffinityEnabledState": "Enabled", + "sessionAffinityTtlSeconds": 60, + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default", + "name": "default", + "properties": { + "hostName": "frontDoor1.azurefd.net" + } + } + ], + "backendPoolsSettings": { + "enforceCertificateNameCheck": "Enabled", + "sendRecvTimeoutSeconds": 60 + }, + "enabledState": "Enabled", + "resourceState": "Creating", + "provisioningState": "Succeeded", + "cname": "frontDoor1.azurefd.net" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1", + "name": "frontDoor1", + "type": "Microsoft.Network/frontDoor", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "routingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1", + "name": "routingRule1", + "properties": { + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default" + } + ], + "acceptedProtocols": [ + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "routeConfiguration": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "customForwardingPath": "", + "forwardingProtocol": "MatchRequest", + "backendPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1" + } + }, + "rulesEngine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" + }, + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + } + ], + "healthProbeSettings": [ + { + "name": "healthProbeSettings1", + "properties": { + "path": "/", + "protocol": "Http", + "intervalInSeconds": 120, + "enabledState": "Enabled", + "healthProbeMethod": "HEAD" + } + } + ], + "loadBalancingSettings": [ + { + "name": "loadBalancingSettings1", + "properties": { + "sampleSize": 4, + "successfulSamplesRequired": 2 + } + } + ], + "backendPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1", + "name": "backendPool1", + "properties": { + "backends": [ + { + "address": "w3.contoso.com", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 2 + }, + { + "address": "contoso.com.website-us-west-2.othercloud.net", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 2, + "priority": 1 + }, + { + "privateLinkAlias": "SQLSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice", + "privateEndpointStatus": "Approved", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "address": "10.0.1.5", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 1 + } + ], + "loadBalancingSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1" + }, + "healthProbeSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1" + } + } + } + ], + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1", + "name": "frontendEndpoint1", + "properties": { + "hostName": "www.contoso.com", + "sessionAffinityEnabledState": "Enabled", + "sessionAffinityTtlSeconds": 60, + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default", + "name": "default", + "properties": { + "hostName": "frontDoor1.azurefd.net" + } + } + ], + "backendPoolsSettings": { + "enforceCertificateNameCheck": "Enabled", + "sendRecvTimeoutSeconds": 60 + }, + "enabledState": "Enabled", + "resourceState": "Creating", + "provisioningState": "Provisioning", + "cname": "frontDoor1.azurefd.net" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1", + "name": "frontDoor1", + "type": "Microsoft.Network/frontDoor", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "routingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1", + "name": "routingRule1", + "properties": { + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default" + } + ], + "acceptedProtocols": [ + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "routeConfiguration": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "customForwardingPath": "", + "forwardingProtocol": "MatchRequest", + "backendPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1" + } + }, + "rulesEngine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" + }, + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + } + ], + "healthProbeSettings": [ + { + "name": "healthProbeSettings1", + "properties": { + "path": "/", + "protocol": "Http", + "intervalInSeconds": 120, + "enabledState": "Enabled", + "healthProbeMethod": "HEAD" + } + } + ], + "loadBalancingSettings": [ + { + "name": "loadBalancingSettings1", + "properties": { + "sampleSize": 4, + "successfulSamplesRequired": 2 + } + } + ], + "backendPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1", + "name": "backendPool1", + "properties": { + "backends": [ + { + "address": "w3.contoso.com", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 2 + }, + { + "address": "contoso.com.website-us-west-2.othercloud.net", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 2, + "priority": 1 + }, + { + "privateLinkAlias": "SQLSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice", + "privateEndpointStatus": "Approved", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "address": "10.0.1.5", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 1 + } + ], + "loadBalancingSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1" + }, + "healthProbeSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1" + } + } + } + ], + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1", + "name": "frontendEndpoint1", + "properties": { + "hostName": "www.contoso.com", + "sessionAffinityEnabledState": "Enabled", + "sessionAffinityTtlSeconds": 60, + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default", + "name": "default", + "properties": { + "hostName": "frontDoor1.azurefd.net" + } + } + ], + "backendPoolsSettings": { + "enforceCertificateNameCheck": "Enabled", + "sendRecvTimeoutSeconds": 60 + }, + "enabledState": "Enabled", + "resourceState": "Creating", + "provisioningState": "Provisioning", + "cname": "frontDoor1.azurefd.net" + } + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorDelete.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorDelete.json new file mode 100644 index 000000000000..1c63c3650063 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorDisableHttps.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorDisableHttps.json new file mode 100644 index 000000000000..1b8eca16edf0 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorDisableHttps.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1", + "frontendEndpointName": "frontendEndpoint1" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorEnableHttps.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorEnableHttps.json new file mode 100644 index 000000000000..d63017ce37d4 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorEnableHttps.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1", + "frontendEndpointName": "frontendEndpoint1", + "customHttpsConfiguration": { + "certificateSource": "AzureKeyVault", + "protocolType": "ServerNameIndication", + "minimumTlsVersion": "1.0", + "keyVaultCertificateSourceParameters": { + "vault": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.KeyVault/vaults/vault1" + }, + "secretName": "secret1", + "secretVersion": "00000000-0000-0000-0000-000000000000" + } + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorFrontendEndpointGet.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorFrontendEndpointGet.json new file mode 100644 index 000000000000..984e7328de72 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorFrontendEndpointGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1", + "frontendEndpointName": "frontendEndpoint1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1", + "name": "frontendEndpoint1", + "properties": { + "hostName": "www.contoso.com", + "sessionAffinityEnabledState": "Enabled", + "sessionAffinityTtlSeconds": 60, + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorFrontendEndpointList.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorFrontendEndpointList.json new file mode 100644 index 000000000000..f0ca66197a46 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorFrontendEndpointList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1", + "name": "frontendEndpoint1", + "properties": { + "hostName": "www.contoso.com", + "sessionAffinityEnabledState": "Enabled", + "sessionAffinityTtlSeconds": 60, + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + } + ] + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorGet.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorGet.json new file mode 100644 index 000000000000..d862d3b7c380 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorGet.json @@ -0,0 +1,214 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1", + "name": "frontDoor1", + "type": "Microsoft.Network/frontDoor", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "routingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1", + "name": "routingRule1", + "properties": { + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default" + } + ], + "acceptedProtocols": [ + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "routeConfiguration": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "customForwardingPath": "", + "forwardingProtocol": "MatchRequest", + "backendPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1" + } + }, + "rulesEngine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" + }, + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + } + ], + "healthProbeSettings": [ + { + "name": "healthProbeSettings1", + "properties": { + "path": "/", + "protocol": "Http", + "intervalInSeconds": 120, + "enabledState": "Enabled", + "healthProbeMethod": "HEAD" + } + } + ], + "loadBalancingSettings": [ + { + "name": "loadBalancingSettings1", + "properties": { + "sampleSize": 4, + "successfulSamplesRequired": 2 + } + } + ], + "backendPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1", + "name": "backendPool1", + "properties": { + "backends": [ + { + "address": "w3.contoso.com", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 2 + }, + { + "address": "contoso.com.website-us-west-2.othercloud.net", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 2, + "priority": 1 + }, + { + "privateLinkAlias": "SQLSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice", + "privateEndpointStatus": "Approved", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "address": "10.0.1.5", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 1 + } + ], + "loadBalancingSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1" + }, + "healthProbeSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1" + } + } + } + ], + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1", + "name": "frontendEndpoint1", + "properties": { + "hostName": "www.contoso.com", + "sessionAffinityEnabledState": "Enabled", + "sessionAffinityTtlSeconds": 60, + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default", + "name": "default", + "properties": { + "hostName": "frontDoor1.azurefd.net" + } + } + ], + "rulesEngines": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1", + "name": "rulesEngine1", + "properties": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration", + "redirectType": "Moved", + "redirectProtocol": "HttpsOnly", + "customHost": "www.bing.com", + "customPath": "/api", + "customFragment": "fragment", + "customQueryString": "a=b" + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RemoteAddr", + "rulesEngineOperator": "GeoMatch", + "rulesEngineMatchValue": [ + "CH" + ] + } + ], + "matchProcessingBehavior": "Stop" + }, + { + "name": "Rule2", + "priority": 2, + "action": { + "responseHeaderActions": [ + { + "headerActionType": "Overwrite", + "headerName": "Cache-Control", + "value": "public, max-age=31536000" + } + ] + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "FilenameExtension", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "jpg" + ], + "transforms": [ + "Lowercase" + ] + } + ] + } + ] + } + } + ], + "backendPoolsSettings": { + "enforceCertificateNameCheck": "Enabled", + "sendRecvTimeoutSeconds": 60 + }, + "enabledState": "Enabled", + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "cname": "frontDoor1.azurefd.net" + } + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorList.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorList.json new file mode 100644 index 000000000000..01f597e20f3f --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorList.json @@ -0,0 +1,217 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1", + "name": "frontDoor1", + "type": "Microsoft.Network/frontDoor", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "routingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1", + "name": "routingRule1", + "properties": { + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default" + } + ], + "acceptedProtocols": [ + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "routeConfiguration": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "customForwardingPath": "", + "forwardingProtocol": "MatchRequest", + "backendPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1" + } + }, + "rulesEngine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" + }, + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + } + ], + "healthProbeSettings": [ + { + "name": "healthProbeSettings1", + "properties": { + "path": "/", + "protocol": "Http", + "intervalInSeconds": 120, + "enabledState": "Enabled", + "healthProbeMethod": "HEAD" + } + } + ], + "loadBalancingSettings": [ + { + "name": "loadBalancingSettings1", + "properties": { + "sampleSize": 4, + "successfulSamplesRequired": 2 + } + } + ], + "backendPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1", + "name": "backendPool1", + "properties": { + "backends": [ + { + "address": "w3.contoso.com", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 2 + }, + { + "address": "contoso.com.website-us-west-2.othercloud.net", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 2, + "priority": 1 + }, + { + "privateLinkAlias": "SQLSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice", + "privateEndpointStatus": "Approved", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "address": "10.0.1.5", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 1 + } + ], + "loadBalancingSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1" + }, + "healthProbeSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1" + } + } + } + ], + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1", + "name": "frontendEndpoint1", + "properties": { + "hostName": "www.contoso.com", + "sessionAffinityEnabledState": "Enabled", + "sessionAffinityTtlSeconds": 60, + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default", + "name": "default", + "properties": { + "hostName": "frontDoor1.azurefd.net" + } + } + ], + "rulesEngines": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/rulesEngine1", + "name": "rulesEngine1", + "properties": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration", + "redirectType": "Moved", + "redirectProtocol": "HttpsOnly", + "customHost": "www.bing.com", + "customPath": "/api", + "customFragment": "fragment", + "customQueryString": "a=b" + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RemoteAddr", + "rulesEngineOperator": "GeoMatch", + "rulesEngineMatchValue": [ + "CH" + ] + } + ], + "matchProcessingBehavior": "Stop" + }, + { + "name": "Rule2", + "priority": 2, + "action": { + "responseHeaderActions": [ + { + "headerActionType": "Overwrite", + "headerName": "Cache-Control", + "value": "public, max-age=31536000" + } + ] + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "FilenameExtension", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "jpg" + ], + "transforms": [ + "Lowercase" + ] + } + ] + } + ] + } + } + ], + "backendPoolsSettings": { + "enforceCertificateNameCheck": "Enabled", + "sendRecvTimeoutSeconds": 60 + }, + "enabledState": "Enabled", + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "cname": "frontDoor1.azurefd.net" + } + } + ] + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorListAll.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorListAll.json new file mode 100644 index 000000000000..144a1f8e33cb --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorListAll.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1", + "name": "frontDoor1", + "type": "Microsoft.Network/frontDoor", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "routingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/routingRule1", + "name": "routingRule1", + "properties": { + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default" + } + ], + "acceptedProtocols": [ + "Http" + ], + "patternsToMatch": [ + "/*" + ], + "routeConfiguration": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "customForwardingPath": "", + "forwardingProtocol": "MatchRequest", + "backendPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1" + } + }, + "rulesEngine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" + }, + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + } + ], + "healthProbeSettings": [ + { + "name": "healthProbeSettings1", + "properties": { + "path": "/", + "protocol": "Http", + "intervalInSeconds": 120, + "enabledState": "Enabled", + "healthProbeMethod": "HEAD" + } + } + ], + "loadBalancingSettings": [ + { + "name": "loadBalancingSettings1", + "properties": { + "sampleSize": 4, + "successfulSamplesRequired": 2 + } + } + ], + "backendPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1", + "name": "backendPool1", + "properties": { + "backends": [ + { + "address": "w3.contoso.com", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 2 + }, + { + "address": "contoso.com.website-us-west-2.othercloud.net", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 2, + "priority": 1 + }, + { + "privateLinkAlias": "SQLSERVER.d84e61f0-0870-4d24-9746-7438fa0019d1.westus2.azure.privatelinkservice", + "privateEndpointStatus": "Approved", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link", + "address": "10.0.1.5", + "httpPort": 80, + "httpsPort": 443, + "enabledState": "Enabled", + "weight": 1, + "priority": 1 + } + ], + "loadBalancingSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/loadBalancingSettings/loadBalancingSettings1" + }, + "healthProbeSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/healthProbeSettings/healthProbeSettings1" + } + } + } + ], + "frontendEndpoints": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/frontendEndpoint1", + "name": "frontendEndpoint1", + "properties": { + "hostName": "www.contoso.com", + "sessionAffinityEnabledState": "Enabled", + "sessionAffinityTtlSeconds": 60, + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/frontendEndpoints/default", + "name": "default", + "properties": { + "hostName": "frontDoor1.azurefd.net" + } + } + ], + "rulesEngines": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/routingRules/rulesEngine1", + "name": "rulesEngine1", + "properties": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration", + "redirectType": "Moved", + "redirectProtocol": "HttpsOnly", + "customHost": "www.bing.com", + "customPath": "/api", + "customFragment": "fragment", + "customQueryString": "a=b" + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RemoteAddr", + "rulesEngineOperator": "GeoMatch", + "rulesEngineMatchValue": [ + "CH" + ] + } + ], + "matchProcessingBehavior": "Stop" + }, + { + "name": "Rule2", + "priority": 2, + "action": { + "responseHeaderActions": [ + { + "headerActionType": "Overwrite", + "headerName": "Cache-Control", + "value": "public, max-age=31536000" + } + ] + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "FilenameExtension", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "jpg" + ], + "transforms": [ + "Lowercase" + ] + } + ] + } + ] + } + } + ], + "backendPoolsSettings": { + "enforceCertificateNameCheck": "Enabled" + }, + "enabledState": "Enabled", + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "cname": "frontDoor1.azurefd.net" + } + } + ] + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorPurgeContent.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorPurgeContent.json new file mode 100644 index 000000000000..a8d47724cba1 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorPurgeContent.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1", + "contentFilePaths": { + "contentPaths": [ + "/pictures.aspx", + "/pictures/*" + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineCreate.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineCreate.json new file mode 100644 index 000000000000..4c929b3b0370 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineCreate.json @@ -0,0 +1,281 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1", + "rulesEngineName": "rulesEngine1", + "rulesEngineParameters": { + "properties": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration", + "redirectType": "Moved", + "redirectProtocol": "HttpsOnly", + "customHost": "www.bing.com", + "customPath": "/api", + "customFragment": "fragment", + "customQueryString": "a=b" + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RemoteAddr", + "rulesEngineOperator": "GeoMatch", + "rulesEngineMatchValue": [ + "CH" + ] + } + ], + "matchProcessingBehavior": "Stop" + }, + { + "name": "Rule2", + "priority": 2, + "action": { + "responseHeaderActions": [ + { + "headerActionType": "Overwrite", + "headerName": "Cache-Control", + "value": "public, max-age=31536000" + } + ] + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RequestFilenameExtension", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "jpg" + ], + "transforms": [ + "Lowercase" + ] + } + ] + }, + { + "name": "Rule3", + "priority": 3, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "customForwardingPath": null, + "forwardingProtocol": "HttpsOnly", + "cacheConfiguration": { + "queryParameterStripDirective": "StripOnly", + "queryParameters": "a=b,p=q", + "dynamicCompression": "Disabled", + "cacheDuration": "P1DT12H20M30S" + }, + "backendPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1" + } + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RequestHeader", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "allowoverride" + ], + "transforms": [ + "Lowercase" + ], + "negateCondition": false, + "selector": "Rules-Engine-Route-Forward" + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1", + "name": "rulesEngine1", + "properties": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration", + "redirectType": "Moved", + "redirectProtocol": "HttpsOnly", + "customHost": "www.bing.com", + "customPath": "/api", + "customFragment": "fragment", + "customQueryString": "a=b" + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RemoteAddr", + "rulesEngineOperator": "GeoMatch", + "rulesEngineMatchValue": [ + "CH" + ] + } + ], + "matchProcessingBehavior": "Stop" + }, + { + "name": "Rule2", + "priority": 2, + "action": { + "responseHeaderActions": [ + { + "headerActionType": "Overwrite", + "headerName": "Cache-Control", + "value": "public, max-age=31536000" + } + ] + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RequestFilenameExtension", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "jpg" + ], + "transforms": [ + "Lowercase" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1", + "name": "rulesEngine1", + "properties": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration", + "redirectType": "Moved", + "redirectProtocol": "HttpsOnly", + "customHost": "www.bing.com", + "customPath": "/api", + "customFragment": "fragment", + "customQueryString": "a=b" + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RemoteAddr", + "rulesEngineOperator": "GeoMatch", + "rulesEngineMatchValue": [ + "CH" + ] + } + ], + "matchProcessingBehavior": "Stop" + }, + { + "name": "Rule2", + "priority": 2, + "action": { + "responseHeaderActions": [ + { + "headerActionType": "Overwrite", + "headerName": "Cache-Control", + "value": "public, max-age=31536000" + } + ] + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RequestFilenameExtension", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "jpg" + ], + "transforms": [ + "Lowercase" + ] + } + ] + } + ] + } + } + }, + "202": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1", + "name": "rulesEngine1", + "properties": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration", + "redirectType": "Moved", + "redirectProtocol": "HttpsOnly", + "customHost": "www.bing.com", + "customPath": "/api", + "customFragment": "fragment", + "customQueryString": "a=b" + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RemoteAddr", + "rulesEngineOperator": "GeoMatch", + "rulesEngineMatchValue": [ + "CH" + ] + } + ], + "matchProcessingBehavior": "Stop" + }, + { + "name": "Rule2", + "priority": 2, + "action": { + "responseHeaderActions": [ + { + "headerActionType": "Overwrite", + "headerName": "Cache-Control", + "value": "public, max-age=31536000" + } + ] + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "FilenameExtension", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "jpg" + ], + "transforms": [ + "Lowercase" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineDelete.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineDelete.json new file mode 100644 index 000000000000..da67c4db4da2 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1", + "rulesEngineName": "rulesEngine1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineGet.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineGet.json new file mode 100644 index 000000000000..d4171bdd7fd9 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineGet.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1", + "rulesEngineName": "rulesEngine1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1", + "name": "rulesEngine1", + "properties": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration", + "redirectType": "Moved", + "redirectProtocol": "HttpsOnly", + "customHost": "www.bing.com", + "customPath": "/api", + "customFragment": "fragment", + "customQueryString": "a=b" + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RemoteAddr", + "rulesEngineOperator": "GeoMatch", + "rulesEngineMatchValue": [ + "CH" + ] + } + ], + "matchProcessingBehavior": "Stop" + }, + { + "name": "Rule2", + "priority": 2, + "action": { + "responseHeaderActions": [ + { + "headerActionType": "Overwrite", + "headerName": "Cache-Control", + "value": "public, max-age=31536000" + } + ] + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RequestFilenameExtension", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "jpg" + ], + "transforms": [ + "Lowercase" + ] + } + ] + }, + { + "name": "Rule3", + "priority": 3, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "customForwardingPath": null, + "forwardingProtocol": "HttpsOnly", + "cacheConfiguration": { + "queryParameterStripDirective": "StripOnly", + "queryParameters": "a=b,p=q", + "dynamicCompression": "Disabled", + "cacheDuration": "P1DT12H20M30S" + }, + "backendPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1" + } + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RequestHeader", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "allowoverride" + ], + "transforms": [ + "Lowercase" + ], + "negateCondition": false, + "selector": "Rules-Engine-Route-Forward" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineList.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineList.json new file mode 100644 index 000000000000..5876451c7ebe --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorRulesEngineList.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1", + "name": "rulesEngine1", + "properties": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration", + "redirectType": "Moved", + "redirectProtocol": "HttpsOnly", + "customHost": "www.bing.com", + "customPath": "/api", + "customFragment": "fragment", + "customQueryString": "a=b" + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RemoteAddr", + "rulesEngineOperator": "GeoMatch", + "rulesEngineMatchValue": [ + "CH" + ] + } + ], + "matchProcessingBehavior": "Stop" + }, + { + "name": "Rule2", + "priority": 2, + "action": { + "responseHeaderActions": [ + { + "headerActionType": "Overwrite", + "headerName": "Cache-Control", + "value": "public, max-age=31536000" + } + ] + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RequestFilenameExtension", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "jpg" + ], + "transforms": [ + "Lowercase" + ] + } + ] + }, + { + "name": "Rule3", + "priority": 3, + "action": { + "routeConfigurationOverride": { + "@odata.type": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "customForwardingPath": null, + "forwardingProtocol": "HttpsOnly", + "cacheConfiguration": { + "queryParameterStripDirective": "StripOnly", + "queryParameters": "a=b,p=q", + "dynamicCompression": "Disabled", + "cacheDuration": "P1DT12H20M30S" + }, + "backendPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/backendPools/backendPool1" + } + } + }, + "matchConditions": [ + { + "rulesEngineMatchVariable": "RequestHeader", + "rulesEngineOperator": "Equal", + "rulesEngineMatchValue": [ + "allowoverride" + ], + "transforms": [ + "Lowercase" + ], + "negateCondition": false, + "selector": "Rules-Engine-Route-Forward" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorValidateCustomDomain.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorValidateCustomDomain.json new file mode 100644 index 000000000000..9e2e823963b4 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/FrontdoorValidateCustomDomain.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "frontDoorName": "frontDoor1", + "customDomainProperties": { + "hostName": "www.someDomain.com" + } + }, + "responses": { + "200": { + "body": { + "customDomainValidated": true, + "message": null, + "reason": null + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafListManagedRuleSets.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafListManagedRuleSets.json new file mode 100644 index 000000000000..67ffc7fc2499 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafListManagedRuleSets.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "DefaultRuleSet_1.0", + "id": "/subscriptions/subid/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallmanagedrulesets", + "properties": { + "provisioningState": "Succeeded", + "ruleSetId": "8125d145-ddc5-4d90-9bc3-24c5f2de69a2", + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "ruleGroups": [ + { + "ruleGroupName": "SQLI", + "description": "SQL injection", + "rules": [ + { + "ruleId": "942100", + "description": "SQL Injection Attack Detected via libinjection", + "defaultState": "Enabled", + "defaultAction": "Block" + }, + { + "ruleId": "942110", + "description": "SQL Injection Attack: Common Injection Testing Detected", + "defaultState": "Enabled", + "defaultAction": "Block" + } + ] + }, + { + "ruleGroupName": "XSS", + "description": "Cross-site scripting", + "rules": [ + { + "ruleId": "941100", + "description": "XSS Attack Detected via libinjection", + "defaultState": "Enabled", + "defaultAction": "Block" + }, + { + "ruleId": "941101", + "description": "XSS Attack Detected via libinjection", + "defaultState": "Enabled", + "defaultAction": "Block" + }, + { + "ruleId": "941110", + "description": "XSS Filter - Category 1: Script Tag Vector", + "defaultState": "Enabled", + "defaultAction": "Block" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafListPolicies.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafListPolicies.json new file mode 100644 index 000000000000..54bb6176f88d --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafListPolicies.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "enabledState": "Enabled", + "ruleType": "RateLimitRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "enabledState": "Enabled", + "ruleType": "MatchRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 0, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "frontendEndpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontdoors/fd1/frontendendpoints/fd1-azurefd-net" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyCreateOrUpdate.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyCreateOrUpdate.json new file mode 100644 index 000000000000..dfbb5d06460e --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyCreateOrUpdate.json @@ -0,0 +1,492 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1", + "parameters": { + "properties": { + "policySettings": { + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "RateLimitRule", + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "operator": "IPMatch", + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "operator": "GeoMatch", + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "operator": "Contains", + "selector": "UserAgent", + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "exclusions": [ + { + "matchVariable": "RequestCookieNames", + "selectorMatchOperator": "StartsWith", + "selector": "token" + } + ], + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect", + "exclusions": [ + { + "matchVariable": "QueryStringArgNames", + "selectorMatchOperator": "Equals", + "selector": "query" + } + ] + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "enabledState": "Enabled", + "ruleType": "RateLimitRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "enabledState": "Enabled", + "ruleType": "MatchRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 0, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "exclusions": [ + { + "matchVariable": "RequestCookieNames", + "selectorMatchOperator": "StartsWith", + "selector": "token" + } + ], + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect", + "exclusions": [ + { + "matchVariable": "QueryStringArgNames", + "selectorMatchOperator": "Equals", + "selector": "query" + } + ] + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "frontendEndpointLinks": [] + } + } + }, + "201": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "enabledState": "Enabled", + "ruleType": "RateLimitRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "enabledState": "Enabled", + "ruleType": "MatchRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 0, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "exclusions": [ + { + "matchVariable": "RequestCookieNames", + "selectorMatchOperator": "StartsWith", + "selector": "token" + } + ], + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect", + "exclusions": [ + { + "matchVariable": "QueryStringArgNames", + "selectorMatchOperator": "Equals", + "selector": "query" + } + ] + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "frontendEndpointLinks": [] + } + } + }, + "202": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "enabledState": "Enabled", + "ruleType": "RateLimitRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "enabledState": "Enabled", + "ruleType": "MatchRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 0, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "exclusions": [ + { + "matchVariable": "RequestCookieNames", + "selectorMatchOperator": "StartsWith", + "selector": "token" + } + ], + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect", + "exclusions": [ + { + "matchVariable": "QueryStringArgNames", + "selectorMatchOperator": "Equals", + "selector": "query" + } + ] + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "frontendEndpointLinks": [] + } + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyDelete.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyDelete.json new file mode 100644 index 000000000000..fbb29b09b644 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyGet.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyGet.json new file mode 100644 index 000000000000..1311e82902db --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/examples/WafPolicyGet.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "enabledState": "Enabled", + "ruleType": "RateLimitRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "enabledState": "Enabled", + "ruleType": "MatchRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 0, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "frontendEndpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontdoors/fd1/frontendendpoints/fd1-azurefd-net" + } + ] + } + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/frontdoor.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/frontdoor.json new file mode 100644 index 000000000000..04ebb2c6a13b --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/frontdoor.json @@ -0,0 +1,2350 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-04-01", + "title": "FrontDoorManagementClient", + "description": "Use these APIs to manage Azure Front Door resources through the Azure Resource Manager. You must make sure that requests made to these resources are secure." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Network/checkFrontDoorNameAvailability": { + "post": { + "tags": [ + "CheckFrontDoorNameAvailability" + ], + "description": "Check the availability of a Front Door resource name.", + "operationId": "CheckFrontDoorNameAvailability", + "x-ms-examples": { + "CheckNameAvailability": { + "$ref": "./examples/CheckFrontdoorNameAvailability.json" + } + }, + "parameters": [ + { + "name": "checkFrontDoorNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/checkFrontDoorNameAvailability": { + "post": { + "tags": [ + "CheckFrontDoorNameAvailabilityWithSubscription" + ], + "description": "Check the availability of a Front Door subdomain.", + "operationId": "CheckFrontDoorNameAvailabilityWithSubscription", + "x-ms-examples": { + "CheckNameAvailabilityWithSubscription": { + "$ref": "./examples/CheckFrontdoorNameAvailabilityWithSubscription.json" + } + }, + "parameters": [ + { + "name": "checkFrontDoorNameAvailabilityInput", + "in": "body", + "description": "Input to check.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + } + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityOutput" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/frontDoors": { + "get": { + "tags": [ + "FrontDoors" + ], + "description": "Lists all of the Front Doors within an Azure subscription.", + "operationId": "FrontDoors_List", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/FrontDoorListResult" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all Front Doors": { + "$ref": "./examples/FrontdoorListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors": { + "get": { + "tags": [ + "FrontDoors" + ], + "description": "Lists all of the Front Doors within a resource group under a subscription.", + "operationId": "FrontDoors_ListByResourceGroup", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/FrontDoorListResult" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Front Doors in a Resource Group": { + "$ref": "./examples/FrontdoorList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}": { + "get": { + "tags": [ + "FrontDoors" + ], + "description": "Gets a Front Door with the specified Front Door name under the specified subscription and resource group.", + "operationId": "FrontDoors_Get", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/FrontDoor" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Front Door": { + "$ref": "./examples/FrontdoorGet.json" + } + } + }, + "put": { + "tags": [ + "FrontDoors" + ], + "description": "Creates a new Front Door with a Front Door name under the specified subscription and resource group.", + "operationId": "FrontDoors_CreateOrUpdate", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "description": "Front Door properties needed to create a new Front Door.", + "in": "body", + "name": "frontDoorParameters", + "required": true, + "schema": { + "$ref": "#/definitions/FrontDoor" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/FrontDoor" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new Front Door has been created.", + "schema": { + "$ref": "#/definitions/FrontDoor" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FrontDoor" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update specific Front Door": { + "$ref": "./examples/FrontdoorCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "FrontDoors" + ], + "description": "Deletes an existing Front Door with the specified parameters.", + "operationId": "FrontDoors_Delete", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the Front Door was not found." + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Front Door": { + "$ref": "./examples/FrontdoorDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints": { + "get": { + "tags": [ + "FrontDoors" + ], + "description": "Lists all of the frontend endpoints within a Front Door.", + "operationId": "FrontendEndpoints_ListByFrontDoor", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/FrontendEndpointsListResult" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Frontend endpoints in a Front Door": { + "$ref": "./examples/FrontdoorFrontendEndpointList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}": { + "get": { + "tags": [ + "FrontDoors" + ], + "description": "Gets a Frontend endpoint with the specified name within the specified Front Door.", + "operationId": "FrontendEndpoints_Get", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "#/parameters/frontendEndpointNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/FrontendEndpoint" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Frontend Endpoint": { + "$ref": "./examples/FrontdoorFrontendEndpointGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/purge": { + "post": { + "tags": [ + "FrontDoors" + ], + "description": "Removes a content from Front Door.", + "operationId": "Endpoints_PurgeContent", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "name": "contentFilePaths", + "in": "body", + "description": "The path to the content to be purged. Path can be a full URL, e.g. '/pictures/city.png' which removes a single file, or a directory with a wildcard, e.g. '/pictures/*' which removes all folders and files in the directory.", + "required": true, + "schema": { + "$ref": "#/definitions/PurgeParameters" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Purge content from Front Door": { + "$ref": "./examples/FrontdoorPurgeContent.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}/enableHttps": { + "post": { + "tags": [ + "FrontDoors" + ], + "description": "Enables a frontendEndpoint for HTTPS traffic", + "operationId": "FrontendEndpoints_EnableHttps", + "x-ms-examples": { + "FrontendEndpoints_EnableHttps": { + "$ref": "./examples/FrontdoorEnableHttps.json" + } + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "#/parameters/frontendEndpointNameParameter" + }, + { + "name": "customHttpsConfiguration", + "in": "body", + "description": "The configuration specifying how to enable HTTPS", + "required": true, + "schema": { + "$ref": "#/definitions/CustomHttpsConfiguration" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/frontendEndpoints/{frontendEndpointName}/disableHttps": { + "post": { + "tags": [ + "FrontDoors" + ], + "description": "Disables a frontendEndpoint for HTTPS traffic", + "operationId": "FrontendEndpoints_DisableHttps", + "x-ms-examples": { + "FrontendEndpoints_DisableHttps": { + "$ref": "./examples/FrontdoorDisableHttps.json" + } + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "#/parameters/frontendEndpointNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/validateCustomDomain": { + "post": { + "tags": [ + "FrontDoors" + ], + "description": "Validates the custom domain mapping to ensure it maps to the correct Front Door endpoint in DNS.", + "operationId": "FrontDoors_ValidateCustomDomain", + "x-ms-examples": { + "FrontDoor_ValidateCustomDomain": { + "$ref": "./examples/FrontdoorValidateCustomDomain.json" + } + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "customDomainProperties", + "in": "body", + "description": "Custom domain to be validated.", + "required": true, + "schema": { + "$ref": "#/definitions/ValidateCustomDomainInput" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ValidateCustomDomainOutput" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/rulesEngines": { + "get": { + "tags": [ + "FrontDoors" + ], + "description": "Lists all of the Rules Engine Configurations within a Front Door.", + "operationId": "RulesEngines_ListByFrontDoor", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/RulesEngineListResult" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Rules Engine Configurations in a Front Door": { + "$ref": "./examples/FrontdoorRulesEngineList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoors/{frontDoorName}/rulesEngines/{rulesEngineName}": { + "get": { + "tags": [ + "FrontDoors" + ], + "description": "Gets a Rules Engine Configuration with the specified name within the specified Front Door.", + "operationId": "RulesEngines_Get", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "#/parameters/rulesEngineNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/RulesEngine" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Rules Engine Configuration": { + "$ref": "./examples/FrontdoorRulesEngineGet.json" + } + } + }, + "put": { + "tags": [ + "FrontDoors" + ], + "description": "Creates a new Rules Engine Configuration with the specified name within the specified Front Door.", + "operationId": "RulesEngines_CreateOrUpdate", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "#/parameters/rulesEngineNameParameter" + }, + { + "description": "Rules Engine Configuration properties needed to create a new Rules Engine Configuration.", + "in": "body", + "name": "rulesEngineParameters", + "required": true, + "schema": { + "$ref": "#/definitions/RulesEngine" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/RulesEngine" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new RulesEngine has been created.", + "schema": { + "$ref": "#/definitions/RulesEngine" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/RulesEngine" + } + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update a specific Rules Engine Configuration": { + "$ref": "./examples/FrontdoorRulesEngineCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "FrontDoors" + ], + "description": "Deletes an existing Rules Engine Configuration with the specified parameters.", + "operationId": "RulesEngines_Delete", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/frontDoorNameParameter" + }, + { + "$ref": "#/parameters/rulesEngineNameParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the Rules Engine Configuration was not found." + }, + "default": { + "description": "Front Door error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete Rules Engine Configuration": { + "$ref": "./examples/FrontdoorRulesEngineDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "FrontDoor": { + "properties": { + "properties": { + "description": "Properties of the Front Door Load Balancer", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FrontDoorProperties" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Front Door represents a collection of backend endpoints to route traffic to along with rules that specify how traffic is sent there." + }, + "FrontDoorUpdateParameters": { + "description": "The properties needed to update a Front Door", + "properties": { + "friendlyName": { + "description": "A friendly name for the frontDoor", + "type": "string" + }, + "routingRules": { + "description": "Routing rules associated with this Front Door.", + "type": "array", + "items": { + "description": "A routing rule", + "$ref": "#/definitions/RoutingRule" + } + }, + "loadBalancingSettings": { + "description": "Load balancing settings associated with this Front Door instance.", + "type": "array", + "items": { + "description": "A load balancing settings", + "$ref": "#/definitions/LoadBalancingSettingsModel" + } + }, + "healthProbeSettings": { + "description": "Health probe settings associated with this Front Door instance.", + "type": "array", + "items": { + "description": "A health probe settings", + "$ref": "#/definitions/HealthProbeSettingsModel" + } + }, + "backendPools": { + "description": "Backend pools available to routing rules.", + "type": "array", + "items": { + "description": "A backend pool", + "$ref": "#/definitions/BackendPool" + } + }, + "frontendEndpoints": { + "description": "Frontend endpoints available to routing rules.", + "type": "array", + "items": { + "description": "A frontend endpoint", + "$ref": "#/definitions/FrontendEndpoint" + } + }, + "backendPoolsSettings": { + "description": "Settings for all backendPools", + "$ref": "#/definitions/BackendPoolsSettings" + }, + "enabledState": { + "description": "Operational status of the Front Door load balancer. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "FrontDoorEnabledState", + "modelAsString": true + } + } + } + }, + "FrontDoorProperties": { + "description": "The JSON object that contains the properties required to create an endpoint.", + "allOf": [ + { + "$ref": "#/definitions/FrontDoorUpdateParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status of the Front Door.", + "$ref": "#/definitions/ResourceState" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the Front Door." + }, + "cname": { + "readOnly": true, + "type": "string", + "description": "The host that each frontendEndpoint must CNAME to." + }, + "frontdoorId": { + "readOnly": true, + "type": "string", + "description": "The Id of the frontdoor." + }, + "rulesEngines": { + "readOnly": true, + "description": "Rules Engine Configurations available to routing rules.", + "type": "array", + "items": { + "description": "A rules engine configuration.", + "$ref": "#/definitions/RulesEngine" + } + } + } + }, + "FrontDoorListResult": { + "description": "Result of the request to list Front Doors. It contains a list of Front Door objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/FrontDoor" + }, + "description": "List of Front Doors within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of Front Door objects if there are any." + } + } + }, + "PurgeParameters": { + "type": "object", + "description": "Parameters required for content purge.", + "required": [ + "contentPaths" + ], + "properties": { + "contentPaths": { + "description": "The path to the content to be purged. Can describe a file path or a wild card directory.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "RoutingRule": { + "properties": { + "properties": { + "description": "Properties of the Front Door Routing Rule", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoutingRuleProperties" + }, + "name": { + "type": "string", + "description": "Resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A routing rule represents a specification for traffic to treat and where to send it, along with health probe information." + }, + "RoutingRuleProperties": { + "description": "The JSON object that contains the properties required to create a routing rule.", + "allOf": [ + { + "$ref": "#/definitions/RoutingRuleUpdateParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status.", + "$ref": "#/definitions/ResourceState" + } + } + }, + "RoutingRuleListResult": { + "description": "Result of the request to list Routing Rules. It contains a list of Routing Rule objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RoutingRule" + }, + "description": "List of Routing Rules within a Front Door." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of RoutingRule objects if there are any." + } + } + }, + "RoutingRuleUpdateParameters": { + "description": "Routing rules to apply to an endpoint", + "type": "object", + "properties": { + "frontendEndpoints": { + "description": "Frontend endpoints associated with this rule", + "type": "array", + "items": { + "description": "A reference to a frontend endpoint", + "$ref": "./network.json#/definitions/SubResource" + } + }, + "acceptedProtocols": { + "description": "Protocol schemes to match for this rule", + "type": "array", + "items": { + "type": "string", + "description": "Accepted protocol schemes.", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "FrontDoorProtocol", + "modelAsString": true + } + } + }, + "patternsToMatch": { + "description": "The route patterns of the rule.", + "type": "array", + "items": { + "type": "string", + "description": "A route pattern of the rule. Must not have any * except possibly after the final / at the end of the path." + } + }, + "enabledState": { + "description": "Whether to enable use of this rule. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "routingRuleEnabledState", + "modelAsString": true + } + }, + "routeConfiguration": { + "description": "A reference to the routing configuration.", + "$ref": "#/definitions/RouteConfiguration" + }, + "rulesEngine": { + "description": "A reference to a specific Rules Engine Configuration to apply to this route.", + "$ref": "./network.json#/definitions/SubResource" + }, + "webApplicationFirewallPolicyLink": { + "description": "Defines the Web Application Firewall policy for each routing rule (if applicable)", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + } + } + }, + "RouteConfiguration": { + "discriminator": "@odata.type", + "description": "Base class for all types of Route.", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ] + }, + "ForwardingConfiguration": { + "description": "Describes Forwarding Route.", + "x-ms-discriminator-value": "#Microsoft.Azure.FrontDoor.Models.FrontdoorForwardingConfiguration", + "properties": { + "customForwardingPath": { + "description": "A custom path used to rewrite resource paths matched by this rule. Leave empty to use incoming path.", + "type": "string" + }, + "forwardingProtocol": { + "description": "Protocol this rule will use when forwarding traffic to backends.", + "type": "string", + "enum": [ + "HttpOnly", + "HttpsOnly", + "MatchRequest" + ], + "x-ms-enum": { + "name": "FrontDoorForwardingProtocol", + "modelAsString": true + } + }, + "cacheConfiguration": { + "description": "The caching configuration associated with this rule.", + "$ref": "#/definitions/CacheConfiguration" + }, + "backendPool": { + "description": "A reference to the BackendPool which this rule routes to.", + "$ref": "./network.json#/definitions/SubResource" + } + }, + "allOf": [ + { + "$ref": "#/definitions/RouteConfiguration" + } + ] + }, + "RedirectConfiguration": { + "description": "Describes Redirect Route.", + "x-ms-discriminator-value": "#Microsoft.Azure.FrontDoor.Models.FrontdoorRedirectConfiguration", + "properties": { + "redirectType": { + "description": "The redirect type the rule will use when redirecting traffic.", + "type": "string", + "enum": [ + "Moved", + "Found", + "TemporaryRedirect", + "PermanentRedirect" + ], + "x-ms-enum": { + "name": "FrontDoorRedirectType", + "modelAsString": true + } + }, + "redirectProtocol": { + "description": "The protocol of the destination to where the traffic is redirected", + "type": "string", + "enum": [ + "HttpOnly", + "HttpsOnly", + "MatchRequest" + ], + "x-ms-enum": { + "name": "FrontDoorRedirectProtocol", + "modelAsString": true + } + }, + "customHost": { + "type": "string", + "description": "Host to redirect. Leave empty to use the incoming host as the destination host." + }, + "customPath": { + "type": "string", + "description": "The full path to redirect. Path cannot be empty and must start with /. Leave empty to use the incoming path as destination path." + }, + "customFragment": { + "type": "string", + "description": "Fragment to add to the redirect URL. Fragment is the part of the URL that comes after #. Do not include the #." + }, + "customQueryString": { + "description": "The set of query strings to be placed in the redirect URL. Setting this value would replace any existing query string; leave empty to preserve the incoming query string. Query string must be in = format. The first ? and & will be added automatically so do not include them in the front, but do separate multiple query strings with &.", + "type": "string" + } + }, + "allOf": [ + { + "$ref": "#/definitions/RouteConfiguration" + } + ] + }, + "Backend": { + "description": "Backend address of a frontDoor load balancer.", + "type": "object", + "properties": { + "address": { + "description": "Location of the backend (IP address or FQDN)", + "type": "string" + }, + "privateLinkAlias": { + "description": "The Alias of the Private Link resource. Populating this optional field indicates that this backend is 'Private'", + "type": "string" + }, + "privateEndpointStatus": { + "description": "The Approval status for the connection to the Private Link", + "type": "string", + "readOnly": true, + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "PrivateEndpointStatus", + "modelAsString": true + } + }, + "privateLinkApprovalMessage": { + "description": "A custom message to be included in the approval request to connect to the Private Link", + "type": "string" + }, + "httpPort": { + "description": "The HTTP TCP port number. Must be between 1 and 65535.", + "type": "integer", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "httpsPort": { + "description": "The HTTPS TCP port number. Must be between 1 and 65535.", + "type": "integer", + "maximum": 65535, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false + }, + "enabledState": { + "description": "Whether to enable use of this backend. Permitted values are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "backendEnabledState", + "modelAsString": true + } + }, + "priority": { + "description": "Priority to use for load balancing. Higher priorities will not be used for load balancing if any lower priority backend is healthy.", + "type": "integer", + "maximum": 5, + "minimum": 1 + }, + "weight": { + "description": "Weight of this endpoint for load balancing purposes.", + "type": "integer", + "maximum": 1000, + "minimum": 1 + }, + "backendHostHeader": { + "description": "The value to use as the host header sent to the backend. If blank or unspecified, this defaults to the incoming host.", + "type": "string" + } + } + }, + "LoadBalancingSettingsModel": { + "properties": { + "properties": { + "description": "Properties of the load balancing settings", + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoadBalancingSettingsProperties" + }, + "name": { + "type": "string", + "description": "Resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Load balancing settings for a backend pool" + }, + "LoadBalancingSettingsProperties": { + "description": "The JSON object that contains the properties required to create load balancing settings", + "allOf": [ + { + "$ref": "#/definitions/LoadBalancingSettingsUpdateParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status.", + "$ref": "#/definitions/ResourceState" + } + } + }, + "LoadBalancingSettingsListResult": { + "description": "Result of the request to list load balancing settings. It contains a list of load balancing settings objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/LoadBalancingSettingsModel" + }, + "description": "List of Backend Pools within a Front Door." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of LoadBalancingSettings objects if there are any." + } + } + }, + "LoadBalancingSettingsUpdateParameters": { + "description": "Round-Robin load balancing settings for a backend pool", + "type": "object", + "properties": { + "sampleSize": { + "description": "The number of samples to consider for load balancing decisions", + "type": "integer" + }, + "successfulSamplesRequired": { + "description": "The number of samples within the sample period that must succeed", + "type": "integer" + }, + "additionalLatencyMilliseconds": { + "description": "The additional latency in milliseconds for probes to fall into the lowest latency bucket", + "type": "integer" + } + } + }, + "HealthProbeSettingsModel": { + "properties": { + "properties": { + "description": "Properties of the health probe settings", + "x-ms-client-flatten": true, + "$ref": "#/definitions/HealthProbeSettingsProperties" + }, + "name": { + "type": "string", + "description": "Resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Load balancing settings for a backend pool" + }, + "HealthProbeSettingsProperties": { + "description": "The JSON object that contains the properties required to create a health probe settings.", + "allOf": [ + { + "$ref": "#/definitions/HealthProbeSettingsUpdateParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status.", + "$ref": "#/definitions/ResourceState" + } + } + }, + "HealthProbeSettingsListResult": { + "description": "Result of the request to list HealthProbeSettings. It contains a list of HealthProbeSettings objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/HealthProbeSettingsModel" + }, + "description": "List of HealthProbeSettings within a Front Door." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of HealthProbeSettings objects if there are any." + } + } + }, + "HealthProbeSettingsUpdateParameters": { + "description": "L7 health probe settings for a backend pool", + "type": "object", + "properties": { + "path": { + "description": "The path to use for the health probe. Default is /", + "type": "string" + }, + "protocol": { + "description": "Protocol scheme to use for this probe", + "type": "string", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "FrontDoorProtocol", + "modelAsString": true + } + }, + "intervalInSeconds": { + "description": "The number of seconds between health probes.", + "type": "integer" + }, + "healthProbeMethod": { + "description": "Configures which HTTP method to use to probe the backends defined under backendPools.", + "type": "string", + "enum": [ + "GET", + "HEAD" + ], + "x-ms-enum": { + "name": "FrontDoorHealthProbeMethod", + "modelAsString": true + }, + "default": "HEAD" + }, + "enabledState": { + "description": "Whether to enable health probes to be made against backends defined under backendPools. Health probes can only be disabled if there is a single enabled backend in single enabled backend pool.", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "HealthProbeEnabled", + "modelAsString": true + } + } + } + }, + "BackendPool": { + "properties": { + "properties": { + "description": "Properties of the Front Door Backend Pool", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendPoolProperties" + }, + "name": { + "type": "string", + "description": "Resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A backend pool is a collection of backends that can be routed to." + }, + "BackendPoolUpdateParameters": { + "description": "A collection of backends that can be routed to.", + "type": "object", + "properties": { + "backends": { + "description": "The set of backends for this pool", + "type": "array", + "items": { + "$ref": "#/definitions/Backend" + } + }, + "loadBalancingSettings": { + "description": "Load balancing settings for a backend pool", + "$ref": "./network.json#/definitions/SubResource" + }, + "healthProbeSettings": { + "description": "L7 health probe settings for a backend pool", + "$ref": "./network.json#/definitions/SubResource" + } + } + }, + "BackendPoolProperties": { + "description": "The JSON object that contains the properties required to create a Backend Pool.", + "allOf": [ + { + "$ref": "#/definitions/BackendPoolUpdateParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status.", + "$ref": "#/definitions/ResourceState" + } + } + }, + "BackendPoolListResult": { + "description": "Result of the request to list Backend Pools. It contains a list of Backend Pools objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BackendPool" + }, + "description": "List of Backend Pools within a Front Door." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of BackendPool objects if there are any." + } + } + }, + "CacheConfiguration": { + "description": "Caching settings for a caching-type route. To disable caching, do not provide a cacheConfiguration object.", + "type": "object", + "properties": { + "queryParameterStripDirective": { + "description": "Treatment of URL query terms when forming the cache key.", + "enum": [ + "StripNone", + "StripAll", + "StripOnly", + "StripAllExcept" + ], + "type": "string", + "x-ms-enum": { + "name": "FrontDoorQuery", + "modelAsString": true + } + }, + "queryParameters": { + "description": "query parameters to include or exclude (comma separated).", + "type": "string" + }, + "dynamicCompression": { + "description": "Whether to use dynamic compression for cached content", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "DynamicCompressionEnabled", + "modelAsString": true + } + }, + "cacheDuration": { + "description": "The duration for which the content needs to be cached. Allowed format is in ISO 8601 format (http://en.wikipedia.org/wiki/ISO_8601#Durations). HTTP requires the value to be no more than a year", + "type": "string", + "format": "duration" + } + } + }, + "KeyVaultCertificateSourceParameters": { + "description": "Parameters required for bring-your-own-certification via Key Vault", + "type": "object", + "properties": { + "vault": { + "description": "The Key Vault containing the SSL certificate", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + }, + "secretName": { + "type": "string", + "description": "The name of the Key Vault secret representing the full certificate PFX" + }, + "secretVersion": { + "type": "string", + "description": "The version of the Key Vault secret representing the full certificate PFX" + } + } + }, + "FrontDoorCertificateSourceParameters": { + "description": "Parameters required for enabling SSL with Front Door-managed certificates", + "type": "object", + "properties": { + "certificateType": { + "description": "Defines the type of the certificate used for secure connections to a frontendEndpoint", + "enum": [ + "Dedicated" + ], + "type": "string", + "x-ms-enum": { + "name": "FrontDoorCertificateType", + "modelAsString": true + } + } + } + }, + "CustomHttpsConfiguration": { + "description": "Https settings for a domain", + "type": "object", + "required": [ + "minimumTlsVersion", + "certificateSource", + "protocolType" + ], + "properties": { + "certificateSource": { + "description": "Defines the source of the SSL certificate", + "enum": [ + "AzureKeyVault", + "FrontDoor" + ], + "type": "string", + "x-ms-enum": { + "name": "FrontDoorCertificateSource", + "modelAsString": true + } + }, + "protocolType": { + "description": "Defines the TLS extension protocol that is used for secure delivery", + "enum": [ + "ServerNameIndication" + ], + "type": "string", + "x-ms-enum": { + "name": "FrontDoorTlsProtocolType", + "modelAsString": true + } + }, + "minimumTlsVersion": { + "description": "The minimum TLS version required from the clients to establish an SSL handshake with Front Door.", + "enum": [ + "1.0", + "1.2" + ], + "type": "string", + "x-ms-enum": { + "name": "MinimumTLSVersion", + "modelAsString": true + } + }, + "keyVaultCertificateSourceParameters": { + "description": "KeyVault certificate source parameters (if certificateSource=AzureKeyVault)", + "x-ms-client-flatten": true, + "$ref": "#/definitions/KeyVaultCertificateSourceParameters" + }, + "frontDoorCertificateSourceParameters": { + "description": "Parameters required for enabling SSL with Front Door-managed certificates (if certificateSource=FrontDoor)", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FrontDoorCertificateSourceParameters" + } + } + }, + "FrontendEndpoint": { + "properties": { + "properties": { + "description": "Properties of the Frontend endpoint", + "x-ms-client-flatten": true, + "$ref": "#/definitions/FrontendEndpointProperties" + }, + "name": { + "type": "string", + "description": "Resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A frontend endpoint used for routing." + }, + "FrontendEndpointProperties": { + "description": "The JSON object that contains the properties required to create a frontend endpoint.", + "allOf": [ + { + "$ref": "#/definitions/FrontendEndpointUpdateParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status.", + "$ref": "#/definitions/ResourceState" + }, + "customHttpsProvisioningState": { + "description": "Provisioning status of Custom Https of the frontendEndpoint.", + "readOnly": true, + "enum": [ + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningState", + "modelAsString": true + } + }, + "customHttpsProvisioningSubstate": { + "description": "Provisioning substate shows the progress of custom HTTPS enabling/disabling process step by step.", + "readOnly": true, + "enum": [ + "SubmittingDomainControlValidationRequest", + "PendingDomainControlValidationREquestApproval", + "DomainControlValidationRequestApproved", + "DomainControlValidationRequestRejected", + "DomainControlValidationRequestTimedOut", + "IssuingCertificate", + "DeployingCertificate", + "CertificateDeployed", + "DeletingCertificate", + "CertificateDeleted" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomHttpsProvisioningSubstate", + "modelAsString": true + } + }, + "customHttpsConfiguration": { + "description": "The configuration specifying how to enable HTTPS", + "readOnly": true, + "$ref": "#/definitions/CustomHttpsConfiguration" + } + } + }, + "FrontendEndpointUpdateParameters": { + "description": "Frontend endpoint used in routing rule", + "type": "object", + "properties": { + "hostName": { + "description": "The host name of the frontendEndpoint. Must be a domain name.", + "type": "string" + }, + "sessionAffinityEnabledState": { + "description": "Whether to allow session affinity on this host. Valid options are 'Enabled' or 'Disabled'", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SessionAffinityEnabledState", + "modelAsString": true + } + }, + "sessionAffinityTtlSeconds": { + "description": "UNUSED. This field will be ignored. The TTL to use in seconds for session affinity, if applicable.", + "type": "integer" + }, + "webApplicationFirewallPolicyLink": { + "description": "Defines the Web Application Firewall policy for each host (if applicable)", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + } + } + }, + "FrontendEndpointsListResult": { + "description": "Result of the request to list frontend endpoints. It contains a list of Frontend endpoint objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/FrontendEndpoint" + }, + "description": "List of Frontend endpoints within a Front Door." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of frontend endpoints if there are any." + } + } + }, + "BackendPoolsSettings": { + "description": "Settings that apply to all backend pools.", + "type": "object", + "properties": { + "enforceCertificateNameCheck": { + "description": "Whether to enforce certificate name check on HTTPS requests to all backend pools. No effect on non-HTTPS requests.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "enforceCertificateNameCheckEnabledState", + "modelAsString": true + }, + "default": "Enabled" + }, + "sendRecvTimeoutSeconds": { + "description": "Send and receive timeout on forwarding request to the backend. When timeout is reached, the request fails and returns.", + "type": "integer", + "minimum": 16, + "exclusiveMinimum": false + } + } + }, + "HeaderAction": { + "description": "An action that can manipulate an http header.", + "required": [ + "headerActionType", + "headerName" + ], + "properties": { + "headerActionType": { + "description": "Which type of manipulation to apply to the header.", + "type": "string", + "enum": [ + "Append", + "Delete", + "Overwrite" + ], + "x-ms-enum": { + "name": "headerActionType", + "modelAsString": true + } + }, + "headerName": { + "description": "The name of the header this action will apply to.", + "type": "string" + }, + "value": { + "description": "The value to update the given header name with. This value is not used if the actionType is Delete.", + "type": "string" + } + } + }, + "RulesEngineMatchCondition": { + "description": "Define a match condition", + "required": [ + "rulesEngineMatchVariable", + "rulesEngineOperator", + "rulesEngineMatchValue" + ], + "properties": { + "rulesEngineMatchVariable": { + "description": "Match Variable", + "type": "string", + "enum": [ + "IsMobile", + "RemoteAddr", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestPath", + "RequestFilename", + "RequestFilenameExtension", + "RequestHeader", + "RequestBody", + "RequestScheme" + ], + "x-ms-enum": { + "name": "RulesEngineMatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "Name of selector in RequestHeader or RequestBody to be matched", + "type": "string" + }, + "rulesEngineOperator": { + "description": "Describes operator to apply to the match condition.", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith" + ], + "x-ms-enum": { + "name": "RulesEngineOperator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if this is negate condition or not", + "type": "boolean" + }, + "rulesEngineMatchValue": { + "description": "Match values to match against. The operator will apply to each value in here with OR semantics. If any of them match the variable with the given operator this match condition is considered a match.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms", + "type": "array", + "items": { + "$ref": "#/definitions/transform" + } + } + } + }, + "ResourceState": { + "title": "Resource status of the Front Door or Front Door SubResource.", + "readOnly": true, + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "FrontDoorResourceState", + "modelAsString": true + } + }, + "RulesEngineAction": { + "description": "One or more actions that will execute, modifying the request and/or response.", + "properties": { + "requestHeaderActions": { + "description": "A list of header actions to apply from the request from AFD to the origin.", + "type": "array", + "items": { + "$ref": "#/definitions/HeaderAction" + } + }, + "responseHeaderActions": { + "description": "A list of header actions to apply from the response from AFD to the client.", + "type": "array", + "items": { + "$ref": "#/definitions/HeaderAction" + } + }, + "routeConfigurationOverride": { + "description": "Override the route configuration.", + "$ref": "#/definitions/RouteConfiguration" + } + } + }, + "RulesEngine": { + "description": "A rules engine configuration containing a list of rules that will run to modify the runtime behavior of the request and response.", + "properties": { + "properties": { + "description": "Properties of the Rules Engine Configuration.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/RulesEngineProperties" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Resource name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Resource type." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource ID." + } + }, + "x-ms-azure-resource": true + }, + "RulesEngineListResult": { + "description": "Result of the request to list Rules Engine Configurations. It contains a list of RulesEngine objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RulesEngine" + }, + "description": "List of rulesEngines within a Front Door." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of RulesEngine objects if there are any." + } + } + }, + "RulesEngineProperties": { + "description": "The JSON object that contains the properties required to create a Rules Engine Configuration.", + "allOf": [ + { + "$ref": "#/definitions/RulesEngineUpdateParameters" + } + ], + "properties": { + "resourceState": { + "description": "Resource status.", + "$ref": "#/definitions/ResourceState" + } + } + }, + "RulesEngineRule": { + "description": "Contains a list of match conditions, and an action on how to modify the request/response. If multiple rules match, the actions from one rule that conflict with a previous rule overwrite for a singular action, or append in the case of headers manipulation.", + "required": [ + "action", + "name", + "priority" + ], + "properties": { + "name": { + "description": "A name to refer to this specific rule.", + "type": "string" + }, + "priority": { + "description": "A priority assigned to this rule. ", + "type": "integer" + }, + "action": { + "description": "Actions to perform on the request and response if all of the match conditions are met.", + "$ref": "#/definitions/RulesEngineAction" + }, + "matchConditions": { + "description": "A list of match conditions that must meet in order for the actions of this rule to run. Having no match conditions means the actions will always run.", + "type": "array", + "items": { + "$ref": "#/definitions/RulesEngineMatchCondition" + } + }, + "matchProcessingBehavior": { + "description": "If this rule is a match should the rules engine continue running the remaining rules or stop. If not present, defaults to Continue.", + "type": "string", + "enum": [ + "Continue", + "Stop" + ], + "x-ms-enum": { + "name": "MatchProcessingBehavior", + "modelAsString": true + } + } + } + }, + "RulesEngineUpdateParameters": { + "description": "Rules Engine Configuration to apply to a Routing Rule.", + "type": "object", + "properties": { + "rules": { + "description": "A list of rules that define a particular Rules Engine Configuration.", + "type": "array", + "items": { + "$ref": "#/definitions/RulesEngineRule" + } + } + } + }, + "transform": { + "description": "Describes what transforms are applied before matching", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "transform", + "modelAsString": true + } + }, + "ValidateCustomDomainInput": { + "description": "Input of the custom domain to be validated for DNS mapping.", + "type": "object", + "required": [ + "hostName" + ], + "properties": { + "hostName": { + "description": "The host name of the custom domain. Must be a domain name.", + "type": "string" + } + } + }, + "ValidateCustomDomainOutput": { + "description": "Output of custom domain validation.", + "type": "object", + "properties": { + "customDomainValidated": { + "description": "Indicates whether the custom domain is valid or not.", + "readOnly": true, + "type": "boolean" + }, + "reason": { + "description": "The reason why the custom domain is not valid.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Error message describing why the custom domain is not valid.", + "readOnly": true, + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "readOnly": true, + "type": "string" + } + } + }, + "CheckNameAvailabilityInput": { + "description": "Input of CheckNameAvailability API.", + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "The resource name to validate.", + "type": "string" + }, + "type": { + "description": "The type of the resource whose name is to be validated.", + "$ref": "#/definitions/ResourceType" + } + } + }, + "CheckNameAvailabilityOutput": { + "description": "Output of check name availability API.", + "type": "object", + "properties": { + "nameAvailability": { + "description": "Indicates whether the name is available.", + "readOnly": true, + "enum": [ + "Available", + "Unavailable" + ], + "type": "string", + "x-ms-enum": { + "name": "Availability", + "modelAsString": true + } + }, + "reason": { + "description": "The reason why the name is not available.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "The detailed error message describing why the name is not available.", + "readOnly": true, + "type": "string" + } + } + }, + "ResourceType": { + "description": "Type of Front Door resource used in CheckNameAvailability.", + "enum": [ + "Microsoft.Network/frontDoors", + "Microsoft.Network/frontDoors/frontendEndpoints" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceType", + "modelAsString": false + } + } + }, + "parameters": { + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + }, + "frontDoorNameParameter": { + "name": "frontDoorName", + "in": "path", + "required": true, + "type": "string", + "x-new-pattern": "^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$", + "pattern": "^[a-zA-Z0-9]+([-a-zA-Z0-9]?[a-zA-Z0-9])*$", + "minLength": 5, + "maxLength": 64, + "x-ms-parameter-location": "method", + "description": "Name of the Front Door which is globally unique." + }, + "routingRuleNameParameter": { + "name": "routingRuleName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "x-previous-pattern": "^[-\\w\\d\\._]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Routing Rule which is unique within the Front Door." + }, + "healthProbeSettingsNameParameter": { + "name": "healthProbeSettingsName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "x-previous-pattern": "^[-\\w\\d\\._]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the health probe settings which is unique within the Front Door." + }, + "loadBalancingSettingsNameParameter": { + "name": "loadBalancingSettingsName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "x-previous-pattern": "^[-\\w\\d\\._]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the load balancing settings which is unique within the Front Door." + }, + "backendPoolNameParameter": { + "name": "backendPoolName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "x-previous-pattern": "^[-\\w\\d\\._]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Backend Pool which is unique within the Front Door." + }, + "frontendEndpointNameParameter": { + "name": "frontendEndpointName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "x-previous-pattern": "^[-\\w\\d\\._]+$", + "minLength": 1, + "maxLength": 255, + "x-ms-parameter-location": "method", + "description": "Name of the Frontend endpoint which is unique within the Front Door." + }, + "rulesEngineNameParameter": { + "name": "rulesEngineName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "x-previous-pattern": "^[-\\w\\d\\._]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of the Rules Engine which is unique within the Front Door." + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/network.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/network.json new file mode 100644 index 000000000000..953304d73a0e --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/network.json @@ -0,0 +1,167 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-04-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ErrorDetails": { + "properties": { + "code": { + "type": "string" + }, + "target": { + "type": "string" + }, + "message": { + "type": "string" + } + } + }, + "Error": { + "properties": { + "code": { + "type": "string" + }, + "message": { + "type": "string" + }, + "target": { + "type": "string" + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "innerError": { + "type": "string" + } + } + }, + "AzureAsyncOperationResult": { + "properties": { + "status": { + "type": "string", + "description": "Status of the Azure async operation. Possible values are: 'InProgress', 'Succeeded', and 'Failed'.", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "NetworkOperationStatus", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/Error" + } + }, + "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Common resource representation.", + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json new file mode 100644 index 000000000000..19e3bb64f699 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json @@ -0,0 +1,902 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-04-01", + "title": "WebApplicationFirewallManagement", + "description": "APIs to manage web application firewall rules." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Lists all of the protection policies within a resource group.", + "operationId": "Policies_List", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Retrieve protection policy with specified name within a resource group.", + "operationId": "Policies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Policy": { + "$ref": "./examples/WafPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Create or update policy with specified rule set name within a resource group.", + "operationId": "Policies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "description": "Policy to be created.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new protection policy has been created.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates specific policy": { + "$ref": "./examples/WafPolicyCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Deletes Policy", + "operationId": "Policies_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the policy was not found." + } + }, + "x-ms-examples": { + "Delete protection policy": { + "$ref": "./examples/WafPolicyDelete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets": { + "get": { + "tags": [ + "WebApplicationFirewallManagedRuleSets" + ], + "description": "Lists all available managed rule sets.", + "operationId": "ManagedRuleSets_List", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall managed rule sets.", + "schema": { + "$ref": "#/definitions/ManagedRuleSetDefinitionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListManagedRuleSets.json" + } + } + } + } + }, + "definitions": { + "WebApplicationFirewallPolicy": { + "description": "Defines web application firewall policy.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the web application firewall policy.", + "$ref": "#/definitions/WebApplicationFirewallPolicyProperties" + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "WebApplicationFirewallPolicyProperties": { + "description": "Defines web application firewall policy properties.", + "properties": { + "policySettings": { + "description": "Describes settings for the policy.", + "$ref": "#/definitions/PolicySettings" + }, + "customRules": { + "description": "Describes custom rules inside the policy.", + "$ref": "#/definitions/CustomRuleList" + }, + "managedRules": { + "description": "Describes managed rules inside the policy.", + "$ref": "#/definitions/ManagedRuleSetList" + }, + "frontendEndpointLinks": { + "description": "Describes Frontend Endpoints associated with this Web Application Firewall policy.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/FrontendEndpointLink" + } + }, + "routingRuleLinks": { + "description": "Describes Routing Rules associated with this Web Application Firewall policy.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RoutingRuleLink" + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the policy." + }, + "resourceState": { + "title": "Resource status of the policy.", + "readOnly": true, + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyResourceState", + "modelAsString": true + } + } + } + }, + "WebApplicationFirewallPolicyList": { + "description": "Defines a list of WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + }, + "description": "List of WebApplicationFirewallPolicies within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." + } + } + }, + "PolicySettings": { + "description": "Defines top-level WebApplicationFirewallPolicy configuration settings.", + "properties": { + "enabledState": { + "description": "Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "PolicyEnabledState", + "modelAsString": true + } + }, + "mode": { + "description": "Describes if it is in detection mode or prevention mode at policy level.", + "type": "string", + "enum": [ + "Prevention", + "Detection" + ], + "x-ms-enum": { + "name": "PolicyMode", + "modelAsString": true + } + }, + "redirectUrl": { + "description": "If action type is redirect, this field represents redirect URL for the client.", + "type": "string" + }, + "customBlockResponseStatusCode": { + "description": "If the action type is block, customer can override the response status code.", + "type": "integer" + }, + "customBlockResponseBody": { + "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + } + } + }, + "CustomRuleList": { + "description": "Defines contents of custom rules", + "properties": { + "rules": { + "description": "List of rules", + "type": "array", + "items": { + "$ref": "#/definitions/CustomRule" + } + } + } + }, + "CustomRule": { + "description": "Defines contents of a web application rule", + "required": [ + "priority", + "ruleType", + "matchConditions", + "action" + ], + "properties": { + "name": { + "type": "string", + "description": "Describes the name of the rule.", + "maxLength": 128 + }, + "priority": { + "description": "Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.", + "type": "integer" + }, + "enabledState": { + "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "CustomRuleEnabledState", + "modelAsString": true + } + }, + "ruleType": { + "description": "Describes type of rule.", + "type": "string", + "enum": [ + "MatchRule", + "RateLimitRule" + ], + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } + }, + "rateLimitDurationInMinutes": { + "description": "Time window for resetting the rate limit count. Default is 1 minute.", + "type": "integer", + "minimum": 0, + "maximum": 5 + }, + "rateLimitThreshold": { + "description": "Number of allowed requests per client within the time window.", + "type": "integer", + "minimum": 0 + }, + "matchConditions": { + "description": "List of match conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchCondition" + } + }, + "action": { + "description": "Describes what action to be applied when rule matches.", + "$ref": "#/definitions/ActionType" + } + } + }, + "TransformType": { + "description": "Describes what transforms applied before matching.", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "TransformType", + "modelAsString": true + } + }, + "MatchCondition": { + "description": "Define a match condition.", + "required": [ + "matchVariable", + "operator", + "matchValue" + ], + "properties": { + "matchVariable": { + "description": "Request variable to compare with.", + "type": "string", + "enum": [ + "RemoteAddr", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeader", + "RequestBody", + "Cookies", + "SocketAddr" + ], + "x-ms-enum": { + "name": "MatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null.", + "type": "string" + }, + "operator": { + "description": "Comparison type to use for matching with the variable value.", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith", + "RegEx" + ], + "x-ms-enum": { + "name": "Operator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if the result of this condition should be negated.", + "type": "boolean" + }, + "matchValue": { + "description": "List of possible match values.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms.", + "type": "array", + "items": { + "$ref": "#/definitions/TransformType" + } + } + } + }, + "ManagedRuleSetList": { + "description": "Defines the list of managed rule sets for the policy.", + "properties": { + "managedRuleSets": { + "description": "List of rule sets.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSet" + } + } + } + }, + "ManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleExclusion" + }, + "description": "Describes the exclusions that are applied to all rules in the set." + }, + "ruleGroupOverrides": { + "description": "Defines the rule group overrides to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleGroupOverride" + } + } + } + }, + "ManagedRuleGroupOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "Describes the managed rule group to override.", + "type": "string" + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleExclusion" + }, + "description": "Describes the exclusions that are applied to all rules in the group." + }, + "rules": { + "description": "List of rules that will be disabled. If none specified, all rules in the group will be disabled.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleOverride" + } + } + } + }, + "ManagedRuleOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + }, + "enabledState": { + "description": "Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.", + "$ref": "#/definitions/ManagedRuleEnabledState" + }, + "action": { + "description": "Describes the override action to be applied when rule matches.", + "$ref": "#/definitions/ActionType" + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleExclusion" + }, + "description": "Describes the exclusions that are applied to this specific rule." + } + } + }, + "ManagedRuleSetDefinitionList": { + "description": "List of managed rule set definitions available for use in a policy.", + "properties": { + "value": { + "description": "List of managed rule set definitions.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSetDefinition" + } + }, + "nextLink": { + "type": "string", + "description": "URL to retrieve next set of managed rule set definitions." + } + } + }, + "ManagedRuleSetDefinition": { + "description": "Describes the a managed rule set definition.", + "properties": { + "properties": { + "description": "Properties for a managed rule set definition.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedRuleSetDefinitionProperties" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ManagedRuleSetDefinitionProperties": { + "description": "Properties for a managed rule set definition.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Provisioning state of the managed rule set." + }, + "ruleSetId": { + "type": "string", + "readOnly": true, + "description": "Id of the managed rule set." + }, + "ruleSetType": { + "type": "string", + "readOnly": true, + "description": "Type of the managed rule set." + }, + "ruleSetVersion": { + "type": "string", + "readOnly": true, + "description": "Version of the managed rule set type." + }, + "ruleGroups": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleGroupDefinition" + }, + "description": "Rule groups of the managed rule set." + } + } + }, + "ManagedRuleGroupDefinition": { + "description": "Describes a managed rule group.", + "properties": { + "ruleGroupName": { + "type": "string", + "readOnly": true, + "description": "Name of the managed rule group." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the managed rule group." + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleDefinition" + }, + "description": "List of rules within the managed rule group." + } + } + }, + "ManagedRuleDefinition": { + "description": "Describes a managed rule definition.", + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "readOnly": true, + "type": "string" + }, + "defaultState": { + "description": "Describes the default state for the managed rule.", + "readOnly": true, + "$ref": "#/definitions/ManagedRuleEnabledState" + }, + "defaultAction": { + "description": "Describes the default action to be applied when the managed rule matches.", + "readOnly": true, + "$ref": "#/definitions/ActionType" + }, + "description": { + "description": "Describes the functionality of the managed rule.", + "readOnly": true, + "type": "string" + } + } + }, + "ManagedRuleExclusion": { + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Exclude variables from managed rule evaluation.", + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestHeaderNames", + "RequestCookieNames", + "QueryStringArgNames", + "RequestBodyPostArgNames" + ], + "description": "The variable type to be excluded.", + "x-ms-enum": { + "name": "ManagedRuleExclusionMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "Equals", + "Contains", + "StartsWith", + "EndsWith", + "EqualsAny" + ], + "description": "Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to.", + "x-ms-enum": { + "name": "ManagedRuleExclusionSelectorMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "Selector value for which elements in the collection this exclusion applies to." + } + } + }, + "ActionType": { + "description": "Defines the action to take on rule match.", + "type": "string", + "enum": [ + "Allow", + "Block", + "Log", + "Redirect" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + }, + "ManagedRuleEnabledState": { + "description": "Describes if the managed rule is in enabled or disabled state.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ManagedRuleEnabledState", + "modelAsString": true + } + }, + "ErrorResponse": { + "description": "Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "readOnly": true, + "type": "string" + } + } + }, + "FrontendEndpointLink": { + "description": "Defines the Resource ID for a Frontend Endpoint.", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + }, + "RoutingRuleLink": { + "description": "Defines the Resource ID for a Routing Rule.", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + } + }, + "parameters": { + "PolicyNameParameter": { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "x-ms-parameter-location": "method", + "description": "The name of the Web Application Firewall Policy." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + } + } +} diff --git a/specification/frontdoor/resource-manager/readme.go.md b/specification/frontdoor/resource-manager/readme.go.md index 7922be870998..e4b384f9f0c2 100644 --- a/specification/frontdoor/resource-manager/readme.go.md +++ b/specification/frontdoor/resource-manager/readme.go.md @@ -19,6 +19,7 @@ batch: - tag: package-2019-04 - tag: package-2019-05 - tag: package-2020-01 + - tag: package-2020-04 - tag: package-2020-05 ``` @@ -31,6 +32,15 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-04' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-04-01/$(namespace) +``` + ### Tag: package-2020-01 and go These settings apply only when `--tag=package-2020-01 --go` is specified on the command line. diff --git a/specification/frontdoor/resource-manager/readme.md b/specification/frontdoor/resource-manager/readme.md index 2728dffd936e..468e7022148d 100644 --- a/specification/frontdoor/resource-manager/readme.md +++ b/specification/frontdoor/resource-manager/readme.md @@ -49,6 +49,24 @@ directive: ``` +### Tag: package-2020-04 + +These settings apply only when `--tag=package-2020-04` is specified on the command line. + +``` yaml $(tag) == 'package-2020-04' +input-file: +- Microsoft.Network/stable/2020-04-01/network.json +- Microsoft.Network/stable/2019-11-01/networkexperiment.json +- Microsoft.Network/stable/2020-04-01/frontdoor.json +- Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json +directive: + - where: + - $.paths + suppress: + - OperationsAPIImplementation +``` + + ### Tag: package-2020-01 These settings apply only when `--tag=package-2020-01` is specified on the command line. From 429e2937619f7cf14561904dd781080c2b6d9a83 Mon Sep 17 00:00:00 2001 From: azuresdkci Date: Thu, 28 May 2020 03:30:34 +0000 Subject: [PATCH 025/318] regenerated all-api-versions --- specification/frontdoor/resource-manager/readme.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/specification/frontdoor/resource-manager/readme.md b/specification/frontdoor/resource-manager/readme.md index 468e7022148d..0268a71d2be0 100644 --- a/specification/frontdoor/resource-manager/readme.md +++ b/specification/frontdoor/resource-manager/readme.md @@ -273,6 +273,9 @@ input-file: - $(this-folder)/Microsoft.Network/stable/2019-11-01/networkexperiment.json - $(this-folder)/Microsoft.Network/stable/2020-05-01/frontdoor.json - $(this-folder)/Microsoft.Network/stable/2019-10-01/webapplicationfirewall.json + - $(this-folder)/Microsoft.Network/stable/2020-04-01/network.json + - $(this-folder)/Microsoft.Network/stable/2020-04-01/frontdoor.json + - $(this-folder)/Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json - $(this-folder)/Microsoft.Network/stable/2020-01-01/network.json - $(this-folder)/Microsoft.Network/stable/2020-01-01/frontdoor.json - $(this-folder)/Microsoft.Network/stable/2019-11-01/network.json From bfa880b24aa762bd810a04a6d60b9418a9755433 Mon Sep 17 00:00:00 2001 From: brpanask <64860651+brpanask@users.noreply.github.com> Date: Thu, 28 May 2020 04:41:58 -0400 Subject: [PATCH 026/318] Add async operation's api to storage cache RP (#9483) --- .../examples/AscOperations_Get.json | 20 ++++ .../stable/2020-03-01/storagecache.json | 98 +++++++++++++++++++ 2 files changed, 118 insertions(+) create mode 100644 specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/AscOperations_Get.json diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/AscOperations_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/AscOperations_Get.json new file mode 100644 index 000000000000..783476d2d00e --- /dev/null +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/AscOperations_Get.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "613192d7-503f-477a-9cfe-4efc3ee2bd60", + "location": "West US", + "operationId": "testoperationid", + "api-version": "2020-03-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/id/locations/westus/ascOperations/testoperationid", + "name": "testoperationid", + "startTime": "2020-03-01T13:13:13.933Z", + "endTime": "2020-03-01T16:13:13.933Z", + "status": "Succeeded" + } + } + } +} diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/storagecache.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/storagecache.json index 3549bc83126f..2e1cdcb3872d 100644 --- a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/storagecache.json +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/storagecache.json @@ -158,6 +158,59 @@ "operationId": "UsageModels_List" } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/locations/{location}/ascOperations/{operationId}": { + "get": { + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The region name which the operation will lookup into." + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation id which uniquely identifies the asynchronous operation." + } + ], + "responses": { + "200": { + "description": "Gets the status of an asynchronous operation for the Azure HPC cache", + "schema": { + "$ref": "#/definitions/AscOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AscOperations_Get": { + "$ref": "./examples/AscOperations_Get.json" + } + }, + "tags": [ + "AscOperations" + ], + "description": "Gets the status of an asynchronous operation for the Azure HPC cache", + "operationId": "AscOperations_Get" + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.StorageCache/caches": { "get": { "produces": [ @@ -1097,6 +1150,51 @@ }, "type": "object" }, + "AscOperation": { + "description": "The status of operation.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "The operation Id." + }, + "name": { + "type": "string", + "description": "The operation name." + }, + "startTime": { + "type": "string", + "description": "The start time of the operation." + }, + "endTime": { + "type": "string", + "description": "The end time of the operation." + }, + "status": { + "type": "string", + "description": "The status of the operation." + }, + "error": { + "type": "object", + "description": "The error detail of the operation if any.", + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, "Cache": { "description": "A Cache instance. Follows Azure Resource Manager standards: https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md", "properties": { From cfeeb87e8a6f698e88b6e1fdfdfbb87532cb5817 Mon Sep 17 00:00:00 2001 From: Shubham Dhond Date: Thu, 28 May 2020 02:20:46 -0700 Subject: [PATCH 027/318] Add basicpublishingcredentialspolicies to Microsoft.Web 2019-08-01 (#9250) * Add basicpublishingcredentialspolicies to Microsoft.Web stable 2019-08-01 * Made new resource a proxy only resource * Added missing reference * Addressing comments * Added examples --- .../stable/2019-08-01/CommonDefinitions.json | 5 +- .../stable/2019-08-01/WebApps.json | 310 +++++++++++++++++- .../GetPublishingCredentialsPolicy.json | 18 + .../ListPublishingCredentialsPolicies.json | 27 ++ .../UpdatePublishingCredentialsPolicy.json | 23 ++ 5 files changed, 377 insertions(+), 6 deletions(-) create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/GetPublishingCredentialsPolicy.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/ListPublishingCredentialsPolicies.json create mode 100644 specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/UpdatePublishingCredentialsPolicy.json diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/CommonDefinitions.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/CommonDefinitions.json index fe02ddd901a7..cf72d9b7c660 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/CommonDefinitions.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/CommonDefinitions.json @@ -1232,9 +1232,10 @@ "type": { "description": "Type of managed service identity.", "enum": [ - "None", "SystemAssigned", - "UserAssigned" + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" ], "type": "string", "x-ms-enum": { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/WebApps.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/WebApps.json index 1efc1c1d5478..281daf0188c8 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/WebApps.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/WebApps.json @@ -710,6 +710,253 @@ "x-ms-long-running-operation": true } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.", + "description": "Description for Returns whether Scm basic auth is allowed and whether Ftp is allowed for a given site.", + "operationId": "WebApps_GetBasicPublishingCredentialsPolicies", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmPublishingCredentialsPoliciesCollection" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "List Publishing Credentials Policies": { + "$ref": "./examples/ListPublishingCredentialsPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/ftp": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns whether FTP is allowed on the site or not.", + "description": "Description for Returns whether FTP is allowed on the site or not.", + "operationId": "WebApps_GetFtpAllowed", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get FTP Allowed": { + "$ref": "./examples/GetPublishingCredentialsPolicy.json" + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates whether FTP is allowed on the site or not.", + "description": "Description for Updates whether FTP is allowed on the site or not.", + "operationId": "WebApps_UpdateFtpAllowed", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "csmPublishingAccessPoliciesEntity", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update FTP Allowed": { + "$ref": "./examples/UpdatePublishingCredentialsPolicy.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/basicPublishingCredentialsPolicies/scm": { + "get": { + "tags": [ + "WebApps" + ], + "summary": "Returns whether Scm basic auth is allowed on the site or not.", + "description": "Description for Returns whether Scm basic auth is allowed on the site or not.", + "operationId": "WebApps_GetScmAllowed", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Get SCM Allowed": { + "$ref": "./examples/GetPublishingCredentialsPolicy.json" + } + } + }, + "put": { + "tags": [ + "WebApps" + ], + "summary": "Updates whether user publishing credentials are allowed on the site or not.", + "description": "Description for Updates whether user publishing credentials are allowed on the site or not.", + "operationId": "WebApps_UpdateScmAllowed", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "name": "name", + "in": "path", + "description": "Name of the app.", + "required": true, + "type": "string" + }, + { + "name": "csmPublishingAccessPoliciesEntity", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity" + } + }, + "default": { + "description": "App Service error response.", + "schema": { + "$ref": "./CommonDefinitions.json#/definitions/DefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Update SCM Allowed": { + "$ref": "./examples/UpdatePublishingCredentialsPolicy.json" + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Web/sites/{name}/config": { "get": { "tags": [ @@ -19827,9 +20074,10 @@ }, "identityType": { "enum": [ - "None", "SystemAssigned", - "UserAssigned" + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" ], "type": "string", "x-ms-enum": { @@ -20581,6 +20829,59 @@ } } }, + "CsmPublishingCredentialsPoliciesCollection": { + "description": "Publishing Credentials Policies collection.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "CsmPublishingCredentialsPoliciesCollection resource specific properties", + "required": [ + "ftp", + "scm" + ], + "properties": { + "ftp": { + "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity", + "description": "Whether FTP is allowed." + }, + "scm": { + "$ref": "#/definitions/CsmPublishingCredentialsPoliciesEntity", + "description": "Whether Scm Basic Auth is allowed." + } + }, + "x-ms-client-flatten": true + } + } + }, + "CsmPublishingCredentialsPoliciesEntity": { + "description": "Publishing Credentials Policies parameters.", + "type": "object", + "allOf": [ + { + "$ref": "./CommonDefinitions.json#/definitions/ProxyOnlyResource" + } + ], + "properties": { + "properties": { + "description": "CsmPublishingCredentialsPoliciesEntity resource specific properties", + "required": [ + "allow" + ], + "properties": { + "allow": { + "description": "true to allow access to a publishing method; otherwise, false.", + "type": "boolean" + } + }, + "x-ms-client-flatten": true + } + } + }, "CsmPublishingProfileOptions": { "description": "Publishing options for requested profile.", "type": "object", @@ -21289,9 +21590,10 @@ }, "identityType": { "enum": [ - "None", "SystemAssigned", - "UserAssigned" + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" ], "type": "string", "x-ms-enum": { diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/GetPublishingCredentialsPolicy.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/GetPublishingCredentialsPolicy.json new file mode 100644 index 000000000000..1a2b02bb2b8d --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/GetPublishingCredentialsPolicy.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "api-version": "2019-08-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "allow": false + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/ListPublishingCredentialsPolicies.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/ListPublishingCredentialsPolicies.json new file mode 100644 index 000000000000..f96c4a736517 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/ListPublishingCredentialsPolicies.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "api-version": "2019-08-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "ftp": { + "properties": { + "allow": false + } + }, + "scm": { + "properties": { + "allow": false + } + } + } + } + } + } +} diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/UpdatePublishingCredentialsPolicy.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/UpdatePublishingCredentialsPolicy.json new file mode 100644 index 000000000000..b8c83f16c837 --- /dev/null +++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/examples/UpdatePublishingCredentialsPolicy.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "rg", + "name": "testSite", + "api-version": "2019-08-01", + "csmPublishingAccessPoliciesEntity": { + "properties": { + "allow": true + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "properties": { + "allow": true + } + } + } + } +} From 9661af80205b3ea2e45583d08191ae4421ab2101 Mon Sep 17 00:00:00 2001 From: Jennifer Marsman Date: Thu, 28 May 2020 09:32:53 -0400 Subject: [PATCH 028/318] Removed description as a required field for SearchIndexerSkillset (#9588) * Removed color and imageType from the visualFeature enumeration in the V2 SDK. These weren't referenced in the examples. * Removed description as a required field for SearchIndexerSkillset --- .../Azure.Search/preview/2019-05-06-preview/searchservice.json | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json index d41c4f4d31dc..abbf86f37d06 100644 --- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json @@ -6830,7 +6830,6 @@ }, "required": [ "name", - "description", "skills" ], "externalDocs": { From 1280dd676549a0631330945508bcee05ee93c800 Mon Sep 17 00:00:00 2001 From: Xia ZHU <398289931@qq.com> Date: Thu, 28 May 2020 22:06:11 +0800 Subject: [PATCH 029/318] add secondly (#9225) --- .../AnomalyDetector/preview/v1.0/AnomalyDetector.json | 7 ++++--- 1 file changed, 4 insertions(+), 3 deletions(-) diff --git a/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json b/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json index 8a3f2b3797fc..ac5d89494132 100644 --- a/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json +++ b/specification/cognitiveservices/data-plane/AnomalyDetector/preview/v1.0/AnomalyDetector.json @@ -188,7 +188,7 @@ }, "Granularity": { "type": "string", - "description": "Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid.", + "description": "Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid.", "x-nullable": false, "x-ms-enum": { "name": "Granularity", @@ -200,7 +200,8 @@ "weekly", "daily", "hourly", - "minutely" + "minutely", + "secondly" ] }, "CustomInterval": { @@ -404,7 +405,7 @@ }, "granularity": { "$ref": "#/definitions/Granularity", - "description": "Can only be one of yearly, monthly, weekly, daily, hourly or minutely. Granularity is used for verify whether input series is valid." + "description": "Can only be one of yearly, monthly, weekly, daily, hourly, minutely or secondly. Granularity is used for verify whether input series is valid." }, "customInterval": { "description": "Custom Interval is used to set non-standard time interval, for example, if the series is 5 minutes, request can be set as {\"granularity\":\"minutely\", \"customInterval\":5}.", From ec0932fa8b708db77ca3fa0bb522bb8a35188168 Mon Sep 17 00:00:00 2001 From: Jennifer Marsman Date: Thu, 28 May 2020 15:01:38 -0400 Subject: [PATCH 030/318] Removed TextExtractionAlgorithm from OCRSkill (#9604) * Removed color and imageType from the visualFeature enumeration in the V2 SDK. These weren't referenced in the examples. * Removed property TextExtractionAlgorithm (which is obsolete) and added property LineEnding to OCRSkill * Fixed bug with json escape characters and quoted default values in descriptions * Backing out changes for LineEnding, so we can get the TextExtractionAlgorithm removal in --- .../2019-05-06-preview/searchservice.json | 28 ------------------- 1 file changed, 28 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json index abbf86f37d06..a8d016d44877 100644 --- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json @@ -7015,10 +7015,6 @@ } ], "properties": { - "textExtractionAlgorithm": { - "$ref": "#/definitions/TextExtractionAlgorithm", - "description": "A value indicating which algorithm to use for extracting text. Default is printed." - }, "defaultLanguageCode": { "$ref": "#/definitions/OcrSkillLanguage", "description": "A value indicating which language code to use. Default is en." @@ -7300,30 +7296,6 @@ ], "description": "Response from a list skillset request. If successful, it includes the full definitions of all skillsets." }, - "TextExtractionAlgorithm": { - "type": "string", - "enum": [ - "printed", - "handwritten" - ], - "x-ms-enum": { - "name": "TextExtractionAlgorithm", - "modelAsString": false, - "values": [ - { - "value": "printed", - "name": "Printed", - "description": "An algorithm suitable for printed text." - }, - { - "value": "handwritten", - "name": "Handwritten", - "description": "An algorithm suitable for handwritten text." - } - ] - }, - "description": "A value indicating which algorithm to use. Default is printed." - }, "TextSplitMode": { "type": "string", "enum": [ From 358aade743f3b749da5aee9394f34b55466f3b14 Mon Sep 17 00:00:00 2001 From: Jennifer Marsman Date: Thu, 28 May 2020 15:10:40 -0400 Subject: [PATCH 031/318] Changed skill-related enums to strings for values that may change (#9621) * Removed color and imageType from the visualFeature enumeration in the V2 SDK. These weren't referenced in the examples. * Changed skill-related enums to be strings for values that may change in the future --- .../preview/2019-05-06-preview/searchservice.json | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json index a8d016d44877..c2a69aac29b9 100644 --- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/searchservice.json @@ -7304,7 +7304,7 @@ ], "x-ms-enum": { "name": "TextSplitMode", - "modelAsString": false, + "modelAsString": true, "values": [ { "value": "pages", @@ -7333,7 +7333,7 @@ ], "x-ms-enum": { "name": "VisualFeature", - "modelAsString": false, + "modelAsString": true, "values": [ { "value": "adult", @@ -7382,7 +7382,7 @@ ], "x-ms-enum": { "name": "ImageDetail", - "modelAsString": false, + "modelAsString": true, "values": [ { "value": "celebrities", @@ -7411,7 +7411,7 @@ ], "x-ms-enum": { "name": "EntityCategory", - "modelAsString": false, + "modelAsString": true, "values": [ { "value": "location", From b29be680afe273be0082c277083e5a92b0c455c2 Mon Sep 17 00:00:00 2001 From: David Date: Thu, 28 May 2020 20:36:16 -0400 Subject: [PATCH 032/318] Add checkTrialAvailability endpoint to Microsoft.AVS manifest (#9618) Co-authored-by: David Ricciardi --- .../Locations_CheckTrialAvailability.json | 15 +++++ .../preview/2019-08-09-preview/vmware.json | 63 +++++++++++++++++++ 2 files changed, 78 insertions(+) create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/examples/Locations_CheckTrialAvailability.json diff --git a/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/examples/Locations_CheckTrialAvailability.json b/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/examples/Locations_CheckTrialAvailability.json new file mode 100644 index 000000000000..1a69e75df941 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/examples/Locations_CheckTrialAvailability.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2019-08-09-preview", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "status": "TrialAvailable", + "availableHosts": 4 + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/vmware.json b/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/vmware.json index 2a5f491f4e2f..8c6fb346d26d 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/vmware.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/vmware.json @@ -128,6 +128,49 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkTrialAvailability": { + "post": { + "tags": [ + "Locations" + ], + "description": "Return trial status for subscription by region", + "operationId": "Locations_CheckTrialAvailability", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "Azure region" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Request has succeeded", + "schema": { + "$ref": "#/definitions/Trial" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "CheckQuotaAvailability": { + "$ref": "./examples/Locations_CheckTrialAvailability.json" + } + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkQuotaAvailability": { "post": { "tags": [ @@ -753,6 +796,26 @@ } }, "definitions": { + "Trial": { + "description": "Subscription trial availability", + "properties": { + "status": { + "description": "Trial status", + "type": "string", + "enum": [ + "TrialAvailable", + "TrialUsed", + "TrialDisabled" + ], + "readOnly": true + }, + "availableHosts": { + "description": "Number of trial hosts available", + "type": "integer", + "readOnly": true + } + } + }, "Quota": { "description": "Subscription quotas", "properties": { From fc2855c6bcef41a1791f90dd91d13643ef0ce443 Mon Sep 17 00:00:00 2001 From: xaliciayang <59986952+xaliciayang@users.noreply.github.com> Date: Thu, 28 May 2020 17:37:14 -0700 Subject: [PATCH 033/318] update 2019-06-01-preview ManagedDatabases swagger file (#9535) * update 2019-06-01-preview ManagedDatabases swagger file * added newline to eof --- .../2019-06-01-preview/managedDatabases.json | 14 +++++++------- 1 file changed, 7 insertions(+), 7 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json index 195dd2b4ce58..37b1e4031a56 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json @@ -101,7 +101,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription." + "description": "*** Error Responses: ***\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" } }, "x-ms-pageable": { @@ -146,7 +146,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found." + "description": "*** Error Responses: ***\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." } }, "x-ms-examples": { @@ -257,7 +257,7 @@ "description": "Successfully deleted the managed database." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 GeoReplicationDatabaseNotPrimary - The operation cannot be performed since the database '{0}' is a replication target.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 DropDisallowedDuringFailover - Can not drop database because a failover operation is in progress on the failover group.\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 GeoReplicationDatabaseNotPrimary - The operation cannot be performed since the database '{0}' is a replication target.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 DropDisallowedDuringFailover - Can not drop database because a failover operation is in progress on the failover group.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Deleting the managed database is in progress." @@ -313,7 +313,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + "description": "*** Error Responses: ***\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." }, "202": { "description": "Updating the managed database is in progress." @@ -359,7 +359,7 @@ } }, "default": { - "description": "*** Error Responses: ***\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription." + "description": "*** Error Responses: ***\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" } }, "x-ms-pageable": { @@ -410,7 +410,7 @@ "description": "Successfully completed restore request." }, "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCompleteRestoreRequest - The complete database restore request is invalid\n\n * 400 InvalidDatabaseCompleteRestoreRequestLastBackupName - The last backup name is invalid\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 MissingThumbprint - Can not find server certificate.\n\n * 400 PartiallyContainedDatabaseUnsupported - \"Backup for a partially contained database is not supported.\"\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 BackupSetNotFound - \"No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 ExternalBackupAlreadySignaledToComplete - The restore request has already been signaled to complete.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 ExternalBackupRestoreHasNotBeenStarted - The restore request can only be completed once the restore has started.\n\n * 400 ExternalBackupUpgradeInProgress - The restore request cannot be completed, since upgrade is in progress.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 IncompatiblePhysicalLayoutTooManyXTPFiles - Database backup contains incompatible physical layout. Multiple files found in the filegroup that contains MEMORY_OPTIMIZED_DATA.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 XtpInitializedDuringRestore - Memory-optimized filegroup must be empty in order to be restored on General Purpose tier of SQL Database Managed Instance.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 FullBackupDamaged - Provided full backup is damaged.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources." + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCompleteRestoreRequest - The complete database restore request is invalid\n\n * 400 InvalidDatabaseCompleteRestoreRequestLastBackupName - The last backup name is invalid\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit.\n\n * 400 BackupSetNotFound - \"No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 XtpInitializedDuringRestore - Memory-optimized filegroup must be empty in order to be restored on General Purpose tier of SQL Database Managed Instance.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 FullBackupDamaged - Provided full backup is damaged.\n\n * 400 PartiallyContainedDatabaseUnsupported - \"Backup for a partially contained database is not supported.\"\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 ExternalBackupAlreadySignaledToComplete - The restore request has already been signaled to complete.\n\n * 400 ExternalBackupRestoreHasNotBeenStarted - The restore request can only be completed once the restore has started.\n\n * 400 ExternalBackupUpgradeInProgress - The restore request cannot be completed, since upgrade is in progress.\n\n * 400 IncompatiblePhysicalLayoutTooManyXTPFiles - Database backup contains incompatible physical layout. Multiple files found in the filegroup that contains MEMORY_OPTIMIZED_DATA.\n\n * 400 BlobStorageFailure - Blob storage failure has occurred.\n\n * 400 MissingThumbprint - Can not find server certificate.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources." }, "202": { "description": "Completing restore request is in progress." @@ -606,7 +606,7 @@ ] }, "createMode": { - "description": "Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore.", + "description": "Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required).", "enum": [ "Default", "RestoreExternalBackup", From 5254afd35572ee1403e5753f93e6f4e04a40f380 Mon Sep 17 00:00:00 2001 From: Ray Chen Date: Fri, 29 May 2020 09:39:20 +0800 Subject: [PATCH 034/318] Update script version for PPE pipeline (#9616) * Add free-form object spec for testing purpose. * Revert "Add free-form object spec for testing purpose." This reverts commit b711d809b6ae964fcbe7d04f31fec76db8798438. * Update script version for ppe pipeline. --- .../package-lock.json | 118 ++++++++++++------ .azure-pipelines-preproduction/package.json | 2 +- 2 files changed, 80 insertions(+), 40 deletions(-) diff --git a/.azure-pipelines-preproduction/package-lock.json b/.azure-pipelines-preproduction/package-lock.json index 3333e5d1810e..3fa5327a4d29 100644 --- a/.azure-pipelines-preproduction/package-lock.json +++ b/.azure-pipelines-preproduction/package-lock.json @@ -93,20 +93,21 @@ } }, "@azure/rest-api-specs-scripts": { - "version": "0.9.1", - "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.9.1.tgz", - "integrity": "sha512-F8Zg+kSd2/hoGCQ7DoMhTCc0u1uf0IIjxWsIpeVWBcWuiBtQ1MOlz5Yib4nCa9q4Dmhfnt5AYBv/q7vkM1aPmw==", + "version": "0.10.1", + "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.10.1.tgz", + "integrity": "sha512-O746D8Cg5OJqNrWw9uCvlTiMysXlYJ3pf7KmiJRvWqp8STyfhgon1nw65K3hUwFFQd3Ioc5SsOhnWJ+DVn5h3w==", "dev": true, "requires": { "@azure/avocado": "^0.4.1", - "@azure/oad": "^0.8.0", + "@azure/oad": "^0.8.1", + "@azure/swagger-validation-common": "^0.0.2", "@octokit/rest": "^16.42.0", "@ts-common/string-map": "^0.3.0", "commonmark": "0.27.0", "fs-extra": "^7.0.1", "glob": "^7.1.3", "js-yaml": "^3.13.1", - "oav": "0.21.5", + "oav": "^0.21.6", "request": "^2.88.0" }, "dependencies": { @@ -157,6 +158,12 @@ } } }, + "@azure/swagger-validation-common": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/@azure/swagger-validation-common/-/swagger-validation-common-0.0.2.tgz", + "integrity": "sha512-/OTgP3USqq2Cko6vzDgmODpqGjk9eTANYMBMXtgsTgh9RtR6b3HZdQTPe5dqkqes/YoIBW8IarJ0B0HucAv1+A==", + "dev": true + }, "@microsoft.azure/autorest-extension-base": { "version": "1.0.13", "resolved": "https://registry.npmjs.org/@microsoft.azure/autorest-extension-base/-/autorest-extension-base-1.0.13.tgz", @@ -183,21 +190,21 @@ "dev": true }, "@octokit/auth-token": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.0.tgz", - "integrity": "sha512-eoOVMjILna7FVQf96iWc3+ZtE/ZT6y8ob8ZzcqKY1ibSQCnu4O/B7pJvzMx5cyZ/RjAff6DAdEb0O0Cjcxidkg==", + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.1.tgz", + "integrity": "sha512-NB81O5h39KfHYGtgfWr2booRxp2bWOJoqbWwbyUg2hw6h35ArWYlAST5B3XwAkbdcx13yt84hFXyFP5X0QToWA==", "dev": true, "requires": { - "@octokit/types": "^2.0.0" + "@octokit/types": "^4.0.1" } }, "@octokit/endpoint": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.1.tgz", - "integrity": "sha512-pOPHaSz57SFT/m3R5P8MUu4wLPszokn5pXcB/pzavLTQf2jbU+6iayTvzaY6/BiotuRS0qyEUkx3QglT4U958A==", + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.2.tgz", + "integrity": "sha512-xs1mmCEZ2y4shXCpFjNq3UbmNR+bLzxtZim2L0zfEtj9R6O6kc4qLDvYw66hvO6lUsYzPTM5hMkltbuNAbRAcQ==", "dev": true, "requires": { - "@octokit/types": "^2.11.1", + "@octokit/types": "^4.0.1", "is-plain-object": "^3.0.0", "universal-user-agent": "^5.0.0" }, @@ -220,6 +227,17 @@ "dev": true, "requires": { "@octokit/types": "^2.0.1" + }, + "dependencies": { + "@octokit/types": { + "version": "2.16.2", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", + "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", + "dev": true, + "requires": { + "@types/node": ">= 8" + } + } } }, "@octokit/plugin-request-log": { @@ -236,17 +254,28 @@ "requires": { "@octokit/types": "^2.0.1", "deprecation": "^2.3.1" + }, + "dependencies": { + "@octokit/types": { + "version": "2.16.2", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", + "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", + "dev": true, + "requires": { + "@types/node": ">= 8" + } + } } }, "@octokit/request": { - "version": "5.4.2", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.2.tgz", - "integrity": "sha512-zKdnGuQ2TQ2vFk9VU8awFT4+EYf92Z/v3OlzRaSh4RIP0H6cvW1BFPXq4XYvNez+TPQjqN+0uSkCYnMFFhcFrw==", + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.4.tgz", + "integrity": "sha512-vqv1lz41c6VTxUvF9nM+a6U+vvP3vGk7drDpr0DVQg4zyqlOiKVrY17DLD6de5okj+YLHKcoqaUZTBtlNZ1BtQ==", "dev": true, "requires": { "@octokit/endpoint": "^6.0.1", "@octokit/request-error": "^2.0.0", - "@octokit/types": "^2.11.1", + "@octokit/types": "^4.0.1", "deprecation": "^2.0.0", "is-plain-object": "^3.0.0", "node-fetch": "^2.3.0", @@ -255,12 +284,12 @@ }, "dependencies": { "@octokit/request-error": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.0.tgz", - "integrity": "sha512-rtYicB4Absc60rUv74Rjpzek84UbVHGHJRu4fNVlZ1mCcyUPPuzFfG9Rn6sjHrd95DEsmjSt1Axlc699ZlbDkw==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.1.tgz", + "integrity": "sha512-5lqBDJ9/TOehK82VvomQ6zFiZjPeSom8fLkFVLuYL3sKiIb5RB8iN/lenLkY7oBmyQcGP7FBMGiIZTO8jufaRQ==", "dev": true, "requires": { - "@octokit/types": "^2.0.0", + "@octokit/types": "^4.0.1", "deprecation": "^2.0.0", "once": "^1.4.0" } @@ -285,6 +314,17 @@ "@octokit/types": "^2.0.0", "deprecation": "^2.0.0", "once": "^1.4.0" + }, + "dependencies": { + "@octokit/types": { + "version": "2.16.2", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", + "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", + "dev": true, + "requires": { + "@types/node": ">= 8" + } + } } }, "@octokit/rest": { @@ -312,9 +352,9 @@ } }, "@octokit/types": { - "version": "2.16.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", - "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", + "version": "4.0.2", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-4.0.2.tgz", + "integrity": "sha512-+4X6qfhT/fk/5FD66395NrFLxCzD6FsGlpPwfwvnukdyfYbhiZB/FJltiT1XM5Q63rGGBSf9FPaNV3WpNHm54A==", "dev": true, "requires": { "@types/node": ">= 8" @@ -745,9 +785,9 @@ "dev": true }, "aws4": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.9.1.tgz", - "integrity": "sha512-wMHVg2EOHaMRxbzgFJ9gtjOOCrI80OHLG14rxi28XwOW8ux6IiEbRCGGGqCtdAIg4FQCbW20k9RsT4y3gJlFug==", + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.10.0.tgz", + "integrity": "sha512-3YDiu347mtVtjpyV3u5kVqQLP242c06zwDOgpeRnybmXlYYsLbtTrUBUm8i8srONt+FWobl5aibnU1030PeeuA==", "dev": true }, "balanced-match": { @@ -3720,9 +3760,9 @@ } }, "moment": { - "version": "2.25.3", - "resolved": "https://registry.npmjs.org/moment/-/moment-2.25.3.tgz", - "integrity": "sha512-PuYv0PHxZvzc15Sp8ybUCoQ+xpyPWvjOuK72a5ovzp2LI32rJXOiIfyoFoYvG3s6EwwrdkMyWuRiEHSZRLJNdg==", + "version": "2.26.0", + "resolved": "https://registry.npmjs.org/moment/-/moment-2.26.0.tgz", + "integrity": "sha512-oIixUO+OamkUkwjhAVE18rAMfRJNsNe/Stid/gwHSOfHrOtw9EhAY2AHvdKZ/k/MggcYELFCJz/Sn2pL8b8JMw==", "dev": true }, "ms": { @@ -3855,9 +3895,9 @@ "dev": true }, "oav": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/oav/-/oav-0.21.5.tgz", - "integrity": "sha512-UgF51hAZArAI9r4tSUCgJE8IYeh5Q3SLcCukwZ6jrWyG3Y8vXKl12Cs2ycGrbQg16Ygf2v2+Dkhx4RHh7uOyfw==", + "version": "0.21.6", + "resolved": "https://registry.npmjs.org/oav/-/oav-0.21.6.tgz", + "integrity": "sha512-zPLaeYuQh1aJND/e2BBLMXAy1qKvHVPido6byoC4K2wsM3MdIFrK0QePBMUXA9gZjNb6HO5oaRuM5uCEeFaxjg==", "dev": true, "requires": { "@azure/openapi-markdown": "^0.9.2", @@ -5061,9 +5101,9 @@ "dev": true }, "spdx-correct": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.0.tgz", - "integrity": "sha512-lr2EZCctC2BNR7j7WzJ2FpDznxky1sjfxvvYEyzxNyb6lZXHODmEoJeFu4JupYlkfha1KZpJyoqiJ7pgA1qq8Q==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz", + "integrity": "sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w==", "dev": true, "requires": { "spdx-expression-parse": "^3.0.0", @@ -5476,9 +5516,9 @@ "dev": true }, "uglify-js": { - "version": "3.9.3", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.9.3.tgz", - "integrity": "sha512-r5ImcL6QyzQGVimQoov3aL2ZScywrOgBXGndbWrdehKoSvGe/RmiE5Jpw/v+GvxODt6l2tpBXwA7n+qZVlHBMA==", + "version": "3.9.4", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.9.4.tgz", + "integrity": "sha512-8RZBJq5smLOa7KslsNsVcSH+KOXf1uDU8yqLeNuVKwmT0T3FA0ZoXlinQfRad7SDcbZZRZE4ov+2v71EnxNyCA==", "dev": true, "optional": true, "requires": { diff --git a/.azure-pipelines-preproduction/package.json b/.azure-pipelines-preproduction/package.json index b17c36d433e5..0b49bd3834d4 100644 --- a/.azure-pipelines-preproduction/package.json +++ b/.azure-pipelines-preproduction/package.json @@ -11,7 +11,7 @@ "license": "MIT", "devDependencies": { "@azure/avocado": "^0.6.4", - "@azure/rest-api-specs-scripts": "^0.9.1", + "@azure/rest-api-specs-scripts": "^0.10.1", "@ts-common/commonmark-to-markdown": "^1.2.0", "@ts-common/fs": "0.2.0", "@ts-common/iterator": "^0.3.6", From af2a03a6a38f931fd4a75743315172735756418f Mon Sep 17 00:00:00 2001 From: sashahdo <64434373+sashahdo@users.noreply.github.com> Date: Thu, 28 May 2020 18:59:44 -0700 Subject: [PATCH 035/318] added dismiss alerts and get single alert. (#9434) --- .../stable/2019-11-01/costmanagement.json | 217 +++++++++++++++++- .../examples/DismissResourceGroupAlerts.json | 59 +++++ .../examples/DismissSubscriptionAlerts.json | 58 +++++ .../examples/SingleResourceGroupAlert.json | 54 +++++ .../examples/SingleSubscriptionAlert.json | 53 +++++ 5 files changed, 434 insertions(+), 7 deletions(-) create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/DismissResourceGroupAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/DismissSubscriptionAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/SingleResourceGroupAlert.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/SingleSubscriptionAlert.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json index 2ed7b3ecb5a4..2f0fc9a8dc97 100644 --- a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json @@ -436,6 +436,103 @@ } } }, + "/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_Get", + "description": "Gets the alert for the scope by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionAlerts": { + "$ref": "./examples/SingleSubscriptionAlert.json" + }, + "ResourceGroupAlerts": { + "$ref": "./examples/SingleResourceGroupAlert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_Dismiss", + "description": "Dismisses the specified alert", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionAlerts": { + "$ref": "./examples/DismissSubscriptionAlerts.json" + }, + "ResourceGroupAlerts": { + "$ref": "./examples/DismissResourceGroupAlerts.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DismissAlertPayload" + }, + "description": "Parameters supplied to the Dismiss Alert operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts": { "get": { "tags": [ @@ -2018,15 +2115,58 @@ "properties": { "type": { "description": "type of alert", - "type": "string" + "type": "string", + "enum": [ + "Budget", + "Invoice", + "Credit", + "Quota", + "General", + "xCloud", + "BudgetForecast" + ], + "x-ms-enum": { + "name": "AlertType", + "modelAsString": true + } }, "category": { "description": "Alert category", - "type": "string" + "type": "string", + "enum": [ + "Cost", + "Usage", + "Billing", + "System" + ], + "x-ms-enum": { + "name": "AlertCategory", + "modelAsString": true + } }, "criteria": { "description": "Criteria that triggered alert", - "type": "string" + "type": "string", + "enum": [ + "CostThresholdExceeded", + "UsageThresholdExceeded", + "CreditThresholdApproaching", + "CreditThresholdReached", + "QuotaThresholdApproaching", + "QuotaThresholdReached", + "MultiCurrency", + "ForecastCostThresholdExceeded", + "ForecastUsageThresholdExceeded", + "InvoiceDueDateApproaching", + "InvoiceDueDateReached", + "CrossCloudNewDataAvailable", + "CrossCloudCollectionError", + "GeneralThresholdError" + ], + "x-ms-enum": { + "name": "AlertCriteria", + "modelAsString": true + } } } }, @@ -2036,7 +2176,15 @@ }, "source": { "description": "Source of alert", - "type": "string" + "type": "string", + "enum": [ + "Preset", + "User" + ], + "x-ms-enum": { + "name": "AlertSource", + "modelAsString": true + } }, "details": { "description": "Alert details", @@ -2044,7 +2192,20 @@ "properties": { "timeGrainType": { "description": "Type of timegrain cadence", - "type": "string" + "type": "string", + "enum": [ + "None", + "Monthly", + "Quarterly", + "Annually", + "BillingMonth", + "BillingQuarter", + "BillingAnnual" + ], + "x-ms-enum": { + "name": "AlertTimeGrainType", + "modelAsString": true + } }, "periodStartDate": { "description": "datetime of periodStartDate", @@ -2081,7 +2242,19 @@ }, "operator": { "description": "operator used to compare currentSpend with amount", - "type": "string" + "type": "string", + "enum": [ + "None", + "EqualTo", + "GreaterThan", + "GreaterThanOrEqualTo", + "LessThan", + "LessThanOrEqualTo" + ], + "x-ms-enum": { + "name": "AlertOperator", + "modelAsString": true + } }, "amount": { "description": "budget threshold amount", @@ -2130,7 +2303,18 @@ }, "status": { "description": "alert status", - "type": "string" + "type": "string", + "enum": [ + "None", + "Active", + "Overridden", + "Resolved", + "Dismissed" + ], + "x-ms-enum": { + "name": "AlertStatus", + "modelAsString": true + } }, "creationTime": { "description": "dateTime in which alert was created", @@ -2154,6 +2338,16 @@ } } }, + "DismissAlertPayload": { + "description": "The request payload to update an alert", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AlertProperties", + "title": "Alert properties" + } + } + }, "QueryResult": { "description": "Result of query. It contains all columns listed under groupings and aggregation.", "type": "object", @@ -2937,6 +3131,15 @@ "type": "string", "description": "This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.", "x-ms-parameter-location": "method" + }, + "alertIdParameter": { + "name": "alertId", + "in": "path", + "description": "Alert ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true } } } diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/DismissResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/DismissResourceGroupAlerts.json new file mode 100644 index 000000000000..d72950db27ea --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/DismissResourceGroupAlerts.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "alertId": "22222222-2222-2222-2222-222222222222", + "parameters": { + "properties": { + "status": "Dismissed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Dismissed", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/DismissSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/DismissSubscriptionAlerts.json new file mode 100644 index 000000000000..2b9751ea4241 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/DismissSubscriptionAlerts.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "alertId": "22222222-2222-2222-2222-222222222222", + "parameters": { + "properties": { + "status": "Dismissed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Dismissed", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/SingleResourceGroupAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/SingleResourceGroupAlert.json new file mode 100644 index 000000000000..d4f3f72ef83a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/SingleResourceGroupAlert.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "alertId": "22222222-2222-2222-2222-222222222222" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/SingleSubscriptionAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/SingleSubscriptionAlert.json new file mode 100644 index 000000000000..cd881b8ea598 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2019-11-01/examples/SingleSubscriptionAlert.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "alertId": "22222222-2222-2222-2222-222222222222" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} From 09e13f38111470a1c33105a566659230f954b15b Mon Sep 17 00:00:00 2001 From: shawnxzq Date: Fri, 29 May 2020 11:36:09 +0800 Subject: [PATCH 036/318] [DataFactory] - Add xml dataset (#9615) * Add xml dataset * Fixed typo * Fixed typo * Fixed typo * Fixed prettier check issues * Removed namespaces in xml ReadSettings Co-authored-by: Shawn Xiao (IM) --- .../2018-06-01/entityTypes/Dataset.json | 41 ++++++++++++++++ .../2018-06-01/entityTypes/Pipeline.json | 49 +++++++++++++++++++ 2 files changed, 90 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json index a0d04a784add..52f028ae93c9 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Dataset.json @@ -798,6 +798,47 @@ "location" ] }, + "XmlDataset": { + "x-ms-discriminator-value": "Xml", + "description": "Xml dataset.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Dataset" + } + ], + "properties": { + "typeProperties": { + "description": "Xml dataset properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/XmlDatasetTypeProperties" + } + } + }, + "XmlDatasetTypeProperties": { + "description": "Xml dataset properties.", + "properties": { + "location": { + "$ref": "#/definitions/DatasetLocation", + "description": "The location of the json data storage." + }, + "encodingName": { + "type": "object", + "description": "The code page name of the preferred encoding. If not specified, the default value is UTF-8, unless BOM denotes another Unicode encoding. Refer to the name column of the table in the following link to set supported values: https://msdn.microsoft.com/library/system.text.encoding.aspx. Type: string (or Expression with resultType string)." + }, + "nullValue": { + "type": "object", + "description": "The null value string. Type: string (or Expression with resultType string)." + }, + "compression": { + "description": "The data compression method used for the json dataset.", + "$ref": "#/definitions/DatasetCompression" + } + }, + "required": [ + "location" + ] + }, "OrcDataset": { "x-ms-discriminator-value": "Orc", "description": "ORC dataset.", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 322b39b41bc1..7188e70e1bdd 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -900,6 +900,29 @@ } } }, + "XmlReadSettings": { + "description": "Xml read settings.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/FormatReadSettings" + } + ], + "properties": { + "compressionProperties": { + "$ref": "#/definitions/CompressionReadSettings", + "description": "Compression settings." + }, + "validationMode": { + "type": "object", + "description": "Indicates what validation method is used when reading the xml files. Allowed values: 'none', 'xsd', or 'dtd'. Type: string (or Expression with resultType string)." + }, + "namespacePrefixes": { + "type": "object", + "description": "Namespace uri to prefix mappings to override the prefixes in column names when namespace is enabled, if no prefix is defined for a namespace uri, the prefix of xml element/attribute name in the xml data file will be used. Example: \"{\"http://www.example.com/xml\":\"prefix\"}\" Type: object (or Expression with resultType object)." + } + } + }, "BinaryReadSettings": { "description": "Binary read settings.", "type": "object", @@ -1114,6 +1137,32 @@ } } }, + "XmlSource": { + "description": "A copy activity Xml source.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CopySource" + } + ], + "properties": { + "storeSettings": { + "$ref": "#/definitions/StoreReadSettings", + "description": "Xml store settings." + }, + "formatSettings": { + "$ref": "#/definitions/XmlReadSettings", + "description": "Xml format settings." + }, + "additionalColumns": { + "type": "array", + "description": "Specifies the additional columns to be added to source data. Type: array of objects (or Expression with resultType array of objects).", + "items": { + "$ref": "#/definitions/AdditionalColumns" + } + } + } + }, "OrcSource": { "description": "A copy activity ORC source.", "type": "object", From 82f64f9d3469eaf98fe733071275fd9edf113766 Mon Sep 17 00:00:00 2001 From: Richard Zhang Date: Thu, 28 May 2020 20:37:34 -0700 Subject: [PATCH 037/318] add linked service and schema linked service to data flow source/sink (#9605) --- .../stable/2018-06-01/entityTypes/DataFlow.json | 16 ++++++++++++++++ 1 file changed, 16 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json index 3644a5838df0..bdac90ebf99b 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/DataFlow.json @@ -113,6 +113,14 @@ "dataset": { "description": "Dataset reference.", "$ref": "../datafactory.json#/definitions/DatasetReference" + }, + "linkedService": { + "description": "Linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "schemaLinkedService": { + "description": "Schema linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" } } }, @@ -127,6 +135,14 @@ "dataset": { "description": "Dataset reference.", "$ref": "../datafactory.json#/definitions/DatasetReference" + }, + "linkedService": { + "description": "Linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + }, + "schemaLinkedService": { + "description": "Schema linked service reference.", + "$ref": "../datafactory.json#/definitions/LinkedServiceReference" } } } From 5dd684b32ab297eb1b3a9bb00c432ede348eaddb Mon Sep 17 00:00:00 2001 From: Amir Keren Date: Fri, 29 May 2020 06:38:46 +0300 Subject: [PATCH 038/318] add alert link to security alert arm model (#9566) * add alert link to security alert arm model * Add alert link to example file * Change to lowercase Co-authored-by: Amir Keren --- .../preview/2019-01-01-preview/SecurityInsights.json | 5 +++++ .../examples/entities/GetSecurityAlertEntityById.json | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json index 895d9b5b05db..0bfdb0305304 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json @@ -7819,6 +7819,11 @@ "description": "The name of the vendor that raise the alert.", "readOnly": true, "type": "string" + }, + "alertLink": { + "description": "The uri link of the alert.", + "readOnly": true, + "type": "string" } }, "type": "object" diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetSecurityAlertEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetSecurityAlertEntityById.json index af742bb18b0a..640d2f28fa68 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetSecurityAlertEntityById.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetSecurityAlertEntityById.json @@ -43,7 +43,8 @@ "Search Query Results Overall Count": "203", "Total Account Entities": "1" }, - "friendlyName": "Suspicious account detected" + "friendlyName": "Suspicious account detected", + "alertLink": "https://portal.azure.com/#blade/Microsoft_Azure_Security/AlertBlade/alertId/2518119885989999999_4aa486e0-6f85-41af-99ea-7acdce7be6c8/subscriptionId/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/myRg/myWorkspace/referencedFrom/alertDeepLink/location/centralus" } } } From 93c7d012ff92cec9d6e1ab1ab3c9f9ff154fed5b Mon Sep 17 00:00:00 2001 From: Ajit Navasare Date: Thu, 28 May 2020 22:40:44 -0700 Subject: [PATCH 039/318] EventHub: fixed the Cluster PUT API (#9596) * fixed the Cluster PUT API * fix examples * examples fix * example fixes * corrected example cluster_put Co-authored-by: v-ajnava --- .../AvailableClusterRegions-preview.json | 2 +- .../2018-01-01-preview/Clusters-preview.json | 28 +++++++++++++------ .../examples/Clusters/ClusterGet.json | 4 +-- .../examples/Clusters/ClusterPatch.json | 8 +++--- .../examples/Clusters/ClusterPut.json | 10 +++---- .../Clusters/ClustersListByResourceGroup.json | 4 +-- 6 files changed, 34 insertions(+), 22 deletions(-) diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json index bc5994cc6b8e..4c22e44c12d0 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/AvailableClusterRegions-preview.json @@ -39,7 +39,7 @@ "tags": [ "Event Hubs Clusters AvailableClusterRegions" ], - "operationId": "Clusters_ListAvailableClusters", + "operationId": "Clusters_ListAvailableClusterRegion", "x-ms-examples": { "ListAvailableClusters": { "$ref": "./examples/Clusters/ListAvailableClustersGet.json" diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json index 1b4b44d7ff1c..d870c2bc4c16 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json @@ -37,7 +37,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters": { "get": { "tags": [ - "Event Hubs Clusters" + "EventHubs Clusters" ], "operationId": "Clusters_ListByResourceGroup", "x-ms-examples": { @@ -79,7 +79,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}": { "get": { "tags": [ - "Event Hubs Clusters" + "EventHubs Clusters" ], "operationId": "Clusters_Get", "x-ms-examples": { @@ -119,7 +119,7 @@ }, "put": { "tags": [ - "Event Hubs Clusters" + "EventHubs Clusters" ], "operationId": "Clusters_Put", "x-ms-examples": { @@ -138,6 +138,18 @@ { "$ref": "../../common/v1/definitions.json#/parameters/ClusterNameParameter" }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster", + "required": [ + "location" + ] + }, + "description": "Parameters for creating a eventhub cluster resource." + }, { "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" } @@ -169,7 +181,7 @@ }, "patch": { "tags": [ - "Event Hubs Clusters" + "EventHubs Clusters" ], "operationId": "Clusters_Patch", "x-ms-examples": { @@ -228,7 +240,7 @@ }, "delete": { "tags": [ - "Event Hubs Clusters" + "EventHubs Clusters" ], "operationId": "Clusters_Delete", "x-ms-examples": { @@ -274,7 +286,7 @@ "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventHub/clusters/{clusterName}/namespaces": { "get": { "tags": [ - "Event Hubs Clusters Namespace" + "EventHubs Clusters Namespace" ], "operationId": "Clusters_ListNamespaces", "parameters": [ @@ -324,12 +336,12 @@ "properties": { "x-ms-client-flatten": true, "properties": { - "created": { + "createdAt": { "readOnly": true, "type": "string", "description": "The UTC time when the Event Hubs Cluster was created." }, - "updated": { + "updatedAt": { "readOnly": true, "type": "string", "description": "The UTC time when the Event Hubs Cluster was last updated." diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterGet.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterGet.json index decf1dc12a9f..60fa11022b25 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterGet.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterGet.json @@ -21,8 +21,8 @@ "capacity": 4 }, "properties": { - "created": "2017-05-24T23:23:27.877Z", - "updated": "2017-05-24T23:23:27.877Z", + "createdAt": "2017-05-24T23:23:27.877Z", + "updatedAt": "2017-05-24T23:23:27.877Z", "metricId": "SN6-008" } } diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPatch.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPatch.json index 49d40843e81d..081bc32e0b32 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPatch.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPatch.json @@ -28,8 +28,8 @@ "capacity": 4 }, "properties": { - "created": "2017-06-01T21:37:04.46Z", - "updated": "2017-06-01T21:37:53.413Z", + "createdAt": "2017-06-01T21:37:04.46Z", + "updatedAt": "2017-06-01T21:37:53.413Z", "metricId": "SN6-008" } } @@ -49,8 +49,8 @@ "capacity": 4 }, "properties": { - "created": "2017-06-01T21:37:04.46Z", - "updated": "2017-06-01T21:37:53.413Z", + "createdAt": "2017-06-01T21:37:04.46Z", + "updatedAt": "2017-06-01T21:37:53.413Z", "metricId": "SN6-008" } } diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPut.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPut.json index 47d7194db72e..26ea0cba1a87 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPut.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClusterPut.json @@ -6,7 +6,7 @@ "subscriptionId": "5f750a97-50d9-4e36-8081-c9ee4c0210d4", "parameters": { "sku": { - "tier": "Dedicated", + "name": "Dedicated", "capacity": 1 }, "location": "South Central US", @@ -32,8 +32,8 @@ "capacity": 1 }, "properties": { - "created": "2017-05-24T23:23:27.877Z", - "updated": "2017-05-24T23:23:27.877Z", + "createdAt": "2017-05-24T23:23:27.877Z", + "updatedAt": "2017-05-24T23:23:27.877Z", "metricId": "SN6-008" } } @@ -53,8 +53,8 @@ "capacity": 1 }, "properties": { - "created": "2017-05-24T23:23:27.877Z", - "updated": "2017-05-24T23:23:27.877Z", + "createdAt": "2017-05-24T23:23:27.877Z", + "updatedAt": "2017-05-24T23:23:27.877Z", "metricId": "SN6-008" } } diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClustersListByResourceGroup.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClustersListByResourceGroup.json index 8f80c72ed5c0..e2e896382d1c 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClustersListByResourceGroup.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/examples/Clusters/ClustersListByResourceGroup.json @@ -19,8 +19,8 @@ "capacity": 4 }, "properties": { - "created": "2016-09-13T23:17:25.24Z", - "updated": "2016-09-13T23:17:28.223Z", + "createdAt": "2016-09-13T23:17:25.24Z", + "updatedAt": "2016-09-13T23:17:28.223Z", "metricId": "SN6-008" } } From e3b694236dde3266238fa0e33682da2269d51bfc Mon Sep 17 00:00:00 2001 From: Marwan Ahmed Date: Thu, 28 May 2020 23:30:47 -0700 Subject: [PATCH 040/318] [AKS] re-apply the changes to making the count field optional to fix regressions (#9610) --- .../examples/AgentPools_Update.json | 73 +++++++++++++++++++ .../stable/2019-11-01/managedClusters.json | 12 +-- .../examples/AgentPools_Update.json | 73 +++++++++++++++++++ .../stable/2020-01-01/managedClusters.json | 12 +-- .../examples/AgentPools_Update.json | 73 +++++++++++++++++++ .../stable/2020-02-01/managedClusters.json | 12 +-- .../examples/AgentPools_Update.json | 73 +++++++++++++++++++ .../stable/2020-03-01/managedClusters.json | 12 +-- .../examples/AgentPools_Update.json | 73 +++++++++++++++++++ .../stable/2020-04-01/managedClusters.json | 12 +-- 10 files changed, 385 insertions(+), 40 deletions(-) create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-11-01/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-01-01/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-02-01/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-03-01/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPools_Update.json diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-11-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-11-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..cf4d40d62ade --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-11-01/examples/AgentPools_Update.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2019-11-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-11-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-11-01/managedClusters.json index 3a873962adcd..8282d9264ca7 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-11-01/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2019-11-01/managedClusters.json @@ -719,6 +719,9 @@ "x-ms-examples": { "Create/Update Agent Pool": { "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" } } }, @@ -1423,10 +1426,7 @@ "count": { "type": "integer", "format": "int32", - "maximum": 100, - "minimum": 1, - "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", - "default": 1 + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1." }, "vmSize": { "$ref": "#/definitions/ContainerServiceVMSize", @@ -1517,10 +1517,6 @@ "description": "Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." } }, - "required": [ - "vmSize", - "count" - ], "description": "Properties for the container service agent pool profile." }, "ManagedClusterAgentPoolProfile": { diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-01-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-01-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..ed54e42a197a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-01-01/examples/AgentPools_Update.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-01-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-01-01/managedClusters.json index 4e21f399e3b1..dea09d26dea6 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-01-01/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-01-01/managedClusters.json @@ -719,6 +719,9 @@ "x-ms-examples": { "Create/Update Agent Pool": { "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" } } }, @@ -1423,10 +1426,7 @@ "count": { "type": "integer", "format": "int32", - "maximum": 100, - "minimum": 1, - "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", - "default": 1 + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1." }, "vmSize": { "$ref": "#/definitions/ContainerServiceVMSize", @@ -1517,10 +1517,6 @@ "description": "Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." } }, - "required": [ - "vmSize", - "count" - ], "description": "Properties for the container service agent pool profile." }, "ManagedClusterAgentPoolProfile": { diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-02-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-02-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..e80f903f7305 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-02-01/examples/AgentPools_Update.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2020-02-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-02-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-02-01/managedClusters.json index 09a127a07480..4c23040f7b7a 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-02-01/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-02-01/managedClusters.json @@ -720,6 +720,9 @@ "Create/Update Agent Pool": { "$ref": "./examples/AgentPoolsCreate_Update.json" }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, "Create Spot Agent Pool": { "$ref": "./examples/AgentPoolsCreate_Spot.json" } @@ -1426,10 +1429,7 @@ "count": { "type": "integer", "format": "int32", - "maximum": 100, - "minimum": 1, - "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", - "default": 1 + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1." }, "vmSize": { "$ref": "#/definitions/ContainerServiceVMSize", @@ -1524,10 +1524,6 @@ "description": "Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." } }, - "required": [ - "vmSize", - "count" - ], "description": "Properties for the container service agent pool profile." }, "ManagedClusterAgentPoolProfile": { diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-03-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-03-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..8bd933ab157b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-03-01/examples/AgentPools_Update.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2020-03-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Low", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-03-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-03-01/managedClusters.json index 28cee03f5637..894a1ab3fb3b 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-03-01/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-03-01/managedClusters.json @@ -720,6 +720,9 @@ "Create/Update Agent Pool": { "$ref": "./examples/AgentPoolsCreate_Update.json" }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, "Create Spot Agent Pool": { "$ref": "./examples/AgentPoolsCreate_Spot.json" } @@ -1426,10 +1429,7 @@ "count": { "type": "integer", "format": "int32", - "maximum": 100, - "minimum": 0, - "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive). The default value is 1. ", - "default": 1 + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1." }, "vmSize": { "$ref": "#/definitions/ContainerServiceVMSize", @@ -1528,10 +1528,6 @@ "description": "Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." } }, - "required": [ - "vmSize", - "count" - ], "description": "Properties for the container service agent pool profile." }, "ManagedClusterAgentPoolProfile": { diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..07f907e2c01b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/examples/AgentPools_Update.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json index ec625d6070a4..83b5e9e30cbb 100644 --- a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json @@ -721,6 +721,9 @@ "Create/Update Agent Pool": { "$ref": "./examples/AgentPoolsCreate_Update.json" }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, "Create Spot Agent Pool": { "$ref": "./examples/AgentPoolsCreate_Spot.json" } @@ -1427,10 +1430,7 @@ "count": { "type": "integer", "format": "int32", - "maximum": 100, - "minimum": 0, - "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive). The default value is 1. ", - "default": 1 + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1." }, "vmSize": { "$ref": "#/definitions/ContainerServiceVMSize", @@ -1537,10 +1537,6 @@ "description": "Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." } }, - "required": [ - "vmSize", - "count" - ], "description": "Properties for the container service agent pool profile." }, "ManagedClusterAgentPoolProfile": { From 6e433aec9033f5d27d047f27e3ea0781615ecdaf Mon Sep 17 00:00:00 2001 From: sugandhaamic <65259091+sugandhaamic@users.noreply.github.com> Date: Thu, 28 May 2020 23:37:21 -0700 Subject: [PATCH 041/318] Swagger for the new ARM resource PrivateLinkHub (#9482) * Swagger for the new ARM resource PrivateLinkHub * fix review comments * Added descriptions * prettier fixes * Add reference to json in readme * Add Patch operation * Added enum for Provisioning State * update example --- .../CreateOrUpdatePrivateLinkHub.json | 53 +++ .../examples/DeletePrivateLinkHub.json | 20 + .../examples/GetPrivateLinkHub.json | 32 ++ .../ListPrivateLinkHubsInResourceGroup.json | 39 ++ .../ListPrivateLinkHubsInSubscription.json | 38 ++ .../examples/UpdatePrivateLinkHub.json | 51 +++ .../2019-06-01-preview/privatelinkhub.json | 422 ++++++++++++++++++ .../synapse/resource-manager/readme.md | 3 +- 8 files changed, 657 insertions(+), 1 deletion(-) create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdatePrivateLinkHub.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeletePrivateLinkHub.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetPrivateLinkHub.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListPrivateLinkHubsInResourceGroup.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListPrivateLinkHubsInSubscription.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdatePrivateLinkHub.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdatePrivateLinkHub.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdatePrivateLinkHub.json new file mode 100644 index 000000000000..cd588c0c9216 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/CreateOrUpdatePrivateLinkHub.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "privateLinkHubName": "privateLinkHub1", + "api-version": "2019-06-01-preview", + "privateLinkHubInfo": { + "properties": {}, + "location": "East US", + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeletePrivateLinkHub.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeletePrivateLinkHub.json new file mode 100644 index 000000000000..b78a84f12fc2 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/DeletePrivateLinkHub.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "privateLinkHubName": "privateLinkHub1", + "api-version": "2019-06-01-preview" + }, + "responses": { + "204": {}, + "200": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetPrivateLinkHub.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetPrivateLinkHub.json new file mode 100644 index 000000000000..34254b77e952 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/GetPrivateLinkHub.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "privateLinkHubName": "privateLinkHub1", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListPrivateLinkHubsInResourceGroup.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListPrivateLinkHubsInResourceGroup.json new file mode 100644 index 000000000000..4012187dec0b --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListPrivateLinkHubsInResourceGroup.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub2", + "name": "privateLinkHub2", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListPrivateLinkHubsInSubscription.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListPrivateLinkHubsInSubscription.json new file mode 100644 index 000000000000..52a395d50933 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/ListPrivateLinkHubsInSubscription.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub2", + "name": "privateLinkHub2", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdatePrivateLinkHub.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdatePrivateLinkHub.json new file mode 100644 index 000000000000..58a037a75bdb --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/examples/UpdatePrivateLinkHub.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "privateLinkHubName": "privateLinkHub1", + "api-version": "2019-06-01-preview", + "privateLinkHubPatchInfo": { + "tags": { + "key": "value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup1/providers/Microsoft.Synapse/privateLinkHubs/privateLinkHub1", + "name": "privateLinkHub1", + "type": "Microsoft.Synapse/privateLinkHubs", + "location": "East US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": { + "key": "value" + } + } + }, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json new file mode 100644 index 000000000000..adf77edd801f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json @@ -0,0 +1,422 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-06-01-preview", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHub": { + "get": { + "operationId": "PrivateLinkHubs_ListByResourceGroup", + "description": "Returns a list of privateLinkHubs in a resource group", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkHubInfoListResult" + }, + "description": "" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List privateLinkHubs in resource group": { + "$ref": "./examples/ListPrivateLinkHubsInResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/privateLinkHubs/{privateLinkHubName}": { + "get": { + "operationId": "PrivateLinkHubs_Get", + "description": "Gets a privateLinkHub", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateLinkHubNameParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "description": "PrivateLinkHub resource details" + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while trying to get details for PrivateLinkHub." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Get a privateLinkHub": { + "$ref": "./examples/GetPrivateLinkHub.json" + } + } + }, + "patch": { + "operationId": "PrivateLinkHubs_Update", + "description": "Updates a privateLinkHub", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateLinkHubNameParameter" + }, + { + "schema": { + "$ref": "#/definitions/PrivateLinkHubPatchInfo" + }, + "in": "body", + "name": "privateLinkHubPatchInfo", + "required": true, + "description": "PrivateLinkHub patch request properties" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "description": "PrivateLinkHub resource details" + }, + "201": { + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "description": "PrivateLinkHub resource details" + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a PrivateLinkHub.\n\n * 500 InternalServerError- Some error occurred while creating PrivateLinkHub." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Update a privateLinkHub": { + "$ref": "./examples/UpdatePrivateLinkHub.json" + } + } + }, + "put": { + "operationId": "PrivateLinkHubs_CreateOrUpdate", + "description": "Creates or updates a privateLinkHub", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateLinkHubNameParameter" + }, + { + "description": "PrivateLinkHub create or update request properties", + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "in": "body", + "name": "privateLinkHubInfo", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "description": "PrivateLinkHub resource details" + }, + "201": { + "schema": { + "$ref": "#/definitions/PrivateLinkHub" + }, + "description": "PrivateLinkHub resource details" + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 400 BadRequest - Invalid request to create a PrivateLinkHub.\n\n * 500 InternalServerError- Some error occurred while creating PrivateLinkHub." + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Create or update a privateLinkHub": { + "$ref": "./examples/CreateOrUpdatePrivateLinkHub.json" + } + } + }, + "delete": { + "operationId": "PrivateLinkHubs_Delete", + "description": "Deletes a privateLinkHub", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateLinkHubNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "PrivateLinkHub resource not found." + }, + "default": { + "schema": { + "$ref": "#/definitions/ErrorContract" + }, + "description": "*** Error Responses: ***\n\n * 500 InternalServerError- Some error occurred while deleting PrivateLinkHub." + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-examples": { + "Delete a privateLinkHub": { + "$ref": "./examples/DeletePrivateLinkHub.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Synapse/privateLinkHubs": { + "get": { + "operationId": "PrivateLinkHubs_List", + "description": "Returns a list of privateLinkHubs in a subscription", + "tags": [ + "PrivateLinkHubs" + ], + "deprecated": false, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/PrivateLinkHubInfoListResult" + }, + "description": "PrivateLinkHub resource details" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List privateLinkHubs in subscription": { + "$ref": "./examples/ListPrivateLinkHubsInSubscription.json" + } + } + } + } + }, + "definitions": { + "ErrorDetail": { + "description": "Error details", + "type": "object", + "properties": { + "message": { + "description": "Error message", + "type": "string" + }, + "code": { + "description": "Error code", + "type": "string" + }, + "target": { + "description": "Error target", + "type": "string" + } + } + }, + "ErrorContract": { + "title": "Error details.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "PrivateLinkHubInfoListResult": { + "description": "List of privateLinkHubs", + "type": "object", + "properties": { + "nextLink": { + "description": "Link to the next page of results", + "type": "string" + }, + "value": { + "description": "List of privateLinkHubs", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkHub" + } + } + } + }, + "PrivateLinkHub": { + "description": "A privateLinkHub", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "description": "PrivateLinkHub resource properties", + "$ref": "#/definitions/PrivateLinkHubProperties", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkHubPatchInfo": { + "description": "PrivateLinkHub patch details", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags", + "additionalProperties": { + "type": "string" + }, + "type": "object" + } + } + }, + "PrivateLinkHubProperties": { + "description": "PrivateLinkHub properties", + "type": "object", + "properties": { + "provisioningState": { + "description": "PrivateLinkHub provisioning state", + "type": "string", + "enum": [ + "Succeeded", + "Failed" + ], + "readOnly": true + } + } + } + }, + "parameters": { + "privateLinkHubNameParameter": { + "name": "privateLinkHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the privateLinkHub", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/resource-manager/readme.md b/specification/synapse/resource-manager/readme.md index bbcb58e62821..612bb97446f3 100644 --- a/specification/synapse/resource-manager/readme.md +++ b/specification/synapse/resource-manager/readme.md @@ -46,6 +46,7 @@ input-file: - Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json - Microsoft.Synapse/preview/2019-06-01-preview/privateLinkResources.json - Microsoft.Synapse/preview/2019-06-01-preview/privateEndpointConnections.json +- Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json ``` ## Suppressions @@ -128,7 +129,7 @@ input-file: - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/integrationRuntime.json - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privateLinkResources.json - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privateEndpointConnections.json - + - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json ``` If there are files that should not be in the `all-api-versions` set, From 4f945a6e0d3273b67de3fd09a6b630817b1fc4d0 Mon Sep 17 00:00:00 2001 From: azuresdkci Date: Fri, 29 May 2020 06:38:52 +0000 Subject: [PATCH 042/318] regenerated all-api-versions --- specification/synapse/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/synapse/resource-manager/readme.md b/specification/synapse/resource-manager/readme.md index 612bb97446f3..220b68f46ab2 100644 --- a/specification/synapse/resource-manager/readme.md +++ b/specification/synapse/resource-manager/readme.md @@ -130,6 +130,7 @@ input-file: - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privateLinkResources.json - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privateEndpointConnections.json - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json + ``` If there are files that should not be in the `all-api-versions` set, From 515d379b069e6ff5d26f24678baccf766070e6ac Mon Sep 17 00:00:00 2001 From: Arcturus Date: Fri, 29 May 2020 15:58:21 +0800 Subject: [PATCH 043/318] Fix output folder in peering (#9631) --- specification/peering/resource-manager/readme.go.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/peering/resource-manager/readme.go.md b/specification/peering/resource-manager/readme.go.md index 74cd7447316f..27337b355f40 100644 --- a/specification/peering/resource-manager/readme.go.md +++ b/specification/peering/resource-manager/readme.go.md @@ -38,7 +38,7 @@ These settings apply only when `--tag=package-2020-04-01 --go` is specified on t Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2020-04-01' && $(go) -output-folder: $(go-sdk-folder)/services/stable/$(namespace)/mgmt/2020-04-01/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-04-01/$(namespace) ``` ### Tag: package-2020-01-01-preview and go From 83c9a6689232c4036294c2d701a75a5d7bc23425 Mon Sep 17 00:00:00 2001 From: Liang Wang Date: Fri, 29 May 2020 16:57:19 +0800 Subject: [PATCH 044/318] Add Readme File for Container Registry (#9632) --- .../resource-manager/readme.az.md | 20 +++++++++++++++++++ .../resource-manager/readme.cli.md | 9 +++++++++ 2 files changed, 29 insertions(+) create mode 100644 specification/containerregistry/resource-manager/readme.az.md create mode 100644 specification/containerregistry/resource-manager/readme.cli.md diff --git a/specification/containerregistry/resource-manager/readme.az.md b/specification/containerregistry/resource-manager/readme.az.md new file mode 100644 index 000000000000..fab7ce840545 --- /dev/null +++ b/specification/containerregistry/resource-manager/readme.az.md @@ -0,0 +1,20 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) +az: + extensions: containerregistry + namespace: azure.mgmt.containerregistry + package-name: azure-mgmt-containerregistry +az-output-folder: $(azure-cli-extension-folder)/src/containerregistry +python-sdk-output-folder: "$(az-output-folder)/azext_containerregistry/vendored_sdks/containerregistry" + +#cli: +# cli-directive: +# - where: +# group: MachineLearningCompute +# op: CreateOrUpdate +# param: properties +# poly-resource: true +``` diff --git a/specification/containerregistry/resource-manager/readme.cli.md b/specification/containerregistry/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c88be4f1c90e --- /dev/null +++ b/specification/containerregistry/resource-manager/readme.cli.md @@ -0,0 +1,9 @@ + CLI + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +#cli: +# test-scenario: +# - name: Example_CreateOrUpdate +``` \ No newline at end of file From 227a4587069f6cc270899c6930925fd0c522c10d Mon Sep 17 00:00:00 2001 From: JianyeXi <59603451+jianyexi@users.noreply.github.com> Date: Fri, 29 May 2020 17:07:00 +0800 Subject: [PATCH 045/318] Fix linter doc mistake (#9630) * update @azure/oad version to fix breaking issue * Adding 5 new lint rules * fix typo * fix typo Co-authored-by: Jianye Xi --- documentation/openapi-authoring-automated-guidelines.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/documentation/openapi-authoring-automated-guidelines.md b/documentation/openapi-authoring-automated-guidelines.md index 7d4fd5353113..848f8f89f120 100644 --- a/documentation/openapi-authoring-automated-guidelines.md +++ b/documentation/openapi-authoring-automated-guidelines.md @@ -103,7 +103,7 @@ We request OpenAPI(Swagger) spec authoring be assigned to engineers who have an | [R4005](#r4005) | [UniqueXmsEnumName](#r4005) | ARM and Data plane OpenAPI(swagger) specs | | [R4008](#r4008) | [AvoidEmptyResponseSchema](#r4008) | ARM OpenAPI(swagger) specs | | [R4012](#r4012) | [XmsPageableMustHaveCorrespondingResponse](#r4012) | ARM OpenAPI(swagger) specs | -| [R4013](#r4013) | [IntergerTypeMustHaveFormat](#r4013) | ARM OpenAPI(swagger) specs | +| [R4013](#r4013) | [IntegerTypeMustHaveFormat](#r4013) | ARM OpenAPI(swagger) specs | #### SDK Warnings @@ -2514,7 +2514,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Output Message** : The operation: '{operation name}' is defined with x-ms-pageable enabled,but can not find the corresponding nextLink property in the response, please add it. -**Description** : Per [extensions](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-pageable) When specifying a x-ms-pagable/nextLinkName, the corresponding nextlink property must be defined in the response schema. +**Description** : Per [extensions](https://github.com/Azure/autorest/blob/master/docs/extensions/readme.md#x-ms-pageable) ,when specifying a x-ms-pagable/nextLinkName, the corresponding nextlink property must be defined in the response schema. **CreatedAt**: May 21, 2020 @@ -2553,7 +2553,7 @@ The following would be valid: ``` Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rules](#automated-rules) | [ARM](#arm-violations): [Errors](#arm-errors) or [Warnings](#arm-warnings) | [SDK](#sdk-violations): [Errors](#sdk-errors) or [Warnings](#sdk-warnings) -### R4013 IntergerTypeMustHaveFormat +### R4013 IntegerTypeMustHaveFormat **Category** : SDK Error From ae14baf35ad53de6f979ac65f4116d3ceb38ff5d Mon Sep 17 00:00:00 2001 From: Amit Aviram Date: Fri, 29 May 2020 12:35:28 +0300 Subject: [PATCH 046/318] Move serverVulnerabilityAssessment API to stable-2020-01-01 (#9097) * Move serverVulnerabilityAssessment API to stable-2020-01-01 * remove preview version * Removed API that is not reachable * fix conflicts * Add serverVA in missing parts * Add missing serverVA * revert readme * ASC: Move VA to 2020-01-01 --- .../CreateServerVulnerabilityAssessments_example.json | 2 +- .../DeleteServerVulnerabilityAssessments_example.json | 2 +- .../GetServerVulnerabilityAssessments_example.json | 2 +- ...endedResourceServerVulnerabilityAssessments_example.json | 2 +- .../2020-01-01}/serverVulnerabilityAssessments.json | 2 +- specification/security/resource-manager/readme.md | 6 +++--- 6 files changed, 8 insertions(+), 8 deletions(-) rename specification/security/resource-manager/Microsoft.Security/{preview/2019-01-01-preview => stable/2020-01-01}/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json (96%) rename specification/security/resource-manager/Microsoft.Security/{preview/2019-01-01-preview => stable/2020-01-01}/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json (88%) rename specification/security/resource-manager/Microsoft.Security/{preview/2019-01-01-preview => stable/2020-01-01}/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json (94%) rename specification/security/resource-manager/Microsoft.Security/{preview/2019-01-01-preview => stable/2020-01-01}/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json (94%) rename specification/security/resource-manager/Microsoft.Security/{preview/2019-01-01-preview => stable/2020-01-01}/serverVulnerabilityAssessments.json (99%) diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json similarity index 96% rename from specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json rename to specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json index 1bccb5ea5cce..eaed80294950 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/CreateServerVulnerabilityAssessments_example.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-01-01-preview", + "api-version": "2020-01-01", "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "resourceGroupName": "rg1", "resourceNamespace": "Microsoft.Compute", diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json similarity index 88% rename from specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json rename to specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json index ebe431b2e5ae..b47510ee03bc 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/DeleteServerVulnerabilityAssessments_example.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-01-01-preview", + "api-version": "2020-01-01", "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "resourceGroupName": "rg1", "resourceNamespace": "Microsoft.Compute", diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json similarity index 94% rename from specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json rename to specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json index aec69b3e88bf..59dddaa785dd 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/GetServerVulnerabilityAssessments_example.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-01-01-preview", + "api-version": "2020-01-01", "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "resourceGroupName": "rg1", "resourceNamespace": "Microsoft.Compute", diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json similarity index 94% rename from specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json rename to specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json index d96e15730233..cdf6cd825bdb 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/ServerVulnerabilityAssessments/ListByExtendedResourceServerVulnerabilityAssessments_example.json @@ -1,6 +1,6 @@ { "parameters": { - "api-version": "2019-01-01-preview", + "api-version": "2020-01-01", "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", "resourceGroupName": "rg1", "resourceNamespace": "Microsoft.Compute", diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json similarity index 99% rename from specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json rename to specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json index 534a37477127..d21a7bca94c7 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json @@ -3,7 +3,7 @@ "info": { "title": "Security Center", "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", - "version": "2019-01-01-preview" + "version": "2020-01-01" }, "host": "management.azure.com", "schemes": [ diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index b324ff734759..982c3d005409 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -152,10 +152,11 @@ input-file: - Microsoft.Security/preview/2017-08-01-preview/securityContacts.json - Microsoft.Security/preview/2017-08-01-preview/workspaceSettings.json - Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json -- Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json + - Microsoft.Security/preview/2019-01-01-preview/subAssessments.json - Microsoft.Security/preview/2019-01-01-preview/automations.json - Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json +- Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json - Microsoft.Security/stable/2020-01-01/assessmentMetadata.json - Microsoft.Security/stable/2020-01-01/assessments.json - Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json @@ -225,7 +226,6 @@ These settings apply only when `--tag=package-2019-01-preview-only` is specified ``` yaml $(tag) == 'package-2019-01-preview-only' input-file: - Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json -- Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json - Microsoft.Security/preview/2019-01-01-preview/alertsSuppressionRules.json - Microsoft.Security/preview/2019-01-01-preview/assessmentMetadata.json - Microsoft.Security/preview/2019-01-01-preview/assessments.json @@ -391,7 +391,7 @@ input-file: - $(this-folder)/Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json - - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/serverVulnerabilityAssessments.json + - $(this-folder)/Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json - $(this-folder)/Microsoft.Security/stable/2020-01-01/assessmentMetadata.json - $(this-folder)/Microsoft.Security/stable/2020-01-01/assessments.json - $(this-folder)/Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json From d540ef6dde969417ad83432fd331d2595652e425 Mon Sep 17 00:00:00 2001 From: Ge Huang Date: Fri, 29 May 2020 02:46:28 -0700 Subject: [PATCH 047/318] update GC Swagger spec to match with most recent service interface (#9595) * update Guestconfiguration Swagger spec to match with most recent service Api interface * fix auto check-Part1 * roll back style change * fix auto check-Part2 * fix auto check-Part3 * fix auto check-Part4 * fix auto check-Part5 * fix auto check-Part6 - readonly * fix auto check-Part7 * fix auto check-Part8 * fix auto check-Part9 -- error code * roll back to Part5 * roll back to Part5.1 * roll back to Part5.2 * roll back to Part5.3 * roll back to Part5.4 Co-authored-by: ge huang --- custom-words.txt | 1 + .../common/v1/definitions.json | 27 +- ...pdateGuestConfigurationHCRPAssignment.json | 104 +++++ ...eleteGuestConfigurationHCRPAssignment.json | 12 + .../getGuestConfigurationHCRPAssignment.json | 36 ++ ...ConfigurationHCRPAssignmentReportById.json | 95 +++++ ...estConfigurationHCRPAssignmentReports.json | 60 +++ ...listGuestConfigurationHCRPAssignments.json | 59 +++ .../stable/2018-11-20/guestconfiguration.json | 367 +++++++++++++++++- 9 files changed, 744 insertions(+), 17 deletions(-) create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationHCRPAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/deleteGuestConfigurationHCRPAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationHCRPAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationHCRPAssignmentReportById.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listAllGuestConfigurationHCRPAssignmentReports.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listGuestConfigurationHCRPAssignments.json diff --git a/custom-words.txt b/custom-words.txt index 6cdb3e767da0..00457b28c91e 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -634,6 +634,7 @@ Hardenings hbase hbasephoenix hcatalog +HCRP HDFS hdinsight Headnode diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/common/v1/definitions.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/common/v1/definitions.json index e82904ba479c..e6b1fa62c385 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/common/v1/definitions.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/common/v1/definitions.json @@ -26,9 +26,18 @@ "definitions": { "ErrorResponse": { "properties": { - "message": { - "description": "Error message indicating why the operation failed.", - "type": "string" + "error": { + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Detail error message indicating why the operation failed.", + "type": "string" + } + } } }, "description": "Error response of an operation failure" @@ -44,12 +53,12 @@ }, "name": { "type": "string", - "readOnly": true, + "readOnly": false, "description": "Name of the guest configuration assignment." }, "location": { "type": "string", - "readOnly": true, + "readOnly": false, "description": "Region where the VM is located." }, "type": { @@ -178,6 +187,14 @@ "description": "The name of the virtual machine.", "x-ms-parameter-location": "method" }, + "MachineNameParameter": { + "name": "machineName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ARC machine.", + "x-ms-parameter-location": "method" + }, "ResourceGroupNameParameter": { "name": "resourceGroupName", "in": "path", diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..d85b484a1f0f --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/createOrUpdateGuestConfigurationHCRPAssignment.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "WhitelistedApplication", + "api-version": "2018-11-20", + "parameters": { + "location": "westcentralus", + "name": "WhitelistedApplication", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "WhitelistedApplication", + "version": "1.*", + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": null, + "name": "WhitelistedApplication", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "WhitelistedApplication", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": null, + "name": "WhitelistedApplication", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "WhitelistedApplication", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/deleteGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/deleteGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..4e192cdfbf22 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/deleteGuestConfigurationHCRPAssignment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2018-11-20" + }, + "responses": { + "200": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..65def9d2a1d4 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationHCRPAssignment.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2018-11-20" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationHCRPAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationHCRPAssignmentReportById.json new file mode 100644 index 000000000000..1d7d43e8929d --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/getGuestConfigurationHCRPAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2018-11-20" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listAllGuestConfigurationHCRPAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listAllGuestConfigurationHCRPAssignmentReports.json new file mode 100644 index 000000000000..381e33222be7 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listAllGuestConfigurationHCRPAssignmentReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "api-version": "2018-11-20" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listGuestConfigurationHCRPAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listGuestConfigurationHCRPAssignments.json new file mode 100644 index 000000000000..bfa7ad0de85d --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/examples/listGuestConfigurationHCRPAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "api-version": "2018-11-20" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json index a2f4ef137443..db2acc806575 100644 --- a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json @@ -370,6 +370,349 @@ ] } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { + "put": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_CreateOrUpdate", + "description": "Creates an association between a ARC machine and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the ARC machine was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the ARC machine was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_Get", + "description": "Get information about a guest configuration assignment", + "x-ms-examples": { + "Get a guest configuration assignment": { + "$ref": "./examples/getGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_List", + "description": "List all guest configuration assignments for an ARC machine.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listGuestConfigurationHCRPAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports": { + "get": { + "tags": [ + "GuestConfigurationAssignmentHCRPReports" + ], + "operationId": "GuestConfigurationHCRPAssignmentReports_List", + "description": "List all reports for the guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listAllGuestConfigurationHCRPAssignmentReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}": { + "get": { + "tags": [ + "GuestConfigurationAssignmentHCRPReports" + ], + "operationId": "GuestConfigurationHCRPAssignmentReports_Get", + "description": "Get a report for the guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine": { + "$ref": "./examples/getGuestConfigurationHCRPAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "name": "reportId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, "/providers/Microsoft.GuestConfiguration/operations": { "get": { "tags": [ @@ -439,7 +782,7 @@ "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" } ], - "description": "Guest configuration assignment is an association between a VM and guest configuration." + "description": "Guest configuration assignment is an association between a machine and guest configuration." }, "GuestConfigurationNavigation": { "description": "Guest configuration is an artifact that encapsulates DSC configuration and its dependencies. The artifact is a zip file containing DSC configuration (as MOF) and dependent resources and other dependencies like modules.", @@ -490,12 +833,12 @@ "properties": { "name": { "type": "string", - "readOnly": true, + "readOnly": false, "description": "Name of the configuration parameter." }, "value": { "type": "string", - "readOnly": true, + "readOnly": false, "description": "Value of the configuration parameter." } }, @@ -505,7 +848,7 @@ "properties": { "configurationMode": { "type": "string", - "readOnly": true, + "readOnly": false, "description": "Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.", "x-ms-enum": { "name": "configurationMode", @@ -531,7 +874,7 @@ }, "actionAfterReboot": { "type": "string", - "readOnly": true, + "readOnly": false, "description": "Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration", "x-ms-enum": { "name": "actionAfterReboot", @@ -544,13 +887,13 @@ }, "refreshFrequencyMins": { "type": "number", - "readOnly": true, + "readOnly": false, "default": 30, "description": "The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30." }, "rebootIfNeeded": { "type": "string", - "readOnly": true, + "readOnly": false, "default": "False", "description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module.", "x-ms-enum": { @@ -564,7 +907,7 @@ }, "configurationModeFrequencyMins": { "type": "number", - "readOnly": true, + "readOnly": false, "default": 15, "description": "How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15." } @@ -580,7 +923,7 @@ "complianceStatus": { "type": "string", "readOnly": true, - "description": "A value indicating compliance status of the virtual machine for the assigned guest configuration.", + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", "x-ms-enum": { "name": "complianceStatus", "modelAsString": true @@ -669,7 +1012,7 @@ "complianceStatus": { "type": "string", "readOnly": true, - "description": "A value indicating compliance status of the virtual machine for the assigned guest configuration.", + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", "x-ms-enum": { "name": "complianceStatus", "modelAsString": true @@ -762,7 +1105,7 @@ "complianceStatus": { "type": "string", "readOnly": true, - "description": "A value indicating compliance status of the virtual machine for the assigned guest configuration.", + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", "x-ms-enum": { "name": "complianceStatus", "modelAsString": true @@ -818,7 +1161,7 @@ "complianceStatus": { "type": "string", "readOnly": true, - "description": "A value indicating compliance status of the virtual machine for the assigned guest configuration.", + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", "x-ms-enum": { "name": "complianceStatus", "modelAsString": true From 9a54fc6b253e65affca9ba35d4c25052e5bcc12c Mon Sep 17 00:00:00 2001 From: vasanthrajams <60414148+vasanthrajams@users.noreply.github.com> Date: Fri, 29 May 2020 14:54:40 -0700 Subject: [PATCH 048/318] Merge 7.2 into master (#9590) * Adding 7.2-preview version (#8397) * Adding 7.2-preview version Signed-off-by: vasanthrajams * Resolve PR feedback * Fix output-folder for go code generation Co-authored-by: Heath Stewart * full backup restore yaml changes (#8685) * Adding the required swagger file changes for full HSM backup Signed-off-by: vasanthrajams * Resolved a few semantic errors in pipeline Signed-off-by: vasanthrajams * Fixed incremental github pipeline model validation erors Signed-off-by: vasanthrajams * Fixed review comments & ci pipeline * spell check fix * pretty fix * Adding required headers as per azure async operations guidelines Signed-off-by: vasanthrajams * Fixed minor typos Signed-off-by: vasanthrajams Co-authored-by: vasanthrajams * selective key restore (#8781) * selective key restore * moved selective key restore to keys.json * fixed github pipeline checks * example missing folder property * Resolved review comments * minor fix * review comments * pretty check fix Co-authored-by: vasanthrajams * Additional 7.2 preview changes (#9141) * Additional 7.2 preview changes * Corrections and Feedback updates * Remove ProtectedKey * Patch export sample * Fix validation errors * Fix more validation errors * More validation fixes * Add 6 more AES-CBC algorithms (#9317) * Add 6 more algorithms * Add new words to fix the spelling * Adding 7.2-preview version (#8397) * Adding 7.2-preview version Signed-off-by: vasanthrajams * Resolve PR feedback * Fix output-folder for go code generation Co-authored-by: Heath Stewart * selective key restore (#8781) * selective key restore * moved selective key restore to keys.json * fixed github pipeline checks * example missing folder property * Resolved review comments * minor fix * review comments * pretty check fix Co-authored-by: vasanthrajams * Additional 7.2 preview changes (#9141) * Additional 7.2 preview changes * Corrections and Feedback updates * Remove ProtectedKey * Patch export sample * Fix validation errors * Fix more validation errors * More validation fixes * Add 6 more AES-CBC algorithms (#9317) * Add 6 more algorithms * Add new words to fix the spelling * fixing validation failures * key-version example fix * model validation Co-authored-by: Heath Stewart Co-authored-by: vasanthrajams Co-authored-by: Hervey Wilson Co-authored-by: Rick Qing Xu --- custom-words.txt | 8 +- .../preview/7.2/backuprestore.json | 119 +++++++++++ .../7.2/examples/ExportKey-example.json | 54 +++++ .../7.2/examples/FullBackup-example.json | 1 + .../examples/FullBackup-pending-example.json | 1 + .../7.2/examples/FullRestore-example.json | 3 +- .../examples/FullRestore-pending-example.json | 1 + .../examples/SelectiveRestore-example.json | 29 +++ .../Microsoft.KeyVault/preview/7.2/keys.json | 190 +++++++++++++++++- specification/keyvault/data-plane/readme.md | 36 ++++ 10 files changed, 436 insertions(+), 6 deletions(-) create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ExportKey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SelectiveRestore-example.json diff --git a/custom-words.txt b/custom-words.txt index 00457b28c91e..15f8cccabb24 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1,4 +1,7 @@ -AADDS +A128CBCPAD +A192CBCPAD +A256CBCPAD +AADDS aadiam AADP AATP @@ -115,6 +118,7 @@ australiaeast australiasoutheast authenticatable Authenticode +authorityURL authorizationrules authprovider authproviders @@ -264,6 +268,8 @@ CIDR CIDRs CIFS ciphertext +claimCondition +claimType clfs Clickthrough clientaccesspolicy diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/backuprestore.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/backuprestore.json index d3539a6a3040..9a6587443dd8 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/backuprestore.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/backuprestore.json @@ -5,6 +5,21 @@ "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", "version": "7.2-preview" }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, "consumes": [ "application/json" ], @@ -193,6 +208,64 @@ } } } + }, + "/keys/{keyName}/restore": { + "put": { + "tags": [ + "Keys" + ], + "operationId": "SelectiveKeyRestoreOperation", + "description": "Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder", + "parameters": [ + { + "name": "keyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key to be restored from the user supplied backup" + }, + { + "name": "restoreBlobDetails", + "in": "body", + "schema": { + "$ref": "#/definitions/SelectiveKeyRestoreOperationParameters" + }, + "description": "The Azure blob SAS token pointing to a folder where the previous successful full backup was stored" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Started selective key restore operation from the previously stored backup", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SelectiveKeyRestoreOperation" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Selectively restore key from a backup": { + "$ref": "./examples/SelectiveRestore-example.json" + } + } + } } }, "definitions": { @@ -211,6 +284,52 @@ "sasTokenParameters" ] }, + "SelectiveKeyRestoreOperationParameters": { + "properties": { + "sasTokenParameters": { + "$ref": "#/definitions/SASTokenParameter" + }, + "folder": { + "type": "string", + "description": "The Folder name of the blob where the previous successful full backup was stored" + } + }, + "required": [ + "folder", + "sasTokenParameters" + ] + }, + "SelectiveKeyRestoreOperation": { + "properties": { + "status": { + "type": "string", + "description": "Status of the restore operation." + }, + "statusDetails": { + "type": "string", + "description": "The status details of restore operation." + }, + "error": { + "$ref": "common.json#/definitions/Error", + "description": "Error encountered, if any, during the selective key restore operation." + }, + "jobId": { + "type": "string", + "description": "Identifier for the selective key restore operation." + }, + "startTime": { + "type": "integer", + "format": "unixtime", + "description": "The start time of the restore operation" + }, + "endTime": { + "type": "integer", + "format": "unixtime", + "description": "The end time of the restore operation" + } + }, + "description": "Selective Key Restore operation" + }, "SASTokenParameter": { "properties": { "storageResourceUri": { diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ExportKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ExportKey-example.json new file mode 100644 index 000000000000..8cb42488f38b --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ExportKey-example.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "key-name": "exportable-aes-key", + "key-version": "4eb68492b5f6421e835d961ad2be3155", + "api-version": "7.2-preview", + "parameters": { + "env": "eyJhbGciOiJSUzI1NiIsInR5cCI6IkpXVCIsImtpZCI6IkdXQXkxNk5ieFJJQ3lCUzVKckJxRk5DdXdjS2YxYUVYbS1hUDVsUlJ4UEUiLCJqa3UiOiJodHRwOi8vbG9jYWxob3N0OjgwMjMva2V5cyJ9.eyJhYXMtZWhkIjoiZXlKclpYbHpJanBiZXlKbElqb2lRVkZCUWlJc0ltdGxlVjl2Y0hNaU9sc2laR1ZqY25sd2RDSXNJbVZ1WTNKNWNIUWlYU3dpYTJsa0lqb2lOVE16TmpReU5HTXRaV1kzWlMxaU1tRm1MVFU1WmprdE5HUXdPRGhtTURRMFpHVTFJaXdpYTNSNUlqb2lVbE5CSWl3aWJpSTZJbkJPYkhoWVNuRTNPSGRPUkVVd2FXMVNOa1JCWWs5alNrRXpUekp1UlZvNVdFaGtjMDVQTjB0b00xWlJRVTh5VWt0eFlqQk9iRXh4TVhwUFRVOTVZVlJPUW5rNWMzUTRjbG95TURWYU1EWTFjalY2YlRKa1FrSllkRkJUU21Sc1VtSm9WRXd0TlRCcWFFVXpiRUV4WjFVemVYcDJaR0o1U1Zob2NtMDNkWEJFVGtKemFXeFNlR1ZVUW1KUGNWOW1XSE5vT1dGMVVHeGxVM0pOWlZCR2JGbElkVmRNTjJacGNYWktiMHMyZUZSSVZFSmZUa2R1WjBWMlFrMTVPRGRxWlVsbExWbEJUbUYxWkRsRk5GYzFhWHBLZFVwNmJGOHhORkJFY1VWdWVGcFNTM0F5YW1WUGJsZEpTRXRVVm0wMWFsRmhiakZoTlVkdmJGWmxRV2szWlhoalNtRXlNaTFLZERSRWEwNHlWakZMTUZCZlR6YzJSME5ETjNCWlVYVlpTWEkxZFZWclExUmtWVVYxYmxKSWIyaFRWbTFHZVZGaldFSlVkVmxuUVdNMVJFZEpaVGQ1UjNSRFdtOW9WRjlsVmxGQ2NESldVU0lzSW5WelpTSTZJbVZ1WXlKOVhYMCIsImlzcyI6Imh0dHA6Ly9sb2NhbGhvc3Q6ODAyMy8iLCJzZ3gtbXJlbmNsYXZlIjoiMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMDAwMCIsInNneC1tcnNpZ25lciI6Ijg2Nzg4ZmU0MDQ0OGYyYTEyZTIwYmY4ZDVlN2ExYzMxMzliYzVmZGMxNDMyYjM3MGMxZGEzNDg5YWI2NDlhODUiLCJpcy1kZWJ1Z2dhYmxlIjp0cnVlLCJ0ZWUiOiJzZ3giLCJpYXQiOjE1ODc0MjUxNzMsImV4cCI6MTU4ODAyOTk3M30.CA9gO0kRMHt6e9xTKopwEnDt-Mc52oAAe6zicFwX3REZd5E0m3WzJuSYS8H9iKTGL1dfusflPx74C5xLTZiHe0D2YFHYoW3efEm3r55DwkpTbA6tbDjMY7OIC9XuC7prAf4nQ5hYRk0LATzwytYIZ-c-R08ZEt5CV5XqR5MuSDKWWslPm36BHD3l03VVNEEG4hC9KuCIZ2z9YK5ofGze-IY1J9x1EwnG-y_1RF6rDKENjOROOaOH9JvohHGIfK0FKVj8_7E6JxMTQMb7K-45GfE20tTVdCs4A4k3jXNrIRcGmSK5EMrB_LbHzk0PIc6sjl-VuPZVqGxhsaAyoH3cdA" + } + }, + "responses": { + "200": { + "body": { + "attributes": { + "created": 1587425174, + "enabled": true, + "exportable": true, + "recoverableDays": 90, + "recoveryLevel": "Recoverable+Purgeable", + "updated": 1587425174 + }, + "key": { + "key_ops": [ + "decrypt", + "encrypt" + ], + "kid": "https://myvault.vault.azure.net/keys/exportable-aes-key/903fab0c1bab0b30266200be85f5f2ed", + "kty": "oct", + "key_hsm": "CxX3qVTt22ZvjwdS-fmMSsLpaQQ8IcfGAC2TYWo3FXIPnOrSmZWdWN3gLMNSLUtUOhXqwXCe6jOxH2jMr6suO4Q0mfrKurAB-IC5gbDZGGD9XksrAkyYS-0p4p4I4Q4QxEOCtCKYPYWWu91dg5xg5aYjVRyR5G3C6O0haotp1FL1FiOB1PVcW9HchDIdHMFCszsb33pbvDuYvJXPPqdSIGIT8P8ExVG9_RwYTZl2Kj3MTSbe9zjOEEW-EnA6Phr0EFO0h94dWK0Y2tPhyzGYOSBScJCWIdwD9lT1aaHNFE0rSLJ9wv0qGezR10nD7V7ALZiEscsrAcwrWTtmmCJMAIJpGf0u9rN1_JQiXuO4Q9Cf4b73nSP1kIIAPkZ3r6Fqmrm8F7NeKis" + }, + "release_policy": { + "anyOf": [ + { + "allOf": [ + { + "claim": "sgx-mrsigner", + "condition": "equals", + "value": "86788fe40448f2a12e20bf8d5e7a1c3139bc5fdc1432b370c1da3489ab649a85" + }, + { + "claim": "is-debuggable", + "condition": "equals", + "value": "false" + } + ], + "authority": "http://localhost:8023/" + } + ], + "version": "0.2" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-example.json index 94db87470eab..ce343dfcfba5 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-example.json @@ -1,5 +1,6 @@ { "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", "azureStorageBlobContainerUri": { "storageResourceUri": "https://myaccount.blob.core.windows.net/sascontainer/sasContainer", "token": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D" diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-pending-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-pending-example.json index 9396af3e5d5d..e634afa229d0 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-pending-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-pending-example.json @@ -1,5 +1,6 @@ { "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", "jobId": "45aacd568ab049a2803861e8dd3ae21f", "api-version": "7.2-preview" }, diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-example.json index cd9c7278ab29..08b8c336100b 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-example.json @@ -1,11 +1,12 @@ { "parameters": { + "vaultBaseUrl": "https://myhsm.managedhsm.azure.net", "restoreBlobDetails": { "sasTokenParameters": { "storageResourceUri": "https://myaccount.blob.core.windows.net/sascontainer/sasContainer", "token": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCHYrBx0bhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D" }, - "folderToRestore": "1490790332" + "folderToRestore": "mhsm-mypool-20200303062926785" }, "api-version": "7.2-preview" }, diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-pending-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-pending-example.json index 70786dedfba1..5cc1666fc91f 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-pending-example.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-pending-example.json @@ -1,5 +1,6 @@ { "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", "jobId": "45aacd568ab049a2803861e8dd3ae21f", "api-version": "7.2-preview" }, diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SelectiveRestore-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SelectiveRestore-example.json new file mode 100644 index 000000000000..91815d730b80 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SelectiveRestore-example.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net", + "keyName": "hsm-mail-key", + "restoreBlobDetails": { + "sasTokenParameters": { + "storageResourceUri": "https://myaccount.blob.core.windows.net/sascontainer/sasContainer", + "token": "se=2018-02-01T00%3A00Z&spr=https&sv=2017-04-17&sr=b&sig=XXFNfuMCH112BxhemJ7PWn0xGfImMXT6LfbXWvtRUk%3D" + }, + "folder": "mhsm-mypool-20200303062926785" + }, + "api-version": "7.2-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 5, + "Azure-AsyncOperation": "https://myvault.vault.azure.net/restore/45aacd568a23b0s49a2803861e8dd3ase21f/pending" + }, + "body": { + "status": "InProgress", + "statusDetails": "Selective Key restore is in progress", + "jobId": "45aacd568a23b0s49a2803861e8dd3ase21f", + "startTime": 1490790000, + "endTime": 0 + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/keys.json index 99327bcef69d..755c98196453 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/keys.json @@ -808,6 +808,64 @@ } } }, + "/keys/{key-name}/{key-version}/export": { + "post": { + "tags": [ + "Keys" + ], + "operationId": "exportKey", + "summary": "Exports a key.", + "description": "The export key operation is applicable to all key types. The target key must be marked exportable. This operation requires the keys/export permission.", + "parameters": [ + { + "name": "key-name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the key to get." + }, + { + "name": "key-version", + "required": true, + "in": "path", + "type": "string", + "description": "Adding the version parameter retrieves a specific version of a key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/KeyExportParameters" + }, + "description": "The parameters for the key export operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "A key bundle containing the key and its attributes.", + "schema": { + "$ref": "#/definitions/KeyBundle" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Export key": { + "$ref": "./examples/ExportKey-example.json" + } + } + } + }, "/deletedkeys": { "get": { "tags": [ @@ -975,6 +1033,83 @@ } }, "definitions": { + "KeyReleaseCondition": { + "properties": { + "claim": { + "x-ms-client-name": "claimType", + "type": "string", + "minLength": 1, + "description": "claim type name" + }, + "condition": { + "x-ms-client-name": "claimCondition", + "type": "string", + "minLength": 1, + "description": "condition to test", + "enum": [ + "equals" + ], + "x-ms-enum": { + "name": "KeyReleaseConditionCondition", + "modelAsString": true, + "values": [ + { + "value": "equals", + "description": "equals comparison." + } + ] + } + }, + "value": { + "type": "string" + } + } + }, + "KeyReleaseAuthority": { + "properties": { + "authority": { + "x-ms-client-name": "authorityURL", + "type": "string", + "minLength": 1, + "description": "Base URL of the attestation service." + }, + "allOf": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyReleaseCondition", + "description": "The set of claim conditions that must be met." + } + } + } + }, + "KeyReleasePolicy": { + "properties": { + "version": { + "description": "key release policy version", + "type": "string", + "enum": [ + "0.2" + ], + "x-ms-enum": { + "name": "KeyReleasePolicyVersion", + "modelAsString": true, + "values": [ + { + "value": "0.2", + "description": "Schema version 0.2" + } + ] + } + }, + "anyOf": { + "type": "array", + "items": { + "$ref": "#/definitions/KeyReleaseAuthority", + "description": "Authorities." + } + } + } + }, "JsonWebKey": { "properties": { "kid": { @@ -1082,7 +1217,7 @@ "x-ms-client-name": "t", "type": "string", "format": "base64url", - "description": "HSM Token, used with 'Bring Your Own Key'." + "description": "Protected Key, used with 'Bring Your Own Key'." }, "crv": { "type": "string", @@ -1160,6 +1295,10 @@ }, "readOnly": true, "x-nullable": false + }, + "exportable": { + "type": "boolean", + "description": "Indicates if the private key can be exported." } }, "description": "The attributes of a key managed by the key vault service." @@ -1185,6 +1324,10 @@ "type": "boolean", "readOnly": true, "description": "True if the key's lifetime is managed by key vault. If this is a key backing a certificate, then managed will be true." + }, + "release_policy": { + "$ref": "#/definitions/KeyReleasePolicy", + "description": "The policy rules under which the key can be exported." } }, "description": "A KeyBundle consisting of a WebKey plus its attributes." @@ -1340,6 +1483,11 @@ "format": "int32", "description": "The key size in bits. For example: 2048, 3072, or 4096 for RSA." }, + "public_exponent": { + "type": "integer", + "format": "int32", + "description": "The public exponent for a RSA key." + }, "key_ops": { "type": "array", "items": { @@ -1352,7 +1500,8 @@ "verify", "wrapKey", "unwrapKey", - "import" + "import", + "export" ], "x-ms-enum": { "name": "JsonWebKeyOperation", @@ -1385,6 +1534,10 @@ "name": "JsonWebKeyCurveName", "modelAsString": true } + }, + "release_policy": { + "$ref": "#/definitions/KeyReleasePolicy", + "description": "The policy rules under which the key can be exported." } }, "description": "The key create parameters.", @@ -1413,6 +1566,10 @@ "type": "string" }, "description": "Application specific metadata in the form of key-value pairs." + }, + "release_policy": { + "$ref": "#/definitions/KeyReleasePolicy", + "description": "The policy rules under which the key can be exported." } }, "description": "The key import parameters.", @@ -1420,6 +1577,20 @@ "key" ] }, + "KeyExportParameters": { + "properties": { + "env": { + "x-ms-client-name": "environment", + "type": "string", + "minLength": 1, + "description": "The target environment assertion." + } + }, + "description": "The export key parameters.", + "required": [ + "env" + ] + }, "KeyOperationsParameters": { "properties": { "alg": { @@ -1436,7 +1607,13 @@ "A256GCM", "A128KW", "A192KW", - "A256KW" + "A256KW", + "A128CBC", + "A192CBC", + "A256CBC", + "A128CBCPAD", + "A192CBCPAD", + "A256CBCPAD" ], "x-ms-enum": { "name": "JsonWebKeyEncryptionAlgorithm", @@ -1609,7 +1786,8 @@ "verify", "wrapKey", "unwrapKey", - "import" + "import", + "export" ], "x-ms-enum": { "name": "JsonWebKeyOperation", @@ -1628,6 +1806,10 @@ "type": "string" }, "description": "Application specific metadata in the form of key-value pairs." + }, + "release_policy": { + "$ref": "#/definitions/KeyReleasePolicy", + "description": "The policy rules under which the key can be exported." } }, "description": "The key update parameters." diff --git a/specification/keyvault/data-plane/readme.md b/specification/keyvault/data-plane/readme.md index eb859f72ce78..9db0128e0f77 100644 --- a/specification/keyvault/data-plane/readme.md +++ b/specification/keyvault/data-plane/readme.md @@ -44,6 +44,22 @@ input-file: - Microsoft.KeyVault/preview/7.2/backuprestore.json ``` +### Tag: package-7.2-preview + +These settings apply only when `--tag=package-7.2-preview` is specified on the command line. + +```yaml $(tag) == 'package-7.2-preview' +input-file: +- Microsoft.KeyVault/preview/7.2/certificates.json +- Microsoft.KeyVault/preview/7.2/common.json +- Microsoft.KeyVault/preview/7.2/keys.json +- Microsoft.KeyVault/preview/7.2/rbac.json +- Microsoft.KeyVault/preview/7.2/secrets.json +- Microsoft.KeyVault/preview/7.2/storage.json +- Microsoft.KeyVault/preview/7.2/backuprestore.json +``` + + ### Tag: package-7.1-preview These settings apply only when `--tag=package-7.1-preview` is specified on the command line. @@ -288,10 +304,22 @@ directive: from: keys.json where: $.definitions.JsonWebKey.properties.key_hsm reason: Merely refactored existing definitions into new files. + - suppress: DefinitionsPropertiesNamesCamelCase + from: keys.json + where: $.definitions.KeyBundle.properties.release_policy + reason: Consistency with other properties. - suppress: DefinitionsPropertiesNamesCamelCase from: keys.json where: $.definitions.KeyCreateParameters.properties.key_size reason: Merely refactored existing definitions into new files. + - suppress: DefinitionsPropertiesNamesCamelCase + from: keys.json + where: $.definitions.KeyCreateParameters.properties.public_exponent + reason: Consistency with other properties. + - suppress: DefinitionsPropertiesNamesCamelCase + from: keys.json + where: $.definitions.KeyCreateParameters.properties.release_policy + reason: Consistency with other properties. - suppress: DefinitionsPropertiesNamesCamelCase from: keys.json where: $.definitions.KeyCreateParameters.properties.key_ops @@ -300,10 +328,18 @@ directive: from: keys.json where: $.definitions.KeyImportParameters.properties.Hsm reason: Merely refactored existing definitions into new files. + - suppress: DefinitionsPropertiesNamesCamelCase + from: keys.json + where: $.definitions.KeyImportParameters.properties.release_policy + reason: Consistency with other properties. - suppress: DefinitionsPropertiesNamesCamelCase from: keys.json where: $.definitions.KeyUpdateParameters.properties.key_ops reason: Merely refactored existing definitions into new files. + - suppress: DefinitionsPropertiesNamesCamelCase + from: keys.json + where: $.definitions.KeyUpdateParameters.properties.release_policy + reason: Consistency with other properties. - suppress: MISSING_REQUIRED_PARAMETER from: certificates.json where: $..parameters[?(@.name=='vaultBaseUrl')] From 1e36f3719b3af5e1a4a23507cabc6d84face189e Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Sat, 30 May 2020 07:49:02 +0200 Subject: [PATCH 049/318] monitor readme fix (#9635) --- specification/monitor/resource-manager/readme.python.md | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/specification/monitor/resource-manager/readme.python.md b/specification/monitor/resource-manager/readme.python.md index b2c18e532fda..6d84860e3278 100644 --- a/specification/monitor/resource-manager/readme.python.md +++ b/specification/monitor/resource-manager/readme.python.md @@ -74,6 +74,12 @@ batch: - multiapiscript: true ``` +``` yaml $(multiapiscript) +output-folder: $(python-sdks-folder)/monitor/azure-mgmt-monitor/azure/mgmt/monitor/ +clear-output-folder: false +perform-load: false +``` + ### Tag: package-2019-10-17-preview-only and python These settings apply only when `--tag=package-2019-10-17-preview-only --python` is specified on the command line. From d8fbe6ae97bfb2ec7b4600237442be7f35bd2be1 Mon Sep 17 00:00:00 2001 From: sashahdo <64434373+sashahdo@users.noreply.github.com> Date: Sat, 30 May 2020 04:34:46 -0700 Subject: [PATCH 050/318] [Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 (#9418) * added forecast api and all of it's scopes * removed extra external forecast example links * updated budgets api to reflect current version * fixed filter properties * fixed typos * cleaned up description * removed OR from budgetFilter * Revert "removed extra external forecast example links" This reverts commit b491abae116fd1e484b0b9d18fbe4bd86aec0fd2. * Revert "added forecast api and all of it's scopes" This reverts commit 6de98db14004d5701c56c42adcade4ee583c011b. * fixed Budgets as per PM's suggestions * renamed x-ms-enum name to avoid conflict --- .../stable/2019-10-01/consumption.json | 98 ++++++---- .../stable/2019-10-01/examples/Budget.json | 59 +++--- .../2019-10-01/examples/BudgetsList.json | 116 +++++++----- .../examples/CreateOrUpdateBudget.json | 173 +++++++++++------- 4 files changed, 274 insertions(+), 172 deletions(-) diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json index 4d14b159469b..df51f5e489e7 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json @@ -3562,7 +3562,7 @@ "format": "decimal" }, "timeGrain": { - "description": "The time covered by a budget. Tracking of the amount will be reset based on the time grain.", + "description": "The time covered by a budget. Tracking of the amount will be reset based on the time grain. BillingMonth, BillingQuarter, and BillingAnnual are only supported by WD customers", "type": "string", "enum": [ "Monthly", @@ -3578,13 +3578,13 @@ } }, "timePeriod": { - "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than three months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.", + "description": "Has start and end date of the budget. The start date must be first of the month and should be less than the end date. Budget start date must be on or after June 1, 2017. Future start date should not be more than twelve months. Past start date should be selected within the timegrain period. There are no restrictions on the end date.", "$ref": "#/definitions/BudgetTimePeriod" }, - "filters": { + "filter": { "description": "May be used to filter budgets by resource group, resource, or meter.", "type": "object", - "$ref": "#/definitions/Filters" + "$ref": "#/definitions/BudgetFilter" }, "currentSpend": { "description": "The current amount of cost which is being tracked for a budget.", @@ -3626,51 +3626,64 @@ "startDate" ] }, - "Filters": { + "BudgetFilter": { "description": "May be used to filter budgets by resource group, resource, or meter.", "properties": { - "resourceGroups": { - "description": "The list of filters on resource groups, allowed at subscription level only.", + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", "type": "array", "items": { - "type": "string" + "$ref": "#/definitions/BudgetFilter" }, - "minItems": 0, - "maxItems": 10 + "minItems": 2 }, - "resources": { - "description": "The list of filters on resources.", - "type": "array", - "items": { - "type": "string" - }, - "minItems": 0, - "maxItems": 10 + "not": { + "description": "The logical \"NOT\" expression.", + "$ref": "#/definitions/BudgetFilter" }, - "meters": { - "description": "The list of filters on meters (GUID), mandatory for budgets of usage category. ", - "type": "array", - "items": { - "type": "string", - "format": "uuid" - }, - "minItems": 0, - "maxItems": 10 + "dimensions": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/BudgetComparisonExpression" }, "tags": { - "type": "object", - "description": "The dictionary of filters on tags.", - "additionalProperties": { - "type": "array", - "items": { - "type": "string" - } - }, - "minItems": 0, - "maxItems": 10 + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/BudgetComparisonExpression" } } }, + "BudgetComparisonExpression": { + "description": "The comparison expression to be used in the budgets.", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "BudgetOperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, "CurrentSpend": { "description": "The current amount of cost which is being tracked for a budget.", "properties": { @@ -3736,6 +3749,17 @@ }, "minItems": 0, "maxItems": 50 + }, + "thresholdType": { + "description": "The type of threshold", + "type": "string", + "enum": [ + "Actual" + ], + "x-ms-enum": { + "name": "ThresholdType", + "modelAsString": true + } } }, "required": [ diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/Budget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/Budget.json index 8471ee227283..dc5d2048afb9 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/Budget.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/Budget.json @@ -9,7 +9,7 @@ "responses": { "200": { "body": { - "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/budgets/TestBudget", + "id": "subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.Consumption/budgets", "eTag": "\"1d34d012214157f\"", @@ -21,27 +21,39 @@ "startDate": "2017-10-01T00:00:00Z", "endDate": "2018-10-31T00:00:00Z" }, - "filters": { - "resourceGroups": [ - "MPDEVTESTRG" - ], - "resources": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" - ], - "meters": [ - "00000000-0000-0000-0000-000000000000" - ], - "tags": { - "category": [ - "Dev", - "Prod" - ], - "department": [ - "engineering", - "sales" - ] - } + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] }, "currentSpend": { "amount": 80.89, @@ -62,7 +74,8 @@ ], "contactGroups": [ "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ] + ], + "thresholdType": "Actual" } } } diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/BudgetsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/BudgetsList.json index 28b3c2a85f87..79016fba4a92 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/BudgetsList.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/BudgetsList.json @@ -10,7 +10,7 @@ "body": { "value": [ { - "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/budgets/TestBudget", + "id": "subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.Consumption/budgets", "eTag": "\"1d34d012214157f\"", @@ -22,27 +22,39 @@ "startDate": "2017-10-01T00:00:00Z", "endDate": "2018-10-31T00:00:00Z" }, - "filters": { - "resourceGroups": [ - "MYDEVTESTRG" - ], - "resources": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MYVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" - ], - "meters": [ - "00000000-0000-0000-0000-000000000000" - ], - "tags": { - "category": [ - "Dev", - "Prod" - ], - "department": [ - "engineering", - "sales" - ] - } + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] }, "currentSpend": { "amount": 80.89, @@ -77,7 +89,8 @@ "contactGroups": [ "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" ] - } + }, + "thresholdType": "Actual" } } }, @@ -94,27 +107,39 @@ "startDate": "2017-10-01T00:00:00Z", "endDate": "2018-10-31T00:00:00Z" }, - "filters": { - "resourceGroups": [ - "MYDEVTESTRG" - ], - "resources": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MYVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" - ], - "meters": [ - "00000000-0000-0000-0000-000000000000" - ], - "tags": { - "category": [ - "Dev", - "Prod" - ], - "department": [ - "engineering", - "sales" - ] - } + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] }, "currentSpend": { "amount": 120.89, @@ -148,7 +173,8 @@ ], "contactGroups": [ "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ] + ], + "thresholdType": "Actual" } } } diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/CreateOrUpdateBudget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/CreateOrUpdateBudget.json index d527262295e6..6e661c37f5d2 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/CreateOrUpdateBudget.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/CreateOrUpdateBudget.json @@ -15,27 +15,39 @@ "startDate": "2017-10-01T00:00:00Z", "endDate": "2018-10-31T00:00:00Z" }, - "filters": { - "resourceGroups": [ - "MYDEVTESTRG" - ], - "resources": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MYVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" - ], - "meters": [ - "00000000-0000-0000-0000-000000000000" - ], - "tags": { - "category": [ - "Dev", - "Prod" - ], - "department": [ - "engineering", - "sales" - ] - } + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] }, "notifications": { "Actual_GreaterThan_80_Percent": { @@ -52,7 +64,8 @@ ], "contactGroups": [ "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ] + ], + "thresholdType": "Actual" } } } @@ -61,7 +74,7 @@ "responses": { "201": { "body": { - "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/budgets/TestBudget", + "id": "subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.Consumption/budgets", "eTag": "\"1d34d012214157f\"", @@ -73,27 +86,39 @@ "startDate": "2017-10-01T00:00:00Z", "endDate": "2018-10-31T00:00:00Z" }, - "filters": { - "resourceGroups": [ - "MPDEVTESTRG" - ], - "resources": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MYVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" - ], - "meters": [ - "00000000-0000-0000-0000-000000000000" - ], - "tags": { - "category": [ - "Dev", - "Prod" - ], - "department": [ - "engineering", - "sales" - ] - } + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] }, "currentSpend": { "amount": 80.89, @@ -114,7 +139,8 @@ ], "contactGroups": [ "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ] + ], + "thresholdType": "Actual" } } } @@ -134,27 +160,39 @@ "startDate": "2017-10-01T00:00:00Z", "endDate": "2018-10-31T00:00:00Z" }, - "filters": { - "resourceGroups": [ - "MPDEVTESTRG" - ], - "resources": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MYVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" - ], - "meters": [ - "00000000-0000-0000-0000-000000000000" - ], - "tags": { - "category": [ - "Dev", - "Prod" - ], - "department": [ - "engineering", - "sales" - ] - } + "filter": { + "and": [ + { + "dimensions": { + "name": "ResourceId", + "operator": "In", + "values": [ + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + ] + } + }, + { + "tags": { + "name": "category", + "operator": "In", + "values": [ + "Dev", + "Prod" + ] + } + }, + { + "tags": { + "name": "department", + "operator": "In", + "values": [ + "engineering", + "sales" + ] + } + } + ] }, "currentSpend": { "amount": 80.89, @@ -175,7 +213,8 @@ ], "contactGroups": [ "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" - ] + ], + "thresholdType": "Actual" } } } From 05f6f66d338b7a96efc45e77ff153975b4d9f4c3 Mon Sep 17 00:00:00 2001 From: kangtao Date: Sat, 30 May 2020 04:36:17 -0700 Subject: [PATCH 051/318] [DataFactory] Add GlobalParameters and update waitTimeInSeconds in WaitActivity (#9362) * Update data type of waitTimeInSeconds in WaitActivity * add global parameters Co-authored-by: Kang Tao --- .../stable/2018-06-01/datafactory.json | 41 +++++++++++++++++++ .../2018-06-01/entityTypes/Pipeline.json | 2 +- 2 files changed, 42 insertions(+), 1 deletion(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json index abb09d4b737c..1419e260fad9 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/datafactory.json @@ -4419,9 +4419,50 @@ "repoConfiguration": { "$ref": "#/definitions/FactoryRepoConfiguration", "description": "Git repo information of the factory." + }, + "globalParameters": { + "$ref": "#/definitions/GlobalParameterDefinitionSpecification", + "description": "List of parameters for factory." } } }, + "GlobalParameterDefinitionSpecification": { + "description": "Definition of all parameters for an entity.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/GlobalParameterSpecification" + } + }, + "GlobalParameterSpecification": { + "description": "Definition of a single parameter for an entity.", + "type": "object", + "properties": { + "type": { + "type": "string", + "description": "Global Parameter type.", + "enum": [ + "Object", + "String", + "Int", + "Float", + "Bool", + "Array" + ], + "x-ms-enum": { + "name": "GlobalParameterType", + "modelAsString": true + } + }, + "value": { + "type": "object", + "description": "Value of parameter." + } + }, + "required": [ + "type", + "value" + ] + }, "PipelineResource": { "description": "Pipeline resource type.", "type": "object", diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 7188e70e1bdd..f3cea912ff1f 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -5957,7 +5957,7 @@ "properties": { "waitTimeInSeconds": { "description": "Duration in seconds.", - "type": "integer" + "type": "object" } }, "required": [ From aef7bda78247cfb37c0c46516824b65a04f1707c Mon Sep 17 00:00:00 2001 From: Richard Li Date: Sun, 31 May 2020 19:46:39 -0700 Subject: [PATCH 052/318] update identity type enum (#9649) Co-authored-by: Richard Li --- .../preview/2020-04-01-preview/machineLearningServices.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json index 02872517f2b7..c744d1dc2d46 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json @@ -2139,7 +2139,7 @@ "description": "The identity type.", "enum": [ "SystemAssigned", - "SystemAssigned, UserAssigned" + "SystemAssigned,UserAssigned" ], "x-ms-enum": { "name": "ResourceIdentityType", From d58990d752a3dae8a26093f205e8006f16048a53 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?=E9=99=88=E7=AE=AD=E9=A3=9E?= <32889038+chenjianfei2017@users.noreply.github.com> Date: Mon, 1 Jun 2020 13:09:43 +0800 Subject: [PATCH 053/318] Revert "Fix Parameter Description for validate resource move (#8524)" (#9580) This reverts commit cb0a81fefacc56fca338e3a2658a9390b305fa61. --- .../Microsoft.Resources/stable/2019-10-01/resources.json | 9 +-------- 1 file changed, 1 insertion(+), 8 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json index 27da76a83a66..399946292489 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json @@ -2620,7 +2620,7 @@ "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SourceSubscriptionIdParameter" + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -5849,13 +5849,6 @@ "type": "string", "description": "The ID of the target subscription." }, - "SourceSubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the source subscription." - }, "DeploymentNameParameter": { "name": "deploymentName", "in": "path", From e83bb3392a13e1bb0b2c2cbdf4597d0a0edde49d Mon Sep 17 00:00:00 2001 From: Anirban Sarkar <33848291+asarkar84@users.noreply.github.com> Date: Sun, 31 May 2020 22:19:19 -0700 Subject: [PATCH 054/318] Correcting the swagger to accept downloadToken similar to other download operations (#9651) Correcting the swagger to accept downloadToken similar to other download operations Co-authored-by: Anirban Sarkar --- .../Microsoft.Billing/stable/2020-05-01/billing.json | 7 +++++++ .../stable/2020-05-01/examples/InvoiceDownload.json | 3 ++- 2 files changed, 9 insertions(+), 1 deletion(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json index 96398ed362ae..a8db81727888 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json @@ -1280,6 +1280,13 @@ }, { "$ref": "#/parameters/invoiceNameParameter" + }, + { + "name": "downloadToken", + "description": "Download token with document source and document ID.", + "in": "query", + "required": true, + "type": "string" } ], "responses": { diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json index a06d8a863789..9bf994a947cb 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/examples/InvoiceDownload.json @@ -2,7 +2,8 @@ "parameters": { "api-version": "2020-05-01", "billingAccountName": "{billingAccountName}", - "invoiceName": "{invoiceName}" + "invoiceName": "{invoiceName}", + "downloadToken": "DRS_12345" }, "responses": { "202": { From 24a42725ddd779b9eb899e6d31b6feb023e2de28 Mon Sep 17 00:00:00 2001 From: Ajit Navasare Date: Mon, 1 Jun 2020 07:11:54 -0700 Subject: [PATCH 055/318] renaming operationIds fro Cluster put and patch as per guidelines (#9639) Co-authored-by: v-ajnava --- .../preview/2018-01-01-preview/Clusters-preview.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json index d870c2bc4c16..548a7852cd5f 100644 --- a/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json +++ b/specification/eventhub/resource-manager/Microsoft.EventHub/preview/2018-01-01-preview/Clusters-preview.json @@ -121,7 +121,7 @@ "tags": [ "EventHubs Clusters" ], - "operationId": "Clusters_Put", + "operationId": "Clusters_CreateOrUpdate", "x-ms-examples": { "ClusterPut": { "$ref": "./examples/Clusters/ClusterPut.json" @@ -183,7 +183,7 @@ "tags": [ "EventHubs Clusters" ], - "operationId": "Clusters_Patch", + "operationId": "Clusters_Update", "x-ms-examples": { "ClusterPatch": { "$ref": "./examples/Clusters/ClusterPatch.json" From d77baea351ade4453199f73e9aad1f4b8a320a76 Mon Sep 17 00:00:00 2001 From: Rahul Singh <53578268+rahuls-microsoft@users.noreply.github.com> Date: Mon, 1 Jun 2020 18:00:21 -0700 Subject: [PATCH 056/318] Updating documentation of Quota APIs. Removing Summary field. (#9641) * Updating operationId to group the opearions in a logical way and the generate APIs are grouped together based on the operations. * 1. Updating schema for autoQuotaRequest 2. Updating examples. * Updates to data model and examples. * Model Update. * Data Model Fix. * Fixing Data Model for AQI. * Removing duplicate definitions. * Adding type=object for emailAction. * Putting the similar definitions together. * Model Fix. * Fixing AQI examples. * Adding descriptions for enum. * Fixing Spell Check error. * Removing used object: phoneActions. Updating the comments for Put and Patch, that both can be used to update quota. * Updating the Put operatonId as _CreateOrUpdate. * Making Tag information same - QuotaInformation. * Updating example for commit. * 1. Updating description of Quota APIs. 2. Removing Summary, as summary and description was combined in the doc. It had repeated statements. * 1. Updating descriptions. 2. Adding BatchML examples and making the example names as - MachineLearningServices. * Upadatin serviceLimitsRequests in path. --- ... => getMachineLearningServicesUsages.json} | 0 .../examples/patchComputeQuotaRequest.json | 4 +- .../putComputeOneSkuQuotaRequest.json | 4 +- ...LearningServicesQuotaRequestDedicated.json | 57 +++++++++++++++++++ ...arningServicesQuotaRequestLowPriority.json | 57 +++++++++++++++++++ .../preview/2019-07-19/quota.json | 38 ++++++------- 6 files changed, 136 insertions(+), 24 deletions(-) rename specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/{getBatchAIUsages.json => getMachineLearningServicesUsages.json} (100%) create mode 100644 specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putMachineLearningServicesQuotaRequestDedicated.json create mode 100644 specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putMachineLearningServicesQuotaRequestLowPriority.json diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getBatchAIUsages.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getMachineLearningServicesUsages.json similarity index 100% rename from specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getBatchAIUsages.json rename to specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getMachineLearningServicesUsages.json diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/patchComputeQuotaRequest.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/patchComputeQuotaRequest.json index 4bd4702a9bf6..e119473eca89 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/patchComputeQuotaRequest.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/patchComputeQuotaRequest.json @@ -18,7 +18,7 @@ "responses": { "201": { "body": { - "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/requests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", "type": "Microsoft.Capacity/ServiceLimits", "properties": { @@ -29,7 +29,7 @@ }, "200": { "body": { - "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/quotaRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", "type": "Microsoft.Capacity/serviceLimits", "properties": { diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putComputeOneSkuQuotaRequest.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putComputeOneSkuQuotaRequest.json index d459467a2130..e8328d5f6e28 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putComputeOneSkuQuotaRequest.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putComputeOneSkuQuotaRequest.json @@ -18,7 +18,7 @@ "responses": { "201": { "body": { - "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimits/requests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", "type": "Microsoft.Capacity/ServiceLimits", "properties": { @@ -29,7 +29,7 @@ }, "200": { "body": { - "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/quotaRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.Compute/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", "type": "Microsoft.Capacity/serviceLimits", "properties": { diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putMachineLearningServicesQuotaRequestDedicated.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putMachineLearningServicesQuotaRequestDedicated.json new file mode 100644 index 000000000000..43fdf27615f5 --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putMachineLearningServicesQuotaRequestDedicated.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "D7EC67B3-7657-4966-BFFC-41EFD36BAAB3", + "providerId": "Microsoft.MachineLearningServices", + "location": "eastus", + "resourceName": "StandardDv2Family", + "api-version": "2019-07-19-preview", + "createQuotaRequest": { + "properties": { + "limit": 200, + "unit": "Count", + "name": { + "value": "StandardDv2Family" + }, + "resourceType": "dedicated" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.MachineLearningServices/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Capacity/ServiceLimits", + "properties": { + "provisioningState": "InProgress", + "message": "" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.MachineLearningServices/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Capacity/serviceLimits", + "properties": { + "provisioningState": "Succeeded", + "message": "Request succeeded", + "properties": { + "properties": { + "limit": 200, + "unit": "Count", + "currentValue": 160, + "name": { + "value": "StandardDv2Family", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "resourceType": "dedicated", + "quotaPeriod": "", + "properties": {} + } + } + } + } + } + } +} diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putMachineLearningServicesQuotaRequestLowPriority.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putMachineLearningServicesQuotaRequestLowPriority.json new file mode 100644 index 000000000000..8893da3a15ae --- /dev/null +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putMachineLearningServicesQuotaRequestLowPriority.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "D7EC67B3-7657-4966-BFFC-41EFD36BAAB3", + "providerId": "Microsoft.MachineLearningServices", + "location": "eastus", + "resourceName": "TotalLowPriorityCores", + "api-version": "2019-07-19-preview", + "createQuotaRequest": { + "properties": { + "limit": 200, + "unit": "Count", + "name": { + "value": "TotalLowPriorityCores" + }, + "resourceType": "lowPriority" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.MachineLearningServices/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Capacity/ServiceLimits", + "properties": { + "provisioningState": "InProgress", + "message": "" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/D7EC67B3-7657-4966-BFFC-41EFD36BAAB3/providers/Microsoft.Capacity/resourceProviders/Microsoft.MachineLearningServices/locations/eastus/serviceLimitsRequests/2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "name": "2B5C8515-37D8-4B6A-879B-CD641A2CF605", + "type": "Microsoft.Capacity/serviceLimits", + "properties": { + "provisioningState": "Succeeded", + "message": "Request succeeded", + "properties": { + "properties": { + "limit": 200, + "unit": "Count", + "currentValue": 160, + "name": { + "value": "TotalLowPriorityCores", + "localizedValue": "Total Cluster Low Priority Regional vCPUs" + }, + "resourceType": "lowPriority", + "quotaPeriod": "", + "properties": {} + } + } + } + } + } + } +} diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json index c5134aee0475..dc60e822df1e 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json @@ -39,8 +39,7 @@ "tags": [ "QuotaInformation" ], - "summary": "Gets the current quota limit and usages for the resource provider for the specified location for the specific resource in the parameter.", - "description": "This API gets the current quota limit and usages for the specific resource for resource provider for the specified location. This response can be used to submit quotaRequests.", + "description": "Gets the current service limits (quotas) and usage of a resource. The response from Get API can be leveraged to submit quota update requests.", "operationId": "Quota_Get", "x-ms-examples": { "Quotas_Request_ForCompute": { @@ -89,12 +88,17 @@ "tags": [ "QuotaInformation" ], - "summary": "Submits a Quota Request for a resource provider at the specified location for the specific resource in the parameter.", - "description": "Submits Quota change request for a resource provider for the specified location for the specific resource in the parameter. To use, first make a Get request to get quota information for the specific resource. This information consists of information regarding that specific resources. For the specific resource, if it requires an update to the quota, update the limit field in the response from the Get request to the new value of quota. Then, submit this updated JSON object to this quota request API. This will update the quota to the value specified. The location header in the response will be used to track the status of the quota request. Please check the provisioningState field in the response. The Patch operation can be used also to update the quota.", + "description": "Create or update the service limits (quota) of a resource to requested value.\n Steps:\n\r 1. Make the Get request to get the quota information for specific resource.\n\r 2. To increase the quota, update the limit field in the response from Get request to new value.\n\r 3. Submit the JSON to the quota request API to update the quota.\r\n The Create quota request may be constructed as follows. The PUT operation can be used to update the quota.", "operationId": "Quota_CreateOrUpdate", "x-ms-examples": { - "Quotas_Request_listForCompute": { + "Quotas_Request_ForCompute": { "$ref": "./examples/putComputeOneSkuQuotaRequest.json" + }, + "Quotas_Request_ForMachineLearningServices_DedicatedResource": { + "$ref": "./examples/putMachineLearningServicesQuotaRequestDedicated.json" + }, + "Quotas_Request_ForMachineLearningServices_LowPriorityResource": { + "$ref": "./examples/putMachineLearningServicesQuotaRequestLowPriority.json" } }, "x-ms-long-running-operation": true, @@ -152,8 +156,7 @@ "tags": [ "QuotaInformation" ], - "summary": "Submits a Quota Request for a resource provider at the specified location for the specific resource in the parameter.", - "description": "Submits Quota change request for a resource provider for the specified location for the specific resource in the parameter. To use, first make a Get request to get quota information for the specific resource. This information consists of information regarding that specific resources. For the specific resource, if it requires an update to the quota, update the limit field in the response from the Get request to the new value of quota. Then, submit this updated JSON object to this quota request API. This will update the quota to the value specified. The location header in the response will be used to track the status of the quota request. Please check the provisioningState field in the response. The Put operation can be used also to update the quota.", + "description": "Create or update the service limits (quota) of a resource to requested value.\n Steps:\n\r 1. Make the Get request to get the quota information for specific resource.\n\r 2. To increase the quota, update the limit field in the response from Get request to new value.\n\r 3. Submit the JSON to the quota request API to update the quota.\r\n The Create quota request may be constructed as follows. The PUT operation can be used to update the quota.", "operationId": "Quota_Update", "x-ms-examples": { "Quotas_Request_PatchForCompute": { @@ -198,7 +201,7 @@ } }, "201": { - "description": "The request is accepted and is being processed. Please use requestId to check the status.", + "description": "The request is accepted and is being processed. Use requestId to check the status.", "schema": { "$ref": "#/definitions/QuotaRequestSubmitResponse201" } @@ -217,15 +220,14 @@ "tags": [ "QuotaInformation" ], - "summary": "Gets the current quota limit and usages for all the resources by the resource provider at the specified location.", - "description": "This API gets the current quota limits and usages for the resource provider for the specified location. This response can be used to submit quotaRequests.", + "description": "Get a list of current service limits (quota) and usages of all the resources. The response from List API can be leveraged to submit quota update requests.", "operationId": "Quota_List", "x-ms-examples": { "Quotas_listUsagesForCompute": { "$ref": "./examples/getComputeUsages.json" }, - "Quotas_listUsagesForBatchAI": { - "$ref": "./examples/getBatchAIUsages.json" + "Quotas_listUsagesMachineLearningServices": { + "$ref": "./examples/getMachineLearningServicesUsages.json" }, "Quotas_listUsagesForMsSql": { "$ref": "./examples/getMsSqlUsages.json" @@ -286,7 +288,6 @@ "$ref": "./examples/getQuotaRequestStatusFailed.json" } }, - "summary": "Gets the Quota request status by requestId, for the specified resource provider at specified location.", "description": "Gets the QuotaRequest details and status by the quota request Id for the resources for the resource provider at a specific location. The requestId is returned as response to the Put requests for serviceLimits.", "operationId": "QuotaRequestStatus_Get", "parameters": [ @@ -332,7 +333,6 @@ "$ref": "./examples/getQuotaRequestsHistory.json" } }, - "summary": "For the specified location and resource Provider, gets the quota requests under the subscription over the time\n period of one year ago from now to one year back, based on the filter specified.", "description": "For the specified location and Resource provider gets the current quota requests under the subscription over the time period of one year ago from now to one year back. oData filter can be used to select quota requests.", "operationId": "QuotaRequestStatus_List", "parameters": [ @@ -386,7 +386,6 @@ "tags": [ "AutoQuotaIncrease" ], - "summary": "For the specified subscription, gets the Auto Quota Increase enrollment status.", "description": "Gets the Auto Quota Increase enrollment details for the specified subscription.", "operationId": "AutoQuotaIncrease_GetProperties", "x-ms-examples": { @@ -421,7 +420,6 @@ "tags": [ "AutoQuotaIncrease" ], - "summary": "For the specified subscription, sets the Auto Quota Increase enrollment properties.", "description": "Sets the Auto Quota Increase enrollment properties for the specified subscription.", "operationId": "AutoQuotaIncrease_Create", "x-ms-examples": { @@ -496,7 +494,7 @@ } }, "QuotaProperties": { - "description": "Resource quota properties.", + "description": "Quota properties for the resource.", "type": "object", "properties": { "limit": { @@ -1120,7 +1118,7 @@ "in": "query", "required": true, "type": "string", - "description": "Api version." + "description": "API version." }, "LocationIdInParameters": { "name": "location", @@ -1135,7 +1133,7 @@ "in": "path", "required": true, "type": "string", - "description": "Azure resource Provider id.", + "description": "Azure resource provider id.", "x-ms-parameter-location": "method" }, "ResourceNameInParameters": { @@ -1143,7 +1141,7 @@ "in": "path", "required": true, "type": "string", - "description": "The Resource name for the specific resource provider, such as SKU name for Microsoft.Compute, pool for Microsoft.Batch.", + "description": "The resource name for a resource provider, such as SKU name for Microsoft.Compute, Sku or TotalLowPriorityCores for Microsoft.MachineLearningServices", "x-ms-parameter-location": "method" }, "RequestIdInParameters": { From fb3f140d92ca42d155ac74e6bf17df0081bce685 Mon Sep 17 00:00:00 2001 From: Kamil Sobol <61715331+kasobol-msft@users.noreply.github.com> Date: Mon, 1 Jun 2020 19:13:57 -0700 Subject: [PATCH 057/318] Update CODEOWNERS (#9669) --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index d81b5416321b..bf60aa798a9f 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -66,7 +66,7 @@ /specification/servicebus/ @sazeesha @v-ajnava /specification/servicefabric/ @juhacket @samedder /specification/sql/ @dnayantara @jaredmoo @nathannfan -/specification/storage/ @blueww @jasonyang-msft @xiaonlimsft +/specification/storage/ @blueww @jasonyang-msft @xiaonlimsft @kasobol-msft /specification/storageimportexport/ @leoz-ms /specification/storagesync/ @ankushbindlish2 /specification/storsimple8000series/ @manaas-microsoft From 83edf65901125c3e31c87f8e3f7d028fb1128325 Mon Sep 17 00:00:00 2001 From: rickysun93 Date: Tue, 2 Jun 2020 11:03:40 +0800 Subject: [PATCH 058/318] add deleteFilesAfterCompletion to binary sources. add listAfter/listBefore to adls gen1 source (#9472) Co-authored-by: Haoran Sun --- .../2018-06-01/entityTypes/Pipeline.json | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index f3cea912ff1f..3f87eba0a425 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -271,6 +271,10 @@ "type": "object", "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, "modifiedDatetimeStart": { "type": "object", "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." @@ -314,6 +318,10 @@ "type": "object", "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, "modifiedDatetimeStart": { "type": "object", "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." @@ -349,6 +357,14 @@ "type": "object", "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." }, + "listAfter": { + "type": "object", + "description": "Lists files after the value (exclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string)." + }, + "listBefore": { + "type": "object", + "description": "Lists files before the value (inclusive) based on file/folder names’ lexicographical order. Applies under the folderPath in data set, and filter files/sub-folders under the folderPath. Type: string (or Expression with resultType string)." + }, "enablePartitionDiscovery": { "type": "boolean", "description": "Indicates whether to enable partition discovery." @@ -357,6 +373,10 @@ "type": "object", "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, "modifiedDatetimeStart": { "type": "object", "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." @@ -404,6 +424,10 @@ "type": "object", "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, "modifiedDatetimeStart": { "type": "object", "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." @@ -447,6 +471,10 @@ "type": "object", "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, "modifiedDatetimeStart": { "type": "object", "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." @@ -498,6 +526,10 @@ "type": "object", "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, "modifiedDatetimeStart": { "type": "object", "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." @@ -564,6 +596,10 @@ "type": "object", "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, "modifiedDatetimeStart": { "type": "object", "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." @@ -603,6 +639,10 @@ "type": "object", "description": "Specify the root path where partition discovery starts from. Type: string (or Expression with resultType string)." }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, "fileListPath": { "type": "object", "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." @@ -646,6 +686,10 @@ "type": "object", "description": "Point to a text file that lists each file (relative path to the path configured in the dataset) that you want to copy. Type: string (or Expression with resultType string)." }, + "deleteFilesAfterCompletion": { + "type": "object", + "description": "Indicates whether the source files need to be deleted after copy completion. Default is false. Type: boolean (or Expression with resultType boolean)." + }, "modifiedDatetimeStart": { "type": "object", "description": "The start of file's modified datetime. Type: string (or Expression with resultType string)." From 6090c3bc80aa2754aa77d80535c70a23564ce552 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Tue, 2 Jun 2020 13:01:32 +0800 Subject: [PATCH 059/318] Fix bad output-folder (#9658) --- specification/billing/resource-manager/readme.go.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/billing/resource-manager/readme.go.md b/specification/billing/resource-manager/readme.go.md index da6a9bb03011..f6bf507cb97e 100644 --- a/specification/billing/resource-manager/readme.go.md +++ b/specification/billing/resource-manager/readme.go.md @@ -26,7 +26,7 @@ These settings apply only when `--tag=package-2020-05 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2020-05' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-05/$(namespace) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-05-01-preview/$(namespace) ``` ### Tag: package-2018-11-preview and go From 5f629e8a6096adf812f276263c62c574d9efe893 Mon Sep 17 00:00:00 2001 From: Ruoxuan Wang <52271048+ruowan@users.noreply.github.com> Date: Tue, 2 Jun 2020 16:05:27 +0800 Subject: [PATCH 060/318] enable rest-api-specs-scripts@0.10.2 (#9671) --- .../package-lock.json | 12 +- .azure-pipelines-preproduction/package.json | 2 +- package-lock.json | 139 ++++++++++++------ package.json | 2 +- 4 files changed, 100 insertions(+), 55 deletions(-) diff --git a/.azure-pipelines-preproduction/package-lock.json b/.azure-pipelines-preproduction/package-lock.json index 3fa5327a4d29..5a137fd25979 100644 --- a/.azure-pipelines-preproduction/package-lock.json +++ b/.azure-pipelines-preproduction/package-lock.json @@ -93,9 +93,9 @@ } }, "@azure/rest-api-specs-scripts": { - "version": "0.10.1", - "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.10.1.tgz", - "integrity": "sha512-O746D8Cg5OJqNrWw9uCvlTiMysXlYJ3pf7KmiJRvWqp8STyfhgon1nw65K3hUwFFQd3Ioc5SsOhnWJ+DVn5h3w==", + "version": "0.10.2", + "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.10.2.tgz", + "integrity": "sha512-g7W4eSvbn2q5wOF0FCj2lZ2yXuASfmIsZoib8ms4LXfixnA8CL2uW4XiVUvx2KzdW1RCCdjgh5n+LfCywLe4jw==", "dev": true, "requires": { "@azure/avocado": "^0.4.1", @@ -352,9 +352,9 @@ } }, "@octokit/types": { - "version": "4.0.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-4.0.2.tgz", - "integrity": "sha512-+4X6qfhT/fk/5FD66395NrFLxCzD6FsGlpPwfwvnukdyfYbhiZB/FJltiT1XM5Q63rGGBSf9FPaNV3WpNHm54A==", + "version": "4.1.4", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-4.1.4.tgz", + "integrity": "sha512-W+aHUBA6pEZ8OC1fgfFW1/jrgtkaMVBhNr7jhhBErvbWQY4Ii9Hlf3LAurwcy5XXjz8EYluiCZjHhnQO4GSfNg==", "dev": true, "requires": { "@types/node": ">= 8" diff --git a/.azure-pipelines-preproduction/package.json b/.azure-pipelines-preproduction/package.json index 0b49bd3834d4..e7d2d90308ab 100644 --- a/.azure-pipelines-preproduction/package.json +++ b/.azure-pipelines-preproduction/package.json @@ -11,7 +11,7 @@ "license": "MIT", "devDependencies": { "@azure/avocado": "^0.6.4", - "@azure/rest-api-specs-scripts": "^0.10.1", + "@azure/rest-api-specs-scripts": "^0.10.2", "@ts-common/commonmark-to-markdown": "^1.2.0", "@ts-common/fs": "0.2.0", "@ts-common/iterator": "^0.3.6", diff --git a/package-lock.json b/package-lock.json index fc609748244c..85b829ee2129 100644 --- a/package-lock.json +++ b/package-lock.json @@ -24,13 +24,17 @@ } }, "@azure/oad": { - "version": "0.7.1", - "resolved": "https://registry.npmjs.org/@azure/oad/-/oad-0.7.1.tgz", - "integrity": "sha512-KTlb+aQRFyKbd4ezie9wA5bthI+9Cia+j59PfYRyt8AD0L1RjW7DNvTXbpK7hOxRYPJdd/+1alczXRnWr99Pbw==", + "version": "0.8.1", + "resolved": "https://registry.npmjs.org/@azure/oad/-/oad-0.8.1.tgz", + "integrity": "sha512-Xl5vTMkfPkv0wVUgbvfITpaV07o6RIPOWpyPcCiZgQpkpfc0vsSh4SK3K4JSJ44z4BXTOhCSmkYgv/Zvtq/vSQ==", "dev": true, "requires": { "@ts-common/fs": "^0.2.0", - "@ts-common/json-parser": "^0.7.0", + "@ts-common/iterator": "^0.3.6", + "@ts-common/json": "^0.3.1", + "@ts-common/json-parser": "^0.9.0", + "@ts-common/source-map": "^0.5.0", + "@ts-common/string-map": "^0.3.0", "autorest": "^2.0.4407", "glob": "^7.1.3", "js-yaml": "^3.13.1", @@ -44,12 +48,13 @@ }, "dependencies": { "@ts-common/json-parser": { - "version": "0.7.2", - "resolved": "https://registry.npmjs.org/@ts-common/json-parser/-/json-parser-0.7.2.tgz", - "integrity": "sha512-Rb0bA/maGzfjA7ZegDvfDABF+vz2norftJX80aTOLb88gLd2+SnD6gYVg3nZH9FpA5/34JXFDvMs4Fb5GuPoew==", + "version": "0.9.0", + "resolved": "https://registry.npmjs.org/@ts-common/json-parser/-/json-parser-0.9.0.tgz", + "integrity": "sha512-how0z/Ak7Bay+feIYfJFVV8UMw8Ky2Czoo5XwN7QigCOlN4HyW6wSNup4zrZ7t6NUB0002tW/+IOKCH2lAVJOg==", "dev": true, "requires": { - "@ts-common/iterator": "^0.3.4", + "@ts-common/add-position": "0.0.2", + "@ts-common/iterator": "^0.3.5", "@ts-common/json": "^0.3.1", "@ts-common/source-map": "^0.5.0", "@ts-common/string-map": "^0.3.0", @@ -88,20 +93,21 @@ } }, "@azure/rest-api-specs-scripts": { - "version": "0.8.0", - "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.8.0.tgz", - "integrity": "sha512-vJxboVIH6D9Z6oFHNvMthkPtCGz3wMsxSgnkkZtS8fEvXHP3r8uNQgDbTdejp0zuH0XnRG3OrO504CwBkoM1Rw==", + "version": "0.10.2", + "resolved": "https://registry.npmjs.org/@azure/rest-api-specs-scripts/-/rest-api-specs-scripts-0.10.2.tgz", + "integrity": "sha512-g7W4eSvbn2q5wOF0FCj2lZ2yXuASfmIsZoib8ms4LXfixnA8CL2uW4XiVUvx2KzdW1RCCdjgh5n+LfCywLe4jw==", "dev": true, "requires": { "@azure/avocado": "^0.4.1", - "@azure/oad": "^0.7.0", + "@azure/oad": "^0.8.1", + "@azure/swagger-validation-common": "^0.0.2", "@octokit/rest": "^16.42.0", "@ts-common/string-map": "^0.3.0", "commonmark": "0.27.0", "fs-extra": "^7.0.1", "glob": "^7.1.3", "js-yaml": "^3.13.1", - "oav": "0.21.5", + "oav": "^0.21.6", "request": "^2.88.0" }, "dependencies": { @@ -152,6 +158,12 @@ } } }, + "@azure/swagger-validation-common": { + "version": "0.0.2", + "resolved": "https://registry.npmjs.org/@azure/swagger-validation-common/-/swagger-validation-common-0.0.2.tgz", + "integrity": "sha512-/OTgP3USqq2Cko6vzDgmODpqGjk9eTANYMBMXtgsTgh9RtR6b3HZdQTPe5dqkqes/YoIBW8IarJ0B0HucAv1+A==", + "dev": true + }, "@microsoft.azure/autorest-extension-base": { "version": "1.0.13", "resolved": "https://registry.npmjs.org/@microsoft.azure/autorest-extension-base/-/autorest-extension-base-1.0.13.tgz", @@ -178,21 +190,21 @@ "dev": true }, "@octokit/auth-token": { - "version": "2.4.0", - "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.0.tgz", - "integrity": "sha512-eoOVMjILna7FVQf96iWc3+ZtE/ZT6y8ob8ZzcqKY1ibSQCnu4O/B7pJvzMx5cyZ/RjAff6DAdEb0O0Cjcxidkg==", + "version": "2.4.1", + "resolved": "https://registry.npmjs.org/@octokit/auth-token/-/auth-token-2.4.1.tgz", + "integrity": "sha512-NB81O5h39KfHYGtgfWr2booRxp2bWOJoqbWwbyUg2hw6h35ArWYlAST5B3XwAkbdcx13yt84hFXyFP5X0QToWA==", "dev": true, "requires": { - "@octokit/types": "^2.0.0" + "@octokit/types": "^4.0.1" } }, "@octokit/endpoint": { - "version": "6.0.1", - "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.1.tgz", - "integrity": "sha512-pOPHaSz57SFT/m3R5P8MUu4wLPszokn5pXcB/pzavLTQf2jbU+6iayTvzaY6/BiotuRS0qyEUkx3QglT4U958A==", + "version": "6.0.2", + "resolved": "https://registry.npmjs.org/@octokit/endpoint/-/endpoint-6.0.2.tgz", + "integrity": "sha512-xs1mmCEZ2y4shXCpFjNq3UbmNR+bLzxtZim2L0zfEtj9R6O6kc4qLDvYw66hvO6lUsYzPTM5hMkltbuNAbRAcQ==", "dev": true, "requires": { - "@octokit/types": "^2.11.1", + "@octokit/types": "^4.0.1", "is-plain-object": "^3.0.0", "universal-user-agent": "^5.0.0" }, @@ -215,6 +227,17 @@ "dev": true, "requires": { "@octokit/types": "^2.0.1" + }, + "dependencies": { + "@octokit/types": { + "version": "2.16.2", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", + "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", + "dev": true, + "requires": { + "@types/node": ">= 8" + } + } } }, "@octokit/plugin-request-log": { @@ -231,17 +254,28 @@ "requires": { "@octokit/types": "^2.0.1", "deprecation": "^2.3.1" + }, + "dependencies": { + "@octokit/types": { + "version": "2.16.2", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", + "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", + "dev": true, + "requires": { + "@types/node": ">= 8" + } + } } }, "@octokit/request": { - "version": "5.4.2", - "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.2.tgz", - "integrity": "sha512-zKdnGuQ2TQ2vFk9VU8awFT4+EYf92Z/v3OlzRaSh4RIP0H6cvW1BFPXq4XYvNez+TPQjqN+0uSkCYnMFFhcFrw==", + "version": "5.4.4", + "resolved": "https://registry.npmjs.org/@octokit/request/-/request-5.4.4.tgz", + "integrity": "sha512-vqv1lz41c6VTxUvF9nM+a6U+vvP3vGk7drDpr0DVQg4zyqlOiKVrY17DLD6de5okj+YLHKcoqaUZTBtlNZ1BtQ==", "dev": true, "requires": { "@octokit/endpoint": "^6.0.1", "@octokit/request-error": "^2.0.0", - "@octokit/types": "^2.11.1", + "@octokit/types": "^4.0.1", "deprecation": "^2.0.0", "is-plain-object": "^3.0.0", "node-fetch": "^2.3.0", @@ -250,12 +284,12 @@ }, "dependencies": { "@octokit/request-error": { - "version": "2.0.0", - "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.0.tgz", - "integrity": "sha512-rtYicB4Absc60rUv74Rjpzek84UbVHGHJRu4fNVlZ1mCcyUPPuzFfG9Rn6sjHrd95DEsmjSt1Axlc699ZlbDkw==", + "version": "2.0.1", + "resolved": "https://registry.npmjs.org/@octokit/request-error/-/request-error-2.0.1.tgz", + "integrity": "sha512-5lqBDJ9/TOehK82VvomQ6zFiZjPeSom8fLkFVLuYL3sKiIb5RB8iN/lenLkY7oBmyQcGP7FBMGiIZTO8jufaRQ==", "dev": true, "requires": { - "@octokit/types": "^2.0.0", + "@octokit/types": "^4.0.1", "deprecation": "^2.0.0", "once": "^1.4.0" } @@ -280,6 +314,17 @@ "@octokit/types": "^2.0.0", "deprecation": "^2.0.0", "once": "^1.4.0" + }, + "dependencies": { + "@octokit/types": { + "version": "2.16.2", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", + "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", + "dev": true, + "requires": { + "@types/node": ">= 8" + } + } } }, "@octokit/rest": { @@ -307,9 +352,9 @@ } }, "@octokit/types": { - "version": "2.16.2", - "resolved": "https://registry.npmjs.org/@octokit/types/-/types-2.16.2.tgz", - "integrity": "sha512-O75k56TYvJ8WpAakWwYRN8Bgu60KrmX0z1KqFp1kNiFNkgW+JW+9EBKZ+S33PU6SLvbihqd+3drvPxKK68Ee8Q==", + "version": "4.1.4", + "resolved": "https://registry.npmjs.org/@octokit/types/-/types-4.1.4.tgz", + "integrity": "sha512-W+aHUBA6pEZ8OC1fgfFW1/jrgtkaMVBhNr7jhhBErvbWQY4Ii9Hlf3LAurwcy5XXjz8EYluiCZjHhnQO4GSfNg==", "dev": true, "requires": { "@types/node": ">= 8" @@ -740,9 +785,9 @@ "dev": true }, "aws4": { - "version": "1.9.1", - "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.9.1.tgz", - "integrity": "sha512-wMHVg2EOHaMRxbzgFJ9gtjOOCrI80OHLG14rxi28XwOW8ux6IiEbRCGGGqCtdAIg4FQCbW20k9RsT4y3gJlFug==", + "version": "1.10.0", + "resolved": "https://registry.npmjs.org/aws4/-/aws4-1.10.0.tgz", + "integrity": "sha512-3YDiu347mtVtjpyV3u5kVqQLP242c06zwDOgpeRnybmXlYYsLbtTrUBUm8i8srONt+FWobl5aibnU1030PeeuA==", "dev": true }, "balanced-match": { @@ -3597,9 +3642,9 @@ } }, "moment": { - "version": "2.25.3", - "resolved": "https://registry.npmjs.org/moment/-/moment-2.25.3.tgz", - "integrity": "sha512-PuYv0PHxZvzc15Sp8ybUCoQ+xpyPWvjOuK72a5ovzp2LI32rJXOiIfyoFoYvG3s6EwwrdkMyWuRiEHSZRLJNdg==", + "version": "2.26.0", + "resolved": "https://registry.npmjs.org/moment/-/moment-2.26.0.tgz", + "integrity": "sha512-oIixUO+OamkUkwjhAVE18rAMfRJNsNe/Stid/gwHSOfHrOtw9EhAY2AHvdKZ/k/MggcYELFCJz/Sn2pL8b8JMw==", "dev": true }, "ms": { @@ -3732,9 +3777,9 @@ "dev": true }, "oav": { - "version": "0.21.5", - "resolved": "https://registry.npmjs.org/oav/-/oav-0.21.5.tgz", - "integrity": "sha512-UgF51hAZArAI9r4tSUCgJE8IYeh5Q3SLcCukwZ6jrWyG3Y8vXKl12Cs2ycGrbQg16Ygf2v2+Dkhx4RHh7uOyfw==", + "version": "0.21.6", + "resolved": "https://registry.npmjs.org/oav/-/oav-0.21.6.tgz", + "integrity": "sha512-zPLaeYuQh1aJND/e2BBLMXAy1qKvHVPido6byoC4K2wsM3MdIFrK0QePBMUXA9gZjNb6HO5oaRuM5uCEeFaxjg==", "dev": true, "requires": { "@azure/openapi-markdown": "^0.9.2", @@ -4944,9 +4989,9 @@ "dev": true }, "spdx-correct": { - "version": "3.1.0", - "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.0.tgz", - "integrity": "sha512-lr2EZCctC2BNR7j7WzJ2FpDznxky1sjfxvvYEyzxNyb6lZXHODmEoJeFu4JupYlkfha1KZpJyoqiJ7pgA1qq8Q==", + "version": "3.1.1", + "resolved": "https://registry.npmjs.org/spdx-correct/-/spdx-correct-3.1.1.tgz", + "integrity": "sha512-cOYcUWwhCuHCXi49RhFRCyJEK3iPj1Ziz9DpViV3tbZOwXD49QzIN3MpOLJNxh2qwq2lJJZaKMVw9qNi4jTC0w==", "dev": true, "requires": { "spdx-expression-parse": "^3.0.0", @@ -5339,9 +5384,9 @@ "dev": true }, "uglify-js": { - "version": "3.9.3", - "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.9.3.tgz", - "integrity": "sha512-r5ImcL6QyzQGVimQoov3aL2ZScywrOgBXGndbWrdehKoSvGe/RmiE5Jpw/v+GvxODt6l2tpBXwA7n+qZVlHBMA==", + "version": "3.9.4", + "resolved": "https://registry.npmjs.org/uglify-js/-/uglify-js-3.9.4.tgz", + "integrity": "sha512-8RZBJq5smLOa7KslsNsVcSH+KOXf1uDU8yqLeNuVKwmT0T3FA0ZoXlinQfRad7SDcbZZRZE4ov+2v71EnxNyCA==", "dev": true, "optional": true, "requires": { diff --git a/package.json b/package.json index 1089ced9b10a..1a58a6b4c14d 100644 --- a/package.json +++ b/package.json @@ -11,7 +11,7 @@ "license": "MIT", "devDependencies": { "@azure/avocado": "^0.6.3", - "@azure/rest-api-specs-scripts": "^0.8.0", + "@azure/rest-api-specs-scripts": "^0.10.2", "@ts-common/commonmark-to-markdown": "^1.2.0", "@ts-common/fs": "0.2.0", "@ts-common/iterator": "^0.3.6", From 9f0049e83efbc2c120d120a68b0b99d93ee4a441 Mon Sep 17 00:00:00 2001 From: digavino <48699384+digavino@users.noreply.github.com> Date: Tue, 2 Jun 2020 06:37:21 -0700 Subject: [PATCH 061/318] Update API specs 2020-05-01 (#9542) * update 2020-05-01 version * Add samples * Update version * Update example * Fix case --- .../2020-05-01/examples/FrontdoorCreate.json | 20 +- .../2020-05-01/examples/FrontdoorGet.json | 5 +- .../2020-05-01/examples/FrontdoorList.json | 5 +- .../2020-05-01/examples/FrontdoorListAll.json | 5 +- .../examples/WafListManagedRuleSets.json | 69 ++ .../2020-05-01/examples/WafListPolicies.json | 130 +++ .../examples/WafPolicyCreateOrUpdate.json | 492 ++++++++++ .../2020-05-01/examples/WafPolicyDelete.json | 13 + .../2020-05-01/examples/WafPolicyGet.json | 127 +++ .../stable/2020-05-01/frontdoor.json | 10 + .../2020-05-01/webapplicationfirewall.json | 902 ++++++++++++++++++ .../frontdoor/resource-manager/readme.md | 2 +- 12 files changed, 1772 insertions(+), 8 deletions(-) create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListManagedRuleSets.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json create mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorCreate.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorCreate.json index 5957738fe115..1138b58eb7f9 100644 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorCreate.json +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorCreate.json @@ -38,7 +38,10 @@ "rulesEngine": { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" }, - "enabledState": "Enabled" + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } } } ], @@ -173,7 +176,10 @@ "rulesEngine": { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" }, - "enabledState": "Enabled" + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } } } ], @@ -318,7 +324,10 @@ "rulesEngine": { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" }, - "enabledState": "Enabled" + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } } } ], @@ -463,7 +472,10 @@ "rulesEngine": { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" }, - "enabledState": "Enabled" + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } } } ], diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorGet.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorGet.json index 64b071212fd3..36c43313a8d6 100644 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorGet.json +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorGet.json @@ -47,7 +47,10 @@ "rulesEngine": { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" }, - "enabledState": "Enabled" + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } } } ], diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorList.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorList.json index f52102336d9c..d57b7873351e 100644 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorList.json +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorList.json @@ -48,7 +48,10 @@ "rulesEngine": { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" }, - "enabledState": "Enabled" + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } } } ], diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorListAll.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorListAll.json index 418a3edbe906..2f72bfadff7d 100644 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorListAll.json +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FrontdoorListAll.json @@ -47,7 +47,10 @@ "rulesEngine": { "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoors/frontDoor1/rulesEngines/rulesEngine1" }, - "enabledState": "Enabled" + "enabledState": "Enabled", + "webApplicationFirewallPolicyLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies/policy1" + } } } ], diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListManagedRuleSets.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListManagedRuleSets.json new file mode 100644 index 000000000000..b6ee1c3ee4db --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListManagedRuleSets.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "DefaultRuleSet_1.0", + "id": "/subscriptions/subid/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallmanagedrulesets", + "properties": { + "provisioningState": "Succeeded", + "ruleSetId": "8125d145-ddc5-4d90-9bc3-24c5f2de69a2", + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "ruleGroups": [ + { + "ruleGroupName": "SQLI", + "description": "SQL injection", + "rules": [ + { + "ruleId": "942100", + "description": "SQL Injection Attack Detected via libinjection", + "defaultState": "Enabled", + "defaultAction": "Block" + }, + { + "ruleId": "942110", + "description": "SQL Injection Attack: Common Injection Testing Detected", + "defaultState": "Enabled", + "defaultAction": "Block" + } + ] + }, + { + "ruleGroupName": "XSS", + "description": "Cross-site scripting", + "rules": [ + { + "ruleId": "941100", + "description": "XSS Attack Detected via libinjection", + "defaultState": "Enabled", + "defaultAction": "Block" + }, + { + "ruleId": "941101", + "description": "XSS Attack Detected via libinjection", + "defaultState": "Enabled", + "defaultAction": "Block" + }, + { + "ruleId": "941110", + "description": "XSS Filter - Category 1: Script Tag Vector", + "defaultState": "Enabled", + "defaultAction": "Block" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json new file mode 100644 index 000000000000..8617a12656df --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "enabledState": "Enabled", + "ruleType": "RateLimitRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "enabledState": "Enabled", + "ruleType": "MatchRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 0, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "frontendEndpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontdoors/fd1/frontendendpoints/fd1-azurefd-net" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json new file mode 100644 index 000000000000..f4c1a6c18373 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json @@ -0,0 +1,492 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1", + "parameters": { + "properties": { + "policySettings": { + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "RateLimitRule", + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "operator": "IPMatch", + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "operator": "GeoMatch", + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "operator": "Contains", + "selector": "UserAgent", + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "exclusions": [ + { + "matchVariable": "RequestCookieNames", + "selectorMatchOperator": "StartsWith", + "selector": "token" + } + ], + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect", + "exclusions": [ + { + "matchVariable": "QueryStringArgNames", + "selectorMatchOperator": "Equals", + "selector": "query" + } + ] + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "enabledState": "Enabled", + "ruleType": "RateLimitRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "enabledState": "Enabled", + "ruleType": "MatchRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 0, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "exclusions": [ + { + "matchVariable": "RequestCookieNames", + "selectorMatchOperator": "StartsWith", + "selector": "token" + } + ], + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect", + "exclusions": [ + { + "matchVariable": "QueryStringArgNames", + "selectorMatchOperator": "Equals", + "selector": "query" + } + ] + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "frontendEndpointLinks": [] + } + } + }, + "201": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "enabledState": "Enabled", + "ruleType": "RateLimitRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "enabledState": "Enabled", + "ruleType": "MatchRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 0, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "exclusions": [ + { + "matchVariable": "RequestCookieNames", + "selectorMatchOperator": "StartsWith", + "selector": "token" + } + ], + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect", + "exclusions": [ + { + "matchVariable": "QueryStringArgNames", + "selectorMatchOperator": "Equals", + "selector": "query" + } + ] + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "frontendEndpointLinks": [] + } + } + }, + "202": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "enabledState": "Enabled", + "ruleType": "RateLimitRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "enabledState": "Enabled", + "ruleType": "MatchRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 0, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "exclusions": [ + { + "matchVariable": "RequestCookieNames", + "selectorMatchOperator": "StartsWith", + "selector": "token" + } + ], + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect", + "exclusions": [ + { + "matchVariable": "QueryStringArgNames", + "selectorMatchOperator": "Equals", + "selector": "query" + } + ] + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "frontendEndpointLinks": [] + } + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json new file mode 100644 index 000000000000..c887714443bf --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json new file mode 100644 index 000000000000..aef1b725a529 --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "enabledState": "Enabled", + "mode": "Prevention", + "redirectUrl": "http://www.bing.com", + "customBlockResponseStatusCode": 499, + "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" + }, + "customRules": { + "rules": [ + { + "name": "Rule1", + "priority": 1, + "enabledState": "Enabled", + "ruleType": "RateLimitRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 1000, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "IPMatch", + "negateCondition": false, + "matchValue": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "enabledState": "Enabled", + "ruleType": "MatchRule", + "rateLimitDurationInMinutes": 0, + "rateLimitThreshold": 0, + "matchConditions": [ + { + "matchVariable": "RemoteAddr", + "selector": null, + "operator": "GeoMatch", + "negateCondition": false, + "matchValue": [ + "CH" + ] + }, + { + "matchVariable": "RequestHeader", + "selector": "UserAgent", + "operator": "Contains", + "negateCondition": false, + "matchValue": [ + "windows" + ], + "transforms": [ + "Lowercase" + ] + } + ], + "action": "Block" + } + ] + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "DefaultRuleSet", + "ruleSetVersion": "1.0", + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "User-Agent" + } + ], + "ruleGroupOverrides": [ + { + "ruleGroupName": "SQLI", + "rules": [ + { + "ruleId": "942100", + "enabledState": "Enabled", + "action": "Redirect" + }, + { + "ruleId": "942110", + "enabledState": "Disabled" + } + ] + } + ] + } + ] + }, + "frontendEndpointLinks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontdoors/fd1/frontendendpoints/fd1-azurefd-net" + } + ] + } + } + } + } +} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/frontdoor.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/frontdoor.json index 433fd6e7fc6c..1aa59b036ba2 100644 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/frontdoor.json +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/frontdoor.json @@ -1124,6 +1124,16 @@ "rulesEngine": { "description": "A reference to a specific Rules Engine Configuration to apply to this route.", "$ref": "./network.json#/definitions/SubResource" + }, + "webApplicationFirewallPolicyLink": { + "description": "Defines the Web Application Firewall policy for each routing rule (if applicable)", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } } } }, diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json new file mode 100644 index 000000000000..e1deda8ac3cd --- /dev/null +++ b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json @@ -0,0 +1,902 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-05-01", + "title": "WebApplicationFirewallManagement", + "description": "APIs to manage web application firewall rules." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Lists all of the protection policies within a resource group.", + "operationId": "Policies_List", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicyList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Retrieve protection policy with specified name within a resource group.", + "operationId": "Policies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Policy": { + "$ref": "./examples/WafPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Create or update policy with specified rule set name within a resource group.", + "operationId": "Policies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "description": "Policy to be created.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new protection policy has been created.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Creates specific policy": { + "$ref": "./examples/WafPolicyCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Deletes Policy", + "operationId": "Policies_Delete", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PolicyNameParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the policy was not found." + } + }, + "x-ms-examples": { + "Delete protection policy": { + "$ref": "./examples/WafPolicyDelete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets": { + "get": { + "tags": [ + "WebApplicationFirewallManagedRuleSets" + ], + "description": "Lists all available managed rule sets.", + "operationId": "ManagedRuleSets_List", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall managed rule sets.", + "schema": { + "$ref": "#/definitions/ManagedRuleSetDefinitionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Policies in a Resource Group": { + "$ref": "./examples/WafListManagedRuleSets.json" + } + } + } + } + }, + "definitions": { + "WebApplicationFirewallPolicy": { + "description": "Defines web application firewall policy.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties of the web application firewall policy.", + "$ref": "#/definitions/WebApplicationFirewallPolicyProperties" + }, + "etag": { + "type": "string", + "description": "Gets a unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "WebApplicationFirewallPolicyProperties": { + "description": "Defines web application firewall policy properties.", + "properties": { + "policySettings": { + "description": "Describes settings for the policy.", + "$ref": "#/definitions/PolicySettings" + }, + "customRules": { + "description": "Describes custom rules inside the policy.", + "$ref": "#/definitions/CustomRuleList" + }, + "managedRules": { + "description": "Describes managed rules inside the policy.", + "$ref": "#/definitions/ManagedRuleSetList" + }, + "frontendEndpointLinks": { + "description": "Describes Frontend Endpoints associated with this Web Application Firewall policy.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/FrontendEndpointLink" + } + }, + "routingRuleLinks": { + "description": "Describes Routing Rules associated with this Web Application Firewall policy.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RoutingRuleLink" + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the policy." + }, + "resourceState": { + "title": "Resource status of the policy.", + "readOnly": true, + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "type": "string", + "x-ms-enum": { + "name": "PolicyResourceState", + "modelAsString": true + } + } + } + }, + "WebApplicationFirewallPolicyList": { + "description": "Defines a list of WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + }, + "description": "List of WebApplicationFirewallPolicies within a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." + } + } + }, + "PolicySettings": { + "description": "Defines top-level WebApplicationFirewallPolicy configuration settings.", + "properties": { + "enabledState": { + "description": "Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "PolicyEnabledState", + "modelAsString": true + } + }, + "mode": { + "description": "Describes if it is in detection mode or prevention mode at policy level.", + "type": "string", + "enum": [ + "Prevention", + "Detection" + ], + "x-ms-enum": { + "name": "PolicyMode", + "modelAsString": true + } + }, + "redirectUrl": { + "description": "If action type is redirect, this field represents redirect URL for the client.", + "type": "string" + }, + "customBlockResponseStatusCode": { + "description": "If the action type is block, customer can override the response status code.", + "type": "integer" + }, + "customBlockResponseBody": { + "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.", + "type": "string", + "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" + } + } + }, + "CustomRuleList": { + "description": "Defines contents of custom rules", + "properties": { + "rules": { + "description": "List of rules", + "type": "array", + "items": { + "$ref": "#/definitions/CustomRule" + } + } + } + }, + "CustomRule": { + "description": "Defines contents of a web application rule", + "required": [ + "priority", + "ruleType", + "matchConditions", + "action" + ], + "properties": { + "name": { + "type": "string", + "description": "Describes the name of the rule.", + "maxLength": 128 + }, + "priority": { + "description": "Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.", + "type": "integer" + }, + "enabledState": { + "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "CustomRuleEnabledState", + "modelAsString": true + } + }, + "ruleType": { + "description": "Describes type of rule.", + "type": "string", + "enum": [ + "MatchRule", + "RateLimitRule" + ], + "x-ms-enum": { + "name": "RuleType", + "modelAsString": true + } + }, + "rateLimitDurationInMinutes": { + "description": "Time window for resetting the rate limit count. Default is 1 minute.", + "type": "integer", + "minimum": 0, + "maximum": 5 + }, + "rateLimitThreshold": { + "description": "Number of allowed requests per client within the time window.", + "type": "integer", + "minimum": 0 + }, + "matchConditions": { + "description": "List of match conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchCondition" + } + }, + "action": { + "description": "Describes what action to be applied when rule matches.", + "$ref": "#/definitions/ActionType" + } + } + }, + "TransformType": { + "description": "Describes what transforms applied before matching.", + "type": "string", + "enum": [ + "Lowercase", + "Uppercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls" + ], + "x-ms-enum": { + "name": "TransformType", + "modelAsString": true + } + }, + "MatchCondition": { + "description": "Define a match condition.", + "required": [ + "matchVariable", + "operator", + "matchValue" + ], + "properties": { + "matchVariable": { + "description": "Request variable to compare with.", + "type": "string", + "enum": [ + "RemoteAddr", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeader", + "RequestBody", + "Cookies", + "SocketAddr" + ], + "x-ms-enum": { + "name": "MatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null.", + "type": "string" + }, + "operator": { + "description": "Comparison type to use for matching with the variable value.", + "type": "string", + "enum": [ + "Any", + "IPMatch", + "GeoMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith", + "RegEx" + ], + "x-ms-enum": { + "name": "Operator", + "modelAsString": true + } + }, + "negateCondition": { + "description": "Describes if the result of this condition should be negated.", + "type": "boolean" + }, + "matchValue": { + "description": "List of possible match values.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms.", + "type": "array", + "items": { + "$ref": "#/definitions/TransformType" + } + } + } + }, + "ManagedRuleSetList": { + "description": "Defines the list of managed rule sets for the policy.", + "properties": { + "managedRuleSets": { + "description": "List of rule sets.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSet" + } + } + } + }, + "ManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleExclusion" + }, + "description": "Describes the exclusions that are applied to all rules in the set." + }, + "ruleGroupOverrides": { + "description": "Defines the rule group overrides to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleGroupOverride" + } + } + } + }, + "ManagedRuleGroupOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "Describes the managed rule group to override.", + "type": "string" + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleExclusion" + }, + "description": "Describes the exclusions that are applied to all rules in the group." + }, + "rules": { + "description": "List of rules that will be disabled. If none specified, all rules in the group will be disabled.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleOverride" + } + } + } + }, + "ManagedRuleOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + }, + "enabledState": { + "description": "Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.", + "$ref": "#/definitions/ManagedRuleEnabledState" + }, + "action": { + "description": "Describes the override action to be applied when rule matches.", + "$ref": "#/definitions/ActionType" + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleExclusion" + }, + "description": "Describes the exclusions that are applied to this specific rule." + } + } + }, + "ManagedRuleSetDefinitionList": { + "description": "List of managed rule set definitions available for use in a policy.", + "properties": { + "value": { + "description": "List of managed rule set definitions.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSetDefinition" + } + }, + "nextLink": { + "type": "string", + "description": "URL to retrieve next set of managed rule set definitions." + } + } + }, + "ManagedRuleSetDefinition": { + "description": "Describes the a managed rule set definition.", + "properties": { + "properties": { + "description": "Properties for a managed rule set definition.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagedRuleSetDefinitionProperties" + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ManagedRuleSetDefinitionProperties": { + "description": "Properties for a managed rule set definition.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Provisioning state of the managed rule set." + }, + "ruleSetId": { + "type": "string", + "readOnly": true, + "description": "Id of the managed rule set." + }, + "ruleSetType": { + "type": "string", + "readOnly": true, + "description": "Type of the managed rule set." + }, + "ruleSetVersion": { + "type": "string", + "readOnly": true, + "description": "Version of the managed rule set type." + }, + "ruleGroups": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleGroupDefinition" + }, + "description": "Rule groups of the managed rule set." + } + } + }, + "ManagedRuleGroupDefinition": { + "description": "Describes a managed rule group.", + "properties": { + "ruleGroupName": { + "type": "string", + "readOnly": true, + "description": "Name of the managed rule group." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "Description of the managed rule group." + }, + "rules": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ManagedRuleDefinition" + }, + "description": "List of rules within the managed rule group." + } + } + }, + "ManagedRuleDefinition": { + "description": "Describes a managed rule definition.", + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "readOnly": true, + "type": "string" + }, + "defaultState": { + "description": "Describes the default state for the managed rule.", + "readOnly": true, + "$ref": "#/definitions/ManagedRuleEnabledState" + }, + "defaultAction": { + "description": "Describes the default action to be applied when the managed rule matches.", + "readOnly": true, + "$ref": "#/definitions/ActionType" + }, + "description": { + "description": "Describes the functionality of the managed rule.", + "readOnly": true, + "type": "string" + } + } + }, + "ManagedRuleExclusion": { + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Exclude variables from managed rule evaluation.", + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestHeaderNames", + "RequestCookieNames", + "QueryStringArgNames", + "RequestBodyPostArgNames" + ], + "description": "The variable type to be excluded.", + "x-ms-enum": { + "name": "ManagedRuleExclusionMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "Equals", + "Contains", + "StartsWith", + "EndsWith", + "EqualsAny" + ], + "description": "Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to.", + "x-ms-enum": { + "name": "ManagedRuleExclusionSelectorMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "Selector value for which elements in the collection this exclusion applies to." + } + } + }, + "ActionType": { + "description": "Defines the action to take on rule match.", + "type": "string", + "enum": [ + "Allow", + "Block", + "Log", + "Redirect" + ], + "x-ms-enum": { + "name": "ActionType", + "modelAsString": true + } + }, + "ManagedRuleEnabledState": { + "description": "Describes if the managed rule is in enabled or disabled state.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ManagedRuleEnabledState", + "modelAsString": true + } + }, + "ErrorResponse": { + "description": "Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "code": { + "description": "Error code.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "readOnly": true, + "type": "string" + } + } + }, + "FrontendEndpointLink": { + "description": "Defines the Resource ID for a Frontend Endpoint.", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + }, + "RoutingRuleLink": { + "description": "Defines the Resource ID for a Routing Rule.", + "type": "object", + "readOnly": true, + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + } + } + }, + "parameters": { + "PolicyNameParameter": { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "x-ms-parameter-location": "method", + "description": "The name of the Web Application Firewall Policy." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$", + "minLength": 1, + "maxLength": 80, + "x-ms-parameter-location": "method", + "description": "Name of the Resource group within the Azure subscription." + } + } +} diff --git a/specification/frontdoor/resource-manager/readme.md b/specification/frontdoor/resource-manager/readme.md index 0268a71d2be0..ff930cde24fa 100644 --- a/specification/frontdoor/resource-manager/readme.md +++ b/specification/frontdoor/resource-manager/readme.md @@ -40,7 +40,7 @@ input-file: - Microsoft.Network/stable/2020-05-01/network.json - Microsoft.Network/stable/2019-11-01/networkexperiment.json - Microsoft.Network/stable/2020-05-01/frontdoor.json -- Microsoft.Network/stable/2019-10-01/webapplicationfirewall.json +- Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json directive: - where: - $.paths From 5433923878dbfe680e9d29e61c7147f82d171aa3 Mon Sep 17 00:00:00 2001 From: azuresdkci Date: Tue, 2 Jun 2020 13:39:00 +0000 Subject: [PATCH 062/318] regenerated all-api-versions --- specification/frontdoor/resource-manager/readme.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/specification/frontdoor/resource-manager/readme.md b/specification/frontdoor/resource-manager/readme.md index ff930cde24fa..4caa6148067b 100644 --- a/specification/frontdoor/resource-manager/readme.md +++ b/specification/frontdoor/resource-manager/readme.md @@ -272,12 +272,13 @@ input-file: - $(this-folder)/Microsoft.Network/stable/2020-05-01/network.json - $(this-folder)/Microsoft.Network/stable/2019-11-01/networkexperiment.json - $(this-folder)/Microsoft.Network/stable/2020-05-01/frontdoor.json - - $(this-folder)/Microsoft.Network/stable/2019-10-01/webapplicationfirewall.json + - $(this-folder)/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json - $(this-folder)/Microsoft.Network/stable/2020-04-01/network.json - $(this-folder)/Microsoft.Network/stable/2020-04-01/frontdoor.json - $(this-folder)/Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json - $(this-folder)/Microsoft.Network/stable/2020-01-01/network.json - $(this-folder)/Microsoft.Network/stable/2020-01-01/frontdoor.json + - $(this-folder)/Microsoft.Network/stable/2019-10-01/webapplicationfirewall.json - $(this-folder)/Microsoft.Network/stable/2019-11-01/network.json - $(this-folder)/Microsoft.Network/stable/2019-05-01/frontdoor.json - $(this-folder)/Microsoft.Network/stable/2019-05-01/network.json From c9084e3a184c938d4110345293b410b64fc4bd65 Mon Sep 17 00:00:00 2001 From: Ashraf Hamad Date: Tue, 2 Jun 2020 15:09:54 -0700 Subject: [PATCH 063/318] Event Grid: 2020-06-01 Swagger (#9629) --- .../stable/2020-06-01/EventGrid.json | 4496 +++++++++++++++++ .../examples/DomainTopics_CreateOrUpdate.json | 21 + .../examples/DomainTopics_Delete.json | 13 + .../2020-06-01/examples/DomainTopics_Get.json | 21 + .../examples/DomainTopics_ListByDomain.json | 32 + .../examples/Domains_CreateOrUpdate.json | 57 + .../2020-06-01/examples/Domains_Delete.json | 12 + .../2020-06-01/examples/Domains_Get.json | 26 + .../examples/Domains_ListByResourceGroup.json | 43 + .../examples/Domains_ListBySubscription.json | 42 + .../Domains_ListSharedAccessKeys.json | 16 + .../examples/Domains_RegenerateKey.json | 19 + .../2020-06-01/examples/Domains_Update.json | 57 + ...ateForCustomTopic_EventHubDestination.json | 61 + ...stomTopic_HybridConnectionDestination.json | 61 + ...orCustomTopic_StorageQueueDestination.json | 63 + ...dateForCustomTopic_WebhookDestination.json | 46 + ...bscriptions_CreateOrUpdateForResource.json | 46 + ...ptions_CreateOrUpdateForResourceGroup.json | 46 + ...iptions_CreateOrUpdateForSubscription.json | 44 + ...entSubscriptions_DeleteForCustomTopic.json | 12 + .../EventSubscriptions_DeleteForResource.json | 12 + ...tSubscriptions_DeleteForResourceGroup.json | 12 + ...ntSubscriptions_DeleteForSubscription.json | 12 + .../EventSubscriptions_GetForCustomTopic.json | 35 + .../EventSubscriptions_GetForResource.json | 35 + ...ventSubscriptions_GetForResourceGroup.json | 35 + ...EventSubscriptions_GetForSubscription.json | 35 + ...ubscriptions_GetFullUrlForCustomTopic.json | 14 + ...ntSubscriptions_GetFullUrlForResource.json | 14 + ...scriptions_GetFullUrlForResourceGroup.json | 14 + ...bscriptions_GetFullUrlForSubscription.json | 14 + .../EventSubscriptions_ListByDomainTopic.json | 78 + .../EventSubscriptions_ListByResource.json | 79 + ...bscriptions_ListGlobalByResourceGroup.json | 55 + ...ListGlobalByResourceGroupForTopicType.json | 40 + ...ubscriptions_ListGlobalBySubscription.json | 54 + ..._ListGlobalBySubscriptionForTopicType.json | 39 + ...criptions_ListRegionalByResourceGroup.json | 64 + ...stRegionalByResourceGroupForTopicType.json | 65 + ...scriptions_ListRegionalBySubscription.json | 63 + ...istRegionalBySubscriptionForTopicType.json | 64 + ...entSubscriptions_UpdateForCustomTopic.json | 52 + .../EventSubscriptions_UpdateForResource.json | 49 + ...tSubscriptions_UpdateForResourceGroup.json | 49 + ...ntSubscriptions_UpdateForSubscription.json | 49 + .../2020-06-01/examples/Operations_List.json | 83 + .../PrivateEndpointConnections_Delete.json | 14 + .../PrivateEndpointConnections_Get.json | 33 + ...ateEndpointConnections_ListByResource.json | 36 + .../PrivateEndpointConnections_Update.json | 63 + .../examples/PrivateLinkResources_Get.json | 29 + .../PrivateLinkResources_ListByResource.json | 32 + .../2020-06-01/examples/TopicTypes_Get.json | 22 + .../2020-06-01/examples/TopicTypes_List.json | 37 + .../examples/TopicTypes_ListEventTypes.json | 34 + .../examples/Topics_CreateOrUpdate.json | 57 + .../2020-06-01/examples/Topics_Delete.json | 12 + .../2020-06-01/examples/Topics_Get.json | 26 + .../examples/Topics_ListByResourceGroup.json | 43 + .../examples/Topics_ListBySubscription.json | 42 + .../examples/Topics_ListEventTypes.json | 38 + .../examples/Topics_ListSharedAccessKeys.json | 16 + .../examples/Topics_RegenerateKey.json | 19 + .../2020-06-01/examples/Topics_Update.json | 57 + .../eventgrid/resource-manager/readme.go.md | 11 +- .../eventgrid/resource-manager/readme.java.md | 15 + .../eventgrid/resource-manager/readme.md | 18 +- .../eventgrid/resource-manager/readme.ruby.md | 11 + 69 files changed, 7008 insertions(+), 6 deletions(-) create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_CreateOrUpdate.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_Delete.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_Get.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_ListByDomain.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_CreateOrUpdate.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Delete.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Get.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListByResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListBySubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListSharedAccessKeys.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_RegenerateKey.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Update.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForSubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForCustomTopic.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForSubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForCustomTopic.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForSubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForCustomTopic.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForSubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListByDomainTopic.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListByResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalByResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalBySubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalByResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalBySubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForCustomTopic.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForSubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Operations_List.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Delete.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Get.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_ListByResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Update.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateLinkResources_Get.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateLinkResources_ListByResource.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_Get.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_List.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_ListEventTypes.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_CreateOrUpdate.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Delete.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Get.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListByResourceGroup.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListBySubscription.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListEventTypes.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListSharedAccessKeys.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_RegenerateKey.json create mode 100644 specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Update.json diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json new file mode 100644 index 000000000000..7a2d45b3710e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json @@ -0,0 +1,4496 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-06-01", + "title": "EventGridManagementClient", + "description": "Azure EventGrid Management Client" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}": { + "get": { + "tags": [ + "Domains" + ], + "summary": "Get a domain.", + "description": "Get properties of a domain.", + "operationId": "Domains_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_Get": { + "$ref": "./examples/Domains_Get.json" + } + } + }, + "put": { + "tags": [ + "Domains" + ], + "summary": "Create or update a domain.", + "description": "Asynchronously creates or updates a new domain with the specified parameters.", + "operationId": "Domains_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "domainInfo", + "in": "body", + "description": "Domain information.", + "required": true, + "schema": { + "$ref": "#/definitions/Domain" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_CreateOrUpdate": { + "$ref": "./examples/Domains_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Domains" + ], + "summary": "Delete a domain.", + "description": "Delete existing domain.", + "operationId": "Domains_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_Delete": { + "$ref": "./examples/Domains_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Domains" + ], + "summary": "Update a domain.", + "description": "Asynchronously updates a domain with the specified parameters.", + "operationId": "Domains_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "domainUpdateParameters", + "in": "body", + "description": "Domain update information.", + "required": true, + "schema": { + "$ref": "#/definitions/DomainUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Domain update request accepted.", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_Update": { + "$ref": "./examples/Domains_Update.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/domains": { + "get": { + "tags": [ + "Domains" + ], + "summary": "List domains under an Azure subscription.", + "description": "List all the domains under an Azure subscription.", + "operationId": "Domains_ListBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_ListBySubscription": { + "$ref": "./examples/Domains_ListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains": { + "get": { + "tags": [ + "Domains" + ], + "summary": "List domains under a resource group.", + "description": "List all the domains under a resource group.", + "operationId": "Domains_ListByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_ListByResourceGroup": { + "$ref": "./examples/Domains_ListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/listKeys": { + "post": { + "tags": [ + "Domains" + ], + "summary": "List keys for a domain.", + "description": "List the two keys used to publish to a domain.", + "operationId": "Domains_ListSharedAccessKeys", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_ListSharedAccessKeys": { + "$ref": "./examples/Domains_ListSharedAccessKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/regenerateKey": { + "post": { + "tags": [ + "Domains" + ], + "summary": "Regenerate key for a domain.", + "description": "Regenerate a shared access key for a domain.", + "operationId": "Domains_RegenerateKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "regenerateKeyRequest", + "in": "body", + "description": "Request body to regenerate key.", + "required": true, + "schema": { + "$ref": "#/definitions/DomainRegenerateKeyRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Domains_RegenerateKey": { + "$ref": "./examples/Domains_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{domainTopicName}": { + "get": { + "tags": [ + "DomainTopics" + ], + "summary": "Get a domain topic.", + "description": "Get properties of a domain topic.", + "operationId": "DomainTopics_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "domainTopicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "DomainTopics_Get": { + "$ref": "./examples/DomainTopics_Get.json" + } + } + }, + "put": { + "tags": [ + "DomainTopics" + ], + "summary": "Create or update a domain topic.", + "description": "Asynchronously creates or updates a new domain topic with the specified parameters.", + "operationId": "DomainTopics_CreateOrUpdate", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "domainTopicName", + "in": "path", + "description": "Name of the domain topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DomainTopic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "DomainTopics_CreateOrUpdate": { + "$ref": "./examples/DomainTopics_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "DomainTopics" + ], + "summary": "Delete a domain topic.", + "description": "Delete existing domain topic.", + "operationId": "DomainTopics_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the domain.", + "required": true, + "type": "string" + }, + { + "name": "domainTopicName", + "in": "path", + "description": "Name of the domain topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "DomainTopics_Delete": { + "$ref": "./examples/DomainTopics_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics": { + "get": { + "tags": [ + "DomainTopics" + ], + "summary": "List domain topics.", + "description": "List all the topics in a domain.", + "operationId": "DomainTopics_ListByDomain", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Domain name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DomainTopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "DomainTopics_ListByDomain": { + "$ref": "./examples/DomainTopics_ListByDomain.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get an event subscription.", + "description": "Get properties of an event subscription.", + "operationId": "EventSubscriptions_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_GetForSubscription": { + "$ref": "./examples/EventSubscriptions_GetForSubscription.json" + }, + "EventSubscriptions_GetForResourceGroup": { + "$ref": "./examples/EventSubscriptions_GetForResourceGroup.json" + }, + "EventSubscriptions_GetForResource": { + "$ref": "./examples/EventSubscriptions_GetForResource.json" + }, + "EventSubscriptions_GetForCustomTopic": { + "$ref": "./examples/EventSubscriptions_GetForCustomTopic.json" + } + } + }, + "put": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Create or update an event subscription.", + "description": "Asynchronously creates a new event subscription or updates an existing event subscription based on the specified scope.", + "operationId": "EventSubscriptions_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The identifier of the resource to which the event subscription needs to be created or updated. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription. Event subscription names must be between 3 and 64 characters in length and should use alphanumeric letters only.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionInfo", + "in": "body", + "description": "Event subscription properties containing the destination and filter information.", + "required": true, + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "EventSubscription CreateOrUpdate request accepted.", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_CreateOrUpdateForSubscription": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForSubscription.json" + }, + "EventSubscriptions_CreateOrUpdateForResourceGroup": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json" + }, + "EventSubscriptions_CreateOrUpdateForResource": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForResource.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json" + }, + "EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination": { + "$ref": "./examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Delete an event subscription.", + "description": "Delete an existing event subscription.", + "operationId": "EventSubscriptions_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_DeleteForSubscription": { + "$ref": "./examples/EventSubscriptions_DeleteForSubscription.json" + }, + "EventSubscriptions_DeleteForResourceGroup": { + "$ref": "./examples/EventSubscriptions_DeleteForResourceGroup.json" + }, + "EventSubscriptions_DeleteForResource": { + "$ref": "./examples/EventSubscriptions_DeleteForResource.json" + }, + "EventSubscriptions_DeleteForCustomTopic": { + "$ref": "./examples/EventSubscriptions_DeleteForCustomTopic.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Update an event subscription.", + "description": "Asynchronously updates an existing event subscription.", + "operationId": "EventSubscriptions_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of existing event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription to be updated.", + "required": true, + "type": "string" + }, + { + "name": "eventSubscriptionUpdateParameters", + "in": "body", + "description": "Updated event subscription information.", + "required": true, + "schema": { + "$ref": "#/definitions/EventSubscriptionUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "EventSubscription update request accepted.", + "schema": { + "$ref": "#/definitions/EventSubscription" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_UpdateForSubscription": { + "$ref": "./examples/EventSubscriptions_UpdateForSubscription.json" + }, + "EventSubscriptions_UpdateForResourceGroup": { + "$ref": "./examples/EventSubscriptions_UpdateForResourceGroup.json" + }, + "EventSubscriptions_UpdateForResource": { + "$ref": "./examples/EventSubscriptions_UpdateForResource.json" + }, + "EventSubscriptions_UpdateForCustomTopic": { + "$ref": "./examples/EventSubscriptions_UpdateForCustomTopic.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/{scope}/providers/Microsoft.EventGrid/eventSubscriptions/{eventSubscriptionName}/getFullUrl": { + "post": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get full URL of an event subscription.", + "description": "Get the full endpoint URL for an event subscription.", + "operationId": "EventSubscriptions_GetFullUrl", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "scope", + "in": "path", + "description": "The scope of the event subscription. The scope can be a subscription, or a resource group, or a top level resource belonging to a resource provider namespace, or an EventGrid topic. For example, use '/subscriptions/{subscriptionId}/' for a subscription, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for a resource group, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{resourceType}/{resourceName}' for a resource, and '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}' for an EventGrid topic.", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true + }, + { + "name": "eventSubscriptionName", + "in": "path", + "description": "Name of the event subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionFullUrl" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_GetFullUrlForSubscription": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForSubscription.json" + }, + "EventSubscriptions_GetFullUrlForResourceGroup": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForResourceGroup.json" + }, + "EventSubscriptions_GetFullUrlForResource": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForResource.json" + }, + "EventSubscriptions_GetFullUrlForCustomTopic": { + "$ref": "./examples/EventSubscriptions_GetFullUrlForCustomTopic.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "Get an aggregated list of all global event subscriptions under an Azure subscription.", + "description": "List all aggregated global event subscriptions under a specific Azure subscription.", + "operationId": "EventSubscriptions_ListGlobalBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalBySubscription": { + "$ref": "./examples/EventSubscriptions_ListGlobalBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all global event subscriptions for a topic type.", + "description": "List all global event subscriptions under an Azure subscription for a topic type.", + "operationId": "EventSubscriptions_ListGlobalBySubscriptionForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalBySubscriptionForTopicType": { + "$ref": "./examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all global event subscriptions under an Azure subscription and resource group.", + "description": "List all global event subscriptions under a specific Azure subscription and resource group.", + "operationId": "EventSubscriptions_ListGlobalByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalByResourceGroup": { + "$ref": "./examples/EventSubscriptions_ListGlobalByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all global event subscriptions under a resource group for a topic type.", + "description": "List all global event subscriptions under a resource group for a specific topic type.", + "operationId": "EventSubscriptions_ListGlobalByResourceGroupForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EventSubscriptions_ListGlobalByResourceGroupForTopicType": { + "$ref": "./examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription.", + "description": "List all event subscriptions from the given location under a specific Azure subscription.", + "operationId": "EventSubscriptions_ListRegionalBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalBySubscription": { + "$ref": "./examples/EventSubscriptions_ListRegionalBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription and resource group.", + "description": "List all event subscriptions from the given location under a specific Azure subscription and resource group.", + "operationId": "EventSubscriptions_ListRegionalByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalByResourceGroup": { + "$ref": "./examples/EventSubscriptions_ListRegionalByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription for a topic type.", + "description": "List all event subscriptions from the given location under a specific Azure subscription and topic type.", + "operationId": "EventSubscriptions_ListRegionalBySubscriptionForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location.", + "required": true, + "type": "string" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalBySubscriptionForTopicType": { + "$ref": "./examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/locations/{location}/topicTypes/{topicTypeName}/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all regional event subscriptions under an Azure subscription and resource group for a topic type.", + "description": "List all event subscriptions from the given location under a specific Azure subscription and resource group and topic type.", + "operationId": "EventSubscriptions_ListRegionalByResourceGroupForTopicType", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "location", + "in": "path", + "description": "Name of the location.", + "required": true, + "type": "string" + }, + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EventSubscriptions_ListRegionalByResourceGroupForTopicType": { + "$ref": "./examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all event subscriptions for a specific topic.", + "description": "List all event subscriptions that have been created for a specific topic.", + "operationId": "EventSubscriptions_ListByResource", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "providerNamespace", + "in": "path", + "description": "Namespace of the provider of the topic.", + "required": true, + "type": "string" + }, + { + "name": "resourceTypeName", + "in": "path", + "description": "Name of the resource type.", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListByResource": { + "$ref": "./examples/EventSubscriptions_ListByResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/domains/{domainName}/topics/{topicName}/providers/Microsoft.EventGrid/eventSubscriptions": { + "get": { + "tags": [ + "EventSubscriptions" + ], + "summary": "List all event subscriptions for a specific domain topic.", + "description": "List all event subscriptions that have been created for a specific domain topic.", + "operationId": "EventSubscriptions_ListByDomainTopic", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "domainName", + "in": "path", + "description": "Name of the top level domain.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the domain topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventSubscriptionsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "EventSubscriptions_ListByDomainTopic": { + "$ref": "./examples/EventSubscriptions_ListByDomainTopic.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.EventGrid/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "List available operations.", + "description": "List the available operations supported by the Microsoft.EventGrid resource provider.", + "operationId": "Operations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}": { + "get": { + "tags": [ + "Topics" + ], + "summary": "Get a topic.", + "description": "Get properties of a topic.", + "operationId": "Topics_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Topic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_Get": { + "$ref": "./examples/Topics_Get.json" + } + } + }, + "put": { + "tags": [ + "Topics" + ], + "summary": "Create a topic.", + "description": "Asynchronously creates a new topic with the specified parameters.", + "operationId": "Topics_CreateOrUpdate", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "name": "topicInfo", + "in": "body", + "description": "Topic information.", + "required": true, + "schema": { + "$ref": "#/definitions/Topic" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Topic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_CreateOrUpdate": { + "$ref": "./examples/Topics_CreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Topics" + ], + "summary": "Delete a topic.", + "description": "Delete existing topic.", + "operationId": "Topics_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_Delete": { + "$ref": "./examples/Topics_Delete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Topics" + ], + "summary": "Update a topic.", + "description": "Asynchronously updates a topic with the specified parameters.", + "operationId": "Topics_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "name": "topicUpdateParameters", + "in": "body", + "description": "Topic update information.", + "required": true, + "schema": { + "$ref": "#/definitions/TopicUpdateParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "201": { + "description": "Topic update request accepted.", + "schema": { + "$ref": "#/definitions/Topic" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_Update": { + "$ref": "./examples/Topics_Update.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.EventGrid/topics": { + "get": { + "tags": [ + "Topics" + ], + "summary": "List topics under an Azure subscription.", + "description": "List all the topics under an Azure subscription.", + "operationId": "Topics_ListBySubscription", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Topics_ListBySubscription": { + "$ref": "./examples/Topics_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics": { + "get": { + "tags": [ + "Topics" + ], + "summary": "List topics under a resource group.", + "description": "List all the topics under a resource group.", + "operationId": "Topics_ListByResourceGroup", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Topics_ListByResourceGroup": { + "$ref": "./examples/Topics_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/listKeys": { + "post": { + "tags": [ + "Topics" + ], + "summary": "List keys for a topic.", + "description": "List the two keys used to publish to a topic.", + "operationId": "Topics_ListSharedAccessKeys", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_ListSharedAccessKeys": { + "$ref": "./examples/Topics_ListSharedAccessKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/topics/{topicName}/regenerateKey": { + "post": { + "tags": [ + "Topics" + ], + "summary": "Regenerate key for a topic.", + "description": "Regenerate a shared access key for a topic.", + "operationId": "Topics_RegenerateKey", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "topicName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "name": "regenerateKeyRequest", + "in": "body", + "description": "Request body to regenerate key.", + "required": true, + "schema": { + "$ref": "#/definitions/TopicRegenerateKeyRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicSharedAccessKeys" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "Topics_RegenerateKey": { + "$ref": "./examples/Topics_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Get a specific private endpoint connection.", + "description": "Get a specific private endpoint connection under a topic or domain.", + "operationId": "PrivateEndpointConnections_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\' or \\'domains\\'.", + "required": true, + "type": "string", + "enum": [ + "topics", + "domains" + ] + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name or domain name).", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Get": { + "$ref": "./examples/PrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Update a specific private endpoint connection.", + "description": "Update a specific private endpoint connection under a topic or domain.", + "operationId": "PrivateEndpointConnections_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\' or \\'domains\\'.", + "required": true, + "type": "string", + "enum": [ + "topics", + "domains" + ] + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name or domain name).", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection connection.", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection object to update.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Update": { + "$ref": "./examples/PrivateEndpointConnections_Update.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Delete a specific private endpoint connection.", + "description": "Delete a specific private endpoint connection under a topic or domain.", + "operationId": "PrivateEndpointConnections_Delete", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\' or \\'domains\\'.", + "required": true, + "type": "string", + "enum": [ + "topics", + "domains" + ] + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name or domain name).", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection connection.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/PrivateEndpointConnections_Delete.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "summary": "Lists all private endpoint connections under a resource.", + "description": "Get all private endpoint connections under a topic or domain.", + "operationId": "PrivateEndpointConnections_ListByResource", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\' or \\'domains\\'.", + "required": true, + "type": "string", + "enum": [ + "topics", + "domains" + ] + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name or domain name).", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_ListByResource": { + "$ref": "./examples/PrivateEndpointConnections_ListByResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources/{privateLinkResourceName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "summary": "Get a private link resource.", + "description": "Get properties of a private link resource.", + "operationId": "PrivateLinkResources_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\' or \\'domains\\'.", + "required": true, + "type": "string" + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name or domain name).", + "required": true, + "type": "string" + }, + { + "name": "privateLinkResourceName", + "in": "path", + "description": "The name of private link resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateLinkResources_Get": { + "$ref": "./examples/PrivateLinkResources_Get.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.EventGrid/{parentType}/{parentName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "summary": "List private link resources under specific topic or domain.", + "description": "List all the private link resources under a topic or domain.", + "operationId": "PrivateLinkResources_ListByResource", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "parentType", + "in": "path", + "description": "The type of the parent resource. This can be either \\'topics\\' or \\'domains\\'.", + "required": true, + "type": "string" + }, + { + "name": "parentName", + "in": "path", + "description": "The name of the parent resource (namely, either, the topic name or domain name).", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/FilterParameter" + }, + { + "$ref": "#/parameters/TopParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourcesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListByResource": { + "$ref": "./examples/PrivateLinkResources_ListByResource.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/{providerNamespace}/{resourceTypeName}/{resourceName}/providers/Microsoft.EventGrid/eventTypes": { + "get": { + "tags": [ + "Topics" + ], + "summary": "List topic event types.", + "description": "List event types for a topic.", + "operationId": "Topics_ListEventTypes", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group within the user's subscription.", + "required": true, + "type": "string" + }, + { + "name": "providerNamespace", + "in": "path", + "description": "Namespace of the provider of the topic.", + "required": true, + "type": "string" + }, + { + "name": "resourceTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "name": "resourceName", + "in": "path", + "description": "Name of the topic.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventTypesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Topics_ListEventTypes": { + "$ref": "./examples/Topics_ListEventTypes.json" + } + } + } + }, + "/providers/Microsoft.EventGrid/topicTypes": { + "get": { + "tags": [ + "TopicTypes" + ], + "summary": "List topic types.", + "description": "List all registered topic types.", + "operationId": "TopicTypes_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicTypesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "TopicTypes_List": { + "$ref": "./examples/TopicTypes_List.json" + } + } + } + }, + "/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}": { + "get": { + "tags": [ + "TopicTypes" + ], + "summary": "Get a topic type.", + "description": "Get information about a topic type.", + "operationId": "TopicTypes_Get", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TopicTypeInfo" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-examples": { + "TopicTypes_Get": { + "$ref": "./examples/TopicTypes_Get.json" + } + } + } + }, + "/providers/Microsoft.EventGrid/topicTypes/{topicTypeName}/eventTypes": { + "get": { + "tags": [ + "TopicTypes" + ], + "summary": "List event types.", + "description": "List event types for a topic type.", + "operationId": "TopicTypes_ListEventTypes", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "topicTypeName", + "in": "path", + "description": "Name of the topic type.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EventTypesListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 404 Not Found.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "TopicTypes_ListEventTypes": { + "$ref": "./examples/TopicTypes_ListEventTypes.json" + } + } + } + } + }, + "definitions": { + "DomainProperties": { + "description": "Properties of the Domain.", + "type": "object", + "properties": { + "privateEndpointConnections": { + "description": "List of private endpoint connections.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "description": "Provisioning state of the domain.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DomainProvisioningState", + "modelAsString": true + } + }, + "endpoint": { + "description": "Endpoint for the domain.", + "type": "string", + "readOnly": true + }, + "inputSchema": { + "description": "This determines the format that Event Grid should expect for incoming events published to the domain.", + "enum": [ + "EventGridSchema", + "CustomEventSchema", + "CloudEventSchemaV1_0" + ], + "type": "string", + "x-ms-enum": { + "name": "InputSchema", + "modelAsString": true + }, + "default": "EventGridSchema" + }, + "inputSchemaMapping": { + "$ref": "#/definitions/InputSchemaMapping", + "description": "Information about the InputSchemaMapping which specified the info about mapping event payload." + }, + "metricResourceId": { + "description": "Metric resource id for the domain.", + "type": "string", + "readOnly": true + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "inboundIpRules": { + "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundIpRule" + } + } + } + }, + "PrivateEndpointConnection": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the PrivateEndpointConnection.", + "x-ms-client-flatten": true + } + } + }, + "InboundIpRule": { + "type": "object", + "properties": { + "ipMask": { + "description": "IP Address in CIDR notation e.g., 10.0.0.0/8.", + "type": "string" + }, + "action": { + "description": "Action to perform based on the match or no match of the IpMask.", + "enum": [ + "Allow" + ], + "type": "string", + "x-ms-enum": { + "name": "IpActionType", + "modelAsString": true + } + } + } + }, + "Resource": { + "description": "Definition of a Resource.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the resource.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "description": "Properties of the private endpoint connection resource.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The Private Endpoint resource for this Connection." + }, + "groupIds": { + "description": "GroupIds from the private link service resource.", + "type": "array", + "items": { + "type": "string" + } + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/ConnectionState", + "description": "Details about the state of the connection." + }, + "provisioningState": { + "description": "Provisioning state of the Private Endpoint Connection.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceProvisioningState", + "modelAsString": true + } + } + } + }, + "PrivateEndpoint": { + "description": "PrivateEndpoint information.", + "type": "object", + "properties": { + "id": { + "description": "The ARM identifier for Private Endpoint.", + "type": "string" + } + } + }, + "ConnectionState": { + "description": "ConnectionState information.", + "type": "object", + "properties": { + "status": { + "description": "Status of the connection.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PersistedConnectionStatus", + "modelAsString": true + } + }, + "description": { + "description": "Description of the connection state.", + "type": "string" + }, + "actionsRequired": { + "description": "Actions required (if any).", + "type": "string" + } + } + }, + "JsonInputSchemaMappingProperties": { + "description": "This can be used to map properties of a source schema (or default values, for certain supported properties) to properties of the EventGridEvent schema.", + "type": "object", + "properties": { + "id": { + "$ref": "#/definitions/JsonField", + "description": "The mapping information for the Id property of the Event Grid Event." + }, + "topic": { + "$ref": "#/definitions/JsonField", + "description": "The mapping information for the Topic property of the Event Grid Event." + }, + "eventTime": { + "$ref": "#/definitions/JsonField", + "description": "The mapping information for the EventTime property of the Event Grid Event." + }, + "eventType": { + "$ref": "#/definitions/JsonFieldWithDefault", + "description": "The mapping information for the EventType property of the Event Grid Event." + }, + "subject": { + "$ref": "#/definitions/JsonFieldWithDefault", + "description": "The mapping information for the Subject property of the Event Grid Event." + }, + "dataVersion": { + "$ref": "#/definitions/JsonFieldWithDefault", + "description": "The mapping information for the DataVersion property of the Event Grid Event." + } + } + }, + "JsonField": { + "description": "This is used to express the source of an input schema mapping for a single target field in the Event Grid Event schema. This is currently used in the mappings for the 'id', 'topic' and 'eventtime' properties. This represents a field in the input event schema.", + "type": "object", + "properties": { + "sourceField": { + "description": "Name of a field in the input event schema that's to be used as the source of a mapping.", + "type": "string" + } + } + }, + "JsonFieldWithDefault": { + "description": "This is used to express the source of an input schema mapping for a single target field\r\nin the Event Grid Event schema. This is currently used in the mappings for the 'subject',\r\n'eventtype' and 'dataversion' properties. This represents a field in the input event schema\r\nalong with a default value to be used, and at least one of these two properties should be provided.", + "type": "object", + "properties": { + "sourceField": { + "description": "Name of a field in the input event schema that's to be used as the source of a mapping.", + "type": "string" + }, + "defaultValue": { + "description": "The default value to be used for mapping when a SourceField is not provided or if there's no property with the specified name in the published JSON event payload.", + "type": "string" + } + } + }, + "JsonInputSchemaMapping": { + "description": "This enables publishing to Event Grid using a custom input schema. This can be used to map properties from a custom input JSON schema to the Event Grid event schema.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/InputSchemaMapping" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JsonInputSchemaMappingProperties", + "description": "JSON Properties of the input schema mapping", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "Json" + }, + "InputSchemaMapping": { + "description": "By default, Event Grid expects events to be in the Event Grid event schema. Specifying an input schema mapping enables publishing to Event Grid using a custom input schema. Currently, the only supported type of InputSchemaMapping is 'JsonInputSchemaMapping'.", + "required": [ + "inputSchemaMappingType" + ], + "type": "object", + "properties": { + "inputSchemaMappingType": { + "description": "Type of the custom mapping", + "enum": [ + "Json" + ], + "type": "string", + "x-ms-enum": { + "name": "InputSchemaMappingType", + "modelAsString": true + } + } + }, + "discriminator": "inputSchemaMappingType" + }, + "TrackedResource": { + "description": "Definition of a Tracked Resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Location of the resource.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Domain": { + "description": "EventGrid Domain.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DomainProperties", + "description": "Properties of the domain.", + "x-ms-client-flatten": true + } + } + }, + "DomainUpdateParameters": { + "description": "Properties of the Domain update.", + "type": "object", + "properties": { + "tags": { + "description": "Tags of the domains resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/DomainUpdateParameterProperties", + "description": "Properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "DomainUpdateParameterProperties": { + "description": "Information of domain update parameter properties.", + "type": "object", + "properties": { + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "inboundIpRules": { + "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundIpRule" + } + } + } + }, + "DomainsListResult": { + "description": "Result of the List Domains operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of Domains.", + "type": "array", + "items": { + "$ref": "#/definitions/Domain" + } + }, + "nextLink": { + "description": "A link for the next page of domains.", + "type": "string" + } + } + }, + "DomainSharedAccessKeys": { + "description": "Shared access keys of the Domain.", + "type": "object", + "properties": { + "key1": { + "description": "Shared access key1 for the domain.", + "type": "string" + }, + "key2": { + "description": "Shared access key2 for the domain.", + "type": "string" + } + } + }, + "DomainRegenerateKeyRequest": { + "description": "Domain regenerate share access key request.", + "required": [ + "keyName" + ], + "type": "object", + "properties": { + "keyName": { + "description": "Key name to regenerate key1 or key2.", + "type": "string" + } + } + }, + "DomainTopicProperties": { + "description": "Properties of the Domain Topic.", + "type": "object", + "properties": { + "provisioningState": { + "description": "Provisioning state of the domain topic.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "DomainTopicProvisioningState", + "modelAsString": true + } + } + } + }, + "DomainTopic": { + "description": "Domain Topic.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DomainTopicProperties", + "description": "Properties of the Domain Topic.", + "x-ms-client-flatten": true + } + } + }, + "DomainTopicsListResult": { + "description": "Result of the List Domain Topics operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of Domain Topics.", + "type": "array", + "items": { + "$ref": "#/definitions/DomainTopic" + } + }, + "nextLink": { + "description": "A link for the next page of domain topics.", + "type": "string" + } + } + }, + "EventSubscriptionProperties": { + "description": "Properties of the Event Subscription.", + "type": "object", + "properties": { + "topic": { + "description": "Name of the topic of the event subscription.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provisioning state of the event subscription.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed", + "AwaitingManualAction" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "EventSubscriptionProvisioningState", + "modelAsString": true + } + }, + "destination": { + "$ref": "#/definitions/EventSubscriptionDestination", + "description": "Information about the destination where events have to be delivered for the event subscription." + }, + "filter": { + "$ref": "#/definitions/EventSubscriptionFilter", + "description": "Information about the filter for the event subscription." + }, + "labels": { + "description": "List of user defined labels.", + "type": "array", + "items": { + "type": "string" + } + }, + "expirationTimeUtc": { + "format": "date-time", + "description": "Expiration time of the event subscription.", + "type": "string" + }, + "eventDeliverySchema": { + "description": "The event delivery schema for the event subscription.", + "enum": [ + "EventGridSchema", + "CustomInputSchema", + "CloudEventSchemaV1_0" + ], + "type": "string", + "x-ms-enum": { + "name": "EventDeliverySchema", + "modelAsString": true + } + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events." + }, + "deadLetterDestination": { + "$ref": "#/definitions/DeadLetterDestination", + "description": "The DeadLetter destination of the event subscription." + } + } + }, + "EventSubscriptionFilter": { + "description": "Filter for the Event Subscription.", + "type": "object", + "properties": { + "subjectBeginsWith": { + "description": "An optional string to filter events for an event subscription based on a resource path prefix.\r\nThe format of this depends on the publisher of the events.\r\nWildcard characters are not supported in this path.", + "type": "string" + }, + "subjectEndsWith": { + "description": "An optional string to filter events for an event subscription based on a resource path suffix.\r\nWildcard characters are not supported in this path.", + "type": "string" + }, + "includedEventTypes": { + "description": "A list of applicable event types that need to be part of the event subscription. If it is desired to subscribe to all default event types, set the IncludedEventTypes to null.", + "type": "array", + "items": { + "type": "string" + } + }, + "isSubjectCaseSensitive": { + "description": "Specifies if the SubjectBeginsWith and SubjectEndsWith properties of the filter\r\nshould be compared in a case sensitive manner.", + "default": false, + "type": "boolean" + }, + "advancedFilters": { + "description": "An array of advanced filters that are used for filtering event subscriptions.", + "type": "array", + "items": { + "$ref": "#/definitions/AdvancedFilter" + } + } + } + }, + "RetryPolicy": { + "description": "Information about the retry policy for an event subscription.", + "type": "object", + "properties": { + "maxDeliveryAttempts": { + "format": "int32", + "description": "Maximum number of delivery retry attempts for events.", + "type": "integer" + }, + "eventTimeToLiveInMinutes": { + "format": "int32", + "description": "Time To Live (in minutes) for events.", + "type": "integer" + } + } + }, + "WebHookEventSubscriptionDestinationProperties": { + "description": "Information about the webhook destination properties for an event subscription.", + "type": "object", + "properties": { + "endpointUrl": { + "description": "The URL that represents the endpoint of the destination of an event subscription.", + "type": "string" + }, + "endpointBaseUrl": { + "description": "The base URL that represents the endpoint of the destination of an event subscription.", + "type": "string", + "readOnly": true + }, + "maxEventsPerBatch": { + "format": "int32", + "description": "Maximum number of events per batch.", + "type": "integer" + }, + "preferredBatchSizeInKilobytes": { + "format": "int32", + "description": "Preferred batch size in Kilobytes.", + "type": "integer" + }, + "azureActiveDirectoryTenantId": { + "description": "The Azure Active Directory Tenant ID to get the access token that will be included as the bearer token in delivery requests.", + "type": "string" + }, + "azureActiveDirectoryApplicationIdOrUri": { + "description": "The Azure Active Directory Application ID or URI to get the access token that will be included as the bearer token in delivery requests.", + "type": "string" + } + } + }, + "StorageBlobDeadLetterDestinationProperties": { + "description": "Properties of the storage blob based dead letter destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource ID of the storage account that is the destination of the deadletter events", + "type": "string" + }, + "blobContainerName": { + "description": "The name of the Storage blob container that is the destination of the deadletter events", + "type": "string" + } + } + }, + "NumberInAdvancedFilter": { + "description": "NumberIn Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + }, + "x-ms-discriminator-value": "NumberIn" + }, + "StorageBlobDeadLetterDestination": { + "description": "Information about the storage blob based dead letter destination.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/DeadLetterDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageBlobDeadLetterDestinationProperties", + "description": "The properties of the Storage Blob based deadletter destination", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "StorageBlob" + }, + "NumberNotInAdvancedFilter": { + "description": "NumberNotIn Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "format": "double", + "type": "number" + } + } + }, + "x-ms-discriminator-value": "NumberNotIn" + }, + "NumberLessThanAdvancedFilter": { + "description": "NumberLessThan Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "value": { + "format": "double", + "description": "The filter value.", + "type": "number" + } + }, + "x-ms-discriminator-value": "NumberLessThan" + }, + "NumberGreaterThanAdvancedFilter": { + "description": "NumberGreaterThan Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "value": { + "format": "double", + "description": "The filter value.", + "type": "number" + } + }, + "x-ms-discriminator-value": "NumberGreaterThan" + }, + "NumberLessThanOrEqualsAdvancedFilter": { + "description": "NumberLessThanOrEquals Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "value": { + "format": "double", + "description": "The filter value.", + "type": "number" + } + }, + "x-ms-discriminator-value": "NumberLessThanOrEquals" + }, + "NumberGreaterThanOrEqualsAdvancedFilter": { + "description": "NumberGreaterThanOrEquals Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "value": { + "format": "double", + "description": "The filter value.", + "type": "number" + } + }, + "x-ms-discriminator-value": "NumberGreaterThanOrEquals" + }, + "BoolEqualsAdvancedFilter": { + "description": "BoolEquals Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "value": { + "description": "The boolean filter value.", + "type": "boolean" + } + }, + "x-ms-discriminator-value": "BoolEquals" + }, + "StringInAdvancedFilter": { + "description": "StringIn Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringIn" + }, + "StringNotInAdvancedFilter": { + "description": "StringNotIn Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringNotIn" + }, + "StringBeginsWithAdvancedFilter": { + "description": "StringBeginsWith Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringBeginsWith" + }, + "StringEndsWithAdvancedFilter": { + "description": "StringEndsWith Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringEndsWith" + }, + "StringContainsAdvancedFilter": { + "description": "StringContains Advanced Filter.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AdvancedFilter" + } + ], + "properties": { + "values": { + "description": "The set of filter values.", + "type": "array", + "items": { + "type": "string" + } + } + }, + "x-ms-discriminator-value": "StringContains" + }, + "AdvancedFilter": { + "description": "This is the base type that represents an advanced filter. To configure an advanced filter, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class such as BoolEqualsAdvancedFilter, NumberInAdvancedFilter, StringEqualsAdvancedFilter etc. depending on the type of the key based on which you want to filter.", + "required": [ + "operatorType" + ], + "type": "object", + "properties": { + "operatorType": { + "description": "The operator type used for filtering, e.g., NumberIn, StringContains, BoolEquals and others.", + "enum": [ + "NumberIn", + "NumberNotIn", + "NumberLessThan", + "NumberGreaterThan", + "NumberLessThanOrEquals", + "NumberGreaterThanOrEquals", + "BoolEquals", + "StringIn", + "StringNotIn", + "StringBeginsWith", + "StringEndsWith", + "StringContains" + ], + "type": "string", + "x-ms-enum": { + "name": "AdvancedFilterOperatorType", + "modelAsString": true + } + }, + "key": { + "description": "The field/property in the event based on which you want to filter.", + "type": "string" + } + }, + "discriminator": "operatorType" + }, + "WebHookEventSubscriptionDestination": { + "description": "Information about the webhook destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebHookEventSubscriptionDestinationProperties", + "description": "WebHook Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "WebHook" + }, + "DeadLetterDestination": { + "description": "Information about the dead letter destination for an event subscription. To configure a deadletter destination, do not directly instantiate an object of this class. Instead, instantiate an object of a derived class. Currently, StorageBlobDeadLetterDestination is the only class that derives from this class.", + "type": "object", + "required": [ + "endpointType" + ], + "properties": { + "endpointType": { + "description": "Type of the endpoint for the dead letter destination", + "enum": [ + "StorageBlob" + ], + "type": "string", + "x-ms-enum": { + "name": "DeadLetterEndPointType", + "modelAsString": true + } + } + }, + "discriminator": "endpointType" + }, + "EventHubEventSubscriptionDestinationProperties": { + "description": "The properties for a event hub destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource Id that represents the endpoint of an Event Hub destination of an event subscription.", + "type": "string" + } + } + }, + "EventHubEventSubscriptionDestination": { + "description": "Information about the event hub destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventHubEventSubscriptionDestinationProperties", + "description": "Event Hub Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "EventHub" + }, + "StorageQueueEventSubscriptionDestinationProperties": { + "description": "The properties for a storage queue destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource ID of the storage account that contains the queue that is the destination of an event subscription.", + "type": "string" + }, + "queueName": { + "description": "The name of the Storage queue under a storage account that is the destination of an event subscription.", + "type": "string" + } + } + }, + "StorageQueueEventSubscriptionDestination": { + "description": "Information about the storage queue destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageQueueEventSubscriptionDestinationProperties", + "description": "Storage Queue Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "StorageQueue" + }, + "HybridConnectionEventSubscriptionDestinationProperties": { + "description": "The properties for a hybrid connection destination.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource ID of an hybrid connection that is the destination of an event subscription.", + "type": "string" + } + } + }, + "HybridConnectionEventSubscriptionDestination": { + "description": "Information about the HybridConnection destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/HybridConnectionEventSubscriptionDestinationProperties", + "description": "Hybrid connection Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "HybridConnection" + }, + "ServiceBusQueueEventSubscriptionDestinationProperties": { + "description": "The properties that represent the Service Bus destination of an event subscription.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource Id that represents the endpoint of the Service Bus destination of an event subscription.", + "type": "string" + } + } + }, + "ServiceBusQueueEventSubscriptionDestination": { + "description": "Information about the service bus destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceBusQueueEventSubscriptionDestinationProperties", + "description": "Service Bus Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "ServiceBusQueue" + }, + "ServiceBusTopicEventSubscriptionDestinationProperties": { + "description": "The properties that represent the Service Bus Topic destination of an event subscription.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource Id that represents the endpoint of the Service Bus Topic destination of an event subscription.", + "type": "string" + } + } + }, + "ServiceBusTopicEventSubscriptionDestination": { + "description": "Information about the service bus topic destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ServiceBusTopicEventSubscriptionDestinationProperties", + "description": "Service Bus Topic Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "ServiceBusTopic" + }, + "AzureFunctionEventSubscriptionDestinationProperties": { + "description": "The properties that represent the Azure Function destination of an event subscription.", + "type": "object", + "properties": { + "resourceId": { + "description": "The Azure Resource Id that represents the endpoint of the Azure Function destination of an event subscription.", + "type": "string" + }, + "maxEventsPerBatch": { + "format": "int32", + "description": "Maximum number of events per batch.", + "type": "integer" + }, + "preferredBatchSizeInKilobytes": { + "format": "int32", + "description": "Preferred batch size in Kilobytes.", + "type": "integer" + } + } + }, + "AzureFunctionEventSubscriptionDestination": { + "description": "Information about the azure function destination for an event subscription.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/EventSubscriptionDestination" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AzureFunctionEventSubscriptionDestinationProperties", + "description": "Azure Function Properties of the event subscription destination.", + "x-ms-client-flatten": true + } + }, + "x-ms-discriminator-value": "AzureFunction" + }, + "EventSubscriptionDestination": { + "description": "Information about the destination for an event subscription.", + "required": [ + "endpointType" + ], + "type": "object", + "properties": { + "endpointType": { + "description": "Type of the endpoint for the event subscription destination.", + "enum": [ + "WebHook", + "EventHub", + "StorageQueue", + "HybridConnection", + "ServiceBusQueue", + "ServiceBusTopic", + "AzureFunction" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointType", + "modelAsString": true + } + } + }, + "discriminator": "endpointType" + }, + "EventSubscription": { + "description": "Event Subscription", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventSubscriptionProperties", + "description": "Properties of the event subscription.", + "x-ms-client-flatten": true + } + } + }, + "EventSubscriptionUpdateParameters": { + "description": "Properties of the Event Subscription update.", + "type": "object", + "properties": { + "destination": { + "$ref": "#/definitions/EventSubscriptionDestination", + "description": "Information about the destination where events have to be delivered for the event subscription." + }, + "filter": { + "$ref": "#/definitions/EventSubscriptionFilter", + "description": "Information about the filter for the event subscription." + }, + "labels": { + "description": "List of user defined labels.", + "type": "array", + "items": { + "type": "string" + } + }, + "expirationTimeUtc": { + "format": "date-time", + "description": "Information about the expiration time for the event subscription.", + "type": "string" + }, + "eventDeliverySchema": { + "description": "The event delivery schema for the event subscription.", + "enum": [ + "EventGridSchema", + "CustomInputSchema", + "CloudEventSchemaV1_0" + ], + "type": "string", + "x-ms-enum": { + "name": "EventDeliverySchema", + "modelAsString": true + } + }, + "retryPolicy": { + "$ref": "#/definitions/RetryPolicy", + "description": "The retry policy for events. This can be used to configure maximum number of delivery attempts and time to live for events." + }, + "deadLetterDestination": { + "$ref": "#/definitions/DeadLetterDestination", + "description": "The DeadLetter destination of the event subscription." + } + } + }, + "EventSubscriptionFullUrl": { + "description": "Full endpoint url of an event subscription", + "type": "object", + "properties": { + "endpointUrl": { + "description": "The URL that represents the endpoint of the destination of an event subscription.", + "type": "string" + } + } + }, + "EventSubscriptionsListResult": { + "description": "Result of the List EventSubscriptions operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of EventSubscriptions", + "type": "array", + "items": { + "$ref": "#/definitions/EventSubscription" + } + }, + "nextLink": { + "description": "A link for the next page of event subscriptions", + "type": "string" + } + } + }, + "OperationsListResult": { + "description": "Result of the List Operations operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + } + } + }, + "Operation": { + "description": "Represents an operation returned by the GetOperations request", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationInfo", + "description": "Display name of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "description": "Properties of the operation", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "OperationInfo": { + "description": "Information about an operation", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider", + "type": "string" + }, + "resource": { + "description": "Name of the resource type", + "type": "string" + }, + "operation": { + "description": "Name of the operation", + "type": "string" + }, + "description": { + "description": "Description of the operation", + "type": "string" + } + } + }, + "PrivateEndpointConnectionListResult": { + "description": "Result of the list of all private endpoint connections operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of private endpoint connection resources.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "A link for the next page of private endpoint connection resources.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "Information of the private link resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of the private link resource.", + "x-ms-client-flatten": true + }, + "id": { + "description": "Fully qualified identifier of the resource.", + "type": "string" + }, + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "description": "Type of the resource", + "type": "string" + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "type": "string" + }, + "displayName": { + "type": "string" + }, + "requiredMembers": { + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateLinkResourcesListResult": { + "description": "Result of the List private link resources operation.", + "type": "object", + "properties": { + "value": { + "description": "A collection of private link resources", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "A link for the next page of private link resources.", + "type": "string" + } + } + }, + "TopicProperties": { + "description": "Properties of the Topic", + "type": "object", + "properties": { + "privateEndpointConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "description": "Provisioning state of the topic.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "TopicProvisioningState", + "modelAsString": true + } + }, + "endpoint": { + "description": "Endpoint for the topic.", + "type": "string", + "readOnly": true + }, + "inputSchema": { + "description": "This determines the format that Event Grid should expect for incoming events published to the topic.", + "enum": [ + "EventGridSchema", + "CustomEventSchema", + "CloudEventSchemaV1_0" + ], + "type": "string", + "x-ms-enum": { + "name": "InputSchema", + "modelAsString": true + }, + "default": "EventGridSchema" + }, + "inputSchemaMapping": { + "$ref": "#/definitions/InputSchemaMapping", + "description": "This enables publishing using custom event schemas. An InputSchemaMapping can be specified to map various properties of a source schema to various required properties of the EventGridEvent schema." + }, + "metricResourceId": { + "description": "Metric resource id for the topic.", + "type": "string", + "readOnly": true + }, + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "inboundIpRules": { + "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundIpRule" + } + } + } + }, + "Topic": { + "description": "EventGrid Topic", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TopicProperties", + "description": "Properties of the topic.", + "x-ms-client-flatten": true + } + } + }, + "TopicUpdateParameters": { + "description": "Properties of the Topic update", + "type": "object", + "properties": { + "tags": { + "description": "Tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "$ref": "#/definitions/TopicUpdateParameterProperties", + "description": "Properties of the resource.", + "x-ms-client-flatten": true + } + } + }, + "TopicUpdateParameterProperties": { + "description": "Information of topic update parameter properties.", + "type": "object", + "properties": { + "publicNetworkAccess": { + "description": "This determines if traffic is allowed over public network. By default it is enabled. \r\nYou can further restrict to specific IPs by configuring ", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "inboundIpRules": { + "description": "This can be used to restrict traffic from specific IPs instead of all IPs. Note: These are considered only if PublicNetworkAccess is enabled.", + "type": "array", + "items": { + "$ref": "#/definitions/InboundIpRule" + } + } + } + }, + "TopicsListResult": { + "description": "Result of the List Topics operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of Topics", + "type": "array", + "items": { + "$ref": "#/definitions/Topic" + } + }, + "nextLink": { + "description": "A link for the next page of topics", + "type": "string" + } + } + }, + "TopicSharedAccessKeys": { + "description": "Shared access keys of the Topic", + "type": "object", + "properties": { + "key1": { + "description": "Shared access key1 for the topic.", + "type": "string" + }, + "key2": { + "description": "Shared access key2 for the topic.", + "type": "string" + } + } + }, + "TopicRegenerateKeyRequest": { + "description": "Topic regenerate share access key request", + "required": [ + "keyName" + ], + "type": "object", + "properties": { + "keyName": { + "description": "Key name to regenerate key1 or key2", + "type": "string" + } + } + }, + "EventTypesListResult": { + "description": "Result of the List Event Types operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of event types", + "type": "array", + "items": { + "$ref": "#/definitions/EventType" + } + } + } + }, + "EventTypeProperties": { + "description": "Properties of the event type", + "type": "object", + "properties": { + "displayName": { + "description": "Display name of the event type.", + "type": "string" + }, + "description": { + "description": "Description of the event type.", + "type": "string" + }, + "schemaUrl": { + "description": "Url of the schema for this event type.", + "type": "string" + }, + "isInDefaultSet": { + "description": "IsInDefaultSet flag of the event type.", + "type": "boolean" + } + } + }, + "EventType": { + "description": "Event Type for a subject under a topic", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EventTypeProperties", + "description": "Properties of the event type.", + "x-ms-client-flatten": true + } + } + }, + "TopicTypesListResult": { + "description": "Result of the List Topic Types operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of topic types", + "type": "array", + "items": { + "$ref": "#/definitions/TopicTypeInfo" + } + } + } + }, + "TopicTypeProperties": { + "description": "Properties of a topic type.", + "type": "object", + "properties": { + "provider": { + "description": "Namespace of the provider of the topic type.", + "type": "string" + }, + "displayName": { + "description": "Display Name for the topic type.", + "type": "string" + }, + "description": { + "description": "Description of the topic type.", + "type": "string" + }, + "resourceRegionType": { + "description": "Region type of the resource.", + "enum": [ + "RegionalResource", + "GlobalResource" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceRegionType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Provisioning state of the topic type", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Canceled", + "Failed" + ], + "type": "string", + "x-ms-enum": { + "name": "TopicTypeProvisioningState", + "modelAsString": true + } + }, + "supportedLocations": { + "description": "List of locations supported by this topic type.", + "type": "array", + "items": { + "type": "string" + } + }, + "sourceResourceFormat": { + "description": "Source resource format.", + "type": "string" + } + } + }, + "TopicTypeInfo": { + "description": "Properties of a topic type info.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TopicTypeProperties", + "description": "Properties of the topic type info", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Subscription credentials that uniquely identify a Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Version of the API to be used with the client request.", + "required": true, + "type": "string" + }, + "FilterParameter": { + "name": "$filter", + "in": "query", + "description": "The query used to filter the search results using OData syntax. Filtering is permitted on the 'name' property only and with limited number of OData operations. These operations are: the 'contains' function as well as the following logical operations: not, and, or, eq (for equal), and ne (for not equal). No arithmetic operations are supported. The following is a valid filter example: $filter=contains(namE, 'PATTERN') and name ne 'PATTERN-1'. The following is not a valid filter example: $filter=location eq 'westus'.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + }, + "TopParameter": { + "name": "$top", + "in": "query", + "description": "The number of results to return per page for the list operation. Valid range for top parameter is 1 to 100. If not specified, the default number of results to be returned is 20 items per page.", + "required": false, + "type": "integer", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_CreateOrUpdate.json new file mode 100644 index 000000000000..ede0597d632c --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_CreateOrUpdate.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain1", + "domainTopicName": "exampledomaintopic1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "201": { + "body": { + "properties": { + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1/topics/exampledomaintopic1", + "name": "exampledomaintopic1", + "type": "Microsoft.EventGrid/domains/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_Delete.json new file mode 100644 index 000000000000..2f7779e09554 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain1", + "domainTopicName": "exampledomaintopic1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_Get.json new file mode 100644 index 000000000000..71d3a4e79f5b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_Get.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain2", + "domainTopicName": "topic1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2/topics/topic1", + "name": "topic1", + "properties": { + "provisioningState": "Succeeded" + }, + "type": "Microsoft.EventGrid/domains/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_ListByDomain.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_ListByDomain.json new file mode 100644 index 000000000000..e2b8d873c8a1 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/DomainTopics_ListByDomain.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/devexprg/providers/Microsoft.EventGrid/domains/domainCli100/topics/domainCli100topic1", + "name": "domainCli100topic1", + "properties": { + "provisioningState": "Succeeded" + }, + "type": "Microsoft.EventGrid/domains/topics" + }, + { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/devexprg/providers/Microsoft.EventGrid/domains/domainCli100/topics/domainCli100topic2", + "name": "domainCli100topic2", + "properties": { + "provisioningState": "Succeeded" + }, + "type": "Microsoft.EventGrid/domains/topics" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_CreateOrUpdate.json new file mode 100644 index 000000000000..75423f7c4dd3 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain1", + "api-version": "2020-04-01-preview", + "domainInfo": { + "location": "westus2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1", + "location": "westus2", + "name": "exampledomain1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Delete.json new file mode 100644 index 000000000000..a963710c69a0 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Get.json new file mode 100644 index 000000000000..958fd7e429fe --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpoint": "https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2", + "location": "westcentralus", + "name": "exampledomain2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListByResourceGroup.json new file mode 100644 index 000000000000..a5615d47e6f4 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1", + "location": "westus2", + "name": "exampledomain1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + }, + { + "properties": { + "endpoint": "https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2", + "location": "westcentralus", + "name": "exampledomain2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListBySubscription.json new file mode 100644 index 000000000000..065fd4370397 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1", + "location": "westus2", + "name": "exampledomain1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + }, + { + "properties": { + "endpoint": "https://exampledomain2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain2", + "location": "westcentralus", + "name": "exampledomain2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListSharedAccessKeys.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListSharedAccessKeys.json new file mode 100644 index 000000000000..bb783cf243eb --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_ListSharedAccessKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "key1": "Rqfq5wWxtQnIQJyswP0Uh/hqQfDDMUOYyQSYEpx5e5g=", + "key2": "sesymbkIXMtZVqXEFHarJmdGmZjjnY+BZC8yRD/FeuA=" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_RegenerateKey.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_RegenerateKey.json new file mode 100644 index 000000000000..4183eca19edb --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_RegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain2", + "api-version": "2020-04-01-preview", + "regenerateKeyRequest": { + "keyName": "key1" + } + }, + "responses": { + "200": { + "body": { + "key1": "Rqfq5wWxtQnIQJyswP0Uh/hqQfDDMUOYyQSYEpx5e5g=", + "key2": "sesymbkIXMtZVqXEFHarJmdGmZjjnY+BZC8yRD/FeuA=" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Update.json new file mode 100644 index 000000000000..3e59834b75b9 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Domains_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "exampledomain1", + "api-version": "2020-04-01-preview", + "domainUpdateParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "200": {}, + "201": { + "body": { + "properties": { + "endpoint": "https://exampledomain1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/exampledomain1", + "location": "westus2", + "name": "exampledomain1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/domains" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json new file mode 100644 index 000000000000..10b5ef006c40 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_EventHubDestination.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2020-04-01-preview", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "EventHub", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + }, + "endpointType": "EventHub" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "provisioningState": "Creating", + "labels": null, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json new file mode 100644 index 000000000000..85f8874c8544 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_HybridConnectionDestination.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2020-04-01-preview", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "HybridConnection", + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Relay/namespaces/ContosoNamespace/hybridConnections/HC1" + }, + "endpointType": "HybridConnection" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "provisioningState": "Creating", + "labels": null, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json new file mode 100644 index 000000000000..9a43e885730f --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_StorageQueueDestination.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2020-04-01-preview", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "StorageQueue", + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "queueName": "queue1" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/d33c5f7a-02ea-40f4-bf52-07f17e84d6a8/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "queueName": "queue1" + }, + "endpointType": "StorageQueue" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "provisioningState": "Creating", + "labels": null, + "deadLetterDestination": { + "endpointType": "StorageBlob", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.Storage/storageAccounts/contosostg", + "blobContainerName": "contosocontainer" + } + } + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json new file mode 100644 index 000000000000..2fbdb457220b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForCustomTopic_WebhookDestination.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-04-01-preview", + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "EventHub", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForResource.json new file mode 100644 index 000000000000..c59f022421cf --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForResource.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription10", + "api-version": "2020-04-01-preview", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json new file mode 100644 index 000000000000..04328d84faca --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForResourceGroup.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2020-04-01-preview", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForSubscription.json new file mode 100644 index 000000000000..21ec84b751b7 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_CreateOrUpdateForSubscription.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2020-04-01-preview", + "eventSubscriptionInfo": { + "properties": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": false + } + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForCustomTopic.json new file mode 100644 index 000000000000..cb910cec146b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForCustomTopic.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForResource.json new file mode 100644 index 000000000000..a36dd4a32c41 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForResource.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription10", + "api-version": "2020-04-01-preview" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForResourceGroup.json new file mode 100644 index 000000000000..bbb6787b1c16 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForResourceGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForSubscription.json new file mode 100644 index 000000000000..c49193c06193 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_DeleteForSubscription.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2020-04-01-preview" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForCustomTopic.json new file mode 100644 index 000000000000..86bf95ba4550 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForCustomTopic.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForResource.json new file mode 100644 index 000000000000..a7e3c1d00558 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForResource.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + }, + "endpointType": "EventHub" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForResourceGroup.json new file mode 100644 index 000000000000..0bd3f3bf5d49 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForResourceGroup.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForSubscription.json new file mode 100644 index 000000000000..fc62fa15469d --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetForSubscription.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForCustomTopic.json new file mode 100644 index 000000000000..29de0d132965 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForCustomTopic.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForResource.json new file mode 100644 index 000000000000..6946be90eca8 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForResource.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForResourceGroup.json new file mode 100644 index 000000000000..e5fe18fe955b --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForResourceGroup.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForSubscription.json new file mode 100644 index 000000000000..d93adff17991 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_GetFullUrlForSubscription.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "endpointUrl": "https://requestb.in/15ksip71" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListByDomainTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListByDomainTopic.json new file mode 100644 index 000000000000..27c0593c0f98 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListByDomainTopic.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "domainName": "domain1", + "topicName": "topic1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/domains/domain1/topics/topic1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/domains/domain1/topics/topic1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListByResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListByResource.json new file mode 100644 index 000000000000..3db6b0fd2706 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListByResource.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerNamespace": "Microsoft.EventGrid", + "resourceTypeName": "topics", + "resourceName": "exampletopic2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalByResourceGroup.json new file mode 100644 index 000000000000..2dc73fcc99eb --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription4", + "name": "examplesubscription4", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json new file mode 100644 index 000000000000..b736f9c55616 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalByResourceGroupForTopicType.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicTypeName": "Microsoft.Resources.ResourceGroups", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalBySubscription.json new file mode 100644 index 000000000000..d36d2cfc0344 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalBySubscription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "", + "subjectEndsWith": "" + }, + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription4", + "name": "examplesubscription4", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json new file mode 100644 index 000000000000..ccb726cbbdff --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListGlobalBySubscriptionForTopicType.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "topicTypeName": "Microsoft.Resources.Subscriptions", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalByResourceGroup.json new file mode 100644 index 000000000000..156d635fa0fc --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalByResourceGroup.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "location": "westus2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json new file mode 100644 index 000000000000..217df915989d --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalByResourceGroupForTopicType.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "location": "westus2", + "topicTypeName": "Microsoft.EventHub.namespaces", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalBySubscription.json new file mode 100644 index 000000000000..704a5fb25abd --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalBySubscription.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "location": "westus2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + }, + "endpointType": "EventHub" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json new file mode 100644 index 000000000000..15c67841ca99 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_ListRegionalBySubscriptionForTopicType.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "location": "westus2", + "topicTypeName": "Microsoft.EventHub.namespaces", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription10", + "name": "examplesubscription10", + "type": "Microsoft.EventGrid/eventSubscriptions" + }, + { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": false, + "subjectBeginsWith": "ExamplePrefix", + "subjectEndsWith": "ExampleSuffix" + }, + "labels": [ + "Finance", + "HR" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventhub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription11", + "name": "examplesubscription11", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForCustomTopic.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForCustomTopic.json new file mode 100644 index 000000000000..f90c2732c92c --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForCustomTopic.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2020-04-01-preview", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/microsoft.eventgrid/topics/exampletopic2" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForResource.json new file mode 100644 index 000000000000..bce346c335c4 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForResource.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1", + "eventSubscriptionName": "examplesubscription1", + "api-version": "2020-04-01-preview", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventHub/namespaces/examplenamespace1/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription1", + "name": "examplesubscription1", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForResourceGroup.json new file mode 100644 index 000000000000..59f8b6db5756 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForResourceGroup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg", + "eventSubscriptionName": "examplesubscription2", + "api-version": "2020-04-01-preview", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "EventHub", + "properties": { + "resourceId": "/subscriptions/55f3dcd4-cac7-43b4-990b-a139d62a1eb2/resourceGroups/TestRG/providers/Microsoft.EventHub/namespaces/ContosoNamespace/eventhubs/EH1" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription2", + "name": "examplesubscription2", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForSubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForSubscription.json new file mode 100644 index 000000000000..673dc543afef --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/EventSubscriptions_UpdateForSubscription.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "scope": "subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "eventSubscriptionName": "examplesubscription3", + "api-version": "2020-04-01-preview", + "eventSubscriptionUpdateParameters": { + "destination": { + "endpointType": "WebHook", + "properties": { + "endpointUrl": "https://requestb.in/15ksip71" + } + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [ + "label1", + "label2" + ] + } + }, + "responses": { + "201": { + "body": { + "properties": { + "destination": { + "properties": { + "endpointBaseUrl": "https://requestb.in/15ksip71" + }, + "endpointType": "WebHook" + }, + "filter": { + "isSubjectCaseSensitive": true, + "subjectBeginsWith": "existingPrefix", + "subjectEndsWith": "newSuffix" + }, + "labels": [], + "provisioningState": "Succeeded", + "topic": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/providers/Microsoft.EventGrid/topics/exampletopic2/providers/Microsoft.EventGrid/eventSubscriptions/examplesubscription3", + "name": "examplesubscription3", + "type": "Microsoft.EventGrid/eventSubscriptions" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Operations_List.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Operations_List.json new file mode 100644 index 000000000000..e0bc0bbee3dd --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Operations_List.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.EventGrid/register/action", + "display": { + "provider": "Microsoft Event Grid", + "resource": "EventGrid Resource Provider", + "operation": "Registers the EventGrid Resource Provider", + "description": "Registers the eventSubscription for the EventGrid resource provider and enables the creation of Event Grid subscriptions." + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/eventSubscriptions/write", + "display": { + "provider": "Microsoft Event Grid", + "resource": "eventSubscriptions", + "operation": "Write EventSubscription", + "description": "Create or update a eventSubscription" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/eventSubscriptions/read", + "display": { + "provider": "Microsoft Event Grid", + "resource": "eventSubscriptions", + "operation": "Read EventSubscription", + "description": "Read a eventSubscription" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/eventSubscriptions/delete", + "display": { + "provider": "Microsoft Event Grid", + "resource": "eventSubscriptions", + "operation": "Delete EventSubscription", + "description": "Delete a eventSubscription" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/topics/write", + "display": { + "provider": "Microsoft Event Grid", + "resource": "topics", + "operation": "Write Topic", + "description": "Create or update a topic" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/topics/read", + "display": { + "provider": "Microsoft Event Grid", + "resource": "topics", + "operation": "Read Topic", + "description": "Read a topic" + }, + "origin": "UserAndSystem" + }, + { + "name": "Microsoft.EventGrid/topics/delete", + "display": { + "provider": "Microsoft Event Grid", + "resource": "topics", + "operation": "Delete Topic", + "description": "Delete a topic" + }, + "origin": "UserAndSystem" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..0b9b52011235 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "privateEndpointConnectionName": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "api-version": "2020-04-01-preview" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..650d12fc40e1 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Get.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "privateEndpointConnectionName": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5" + }, + "groupIds": [ + "topic" + ], + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Test", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "name": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "type": "Microsoft.EventGrid/topics/privateEndpointConnections" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_ListByResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_ListByResource.json new file mode 100644 index 000000000000..c16c488defbc --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_ListByResource.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5" + }, + "groupIds": [ + "topic" + ], + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Test", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "name": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "type": "Microsoft.EventGrid/topics/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..05dbe5771842 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateEndpointConnections_Update.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "privateEndpointConnectionName": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "api-version": "2020-04-01-preview", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approving connection", + "actionsRequired": "None" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5" + }, + "groupIds": [ + "topic" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approving connection", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "name": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "type": "Microsoft.EventGrid/topics/privateEndpointConnections" + } + }, + "201": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.Network/privateEndpoints/bmtpe5" + }, + "groupIds": [ + "topic" + ], + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approving connection", + "actionsRequired": "None" + }, + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1/privateEndpointConnections/BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "name": "BMTPE5.8A30D251-4C61-489D-A1AA-B37C4A329B8B", + "type": "Microsoft.EventGrid/topics/privateEndpointConnections" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateLinkResources_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateLinkResources_Get.json new file mode 100644 index 000000000000..aaca5edd77a2 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateLinkResources_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "privateLinkResourceName": "topic", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "groupId": "topic", + "displayName": "Event Grid topic", + "requiredMembers": [ + "topic" + ], + "requiredZoneNames": [ + "privatelink.eventgrid.azure.net" + ] + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/amh/providers/Microsoft.EventGrid/topics/exampletopic1/privateLinkResources/topic", + "name": "topic", + "type": "Microsoft.EventGrid/topics/privateLinkResources" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateLinkResources_ListByResource.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateLinkResources_ListByResource.json new file mode 100644 index 000000000000..613d05b44e05 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/PrivateLinkResources_ListByResource.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "parentType": "topics", + "parentName": "exampletopic1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "topic", + "displayName": "Event Grid topic", + "requiredMembers": [ + "topic" + ], + "requiredZoneNames": [ + "privatelink.eventgrid.azure.net" + ] + }, + "id": "/subscriptions/5B4B650E-28B9-4790-B3AB-DDBD88D727C4/resourceGroups/amh/providers/Microsoft.EventGrid/topics/exampletopic1/privateLinkResources/topic", + "name": "topic", + "type": "Microsoft.EventGrid/topics/privateLinkResources" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_Get.json new file mode 100644 index 000000000000..8a5b5b95dc18 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "topicTypeName": "Microsoft.Storage.StorageAccounts", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "Microsoft Storage service events.", + "displayName": "Storage Accounts", + "provider": "Microsoft.Storage", + "provisioningState": "Succeeded", + "resourceRegionType": "RegionalResource" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts", + "name": "Microsoft.Storage.StorageAccounts", + "type": "Microsoft.EventGrid/topicTypes" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_List.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_List.json new file mode 100644 index 000000000000..06bb41c66f85 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_List.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "Microsoft EventHubs service events.", + "displayName": "EventHubs Namespace", + "provider": "Microsoft.Eventhub", + "provisioningState": "Succeeded", + "resourceRegionType": "RegionalResource" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Eventhub.Namespaces", + "name": "Microsoft.Eventhub.Namespaces", + "type": "Microsoft.EventGrid/topicTypes" + }, + { + "properties": { + "description": "Microsoft Storage service events.", + "displayName": "Storage Accounts", + "provider": "Microsoft.Storage", + "provisioningState": "Succeeded", + "resourceRegionType": "RegionalResource" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts", + "name": "Microsoft.Storage.StorageAccounts", + "type": "Microsoft.EventGrid/topicTypes" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_ListEventTypes.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_ListEventTypes.json new file mode 100644 index 000000000000..98e62df5aa9e --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/TopicTypes_ListEventTypes.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "topicTypeName": "Microsoft.Storage.StorageAccounts", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "displayName": "Blob Created", + "description": "Raised when a blob is created.", + "schemaUrl": "tbd" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobCreated", + "name": "Microsoft.Storage.BlobCreated", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + }, + { + "properties": { + "description": "Raised when a blob is deleted.", + "schemaUrl": "tbd", + "displayName": "Blob Deleted" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobDeleted", + "name": "Microsoft.Storage.BlobDeleted", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_CreateOrUpdate.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_CreateOrUpdate.json new file mode 100644 index 000000000000..5df2e89d6b4c --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_CreateOrUpdate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic1", + "api-version": "2020-04-01-preview", + "topicInfo": { + "location": "westus2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Delete.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Delete.json new file mode 100644 index 000000000000..8ad5954e6073 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Get.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Get.json new file mode 100644 index 000000000000..5a447d1cbf5a --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Get.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "location": "westcentralus", + "name": "exampletopic2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListByResourceGroup.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListByResourceGroup.json new file mode 100644 index 000000000000..26462c27abda --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + }, + { + "properties": { + "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "location": "westcentralus", + "name": "exampletopic2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListBySubscription.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListBySubscription.json new file mode 100644 index 000000000000..12aef1a81833 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListBySubscription.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + }, + { + "properties": { + "endpoint": "https://exampletopic2.westcentralus-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic2", + "location": "westcentralus", + "name": "exampletopic2", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListEventTypes.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListEventTypes.json new file mode 100644 index 000000000000..5e5180b28c06 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListEventTypes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "providerNamespace": "Microsoft.Storage", + "resourceTypeName": "storageAccounts", + "resourceName": "ExampleStorageAccount", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "Raised when a blob is created.", + "schemaUrl": "tbd", + "displayName": "Blob Created" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobCreated", + "name": "Microsoft.Storage.BlobCreated", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + }, + { + "properties": { + "description": "Raised when a blob is deleted.", + "schemaUrl": "tbd", + "displayName": "Blob Deleted" + }, + "id": "providers/Microsoft.EventGrid/topicTypes/Microsoft.Storage.StorageAccounts/eventTypes/Microsoft.Storage.BlobDeleted", + "name": "Microsoft.Storage.BlobDeleted", + "type": "Microsoft.EventGrid/topicTypes/eventTypes" + } + ] + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListSharedAccessKeys.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListSharedAccessKeys.json new file mode 100644 index 000000000000..069d13770226 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_ListSharedAccessKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic2", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "key1": "Rqfq5wWxtQnIQJyswP0Uh/hqQfDDMUOYyQSYEpx5e5g=", + "key2": "sesymbkIXMtZVqXEFHarJmdGmZjjnY+BZC8yRD/FeuA=" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_RegenerateKey.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_RegenerateKey.json new file mode 100644 index 000000000000..a60093e80029 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_RegenerateKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic2", + "api-version": "2020-04-01-preview", + "regenerateKeyRequest": { + "keyName": "key1" + } + }, + "responses": { + "200": { + "body": { + "key1": "Rqfq5wWxtQnIQJyswP0Uh/hqQfDDMUOYyQSYEpx5e5g=", + "key2": "sesymbkIXMtZVqXEFHarJmdGmZjjnY+BZC8yRD/FeuA=" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Update.json b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Update.json new file mode 100644 index 000000000000..71edda7cf0a7 --- /dev/null +++ b/specification/eventgrid/resource-manager/Microsoft.EventGrid/stable/2020-06-01/examples/Topics_Update.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "5b4b650e-28b9-4790-b3ab-ddbd88d727c4", + "resourceGroupName": "examplerg", + "topicName": "exampletopic1", + "api-version": "2020-04-01-preview", + "topicUpdateParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + } + } + }, + "responses": { + "200": {}, + "201": { + "body": { + "properties": { + "endpoint": "https://exampletopic1.westus2-1.eventgrid.azure.net/api/events", + "provisioningState": "Succeeded", + "publicNetworkAccess": "Enabled", + "inboundIpRules": [ + { + "ipMask": "12.18.30.15", + "action": "Allow" + }, + { + "ipMask": "12.18.176.1", + "action": "Allow" + } + ] + }, + "id": "/subscriptions/5b4b650e-28b9-4790-b3ab-ddbd88d727c4/resourceGroups/examplerg/providers/Microsoft.EventGrid/topics/exampletopic1", + "location": "westus2", + "name": "exampletopic1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.EventGrid/topics" + } + } + } +} diff --git a/specification/eventgrid/resource-manager/readme.go.md b/specification/eventgrid/resource-manager/readme.go.md index f1cac68b146f..a3120a996830 100644 --- a/specification/eventgrid/resource-manager/readme.go.md +++ b/specification/eventgrid/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-06 - tag: package-2020-04-preview - tag: package-2020-01-preview - tag: package-2019-06 @@ -25,6 +26,15 @@ batch: - tag: package-2017-06-preview ``` +### Tag: package-2020-06 and go + +These settings apply only when `--tag=package-2020-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-06' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-01/$(namespace) +``` + ### Tag: package-2020-04-preview and go These settings apply only when `--tag=package-2020-04-preview --go` is specified on the command line. @@ -43,7 +53,6 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.eventgrid.v2020_06_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/eventgrid/mgmt-v2020_06_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2020-04-preview and java These settings apply only when `--tag=package-2020-04-preview --java` is specified on the command line. diff --git a/specification/eventgrid/resource-manager/readme.md b/specification/eventgrid/resource-manager/readme.md index e6f25e877148..85b509c238ed 100644 --- a/specification/eventgrid/resource-manager/readme.md +++ b/specification/eventgrid/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the Azure EventGrid API. ``` yaml openapi-type: arm -tag: package-2020-04-preview +tag: package-2020-06 +``` + +### Tag: package-2020-06 + +These settings apply only when `--tag=package-2020-06` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06' +input-file: +- Microsoft.EventGrid/stable/2020-06-01/EventGrid.json ``` ### Tag: package-2020-04-preview @@ -47,7 +56,6 @@ input-file: - Microsoft.EventGrid/preview/2020-01-01-preview/EventGrid.json ``` - ### Tag: package-2019-06 These settings apply only when `--tag=package-2019-06` is specified on the command line. @@ -202,6 +210,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.EventGrid/stable/2020-06-01/EventGrid.json - $(this-folder)/Microsoft.EventGrid/preview/2020-04-01-preview/EventGrid.json - $(this-folder)/Microsoft.EventGrid/preview/2020-01-01-preview/EventGrid.json - $(this-folder)/Microsoft.EventGrid/stable/2019-06-01/EventGrid.json @@ -215,11 +224,10 @@ input-file: ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' -#exclude-file: +#exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - diff --git a/specification/eventgrid/resource-manager/readme.ruby.md b/specification/eventgrid/resource-manager/readme.ruby.md index 0d2823e2c8a9..18381c4c396e 100644 --- a/specification/eventgrid/resource-manager/readme.ruby.md +++ b/specification/eventgrid/resource-manager/readme.ruby.md @@ -12,6 +12,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2020-06 - tag: package-2020-04-preview - tag: package-2020-01-preview - tag: package-2019-06 @@ -24,6 +25,16 @@ batch: - tag: package-2017-06-preview ``` +### Tag: package-2020-06 and ruby +These settings apply only when `--tag=package-2020-06 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-06' && $(ruby) + +namespace: "Azure::EventGrid::Mgmt::V2020_06_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_event_grid/lib +``` + ### Tag: package-2020-01-preview and ruby These settings apply only when `--tag=package-2020-04-preview --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. From e3e0fff3be9befda4fd2cc18ee355b88b024fac7 Mon Sep 17 00:00:00 2001 From: Shangwei Sun <63389531+sunsw1994@users.noreply.github.com> Date: Tue, 2 Jun 2020 23:57:08 +0000 Subject: [PATCH 064/318] [HDInsight]-Add livyspark api spec for hdi. (#9469) * Add livyspark api spec for hdi. * Prettier check * Update code style. * fix comments * prettier check * Update the code in order to unify the naming rules. --- custom-words.txt | 2 + .../examples/HDI_Job_DeleteSparkBatch.json | 14 + .../HDI_Job_DeleteSparkSessionJob.json | 14 + .../HDI_Job_DeleteSparkStatementJob.json | 14 + .../examples/HDI_Job_Get.json | 4 +- .../examples/HDI_Job_GetAppState.json | 2 +- .../examples/HDI_Job_GetSparkBatchJob.json | 31 + .../examples/HDI_Job_GetSparkBatchLog.json | 29 + .../examples/HDI_Job_GetSparkBatchState.json | 14 + .../examples/HDI_Job_GetSparkSessionJob.json | 34 + .../examples/HDI_Job_GetSparkSessionLog.json | 29 + .../HDI_Job_GetSparkSessionState.json | 14 + .../HDI_Job_GetSparkStatementJob.json | 24 + .../examples/HDI_Job_Kill.json | 7 +- .../examples/HDI_Job_List.json | 2 +- .../examples/HDI_Job_ListAfterJobId.json | 2 +- .../examples/HDI_Job_ListSparkBatchJob.json | 38 + .../examples/HDI_Job_ListSparkSessionJob.json | 41 + .../HDI_Job_ListSparkStatementJob.json | 40 + .../examples/HDI_Job_SubmitHiveJob.json | 2 +- .../examples/HDI_Job_SubmitMapReduceJob.json | 2 +- .../HDI_Job_SubmitMapReduceStreamingJob.json | 2 +- .../examples/HDI_Job_SubmitPigJob.json | 2 +- .../examples/HDI_Job_SubmitSparkBatchJob.json | 47 + .../HDI_Job_SubmitSparkSessionJob.json | 44 + .../HDI_Job_SubmitSparkStatementJob.json | 22 + .../examples/HDI_Job_SubmitSqoopJob.json | 2 +- .../preview/2018-11-01-preview/job.json | 12 +- .../preview/2018-11-01-preview/livySpark.json | 1121 +++++++++++++++++ specification/hdinsight/data-plane/readme.md | 11 + 30 files changed, 1600 insertions(+), 22 deletions(-) create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkBatch.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkSessionJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkStatementJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchLog.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchState.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionLog.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionState.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkStatementJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkBatchJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkSessionJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkStatementJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkBatchJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkSessionJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkStatementJob.json create mode 100644 specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/livySpark.json diff --git a/custom-words.txt b/custom-words.txt index 15f8cccabb24..67cd81c107c0 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1781,3 +1781,5 @@ userprincipalname sessionstate sessionhosts hostpool +sparkr +ambari diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkBatch.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkBatch.json new file mode 100644 index 000000000000..c142db23107b --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkBatch.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "X-Requested-By": "admin", + "batchId": 123 + }, + "responses": { + "200": { + "body": { + "msg": "deleted" + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkSessionJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkSessionJob.json new file mode 100644 index 000000000000..1de611517d3d --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkSessionJob.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "x-Requested-By": "admin", + "sessionId": 123 + }, + "responses": { + "200": { + "body": { + "msg": "deleted" + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkStatementJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkStatementJob.json new file mode 100644 index 000000000000..66961d597b2f --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_DeleteSparkStatementJob.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "sessionId": 123, + "statementId": 123 + }, + "responses": { + "200": { + "body": { + "msg": "canceled" + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json index d6b5d8d8977d..c246f56679d8 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Get.json @@ -1,7 +1,7 @@ { "parameters": { "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", + "endpoint": "cluster.azurehdinsight.net", "jobId": "job_1542085634998_0024", "fields": "*" }, @@ -62,9 +62,7 @@ "callback": null, "completed": "done", "userargs": { - "statusdir": "2018-11-13T05-49-52-4418fce1-e92e-4732-bc12-f2a3b8ef4432", "file": null, - "enablejobreconnect": null, "define": [], "enablelog": "false", "files": null, diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json index 7706db1f395a..50263f2566c5 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetAppState.json @@ -1,7 +1,7 @@ { "parameters": { "appId": "application_1462754318084_0071", - "clusterDnsName": "cluster.azurehdinsight.net" + "endpoint": "cluster.azurehdinsight.net" }, "responses": { "200": { diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchJob.json new file mode 100644 index 000000000000..8834c36eba62 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchJob.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "batchId": 45 + }, + "responses": { + "200": { + "body": { + "id": 45, + "appId": null, + "appInfo": { + "driverLogUrl": null, + "sparkUiUrl": null + }, + "state": "starting", + "log": [ + "\t queue: default", + "\t start time: 1590386942572", + "\t final status: UNDEFINED", + "\t tracking URL: https://shangwei-hdi-cmk-ps.azurehdinsight.net/yarnui/hn/proxy/application_1590286636717_0005/", + "\t user: livy", + "20/05/25 06:09:02 INFO ShutdownHookManager: Shutdown hook called", + "20/05/25 06:09:02 INFO ShutdownHookManager: Deleting directory /tmp/spark-9ddb6d73-f204-44a4-83e8-afdbd4ce1a0b", + "20/05/25 06:09:02 INFO ShutdownHookManager: Deleting directory /tmp/spark-ef198a0d-de24-4da9-aeb5-c1b78c5fdd5c", + "\nstderr: ", + "\nYARN Diagnostics: " + ] + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchLog.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchLog.json new file mode 100644 index 000000000000..19b0c392ee7e --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchLog.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "batchId": 45, + "from": 1, + "size": 10 + }, + "responses": { + "200": { + "body": { + "id": 45, + "from": 1, + "size": 10, + "log": [ + "SLF4J: Class path contains multiple SLF4J bindings.", + "SLF4J: Found binding in [jar:file:/usr/hdp/2.6.5.3015-8/spark2/jars/slf4j-log4j12-1.7.16.jar!/org/slf4j/impl/StaticLoggerBinder.class]", + "SLF4J: Found binding in [jar:file:/usr/hdp/2.6.5.3015-8/spark_llap/spark-llap-assembly-1.0.0.2.6.5.3015-8.jar!/org/slf4j/impl/StaticLoggerBinder.class]", + "SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.", + "SLF4J: Actual binding is of type [org.slf4j.impl.Log4jLoggerFactory]", + "Warning: Master yarn-cluster is deprecated since 2.0. Please use master \"yarn\" with specified deploy mode instead.", + "20/05/25 06:08:59 WARN NativeCodeLoader: Unable to load native-hadoop library for your platform... using builtin-java classes where applicable", + "Warning: Skip remote jar wasbs://containercmk002@shangweistorageaccount.blob.core.windows.net/microsoft-spark-2.3.x-0.6.0.jar.", + "20/05/25 06:08:59 INFO MetricsConfig: loaded properties from hadoop-metrics2-azure-file-system.properties", + "20/05/25 06:08:59 INFO WasbAzureIaasSink: Init starting." + ] + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchState.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchState.json new file mode 100644 index 000000000000..c3444effea60 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkBatchState.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "batchId": 45 + }, + "responses": { + "200": { + "body": { + "id": 45, + "state": "starting" + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionJob.json new file mode 100644 index 000000000000..5008f9c51d27 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionJob.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "sessionId": 123 + }, + "responses": { + "200": { + "body": { + "id": 34, + "appId": "application_1590286636717_0004", + "owner": null, + "proxyUser": null, + "state": "idle", + "kind": "spark", + "appInfo": { + "driverLogUrl": "http://wn2-shangw.4jhwm2oxfmoehnhvt2gwwtriqb.bx.internal.cloudapp.net:30060/node/containerlogs/container_e06_1590286636717_0004_01_000001/livy", + "sparkUiUrl": "https://shangwei-hdi-cmk-ps.azurehdinsight.net/yarnui/hn/proxy/application_1590286636717_0004/" + }, + "log": [ + "\t ApplicationMaster RPC port: -1", + "\t queue: default", + "\t start time: 1590384019312", + "\t final status: UNDEFINED", + "\t tracking URL: https://shangwei-hdi-cmk-ps.azurehdinsight.net/yarnui/hn/proxy/application_1590286636717_0004/", + "\t user: livy", + "20/05/25 05:20:19 INFO ShutdownHookManager: Shutdown hook called", + "20/05/25 05:20:19 INFO ShutdownHookManager: Deleting directory /tmp/spark-1557a190-880c-422d-a744-ce31d0fefa1d", + "20/05/25 05:20:19 INFO ShutdownHookManager: Deleting directory /tmp/spark-12bb0346-a2c9-4b9d-9f9b-feb91e30f554", + "\nYARN Diagnostics: " + ] + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionLog.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionLog.json new file mode 100644 index 000000000000..d2846f9b62ae --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionLog.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "sessionId": 34, + "from": 1, + "size": 10 + }, + "responses": { + "200": { + "body": { + "id": 34, + "from": 0, + "total": 57, + "log": [ + "stdout: ", + "\nstderr: ", + "SLF4J: Class path contains multiple SLF4J bindings.", + "SLF4J: Found binding in [jar:file:/usr/hdp/2.6.5.3015-8/spark2/jars/slf4j-log4j12-1.7.16.jar!/org/slf4j/impl/StaticLoggerBinder.class]", + "SLF4J: Found binding in [jar:file:/usr/hdp/2.6.5.3015-8/spark_llap/spark-llap-assembly-1.0.0.2.6.5.3015-8.jar!/org/slf4j/impl/StaticLoggerBinder.class]", + "SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.", + "SLF4J: Actual binding is of type [org.slf4j.impl.Log4jLoggerFactory]", + "Warning: Master yarn-cluster is deprecated since 2.0. Please use master \"yarn\" with specified deploy mode instead.", + "20/05/25 05:20:14 WARN NativeCodeLoader: Unable to load native-hadoop library for your platform... using builtin-java classes where applicable", + "20/05/25 05:20:15 INFO MetricsConfig: loaded properties from hadoop-metrics2-azure-file-system.properties" + ] + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionState.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionState.json new file mode 100644 index 000000000000..3c73a94ce528 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkSessionState.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "sessionId": 34 + }, + "responses": { + "200": { + "body": { + "id": 34, + "state": "idle" + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkStatementJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkStatementJob.json new file mode 100644 index 000000000000..1c45ad23b01c --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_GetSparkStatementJob.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "sessionId": 34, + "statementId": 1 + }, + "responses": { + "200": { + "body": { + "id": 0, + "code": "1 + 1", + "state": "available", + "output": { + "status": "ok", + "execution_count": 0, + "data": { + "text/plain": "res0: Int = 2" + } + }, + "progress": 1.0 + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json index a5574d18d08e..d0b67543a848 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_Kill.json @@ -1,7 +1,7 @@ { "parameters": { "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", + "endpoint": "cluster.azurehdinsight.net", "jobId": "job_1542085634998_0007" }, "responses": { @@ -62,7 +62,6 @@ "completed": null, "userargs": { "statusdir": "2018-11-13T05-35-01-6f79af0f-6157-494a-a03e-eabb190a0c10", - "enablejobreconnect": null, "arg": [ "10", "1000" @@ -73,11 +72,9 @@ "mapreduce.task.timeout=60000" ], "enablelog": "false", - "libjars": null, "files": null, "callback": null, - "jar": "/example/jars/hadoop-mapreduce-examples.jar", - "class": "pi" + "jar": "/example/jars/hadoop-mapreduce-examples.jar" }, "msg": null } diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json index b4f85d1dd7a7..d19c3bc9109e 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_List.json @@ -1,7 +1,7 @@ { "parameters": { "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", + "endpoint": "cluster.azurehdinsight.net", "fields": "*", "showall": "true" }, diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json index c1c106808005..0fea23c34a31 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListAfterJobId.json @@ -1,7 +1,7 @@ { "parameters": { "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", + "endpoint": "cluster.azurehdinsight.net", "jobId": "job_1542085634998_0029", "numrecords": 3, "fields": "*", diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkBatchJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkBatchJob.json new file mode 100644 index 000000000000..3c7db0140439 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkBatchJob.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "clustername.azurehdinsight.net", + "from": 0, + "size": 1 + }, + "responses": { + "200": { + "body": { + "from": 0, + "total": 1, + "sessions": [ + { + "id": 44, + "state": "starting", + "appId": null, + "appInfo": { + "driverLogUrl": null, + "sparkUiUrl": null + }, + "log": [ + "20/05/25 04:59:18 WARN NativeCodeLoader: Unable to load native-hadoop library for your platform... using builtin-java classes where applicable", + "Warning: Skip remote jar wasbs://containercmk002@shangweistorageaccount.blob.core.windows.net/microsoft-spark-2.3.x-0.6.0.jar.", + "20/05/25 04:59:18 INFO MetricsConfig: loaded properties from hadoop-metrics2-azure-file-system.properties", + "20/05/25 04:59:18 INFO WasbAzureIaasSink: Init starting.", + "20/05/25 04:59:18 INFO AzureIaasSink: Init starting. Initializing MdsLogger.", + "20/05/25 04:59:18 INFO AzureIaasSink: Init completed.", + "20/05/25 04:59:18 INFO WasbAzureIaasSink: Init completed.", + "20/05/25 04:59:18 INFO MetricsSinkAdapter: Sink azurefs2 started", + "\nstderr: ", + "\nYARN Diagnostics: " + ] + } + ] + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkSessionJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkSessionJob.json new file mode 100644 index 000000000000..30f7a88887a4 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkSessionJob.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "from": 0, + "size": 1 + }, + "responses": { + "200": { + "body": { + "from": 0, + "total": 1, + "sessions": [ + { + "id": 34, + "appId": "application_1590286636717_0004", + "owner": null, + "proxyUser": null, + "state": "idle", + "kind": "spark", + "appInfo": { + "driverLogUrl": "http://wn2-shangw.4jhwm2oxfmoehnhvt2gwwtriqb.bx.internal.cloudapp.net:30060/node/containerlogs/container_e06_1590286636717_0004_01_000001/livy", + "sparkUiUrl": "https://shangwei-hdi-cmk-ps.azurehdinsight.net/yarnui/hn/proxy/application_1590286636717_0004/" + }, + "log": [ + "\t ApplicationMaster RPC port: -1", + "\t queue: default", + "\t start time: 1590384019312", + "\t final status: UNDEFINED", + "\t tracking URL: https://shangwei-hdi-cmk-ps.azurehdinsight.net/yarnui/hn/proxy/application_1590286636717_0004/", + "\t user: livy", + "20/05/25 05:20:19 INFO ShutdownHookManager: Shutdown hook called", + "20/05/25 05:20:19 INFO ShutdownHookManager: Deleting directory /tmp/spark-1557a190-880c-422d-a744-ce31d0fefa1d", + "20/05/25 05:20:19 INFO ShutdownHookManager: Deleting directory /tmp/spark-12bb0346-a2c9-4b9d-9f9b-feb91e30f554", + "\nYARN Diagnostics: " + ] + } + ] + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkStatementJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkStatementJob.json new file mode 100644 index 000000000000..3e447a4f4318 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_ListSparkStatementJob.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "sessionId": 34 + }, + "responses": { + "200": { + "body": { + "statements": [ + { + "id": 0, + "code": "1 + 1", + "state": "available", + "output": { + "status": "ok", + "execution_count": 0, + "data": { + "text/plain": "res0: Int = 2" + } + }, + "progress": 1.0 + }, + { + "id": 1, + "code": "1 + 1", + "state": "available", + "output": { + "status": "ok", + "execution_count": 1, + "data": { + "text/plain": "res1: Int = 2" + } + }, + "progress": 1.0 + } + ] + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json index 314b5c13f31d..bcd62e40bfde 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitHiveJob.json @@ -1,7 +1,7 @@ { "parameters": { "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", + "endpoint": "cluster.azurehdinsight.net", "content": "execute=select%20querydwelltime%2B2%20from%20hivesampletable%20where%20clientid%20%3D%208&statusdir=2018-10-30T10-13-36-30513317-c398-4da0-a98c-57db43750f3a" }, "responses": { diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json index 5cf12f4e0d8f..9a13c808f75a 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceJob.json @@ -1,7 +1,7 @@ { "parameters": { "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", + "endpoint": "cluster.azurehdinsight.net", "content": "jar=%2Fexample%2Fjars%2Fhadoop-mapreduce-examples.jar&class=pi&arg=10&arg=1000&define=mapreduce.map.maxattempts%3D10&define=mapreduce.reduce.maxattempts%3D10&define=mapreduce.task.timeout%3D60000&statusdir=2018-10-30T10-12-29-595ef52d-583c-4b17-987b-675e4f8eea8f" }, "responses": { diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json index b3cb16e542b2..506c4135ff63 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitMapReduceStreamingJob.json @@ -1,7 +1,7 @@ { "parameters": { "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", + "endpoint": "cluster.azurehdinsight.net", "content": "input=%2Fexample%2Fdata%2Fgutenberg%2Fdavinci.txt&output=%2Fexample%2Fdata%2Fgutenberg%2Fwcount%2F3745c39c-0115-4735-a9eb-c57de9a29dcd&mapper=cat&reducer=wc&statusdir=2018-10-30T11-40-44-eb9dc5c1-99dd-4282-9d4a-a77c8ffb6b35" }, "responses": { diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json index 95f0e96fafde..ad2da4c1f308 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitPigJob.json @@ -1,7 +1,7 @@ { "parameters": { "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", + "endpoint": "cluster.azurehdinsight.net", "content": "execute=LOGS%20%3D%20LOAD%20%27wasb%3A%2F%2F%2Fexample%2Fdata%2Fsample.log%27%3BLEVELS%20%3D%20foreach%20LOGS%20generate%20REGEX_EXTRACT%28%240%2C%20%27%28TRACE%7CDEBUG%7CINFO%7CWARN%7CERROR%7CFATAL%29%27%2C%201%29%20%20as%20LOGLEVEL%3BFILTEREDLEVELS%20%3D%20FILTER%20LEVELS%20by%20LOGLEVEL%20is%20not%20null%3BGROUPEDLEVELS%20%3D%20GROUP%20FILTEREDLEVELS%20by%20LOGLEVEL%3BFREQUENCIES%20%3D%20foreach%20GROUPEDLEVELS%20generate%20group%20as%20LOGLEVEL%2C%20COUNT%28FILTEREDLEVELS.LOGLEVEL%29%20as%20COUNT%3BRESULT%20%3D%20order%20FREQUENCIES%20by%20COUNT%20desc%3BDUMP%20RESULT%3B&statusdir=2018-10-30T12-44-24-bd642975-9a89-4480-aea7-3ee1f34016ec" }, "responses": { diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkBatchJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkBatchJob.json new file mode 100644 index 000000000000..9090b5329746 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkBatchJob.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "X-Requested-By": "admin", + "sparkBatchJobRequest": { + "file": "wasbs://containercmk002@shangweistorageaccount.blob.core.windows.net/microsoft-spark-2.3.x-0.6.0.jar", + "proxyUser": "", + "className": "org.apache.spark.deploy.dotnet.DotnetRunner12", + "args": [ + "wasbs://containercmk002@shangweistorageaccount.blob.core.windows.net/wordcount.zip", + "WordCount", + "wasbs://containercmk002@shangweistorageaccount.blob.core.windows.net/user/sshroot/shakespeare.txt", + "wasbs://containercmk002@shangweistorageaccount.blob.core.windows.net/user/sshroot/result_livy.txt" + ], + "jars": [], + "pyFiles": [], + "files": [], + "driverMemory": "4g", + "driverCores": 4, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2, + "archives": [], + "queue": "default", + "name": "jobname", + "conf": null + } + }, + "responses": { + "201": { + "body": { + "id": 46, + "state": "starting", + "appId": null, + "appInfo": { + "driverLogUrl": null, + "sparkUiUrl": null + }, + "log": [ + "stdout: ", + "\nstderr: ", + "\nYARN Diagnostics: " + ] + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkSessionJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkSessionJob.json new file mode 100644 index 000000000000..cc0c91872f3e --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkSessionJob.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "X-Requested-By": "admin", + "sparkSessionJobRequest": { + "kind": "spark", + "proxyUser": "", + "jars": [], + "pyFiles": [], + "files": [], + "driverMemory": "4g", + "driverCores": 4, + "executorMemory": "2g", + "executorCores": 2, + "numExecutors": 2, + "archives": [], + "queue": "default", + "name": "jobname", + "conf": null, + "heartbeatTimeoutInSecond": 0 + } + }, + "responses": { + "201": { + "body": { + "id": 34, + "appId": null, + "owner": null, + "proxyUser": null, + "kind": "spark", + "state": "starting", + "log": [ + "stdout: ", + "\nstderr: ", + "\nYARN Diagnostics: " + ], + "appInfo": { + "driverLogUrl": null, + "sparkUiUrl": null + } + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkStatementJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkStatementJob.json new file mode 100644 index 000000000000..0a288511d8aa --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSparkStatementJob.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "cluster.azurehdinsight.net", + "X-Requested-By": "admin", + "sessionId": 34, + "sparkStatementRequest": { + "code": "1 + 1", + "kind": "spark" + } + }, + "responses": { + "201": { + "body": { + "id": 0, + "code": "1 + 1", + "state": "waiting", + "output": null, + "progress": 0.0 + } + } + } +} diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json index 2c26b24f605d..eddc3cb5cded 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/examples/HDI_Job_SubmitSqoopJob.json @@ -1,7 +1,7 @@ { "parameters": { "user.name": "admin", - "clusterDnsName": "cluster.azurehdinsight.net", + "endpoint": "cluster.azurehdinsight.net", "content": "command=import%20--connect%20jdbc%3Asqlserver%3A%2F%2Fdongwwahdi.database.windows.net%3A1433%3Bdatabase%3DHdInsightJobTest%3Buser%3Ddongwwaadmin%3Bpassword%3DHDInsight123%21%3B%20--table%20dept%20--warehouse-dir%20%2Fuser%2Fadmin%2Fsqoop%2F25c8b9f9-dbc1-4096-aa42-45f2868ab782%20--hive-import%20-m%201%20--hive-table%20deptd3175062928d4170831ac17d2eefdaeb&statusdir=SqoopStatus" }, "responses": { diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json index 9faa6c4282c0..544f3e29c9c8 100644 --- a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/job.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "title": "HDInsightJobManagementClient", + "title": "HDInsightJobClient", "description": "The HDInsight Job Client.", "version": "2018-11-01-preview", "x-ms-code-generation-settings": { @@ -9,10 +9,10 @@ } }, "x-ms-parameterized-host": { - "hostTemplate": "{clusterDnsName}", + "hostTemplate": "{endpoint}", "parameters": [ { - "$ref": "#/parameters/clusterDnsNameParameter" + "$ref": "#/parameters/endpointParameter" } ] }, @@ -911,13 +911,13 @@ } }, "parameters": { - "clusterDnsNameParameter": { - "name": "clusterDnsName", + "endpointParameter": { + "name": "endpoint", "in": "path", "required": true, "type": "string", "x-ms-skip-url-encoding": true, - "description": "The cluster dns name against which the job management is to be.", + "description": "The cluster endpoint, for example https://clustername.azurehdinsight.net.", "x-ms-parameter-location": "client" }, "UserNameParameter": { diff --git a/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/livySpark.json b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/livySpark.json new file mode 100644 index 000000000000..d5cbc84df867 --- /dev/null +++ b/specification/hdinsight/data-plane/Microsoft.HDInsight/preview/2018-11-01-preview/livySpark.json @@ -0,0 +1,1121 @@ +{ + "swagger": "2.0", + "info": { + "title": "HDInsightJobClient", + "description": "The HDInsight Job Client.", + "version": "2018-11-01-preview", + "x-ms-code-generation-settings": { + "internalConstructors": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "parameters": [ + { + "$ref": "#/parameters/endpointParameter" + } + ] + }, + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/livy/batches": { + "get": { + "tags": [ + "Job" + ], + "description": "List all spark batch jobs", + "operationId": "Job_ListSparkBatchJob", + "x-ms-examples": { + "List all spark batch jobs": { + "$ref": "./examples/HDI_Job_ListSparkBatchJob.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "from", + "in": "query", + "description": "Optional param specifying which index the list should begin from.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "size", + "in": "query", + "description": "Optional param specifying the size of the returned list.\r\n By default it is 20 and that is the maximum.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkBatchJobCollection" + } + } + } + }, + "post": { + "tags": [ + "Job" + ], + "description": "Create a new spark batch job.", + "operationId": "Job_SubmitSparkBatchJob", + "x-ms-examples": { + "Create a spark batch job": { + "$ref": "./examples/HDI_Job_SubmitSparkBatchJob.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/requestedByParameter" + }, + { + "name": "sparkBatchJobRequest", + "in": "body", + "description": "Livy compatible batch job request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/SparkBatchJobRequest" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SparkBatchJob" + } + } + } + } + }, + "/livy/batches/{batchId}": { + "get": { + "tags": [ + "Job" + ], + "description": "Gets a single spark batch job.", + "operationId": "Job_GetSparkBatchJob", + "x-ms-examples": { + "Gets a single spark batch job": { + "$ref": "./examples/HDI_Job_GetSparkBatchJob.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "batchId", + "in": "path", + "description": "Identifier for the batch job.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkBatchJob" + } + } + } + }, + "delete": { + "tags": [ + "Job" + ], + "description": "Cancels a running spark batch job.", + "operationId": "Job_DeleteSparkBatch", + "x-ms-examples": { + "Cancels a running spark batch job": { + "$ref": "./examples/HDI_Job_DeleteSparkBatch.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/requestedByParameter" + }, + { + "name": "batchId", + "in": "path", + "description": "Identifier for the batch job.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkJobDeletedResult" + } + } + } + } + }, + "/livy/batches/{batchId}/log": { + "get": { + "tags": [ + "Job" + ], + "description": "Gets a single spark batch job logs.", + "operationId": "Job_GetSparkBatchLog", + "x-ms-examples": { + "Gets a single spark batch job logs": { + "$ref": "./examples/HDI_Job_GetSparkBatchLog.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "batchId", + "in": "path", + "description": "Identifier for the batch job.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "from", + "in": "query", + "description": "Optional param specifying which index the list should begin from.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "size", + "in": "query", + "description": "Optional param specifying the size of the returned list.\r\n By default it is 20 and that is the maximum.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkJobLog" + } + } + } + } + }, + "/livy/batches/{batchId}/state": { + "get": { + "tags": [ + "Job" + ], + "description": "Gets a single spark batch state.", + "operationId": "Job_GetSparkBatchState", + "x-ms-examples": { + "Gets a single spark batch state": { + "$ref": "./examples/HDI_Job_GetSparkBatchState.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "batchId", + "in": "path", + "description": "Identifier for the batch job.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkJobState" + } + } + } + } + }, + "/livy/sessions": { + "get": { + "tags": [ + "Job" + ], + "description": "List all spark sessions.", + "operationId": "Job_ListSparkSessionJob", + "x-ms-examples": { + "List all spark sessions": { + "$ref": "./examples/HDI_Job_ListSparkSessionJob.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "from", + "in": "query", + "description": "Optional param specifying which index the list should begin from.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "size", + "in": "query", + "description": "Optional param specifying the size of the returned list.\r\n By default it is 20 and that is the maximum.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkSessionCollection" + } + } + } + }, + "post": { + "tags": [ + "Job" + ], + "description": "Create a new spark session.", + "operationId": "Job_SubmitSparkSessionJob", + "x-ms-examples": { + "Create a new spark session": { + "$ref": "./examples/HDI_Job_SubmitSparkSessionJob.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/requestedByParameter" + }, + { + "name": "sparkSessionJobRequest", + "in": "body", + "description": "Livy compatible session job request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/SparkSessionJobRequest" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SparkSessionJob" + } + } + } + } + }, + "/livy/sessions/{sessionId}": { + "get": { + "tags": [ + "Job" + ], + "description": "Gets a single spark session.", + "operationId": "Job_GetSparkSessionJob", + "x-ms-examples": { + "Gets a single spark session": { + "$ref": "./examples/HDI_Job_GetSparkSessionJob.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkSessionJob" + } + } + } + }, + "delete": { + "tags": [ + "Job" + ], + "description": "Cancels a running spark session.", + "operationId": "Job_DeleteSparkSessionJob", + "x-ms-examples": { + "Cancels a running spark session": { + "$ref": "./examples/HDI_Job_DeleteSparkSessionJob.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/requestedByParameter" + }, + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkJobDeletedResult" + } + } + } + } + }, + "/livy/sessions/{sessionId}/log": { + "get": { + "tags": [ + "Job" + ], + "description": "Gets a single spark session job logs.", + "operationId": "Job_GetSparkSessionLog", + "x-ms-examples": { + "Gets a single spark session job logs": { + "$ref": "./examples/HDI_Job_GetSparkSessionLog.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session job.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "from", + "in": "query", + "description": "Optional param specifying which index the list should begin from.", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "size", + "in": "query", + "description": "Optional param specifying the size of the returned list.\r\n By default it is 20 and that is the maximum.", + "required": false, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkJobLog" + } + } + } + } + }, + "/livy/sessions/{sessionId}/state": { + "get": { + "tags": [ + "Job" + ], + "description": "Gets a single spark session job state.", + "operationId": "Job_GetSparkSessionState", + "x-ms-examples": { + "Gets a single spark session job state": { + "$ref": "./examples/HDI_Job_GetSparkSessionState.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session job.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkJobState" + } + } + } + } + }, + "/livy/sessions/{sessionId}/statements": { + "get": { + "tags": [ + "Job" + ], + "description": "Gets a list of statements within a spark session.", + "operationId": "Job_ListSparkStatementJob", + "x-ms-examples": { + "Gets a list of statements within a spark session": { + "$ref": "./examples/HDI_Job_ListSparkStatementJob.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkStatementCollection" + } + } + } + }, + "post": { + "tags": [ + "Job" + ], + "description": "Create a statement within a spark session.", + "operationId": "Job_SubmitSparkStatementJob", + "x-ms-examples": { + "Create a statement within a spark session": { + "$ref": "./examples/HDI_Job_SubmitSparkStatementJob.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/requestedByParameter" + }, + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "sparkStatementRequest", + "in": "body", + "description": "Livy compatible batch job request payload.", + "required": true, + "schema": { + "$ref": "#/definitions/SparkStatementRequest" + } + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SparkStatement" + } + } + } + } + }, + "/livy/sessions/{sessionId}/statements/{statementId}": { + "get": { + "tags": [ + "Job" + ], + "description": "Gets a single statement within a spark session.", + "operationId": "Job_GetSparkStatementJob", + "x-ms-examples": { + "Gets a single statement within a spark session": { + "$ref": "./examples/HDI_Job_GetSparkStatementJob.json" + } + }, + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "statementId", + "in": "path", + "description": "Identifier for the statement.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkStatement" + } + } + } + } + }, + "/livy/sessions/{sessionId}/statements/{statementId}/cancel": { + "post": { + "tags": [ + "Job" + ], + "description": "Kill a statement within a session.", + "operationId": "Job_DeleteSparkStatementJob", + "x-ms-examples": { + "Kill a statement within a session": { + "$ref": "./examples/HDI_Job_DeleteSparkStatementJob.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/requestedByParameter" + }, + { + "name": "sessionId", + "in": "path", + "description": "Identifier for the session.", + "required": true, + "type": "integer", + "format": "int32" + }, + { + "name": "statementId", + "in": "path", + "description": "Identifier for the statement.", + "required": true, + "type": "integer", + "format": "int32" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/SparkStatementCancellationResult" + } + } + } + } + } + }, + "definitions": { + "SparkBatchJobCollection": { + "type": "object", + "properties": { + "from": { + "format": "int32", + "type": "integer" + }, + "total": { + "format": "int32", + "type": "integer" + }, + "sessions": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SparkBatchJob" + } + } + } + }, + "SparkBatchJob": { + "type": "object", + "properties": { + "id": { + "format": "int32", + "type": "integer" + }, + "appId": { + "type": "string" + }, + "appInfo": { + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "state": { + "type": "string" + }, + "log": { + "x-ms-client-name": "logLines", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SparkBatchJobRequest": { + "type": "object", + "properties": { + "file": { + "type": "string" + }, + "proxyUser": { + "type": "string" + }, + "className": { + "type": "string" + }, + "args": { + "x-ms-client-name": "arguments", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "jars": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "pyFiles": { + "x-ms-client-name": "pythonFiles", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "driverMemory": { + "type": "string" + }, + "driverCores": { + "format": "int32", + "type": "integer" + }, + "executorMemory": { + "type": "string" + }, + "executorCores": { + "format": "int32", + "type": "integer" + }, + "numExecutors": { + "x-ms-client-name": "executorCount", + "format": "int32", + "type": "integer" + }, + "archives": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "queue": { + "type": "string" + }, + "name": { + "type": "string" + }, + "conf": { + "x-ms-client-name": "configuration", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SparkSessionCollection": { + "type": "object", + "properties": { + "from": { + "format": "int32", + "type": "integer" + }, + "total": { + "format": "int32", + "type": "integer" + }, + "sessions": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SparkSessionJob" + } + } + } + }, + "SparkSessionJob": { + "type": "object", + "properties": { + "id": { + "format": "int32", + "type": "integer" + }, + "appId": { + "type": "string" + }, + "owner": { + "type": "string" + }, + "proxyUser": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "log": { + "x-ms-client-name": "logLines", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "state": { + "type": "string" + }, + "appInfo": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SparkSessionJobRequest": { + "type": "object", + "properties": { + "kind": { + "type": "string", + "x-ms-enum": { + "name": "SessionJobKind", + "modelAsString": true + }, + "enum": [ + "spark", + "pyspark", + "sparkr", + "sql" + ] + }, + "proxyUser": { + "type": "string" + }, + "jars": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "pyFiles": { + "x-ms-client-name": "pythonFiles", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "files": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "driverMemory": { + "type": "string" + }, + "driverCores": { + "format": "int32", + "type": "integer" + }, + "executorMemory": { + "type": "string" + }, + "executorCores": { + "format": "int32", + "type": "integer" + }, + "numExecutors": { + "x-ms-client-name": "executorCount", + "format": "int32", + "type": "integer" + }, + "archives": { + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, + "queue": { + "type": "string" + }, + "name": { + "type": "string" + }, + "conf": { + "x-ms-client-name": "configuration", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "heartbeatTimeoutInSecond": { + "format": "int32", + "type": "integer" + } + } + }, + "SparkJobLog": { + "type": "object", + "properties": { + "id": { + "format": "int32", + "type": "integer" + }, + "from": { + "format": "int32", + "type": "integer" + }, + "size": { + "format": "int32", + "type": "integer" + }, + "total": { + "format": "int64", + "type": "integer" + }, + "log": { + "x-ms-client-name": "logLines", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SparkJobState": { + "type": "object", + "properties": { + "id": { + "format": "int32", + "type": "integer" + }, + "state": { + "type": "string" + } + } + }, + "SparkStatementCollection": { + "type": "object", + "properties": { + "statements": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SparkStatement" + } + } + } + }, + "SparkStatement": { + "type": "object", + "properties": { + "id": { + "format": "int32", + "type": "integer" + }, + "code": { + "type": "string" + }, + "state": { + "type": "string" + }, + "output": { + "$ref": "#/definitions/SparkStatementOutput" + }, + "progress": { + "type": "number", + "format": "double" + } + } + }, + "SparkStatementOutput": { + "type": "object", + "properties": { + "status": { + "type": "string" + }, + "execution_count": { + "format": "int32", + "type": "integer" + }, + "data": { + "type": "object" + } + } + }, + "SparkStatementRequest": { + "type": "object", + "properties": { + "code": { + "type": "string" + }, + "kind": { + "type": "string" + } + } + }, + "SparkStatementCancellationResult": { + "type": "object", + "properties": { + "msg": { + "x-ms-client-name": "cancelMessage", + "type": "string" + } + } + }, + "SparkJobDeletedResult": { + "type": "object", + "properties": { + "msg": { + "x-ms-client-name": "deletedMessage", + "type": "string" + } + } + } + }, + "parameters": { + "requestedByParameter": { + "name": "X-Requested-By", + "x-ms-parameter-location": "method", + "x-ms-client-name": "requestedBy", + "description": "Add default value for X-Requested-By in header.", + "in": "header", + "required": false, + "default": "ambari", + "type": "string" + }, + "endpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The cluster endpoint, for example https://clustername.azurehdinsight.net.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/hdinsight/data-plane/readme.md b/specification/hdinsight/data-plane/readme.md index ffd1eb557e82..7116c5692305 100644 --- a/specification/hdinsight/data-plane/readme.md +++ b/specification/hdinsight/data-plane/readme.md @@ -36,8 +36,18 @@ These settings apply only when `--tag=package-2018-11-preview` is specified on t ``` yaml $(tag) == 'package-2018-11-preview' input-file: - Microsoft.HDInsight/preview/2018-11-01-preview/job.json +- Microsoft.HDInsight/preview/2018-11-01-preview/livySpark.json ``` +## Suppression +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: This would require a breaking change, and need to be consistent with the response from RP side. + from: livySpark.json + where: + - $.definitions.SparkStatementOutput.properties.execution_count +``` --- # Code Generation @@ -146,6 +156,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/Microsoft.HDInsight/preview/2018-11-01-preview/job.json + - $(this-folder)/Microsoft.HDInsight/preview/2018-11-01-preview/livySpark.json ``` From 170dbe19c7da0be95c88c02f14784cb72de2a1f3 Mon Sep 17 00:00:00 2001 From: gkgaurav31 Date: Wed, 3 Jun 2020 07:26:28 +0530 Subject: [PATCH 065/318] updated AppServicePlan doc (#9679) --- .../Microsoft.Web/stable/2019-08-01/AppServicePlans.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/AppServicePlans.json b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/AppServicePlans.json index 487977095b1c..c5b99cff768f 100644 --- a/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/AppServicePlans.json +++ b/specification/web/resource-manager/Microsoft.Web/stable/2019-08-01/AppServicePlans.json @@ -1540,7 +1540,7 @@ "readOnly": true }, "reserved": { - "description": "If Linux app service plan true, false otherwise.", + "description": "This needs to set to true when creating a Linux App Service Plan, along with kind set to Linux. It should be false otherwise.", "default": false, "type": "boolean", "x-ms-mutability": [ From 9dc64d8a540c416be8b9a7b1992bc9c7ccf7d063 Mon Sep 17 00:00:00 2001 From: Chuang <54572251+xccc-msft@users.noreply.github.com> Date: Wed, 3 Jun 2020 09:57:02 +0800 Subject: [PATCH 066/318] Kusto: update java readme (#9576) --- .../azure-kusto/resource-manager/readme.java.md | 14 ++++++++++++++ 1 file changed, 14 insertions(+) diff --git a/specification/azure-kusto/resource-manager/readme.java.md b/specification/azure-kusto/resource-manager/readme.java.md index d8a5cd934f22..aa1b6240aba8 100644 --- a/specification/azure-kusto/resource-manager/readme.java.md +++ b/specification/azure-kusto/resource-manager/readme.java.md @@ -17,6 +17,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-kusto ``` yaml $(java) && $(multiapi) batch: - tag: package-2019-11-09 + - tag: package-2020-02-15 ``` ### Tag: package-2018-09-07-preview and java @@ -82,4 +83,17 @@ java: output-folder: $(azure-libraries-for-java-folder)/sdk/kusto/mgmt-v2019_11_09 regenerate-manager: true generate-interface: true +``` + +### Tag: package-2020-02-15 and java + +These settings apply only when `--tag=package-2020-02-15 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-02-15' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.kusto.v2020_02_15 + output-folder: $(azure-libraries-for-java-folder)/sdk/kusto/mgmt-v2020_02_15 +regenerate-manager: true +generate-interface: true ``` \ No newline at end of file From d1e213a087b87f469dc78e261404c7691bba7631 Mon Sep 17 00:00:00 2001 From: Rahul Singh <53578268+rahuls-microsoft@users.noreply.github.com> Date: Tue, 2 Jun 2020 18:59:23 -0700 Subject: [PATCH 067/318] Updating Patch API description. (#9676) * Updating operationId to group the opearions in a logical way and the generate APIs are grouped together based on the operations. * 1. Updating schema for autoQuotaRequest 2. Updating examples. * Updates to data model and examples. * Model Update. * Data Model Fix. * Fixing Data Model for AQI. * Removing duplicate definitions. * Adding type=object for emailAction. * Putting the similar definitions together. * Model Fix. * Fixing AQI examples. * Adding descriptions for enum. * Fixing Spell Check error. * Removing used object: phoneActions. Updating the comments for Put and Patch, that both can be used to update quota. * Updating the Put operatonId as _CreateOrUpdate. * Making Tag information same - QuotaInformation. * Updating example for commit. * 1. Updating description of Quota APIs. 2. Removing Summary, as summary and description was combined in the doc. It had repeated statements. * 1. Updating descriptions. 2. Adding BatchML examples and making the example names as - MachineLearningServices. * Upadatin serviceLimitsRequests in path. * Updating Patch API description. * Patch description updated. --- .../Microsoft.Capacity/preview/2019-07-19/quota.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json index dc60e822df1e..e074aac5279f 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json @@ -156,7 +156,7 @@ "tags": [ "QuotaInformation" ], - "description": "Create or update the service limits (quota) of a resource to requested value.\n Steps:\n\r 1. Make the Get request to get the quota information for specific resource.\n\r 2. To increase the quota, update the limit field in the response from Get request to new value.\n\r 3. Submit the JSON to the quota request API to update the quota.\r\n The Create quota request may be constructed as follows. The PUT operation can be used to update the quota.", + "description": "Update the service limits (quota) of a resource to requested value.\n Steps:\n\r 1. Make the Get request to get the quota information for specific resource.\n\r 2. To increase the quota, update the limit field in the response from Get request to new value.\n\r 3. Submit the JSON to the quota request API to update the quota.\r\n The Update quota request may be constructed as follows. The PATCH operation can be used to update the quota.", "operationId": "Quota_Update", "x-ms-examples": { "Quotas_Request_PatchForCompute": { From e9610d6fbb487938d8d71450eace5325ca4fbfa4 Mon Sep 17 00:00:00 2001 From: sarajang <37909871+sarajang@users.noreply.github.com> Date: Tue, 2 Jun 2020 20:33:49 -0700 Subject: [PATCH 068/318] Update data share examples for consumer invitations (#9668) * update examples for consumer invitations with correct id * run prettier --- .../examples/ConsumerInvitations_Get.json | 2 +- .../ConsumerInvitations_ListInvitations.json | 2 +- .../ConsumerInvitations_RejectInvitation.json | 2 +- .../ProviderShareSubscriptions_GetByShare.json | 8 ++++---- .../ProviderShareSubscriptions_ListByShare.json | 6 +++--- .../ProviderShareSubscriptions_Reinstate.json | 8 ++++---- .../ProviderShareSubscriptions_Revoke.json | 15 ++++++++------- .../examples/ConsumerInvitations_Get.json | 2 +- .../ConsumerInvitations_ListInvitations.json | 2 +- .../ConsumerInvitations_RejectInvitation.json | 2 +- .../ProviderShareSubscriptions_GetByShare.json | 8 ++++---- .../ProviderShareSubscriptions_ListByShare.json | 6 +++--- .../ProviderShareSubscriptions_Reinstate.json | 8 ++++---- .../ProviderShareSubscriptions_Revoke.json | 15 ++++++++------- 14 files changed, 44 insertions(+), 42 deletions(-) diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_Get.json b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_Get.json index b96b9eda962e..b93ee3d85636 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_Get.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_Get.json @@ -28,7 +28,7 @@ "dataSetCount": 1, "shareName": "share1" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", + "id": "providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", "name": "invitation1", "type": "Microsoft.DataShare/consumerInvitations" } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_ListInvitations.json b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_ListInvitations.json index 6e888dff3a47..99cf58e72d0e 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_ListInvitations.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_ListInvitations.json @@ -28,7 +28,7 @@ "providerTenantName": "microsoft", "shareName": "share1" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", + "id": "providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", "name": "invitation1", "type": "Microsoft.DataShare/consumerInvitations" } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_RejectInvitation.json b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_RejectInvitation.json index e0c2b2087285..95b85eca540e 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_RejectInvitation.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ConsumerInvitations_RejectInvitation.json @@ -32,7 +32,7 @@ "dataSetCount": 1, "shareName": "share1" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", + "id": "providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", "name": "invitation1", "type": "Microsoft.DataShare/consumerInvitations" } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_GetByShare.json b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_GetByShare.json index 47d23521376d..53721147f187 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_GetByShare.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_GetByShare.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "accountName": "Account1", "shareName": "Share1", - "providerShareSubscriptionId": "d5496da4-9c52-402f-b067-83cc9ddea888", + "providerShareSubscriptionId": "4256e2cf-0f82-4865-961b-12f83333f487", "api-version": "2018-11-01-preview" }, "responses": { @@ -27,9 +27,9 @@ "consumerTenantName": "Microsoft", "shareSubscriptionStatus": "Active" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", - "name": "invitation1", - "type": "Microsoft.DataShare/shareSubscripitons" + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", + "name": "4256e2cf-0f82-4865-961b-12f83333f487", + "type": "Microsoft.DataShare/providerShareSubscripitons" } } } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_ListByShare.json b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_ListByShare.json index f41b2fe534b7..faf514c0e617 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_ListByShare.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_ListByShare.json @@ -28,9 +28,9 @@ "consumerTenantName": "Microsoft", "shareSubscriptionStatus": "Active" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", - "name": "invitation1", - "type": "Microsoft.DataShare/shareSubscripitons" + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", + "name": "4256e2cf-0f82-4865-961b-12f83333f487", + "type": "Microsoft.DataShare/providerShareSubscripitons" } ] } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_Reinstate.json b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_Reinstate.json index 47d23521376d..53721147f187 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_Reinstate.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_Reinstate.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "accountName": "Account1", "shareName": "Share1", - "providerShareSubscriptionId": "d5496da4-9c52-402f-b067-83cc9ddea888", + "providerShareSubscriptionId": "4256e2cf-0f82-4865-961b-12f83333f487", "api-version": "2018-11-01-preview" }, "responses": { @@ -27,9 +27,9 @@ "consumerTenantName": "Microsoft", "shareSubscriptionStatus": "Active" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", - "name": "invitation1", - "type": "Microsoft.DataShare/shareSubscripitons" + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", + "name": "4256e2cf-0f82-4865-961b-12f83333f487", + "type": "Microsoft.DataShare/providerShareSubscripitons" } } } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_Revoke.json b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_Revoke.json index 6dc1c231af20..26f40068c247 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_Revoke.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/preview/2018-11-01-preview/examples/ProviderShareSubscriptions_Revoke.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "accountName": "Account1", "shareName": "Share1", - "providerShareSubscriptionId": "d5496da4-9c52-402f-b067-83cc9ddea888", + "providerShareSubscriptionId": "4256e2cf-0f82-4865-961b-12f83333f487", "api-version": "2018-11-01-preview" }, "responses": { @@ -27,8 +27,8 @@ "consumerTenantName": "Microsoft", "shareSubscriptionStatus": "Revoked" }, - "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/account1/shares/share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", - "name": "providerShareSubscripiton", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", + "name": "4256e2cf-0f82-4865-961b-12f83333f487", "type": "Microsoft.DataShare/providerShareSubscripitons" } }, @@ -40,7 +40,7 @@ "x-ms-ratelimit-remaining-tenant-reads": "14999", "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", "x-ms-long-running-operation": true, - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/consumerAccount/shares/shareSub1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview" + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview" }, "body": { "properties": { @@ -48,12 +48,13 @@ "consumerEmail": "john.smith@microsoft.com", "createdAt": "2018-12-13T08:52:42.6224087Z", "providerName": "John Smith", + "providerEmail": "john.smith@microsoft.com", "sharedAt": "2018-12-13T08:45:40.9005877Z", "consumerTenantName": "Microsoft", - "shareSubscriptionStatus": "Revoked" + "shareSubscriptionStatus": "Revoking" }, - "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/account1/shares/share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", - "name": "providerShareSubscripiton", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", + "name": "4256e2cf-0f82-4865-961b-12f83333f487", "type": "Microsoft.DataShare/providerShareSubscripitons" } } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_Get.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_Get.json index 3947c32f1d2d..4f48f4b70235 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_Get.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_Get.json @@ -28,7 +28,7 @@ "dataSetCount": 1, "shareName": "share1" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", + "id": "providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", "name": "invitation1", "type": "Microsoft.DataShare/consumerInvitations" } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_ListInvitations.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_ListInvitations.json index be162fe02bd5..e4fbe7a361e4 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_ListInvitations.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_ListInvitations.json @@ -28,7 +28,7 @@ "providerTenantName": "microsoft", "shareName": "share1" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", + "id": "providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", "name": "invitation1", "type": "Microsoft.DataShare/consumerInvitations" } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_RejectInvitation.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_RejectInvitation.json index 94863b3897a0..53670998bd16 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_RejectInvitation.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ConsumerInvitations_RejectInvitation.json @@ -32,7 +32,7 @@ "dataSetCount": 1, "shareName": "share1" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", + "id": "providers/Microsoft.DataShare/locations/eastus2/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", "name": "invitation1", "type": "Microsoft.DataShare/consumerInvitations" } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_GetByShare.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_GetByShare.json index 64e4f3659f8b..8ac27fec3bbb 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_GetByShare.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_GetByShare.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "accountName": "Account1", "shareName": "Share1", - "providerShareSubscriptionId": "d5496da4-9c52-402f-b067-83cc9ddea888", + "providerShareSubscriptionId": "4256e2cf-0f82-4865-961b-12f83333f487", "api-version": "2019-11-01" }, "responses": { @@ -27,9 +27,9 @@ "consumerTenantName": "Microsoft", "shareSubscriptionStatus": "Active" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", - "name": "invitation1", - "type": "Microsoft.DataShare/shareSubscripitons" + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", + "name": "4256e2cf-0f82-4865-961b-12f83333f487", + "type": "Microsoft.DataShare/providerShareSubscripitons" } } } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_ListByShare.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_ListByShare.json index b230d875f279..65dd14bcad7b 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_ListByShare.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_ListByShare.json @@ -28,9 +28,9 @@ "consumerTenantName": "Microsoft", "shareSubscriptionStatus": "Active" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", - "name": "invitation1", - "type": "Microsoft.DataShare/shareSubscripitons" + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", + "name": "4256e2cf-0f82-4865-961b-12f83333f487", + "type": "Microsoft.DataShare/providerShareSubscripitons" } ] } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_Reinstate.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_Reinstate.json index 64e4f3659f8b..8ac27fec3bbb 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_Reinstate.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_Reinstate.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "accountName": "Account1", "shareName": "Share1", - "providerShareSubscriptionId": "d5496da4-9c52-402f-b067-83cc9ddea888", + "providerShareSubscriptionId": "4256e2cf-0f82-4865-961b-12f83333f487", "api-version": "2019-11-01" }, "responses": { @@ -27,9 +27,9 @@ "consumerTenantName": "Microsoft", "shareSubscriptionStatus": "Active" }, - "id": "providers/Microsoft.DataShare/consumerInvitations/4256e2cf-0f82-4865-961b-12f83333f487", - "name": "invitation1", - "type": "Microsoft.DataShare/shareSubscripitons" + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", + "name": "4256e2cf-0f82-4865-961b-12f83333f487", + "type": "Microsoft.DataShare/providerShareSubscripitons" } } } diff --git a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_Revoke.json b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_Revoke.json index 59b9c4d9a1b9..536a8324c789 100644 --- a/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_Revoke.json +++ b/specification/datashare/resource-manager/Microsoft.DataShare/stable/2019-11-01/examples/ProviderShareSubscriptions_Revoke.json @@ -4,7 +4,7 @@ "resourceGroupName": "SampleResourceGroup", "accountName": "Account1", "shareName": "Share1", - "providerShareSubscriptionId": "d5496da4-9c52-402f-b067-83cc9ddea888", + "providerShareSubscriptionId": "4256e2cf-0f82-4865-961b-12f83333f487", "api-version": "2019-11-01" }, "responses": { @@ -27,8 +27,8 @@ "consumerTenantName": "Microsoft", "shareSubscriptionStatus": "Revoked" }, - "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/account1/shares/share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", - "name": "providerShareSubscripiton", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", + "name": "4256e2cf-0f82-4865-961b-12f83333f487", "type": "Microsoft.DataShare/providerShareSubscripitons" } }, @@ -40,7 +40,7 @@ "x-ms-ratelimit-remaining-tenant-reads": "14999", "x-ms-correlation-request-id": "25c78f97-0b0a-4fe9-ad39-883a482265cd", "x-ms-long-running-operation": true, - "Azure-AsyncOperation": "https://management.azure.com/subscriptions/d8869ae5-cd9e-413a-b660-104573d8bcee/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/consumerAccount/shares/shareSub1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2018-11-01-preview" + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/operationResults/dad6baec-3a39-41df-a469-843a9ee94213?api-version=2019-11-01" }, "body": { "properties": { @@ -48,12 +48,13 @@ "consumerEmail": "john.smith@microsoft.com", "createdAt": "2018-12-13T08:52:42.6224087Z", "providerName": "John Smith", + "providerEmail": "john.smith@microsoft.com", "sharedAt": "2018-12-13T08:45:40.9005877Z", "consumerTenantName": "Microsoft", - "shareSubscriptionStatus": "Revoked" + "shareSubscriptionStatus": "Revoking" }, - "id": "/subscriptions/433a8dfd-e5d5-4e77-ad86-90acdc75eb1a/resourceGroups/testrg/providers/Microsoft.DataShare/accounts/account1/shares/share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", - "name": "providerShareSubscripiton", + "id": "/subscriptions/12345678-1234-1234-12345678abc/resourceGroups/SampleResourceGroup/providers/Microsoft.DataShare/accounts/Account1/shares/Share1/providerShareSubscripitons/4256e2cf-0f82-4865-961b-12f83333f487", + "name": "4256e2cf-0f82-4865-961b-12f83333f487", "type": "Microsoft.DataShare/providerShareSubscripitons" } } From df38cb97227fc81e32ca795ebe6e4afc9351b17d Mon Sep 17 00:00:00 2001 From: bradrich-msft <53872276+bradrich-msft@users.noreply.github.com> Date: Tue, 2 Jun 2020 20:52:54 -0700 Subject: [PATCH 069/318] Remove lt rv1 WaitForARMFeedback (#9247) --- .../backupLongTermRetentionPolicies.json | 279 ------------------ .../backupLongTermRetentionVaults.json | 246 --------------- .../BackupLongTermRetentionPolicyGet.json | 24 -- .../BackupLongTermRetentionPolicyList.json | 28 -- .../BackupLongTermRetentionPolicyUpdate.json | 44 --- .../BackupLongTermRetentionVaultGet.json | 22 -- .../BackupLongTermRetentionVaultList.json | 25 -- .../BackupLongTermRetentionVaultUpdate.json | 40 --- .../2014-04-01/examples/OperationList.json | 16 - specification/sql/resource-manager/readme.md | 12 - 10 files changed, 736 deletions(-) delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyGet.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyList.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyUpdate.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultGet.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultList.json delete mode 100644 specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultUpdate.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json deleted file mode 100644 index 63699e0d02b9..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json +++ /dev/null @@ -1,279 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure SQL Database Backup Long Term Retention Policy", - "description": "Provides read and update functionality for Azure SQL Database backup long term retention policy", - "version": "2014-04-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies/{backupLongTermRetentionPolicyName}": { - "get": { - "tags": [ - "BackupLongTermRetentionPolicies" - ], - "operationId": "BackupLongTermRetentionPolicies_Get", - "description": "Returns a database backup long term retention policy", - "x-ms-examples": { - "Get backup long term retention policy": { - "$ref": "./examples/BackupLongTermRetentionPolicyGet.json" - } - }, - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "databaseName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the database." - }, - { - "name": "backupLongTermRetentionPolicyName", - "in": "path", - "description": "The name of the backup long term retention policy", - "required": true, - "type": "string", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "BackupLongTermRetentionPolicyName", - "modelAsString": true - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionPolicy" - } - } - } - }, - "put": { - "tags": [ - "BackupLongTermRetentionPolicies" - ], - "operationId": "BackupLongTermRetentionPolicies_CreateOrUpdate", - "description": "Creates or updates a database backup long term retention policy", - "x-ms-examples": { - "Update backup long term retention policy": { - "$ref": "./examples/BackupLongTermRetentionPolicyUpdate.json" - } - }, - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "databaseName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the database" - }, - { - "name": "backupLongTermRetentionPolicyName", - "in": "path", - "description": "The name of the backup long term retention policy", - "required": true, - "type": "string", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "BackupLongTermRetentionPolicyName", - "modelAsString": true - } - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionPolicy" - }, - "description": "The required parameters to update a backup long term retention policy" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionPolicy" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionPolicy" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/backupLongTermRetentionPolicies": { - "get": { - "tags": [ - "BackupLongTermRetentionPolicies" - ], - "operationId": "BackupLongTermRetentionPolicies_ListByDatabase", - "description": "Returns a database backup long term retention policy", - "x-ms-examples": { - "Get backup long term retention policy": { - "$ref": "./examples/BackupLongTermRetentionPolicyList.json" - } - }, - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "databaseName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the database." - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionPolicyListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - } - }, - "definitions": { - "BackupLongTermRetentionPolicyProperties": { - "properties": { - "state": { - "type": "string", - "description": "The status of the backup long term retention policy", - "enum": [ - "Disabled", - "Enabled" - ], - "x-ms-enum": { - "name": "BackupLongTermRetentionPolicyState" - } - }, - "recoveryServicesBackupPolicyResourceId": { - "type": "string", - "description": "The azure recovery services backup protection policy resource id" - } - }, - "required": [ - "state", - "recoveryServicesBackupPolicyResourceId" - ], - "description": "The properties of a backup long term retention policy" - }, - "BackupLongTermRetentionPolicy": { - "properties": { - "location": { - "type": "string", - "readOnly": true, - "description": "The geo-location where the resource lives" - }, - "properties": { - "$ref": "#/definitions/BackupLongTermRetentionPolicyProperties", - "description": "The properties of the backup long term retention policy", - "x-ms-client-flatten": true - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "description": "A backup long term retention policy" - }, - "BackupLongTermRetentionPolicyListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/BackupLongTermRetentionPolicy" - }, - "description": "The list of long-term retention policies in the database." - } - }, - "required": [ - "value" - ], - "description": "Represents the response to a list long-term retention policies request." - } - }, - "parameters": { - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the server.", - "x-ms-parameter-location": "method" - } - }, - "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" - } - } - } -} diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json deleted file mode 100644 index f99b9020d32c..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json +++ /dev/null @@ -1,246 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure SQL Server Backup Long Term Retention Vault", - "description": "Provides read and update functionality for Azure SQL Server backup long term retention vault", - "version": "2014-04-01" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/backupLongTermRetentionVaults/{backupLongTermRetentionVaultName}": { - "get": { - "tags": [ - "BackupLongTermRetentionVaults" - ], - "operationId": "BackupLongTermRetentionVaults_Get", - "description": "Gets a server backup long term retention vault", - "x-ms-examples": { - "Get backup long term retention vault": { - "$ref": "./examples/BackupLongTermRetentionVaultGet.json" - } - }, - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "backupLongTermRetentionVaultName", - "in": "path", - "description": "The name of the Azure SQL Server backup LongTermRetention vault", - "required": true, - "type": "string", - "enum": [ - "RegisteredVault" - ], - "x-ms-enum": { - "name": "BackupLongTermRetentionVaultName", - "modelAsString": true - } - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionVault" - } - } - } - }, - "put": { - "tags": [ - "BackupLongTermRetentionVaults" - ], - "operationId": "BackupLongTermRetentionVaults_CreateOrUpdate", - "description": "Updates a server backup long term retention vault", - "x-ms-examples": { - "Update backup long term retention vault": { - "$ref": "./examples/BackupLongTermRetentionVaultUpdate.json" - } - }, - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "backupLongTermRetentionVaultName", - "in": "path", - "description": "The name of the backup long term retention vault", - "required": true, - "type": "string", - "enum": [ - "RegisteredVault" - ], - "x-ms-enum": { - "name": "BackupLongTermRetentionVaultName", - "modelAsString": true - } - }, - { - "name": "parameters", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionVault" - }, - "description": "The required parameters to update a backup long term retention vault" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionVault" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionVault" - } - }, - "202": { - "description": "Accepted" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/backupLongTermRetentionVaults": { - "get": { - "tags": [ - "BackupLongTermRetentionVaults" - ], - "operationId": "BackupLongTermRetentionVaults_ListByServer", - "description": "Gets server backup long term retention vaults in a server", - "x-ms-examples": { - "Get backup long term retention vault": { - "$ref": "./examples/BackupLongTermRetentionVaultList.json" - } - }, - "parameters": [ - { - "$ref": "../../../common/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/BackupLongTermRetentionVaultListResult" - } - } - }, - "x-ms-pageable": { - "nextLinkName": null - } - } - } - }, - "definitions": { - "BackupLongTermRetentionVaultProperties": { - "properties": { - "recoveryServicesVaultResourceId": { - "type": "string", - "description": "The azure recovery services vault resource id" - } - }, - "required": [ - "recoveryServicesVaultResourceId" - ], - "description": "The properties of a backup long term retention vault." - }, - "BackupLongTermRetentionVault": { - "properties": { - "location": { - "type": "string", - "readOnly": true, - "description": "The geo-location where the resource lives" - }, - "properties": { - "$ref": "#/definitions/BackupLongTermRetentionVaultProperties", - "description": "The properties of the backup long term retention vault", - "x-ms-client-flatten": true - } - }, - "allOf": [ - { - "$ref": "../../../common/v1/types.json#/definitions/ProxyResource" - } - ], - "description": "A backup long term retention vault" - }, - "BackupLongTermRetentionVaultListResult": { - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/BackupLongTermRetentionVault" - }, - "description": "The list of vaults in the server." - } - }, - "required": [ - "value" - ], - "description": "Represents the response to a list vaults request." - } - }, - "parameters": { - "ServerNameParameter": { - "name": "serverName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the server.", - "x-ms-parameter-location": "method" - } - }, - "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" - } - } - } -} diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyGet.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyGet.json deleted file mode 100644 index 93363b068510..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyGet.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "longtermretentiontest-1234", - "serverName": "longtermretentiontest-5678", - "databaseName": "longtermretentiontest-9012", - "backupLongTermRetentionPolicyName": "Default", - "api-version": "2014-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/databases/longtermretentiontest-9012/backupLongTermRetentionPolicies/Default", - "name": "Default", - "type": "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies", - "location": "Japan East", - "properties": { - "recoveryServicesBackupPolicyResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc/backupPolicies/testPolicyxyz", - "state": "Enabled" - } - } - } - } -} diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyList.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyList.json deleted file mode 100644 index 28f8c70d6fd4..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyList.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "longtermretentiontest-1234", - "serverName": "longtermretentiontest-5678", - "databaseName": "longtermretentiontest-9012", - "backupLongTermRetentionPolicyName": "Default", - "api-version": "2014-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/databases/longtermretentiontest-9012/backupLongTermRetentionPolicies/Default", - "name": "Default", - "type": "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies", - "location": "Japan East", - "properties": { - "recoveryServicesBackupPolicyResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc/backupPolicies/testPolicyxyz", - "state": "Enabled" - } - } - ] - } - } - } -} diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyUpdate.json deleted file mode 100644 index de1cf5233a3a..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionPolicyUpdate.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "longtermretentiontest-1234", - "serverName": "longtermretentiontest-5678", - "databaseName": "longtermretentiontest-9012", - "backupLongTermRetentionPolicyName": "Default", - "api-version": "2014-04-01", - "parameters": { - "properties": { - "recoveryServicesBackupPolicyResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc/backupPolicies/testPolicyxyz", - "state": "Enabled" - }, - "location": "Japan East" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/databases/longtermretentiontest-9012/backupLongTermRetentionPolicies/Default", - "name": "Default", - "type": "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies", - "location": "Japan East", - "properties": { - "recoveryServicesBackupPolicyResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc/backupPolicies/testPolicyxyz", - "state": "Enabled" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/databases/longtermretentiontest-9012/backupLongTermRetentionPolicies/Default", - "name": "Default", - "type": "Microsoft.Sql/servers/databases/backupLongTermRetentionPolicies", - "location": "Japan East", - "properties": { - "recoveryServicesBackupPolicyResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc/backupPolicies/testPolicyxyz", - "state": "Enabled" - } - } - }, - "202": {} - } -} diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultGet.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultGet.json deleted file mode 100644 index 71d522217d44..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultGet.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "longtermretentiontest-1234", - "serverName": "longtermretentiontest-5678", - "backupLongTermRetentionVaultName": "RegisteredVault", - "api-version": "2014-04-01" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/backupLongTermRetentionVaults/RegisteredVault", - "name": "RegisteredVault", - "type": "Microsoft.Sql/servers/backupLongTermRetentionVaults", - "location": "Japan East", - "properties": { - "recoveryServicesVaultResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc" - } - } - } - } -} diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultList.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultList.json deleted file mode 100644 index 309ca317552c..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultList.json +++ /dev/null @@ -1,25 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "longtermretentiontest-1234", - "serverName": "longtermretentiontest-5678", - "api-version": "2014-04-01" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/backupLongTermRetentionVaults/RegisteredVault", - "name": "RegisteredVault", - "type": "Microsoft.Sql/servers/backupLongTermRetentionVaults", - "location": "Japan East", - "properties": { - "recoveryServicesVaultResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc" - } - } - ] - } - } - } -} diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultUpdate.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultUpdate.json deleted file mode 100644 index f6c1aadd3e9b..000000000000 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/BackupLongTermRetentionVaultUpdate.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "longtermretentiontest-1234", - "serverName": "longtermretentiontest-5678", - "backupLongTermRetentionVaultName": "RegisteredVault", - "api-version": "2014-04-01", - "parameters": { - "properties": { - "recoveryServicesVaultResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-5678/providers/Microsoft.RecoveryServices/vaults/testVaultabc" - }, - "location": "Japan East" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/backupLongTermRetentionVaults/RegisteredVault", - "name": "RegisteredVault", - "type": "Microsoft.Sql/servers/backupLongTermRetentionVaults", - "location": "Japan East", - "properties": { - "recoveryServicesVaultResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc" - } - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentiontest-1234/providers/Microsoft.Sql/servers/longtermretentiontest-5678/backupLongTermRetentionVaults/RegisteredVault", - "name": "RegisteredVault", - "type": "Microsoft.Sql/servers/backupLongTermRetentionVaults", - "location": "Japan East", - "properties": { - "recoveryServicesVaultResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/longtermretentionvaulttest-1234/providers/Microsoft.RecoveryServices/vaults/testVaultabc" - } - } - }, - "202": {} - } -} diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json index 5b54c709b1f8..e2eebc1c75e7 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/OperationList.json @@ -1136,22 +1136,6 @@ "resource": "Data Warehouse Query Step", "operation": "Get details about data warehouse query step" } - }, - { - "name": "Microsoft.Sql/servers/backupLongTermRetentionVaults/read", - "display": { - "provider": "Microsoft SQL Database", - "resource": "A backup long term retention vault", - "operation": "Read a backup long term retention vault" - } - }, - { - "name": "Microsoft.Sql/servers/backupLongTermRetentionVaults/write", - "display": { - "provider": "Microsoft SQL Database", - "resource": "A backup long term retention vault", - "operation": "This operation is used to register a backup long term retention vault to a server." - } } ] } diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index c18845faab56..b67d56d4dc40 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -257,8 +257,6 @@ APIs must only be added to this section when the API is publicly available in at ``` yaml $(tag) == 'package-composite-v1' input-file: -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json - Microsoft.Sql/stable/2014-04-01/backups.json - Microsoft.Sql/stable/2014-04-01/capabilities.json - Microsoft.Sql/stable/2014-04-01/connectionPolicies.json @@ -349,8 +347,6 @@ APIs must only be added to this section when the API is publicly available in at ``` yaml $(tag) == 'package-2017-03-preview' input-file: -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json - Microsoft.Sql/stable/2014-04-01/backups.json - Microsoft.Sql/stable/2014-04-01/capabilities.json - Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json @@ -414,8 +410,6 @@ APIs must only be added to this section when the API is publicly available in at ``` yaml $(tag) == 'package-2015-05-preview' input-file: -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json -- Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json - Microsoft.Sql/stable/2014-04-01/backups.json - Microsoft.Sql/stable/2014-04-01/restorePoints.json - Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json @@ -662,8 +656,6 @@ These can be regenerated by running the following PowerShell script from this re ``` yaml $(tag) == 'package-pure-2014-04' input-file: - ./Microsoft.Sql/stable/2014-04-01/advisors.json - - ./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json - - ./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json - ./Microsoft.Sql/stable/2014-04-01/backups.json - ./Microsoft.Sql/stable/2014-04-01/capabilities.json - ./Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json @@ -883,8 +875,6 @@ input-file: - $(this-folder)/Microsoft.Sql/stable/2014-04-01/elasticPools.json - $(this-folder)/Microsoft.Sql/stable/2014-04-01/recommendedElasticPools.json - $(this-folder)/Microsoft.Sql/preview/2017-03-01-preview/renameDatabase.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json - - $(this-folder)/Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json - $(this-folder)/Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json - $(this-folder)/Microsoft.Sql/stable/2014-04-01/serverAzureADAdministrators.json - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/managedInstances.json @@ -976,8 +966,6 @@ input-file: - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/virtualclusters.json - $(this-folder)/./Microsoft.Sql/preview/2015-05-01-preview/virtualNetworkRules.json - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/advisors.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionPolicies.json - - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/backupLongTermRetentionVaults.json - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/backups.json - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/capabilities.json - $(this-folder)/./Microsoft.Sql/stable/2014-04-01/checkNameAvailability.json From 739ce389b7e9e41af900bfce75df611f3eef6839 Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Wed, 3 Jun 2020 12:54:50 +0800 Subject: [PATCH 070/318] add readme.az for databoxedge (#9683) * add readme.az * add cli_extension --- .../databoxedge/resource-manager/readme.az.md | 12 ++++++++++++ specification/databoxedge/resource-manager/readme.md | 1 + 2 files changed, 13 insertions(+) create mode 100644 specification/databoxedge/resource-manager/readme.az.md diff --git a/specification/databoxedge/resource-manager/readme.az.md b/specification/databoxedge/resource-manager/readme.az.md new file mode 100644 index 000000000000..15d8db6ed9a2 --- /dev/null +++ b/specification/databoxedge/resource-manager/readme.az.md @@ -0,0 +1,12 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) +az: + extensions: databoxedge + package-name: azure-mgmt-databoxedge + namespace: azure.mgmt.databoxedge +az-output-folder: $(azure-cli-extension-folder)/src/databoxedge +python-sdk-output-folder: "$(az-output-folder)/azext_databoxedge/vendored_sdks/databoxedge" +``` diff --git a/specification/databoxedge/resource-manager/readme.md b/specification/databoxedge/resource-manager/readme.md index 18353b7dbfc2..455345faee18 100644 --- a/specification/databoxedge/resource-manager/readme.md +++ b/specification/databoxedge/resource-manager/readme.md @@ -76,6 +76,7 @@ swagger-to-sdk: - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_databoxedge'] + - repo: azure-cli-extensions ``` ## C# From 3adf23e0e1c74017dac7a500e0a10dddbb6c81c2 Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Wed, 3 Jun 2020 12:57:32 +0800 Subject: [PATCH 071/318] validate CLI codegen for databox (#9211) * validate databox * repo: azure-cli-extensions * relocate python config Co-authored-by: Changlong Liu --- .../databox/resource-manager/readme.az.md | 12 ++++++++ .../databox/resource-manager/readme.md | 28 ++----------------- .../databox/resource-manager/readme.python.md | 28 +++++++++++++++++++ 3 files changed, 42 insertions(+), 26 deletions(-) create mode 100644 specification/databox/resource-manager/readme.az.md create mode 100644 specification/databox/resource-manager/readme.python.md diff --git a/specification/databox/resource-manager/readme.az.md b/specification/databox/resource-manager/readme.az.md new file mode 100644 index 000000000000..8b71862eff6c --- /dev/null +++ b/specification/databox/resource-manager/readme.az.md @@ -0,0 +1,12 @@ +## CLI + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) +az: + extensions: databox + package-name: azure-mgmt-databox + namespace: azure.mgmt.databox +az-output-folder: $(azure-cli-extension-folder)/src/databox +python-sdk-output-folder: "$(az-output-folder)/azext_databox/vendored_sdks/databox" +``` diff --git a/specification/databox/resource-manager/readme.md b/specification/databox/resource-manager/readme.md index 2fb1565805b6..cb252a0cfb96 100644 --- a/specification/databox/resource-manager/readme.md +++ b/specification/databox/resource-manager/readme.md @@ -67,6 +67,7 @@ swagger-to-sdk: - repo: azure-sdk-for-ruby after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_databox'] + - repo: azure-cli-extensions ``` ## C# @@ -86,32 +87,7 @@ csharp: ## Python -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.databox - package-name: azure-mgmt-databox - title: DataBoxManagementClient - description: The DataBox Client. - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox -``` +See configuration in [readme.python.md](./readme.python.md) ## Ruby diff --git a/specification/databox/resource-manager/readme.python.md b/specification/databox/resource-manager/readme.python.md new file mode 100644 index 000000000000..c58c21fa9f86 --- /dev/null +++ b/specification/databox/resource-manager/readme.python.md @@ -0,0 +1,28 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.databox + package-name: azure-mgmt-databox + package-version: 0.1.0 + title: DataBoxManagementClient + description: The DataBox Client. + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox/azure/mgmt/databox +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/databox/azure-mgmt-databox +``` From 41346a1b8bcf8265d7e86d844a72acc7ed9cfa1a Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Wed, 3 Jun 2020 10:09:08 +0200 Subject: [PATCH 072/318] updated resources readme (#9638) --- .../resource-manager/readme.python.md | 55 ++++++++++++++++++- 1 file changed, 52 insertions(+), 3 deletions(-) diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index e000118f5bbd..24a7fb0be6b6 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -63,9 +63,12 @@ batch: clear-output-folder: true batch: - tag: package-features-2015-12 + - multiapiscript-features: true - tag: package-links-2016-09 + - multiapiscript-links: true - tag: package-locks-2016-09 - tag: package-locks-2015-01 + - multiapiscript-locks: true - tag: package-managedapplications-2018-06 - tag: package-policy-2019-09 - tag: package-policy-2019-06 @@ -76,6 +79,7 @@ batch: - tag: package-policy-2016-12 - tag: package-policy-2016-04 - tag: package-policy-2015-10 + - multiapiscript-policy: true - tag: package-resources-2019-10 - tag: package-resources-2019-08 - tag: package-resources-2019-07 @@ -87,16 +91,61 @@ batch: - tag: package-resources-2017-05 - tag: package-resources-2016-09 - tag: package-resources-2016-02 + - multiapiscript-resources: true - tag: package-subscriptions-2019-11 - tag: package-subscriptions-2019-06 - tag: package-subscriptions-2018-06 - tag: package-subscriptions-2016-06 + - multiapiscript-subscriptions: true - tag: package-deploymentscripts-2019-10-preview - - multiapiscript: true + - multiapiscript-deploymentscripts: true ``` -``` yaml $(multiapiscript) -output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/ +```yaml $(multiapiscript-features) +multiapiscript: true +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/features +clear-output-folder: false +perform-load: false +``` + +```yaml $(multiapiscript-policy) +multiapiscript: true +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/policy +clear-output-folder: false +perform-load: false +``` + +```yaml $(multiapiscript-resources) +multiapiscript: true +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/resources +clear-output-folder: false +perform-load: false +``` + +```yaml $(multiapiscript-subscriptions) +multiapiscript: true +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/subscriptions +clear-output-folder: false +perform-load: false +``` + +```yaml $(multiapiscript-deploymentscripts) +multiapiscript: true +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/deploymentscripts +clear-output-folder: false +perform-load: false +``` + +```yaml $(multiapiscript-locks) +multiapiscript: true +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/locks +clear-output-folder: false +perform-load: false +``` + +```yaml $(multiapiscript-links) +multiapiscript: true +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/links clear-output-folder: false perform-load: false ``` From 341e493221d3671eecf7fbe9d8ac8e1f2b412e9f Mon Sep 17 00:00:00 2001 From: Shinil Mannadath Date: Wed, 3 Jun 2020 02:27:16 -0700 Subject: [PATCH 073/318] Update InfrastructureEncryption property description for PostgreSQL and MySQL (#9390) * Update InfrastructureEncryption property description for PostgreSQL and MySQL * Update InfrastructureEncryption property description for PostgreSQL and MySQL --- .../stable/2017-12-01/mysql.json | 14 ++++++++++++-- .../stable/2017-12-01/postgresql.json | 14 ++++++++++++-- 2 files changed, 24 insertions(+), 4 deletions(-) diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json index 7f9bebd28eab..355fccb1b110 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json @@ -1524,14 +1524,24 @@ }, "InfrastructureEncryption": { "type": "string", - "description": "Status showing whether the server enabled infrastructure encryption.", + "description": "Add a second layer of encryption for your data using new encryption algorithm which gives additional data protection. Value is optional but if passed in, must be 'Disabled' or 'Enabled'.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "InfrastructureEncryption", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Default value for single layer of encryption for data at rest." + }, + { + "value": "Disabled", + "description": "Additional (2nd) layer of encryption for data at rest" + } + ] } }, "PublicNetworkAccess": { diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json index 59450f0fab7b..8c229dbd192f 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json @@ -1527,14 +1527,24 @@ }, "InfrastructureEncryption": { "type": "string", - "description": "Status showing whether the server enabled infrastructure encryption.", + "description": "Add a second layer of encryption for your data using new encryption algorithm which gives additional data protection. Value is optional but if passed in, must be 'Disabled' or 'Enabled'.", "enum": [ "Enabled", "Disabled" ], "x-ms-enum": { "name": "InfrastructureEncryption", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Enabled", + "description": "Default value for single layer of encryption for data at rest." + }, + { + "value": "Disabled", + "description": "Additional (2nd) layer of encryption for data at rest" + } + ] } }, "PublicNetworkAccess": { From e9174c4ed714763ac650bb9713d3ef6ded5d8b03 Mon Sep 17 00:00:00 2001 From: Dongwei Wang Date: Wed, 3 Jun 2020 17:42:35 +0800 Subject: [PATCH 074/318] Update allowed range for nodeCount (#9602) * Update allowed range for nodeCount * Remove minimum --- .../preview/2019-06-01-preview/bigDataPool.json | 2 -- 1 file changed, 2 deletions(-) diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json index 97c9cc44ccca..57b66826ff17 100644 --- a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2019-06-01-preview/bigDataPool.json @@ -413,8 +413,6 @@ "nodeCount": { "type": "integer", "format": "int32", - "minimum": 3, - "maximum": 200, "description": "The number of nodes in the Big Data pool." }, "libraryRequirements": { From 4ead91e7210d47dc470997084c27d56988298e6c Mon Sep 17 00:00:00 2001 From: Raouf Merouche Date: Wed, 3 Jun 2020 08:56:27 -0700 Subject: [PATCH 075/318] Remove features mode (#9645) --- .../SearchIndexSearchDocumentsGet.json | 11 ---- .../SearchIndexSearchDocumentsPost.json | 12 ---- .../2019-05-06-preview/searchindex.json | 64 ------------------- 3 files changed, 87 deletions(-) diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsGet.json index d3eff019e3ac..e28054126c8e 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsGet.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsGet.json @@ -21,7 +21,6 @@ ], "queryType": "simple", "sessionId": "mysessionid", - "featuresMode": "enabled", "scoringStatistics": "global", "scoringParameters": [ "currentLocation--122.123,44.77233" @@ -77,16 +76,6 @@ "Fancy Hotel" ] }, - "@search.features": { - "description": { - "uniqueTokenMatches": 1.0, - "similarityScore": 0.023745812 - }, - "title": { - "uniqueTokenMatches": 1.0, - "similarityScore": 0.016049799 - } - }, "description": "Best hotel in town", "docId": "2", "title": "Fancy Hotel" diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsPost.json index c95e8c51acd2..b834f10417f1 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsPost.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/examples/SearchIndexSearchDocumentsPost.json @@ -24,7 +24,6 @@ "searchFields": "title,description", "searchMode": "any", "sessionId": "mysessionid", - "featuresMode": "enabled", "scoringStatistics": "global", "select": "docId,title,description", "skip": 0, @@ -60,7 +59,6 @@ "orderby": "search.score() desc,rating desc", "queryType": "simple", "sessionId": "mysessionid", - "featuresMode": "enabled", "scoringStatistics": "global", "scoringParameters": [ "currentLocation--122.123,44.77233" @@ -92,16 +90,6 @@ "Fancy Hotel" ] }, - "@search.features": { - "description": { - "uniqueTokenMatches": 1.0, - "similarityScore": 0.023745812 - }, - "title": { - "uniqueTokenMatches": 1.0, - "similarityScore": 0.016049799 - } - }, "description": "Best hotel in town", "docId": "2", "title": "Fancy Hotel" diff --git a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/searchindex.json b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/searchindex.json index 073df28cd754..e785feeed67d 100644 --- a/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/searchindex.json +++ b/specification/search/data-plane/Microsoft.Azure.Search.Data/preview/2019-05-06-preview/searchindex.json @@ -248,24 +248,6 @@ "name": "SearchParameters" } }, - { - "name": "featuresMode", - "in": "query", - "type": "string", - "enum": [ - "disabled", - "enabled" - ], - "x-ms-enum": { - "name": "FeaturesMode", - "modelAsString": false - }, - "x-nullable": false, - "description": "A value that specifies whether the results should include scoring features such as per field similarity.", - "x-ms-parameter-grouping": { - "name": "SearchParameters" - } - }, { "name": "scoringStatistics", "in": "query", @@ -902,27 +884,6 @@ "additionalProperties": true, "description": "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval." }, - "SearchFeatures": { - "properties": { - "uniqueTokenMatches": { - "type": "number", - "readOnly": true, - "format": "double", - "description": "The number of unique tokens from the search query that matched this field." - }, - "similarityScore": { - "type": "number", - "readOnly": true, - "format": "double", - "description": "The similarity score computed between the search query and this field." - } - }, - "required": [ - "uniqueTokenMatches", - "similarityScore" - ], - "description": "A list of features describing the scoring of a specific field against the search query." - }, "DocumentSearchResult": { "properties": { "@odata.count": { @@ -996,15 +957,6 @@ "readOnly": true, "x-ms-client-name": "Highlights", "description": "Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query." - }, - "@search.features": { - "type": "object", - "additionalProperties": { - "$ref": "#/definitions/SearchFeatures" - }, - "readOnly": true, - "x-ms-client-name": "Features", - "description": "description for the feature" } }, "additionalProperties": true, @@ -1114,18 +1066,6 @@ }, "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." }, - "FeaturesMode": { - "type": "string", - "enum": [ - "disabled", - "enabled" - ], - "x-ms-enum": { - "name": "FeaturesMode", - "modelAsString": false - }, - "description": "A value that specifies whether the results should include scoring features, such as per field similarity. The default is 'disabled'. Use 'enabled' to expose additional scoring features." - }, "ScoringStatistics": { "type": "string", "enum": [ @@ -1202,10 +1142,6 @@ "$ref": "#/definitions/QueryType", "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." }, - "featuresMode": { - "$ref": "#/definitions/FeaturesMode", - "description": "A value that specifies whether the results should include scoring features, such as per field similarity. The default is 'disabled'. Use 'enabled' to expose additional scoring features." - }, "scoringStatistics": { "$ref": "#/definitions/ScoringStatistics", "description": "A value that specifies whether we want to calculate scoring statistics (such as document frequency) globally for more consistent scoring, or locally, for lower latency. The default is 'local'. Use 'global' to aggregate scoring statistics globally before scoring. Using global scoring statistics can increase latency of search queries." From 46fe6d8c8d88e057d9f116273b0b082f286c1358 Mon Sep 17 00:00:00 2001 From: giromm2ms <52413295+giromm2ms@users.noreply.github.com> Date: Wed, 3 Jun 2020 18:58:53 +0300 Subject: [PATCH 076/318] Documentation fix (#9693) --- .../preview/2020-01-01-preview/secureScore.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json index 7d2ebe1a4e0c..3e742573ba4f 100644 --- a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/secureScore.json @@ -83,7 +83,7 @@ "tags": [ "Secure Score" ], - "description": "Get secure score for a specific initiative within your current scope. For the ASC Default initiative, use 'ascScore'.", + "description": "Get secure score for a specific Security Center initiative within your current scope. For the ASC Default initiative, use 'ascScore'.", "operationId": "SecureScores_Get", "parameters": [ { From 33c52e4f87f3ae21611d45f34db65f9ccc510ea6 Mon Sep 17 00:00:00 2001 From: annatisch Date: Wed, 3 Jun 2020 13:20:25 -0700 Subject: [PATCH 077/318] Tables swagger fixes (#9584) --- .../Microsoft.Tables/preview/2019-02-02/table.json | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/table.json b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/table.json index 6ec8ea5e20b5..abc01960c97c 100644 --- a/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/table.json +++ b/specification/cosmos-db/data-plane/Microsoft.Tables/preview/2019-02-02/table.json @@ -1310,6 +1310,9 @@ "TableServiceProperties": { "description": "Table Service Properties.", "type": "object", + "xml": { + "name": "StorageServiceProperties" + }, "properties": { "Logging": { "description": "Azure Analytics Logging settings.", @@ -1496,9 +1499,11 @@ } }, "TableServiceStats": { - "xml": {}, "description": "Stats for the service.", "type": "object", + "xml": { + "name": "StorageServiceStats" + }, "properties": { "GeoReplication": { "description": "Geo-Replication information for the Secondary Storage Service.", From 3b552e66a85a3de4cc51de5998989c3db6a63920 Mon Sep 17 00:00:00 2001 From: Ivan Matantsev Date: Wed, 3 Jun 2020 16:15:24 -0700 Subject: [PATCH 078/318] According to this PR https://github.com/Azure/azure-sdk-for-net/pull/7235 having Vision.FormRecognizer folder was mistake. (#8422) But this readme still contains vision and if you try to regenerate code in azure-sdk-for-net repository they would be created in Vision.FormRecognizer rather than just FormRecognizer. --- .../cognitiveservices/data-plane/FormRecognizer/readme.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/cognitiveservices/data-plane/FormRecognizer/readme.md b/specification/cognitiveservices/data-plane/FormRecognizer/readme.md index 969d24a80c96..6cf863de25a5 100644 --- a/specification/cognitiveservices/data-plane/FormRecognizer/readme.md +++ b/specification/cognitiveservices/data-plane/FormRecognizer/readme.md @@ -64,7 +64,7 @@ csharp: license-header: MICROSOFT_MIT_NO_VERSION azure-arm: false namespace: Microsoft.Azure.CognitiveServices.FormRecognizer - output-folder: $(csharp-sdks-folder)/CognitiveServices/Vision.FormRecognizer/src/Generated + output-folder: $(csharp-sdks-folder)/CognitiveServices/FormRecognizer/src/Generated title: "FormRecognizerClient" clear-output-folder: true ``` From 0d015f7dec0c531bf1b22d6f85de6f64f22c3eae Mon Sep 17 00:00:00 2001 From: Nate Lehman Date: Wed, 3 Jun 2020 20:37:52 -0700 Subject: [PATCH 079/318] init (#9667) --- .../preview/2020-03-01-preview/digitaltwins.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview/digitaltwins.json b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview/digitaltwins.json index efaa727db040..ad2e784412c5 100644 --- a/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview/digitaltwins.json +++ b/specification/digitaltwins/resource-manager/Microsoft.DigitalTwins/preview/2020-03-01-preview/digitaltwins.json @@ -1087,8 +1087,7 @@ "in": "path", "description": "The subscription identifier.", "required": true, - "type": "string", - "format": "uuid" + "type": "string" }, "api-version": { "name": "api-version", From 8bb7426d94a3e573cccc5af8a69806a65d26ae08 Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Thu, 4 Jun 2020 13:44:26 +0800 Subject: [PATCH 080/318] Onboard python track2 codegen (#9708) --- .azure-pipelines/SDKAutomation.yml | 2 ++ specificationRepositoryConfiguration.json | 4 ++++ 2 files changed, 6 insertions(+) diff --git a/.azure-pipelines/SDKAutomation.yml b/.azure-pipelines/SDKAutomation.yml index d119dafbe8d1..da696e39c823 100644 --- a/.azure-pipelines/SDKAutomation.yml +++ b/.azure-pipelines/SDKAutomation.yml @@ -34,6 +34,8 @@ jobs: SDK_REPO_NAME: azure-sdk-for-js Python: SDK_REPO_NAME: azure-sdk-for-python + PythonT2: + SDK_REPO_NAME: azure-sdk-for-python-track2 Cliextension: SDK_REPO_NAME: azure-cli-extensions Go: diff --git a/specificationRepositoryConfiguration.json b/specificationRepositoryConfiguration.json index a9d5a82a7098..dbcddfeb40e2 100644 --- a/specificationRepositoryConfiguration.json +++ b/specificationRepositoryConfiguration.json @@ -24,6 +24,10 @@ "mainRepository": "Azure/azure-sdk-for-python", "mainBranch": "release/v3" }, + "azure-sdk-for-python-track2": { + "integrationRepository": "AzureSDKAutomation/azure-sdk-for-python", + "mainRepository": "Azure/azure-sdk-for-python" + }, "azure-cli-extensions": { "integrationRepository": "AzureSDKAutomation/azure-cli-extensions", "mainRepository": "Azure/azure-cli-extensions" From d6c2153d61724c455d87aef336cd564b69e1cfe0 Mon Sep 17 00:00:00 2001 From: Arik Olsh <47111029+arolshan@users.noreply.github.com> Date: Thu, 4 Jun 2020 08:58:13 +0300 Subject: [PATCH 081/318] align eTag with server (#9687) * align with server * revert for certain --- .../2020-03-01-preview/DataSources.json | 2 +- .../2020-03-01-preview/SavedSearches.json | 2 +- .../examples/DataSourcesCreate.json | 4 +- .../examples/DataSourcesGet.json | 2 +- .../examples/DataSourcesListByWorkspace.json | 400 +++++++++--------- .../SavedSearchesListByWorkspace.json | 2 +- ...WorkspacesSavedSearchesCreateOrUpdate.json | 2 +- .../examples/WorkspacesSavedSearchesGet.json | 2 +- 8 files changed, 208 insertions(+), 208 deletions(-) diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataSources.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataSources.json index 7f2126d9ea7c..2a89a4078fea 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataSources.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataSources.json @@ -279,7 +279,7 @@ "$ref": "#/definitions/Object", "description": "The data source properties in raw json format, each kind of data source have it's own schema." }, - "eTag": { + "etag": { "type": "string", "description": "The ETag of the data source." }, diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/SavedSearches.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/SavedSearches.json index 29a5022ca47c..74e3b4fc630b 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/SavedSearches.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/SavedSearches.json @@ -264,7 +264,7 @@ }, "SavedSearch": { "properties": { - "eTag": { + "etag": { "type": "string", "description": "The ETag of the saved search." }, diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesCreate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesCreate.json index f5163ab10916..aa37dbcd94ce 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesCreate.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesCreate.json @@ -20,7 +20,7 @@ "linkedResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/AzTest9724/datasources/AzTestDS774", - "eTag": "W/\"datetime'2017-10-01T08%3A01%3A21.2351243Z'\"", + "etag": "W/\"datetime'2017-10-01T08%3A01%3A21.2351243Z'\"", "name": "AzTestDS774", "type": "Microsoft.OperationalInsights/workspaces/datasources" } @@ -32,7 +32,7 @@ "linkedResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/AzTest9724/datasources/AzTestDS774", - "eTag": "W/\"datetime'2017-10-01T08%3A01%3A21.2351243Z'\"", + "etag": "W/\"datetime'2017-10-01T08%3A01%3A21.2351243Z'\"", "name": "AzTestDS774", "type": "Microsoft.OperationalInsights/workspaces/datasources" } diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesGet.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesGet.json index df03a4b5687d..b487e0dc26b5 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesGet.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesGet.json @@ -14,7 +14,7 @@ "linkedResourceId": "/subscriptions/00000000-0000-0000-0000-00000000000/providers/microsoft.insights/eventtypes/management" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest5123/providers/Microsoft.OperationalInsights/workspaces/AzTest9724/datasources/AzTestDS774", - "eTag": "W/\"datetime'2017-10-01T08%3A01%3A21.2351243Z'\"", + "etag": "W/\"datetime'2017-10-01T08%3A01%3A21.2351243Z'\"", "name": "AzTestDS774", "type": "Microsoft.OperationalInsights/workspaces/datasources" } diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesListByWorkspace.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesListByWorkspace.json index b24fee05304c..9b8663bd8525 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesListByWorkspace.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataSourcesListByWorkspace.json @@ -22,7 +22,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1011", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A08.5629323Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A08.5629323Z'\"", "name": "AzTestDSWE1011", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -37,7 +37,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1013", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A22.2533211Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A22.2533211Z'\"", "name": "AzTestDSWE1013", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -52,7 +52,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1020", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A04.4645698Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A04.4645698Z'\"", "name": "AzTestDSWE1020", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -67,7 +67,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1074", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A12.5871672Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A12.5871672Z'\"", "name": "AzTestDSWE1074", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -82,7 +82,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1117", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A28.9325389Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A28.9325389Z'\"", "name": "AzTestDSWE1117", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -97,7 +97,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1128", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A13.2185735Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A13.2185735Z'\"", "name": "AzTestDSWE1128", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -112,7 +112,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1176", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A22.7779289Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A22.7779289Z'\"", "name": "AzTestDSWE1176", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -127,7 +127,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1293", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A03.5114136Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A03.5114136Z'\"", "name": "AzTestDSWE1293", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -142,7 +142,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE134", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A33.6788897Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A33.6788897Z'\"", "name": "AzTestDSWE134", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -157,7 +157,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1352", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A36.2312139Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A36.2312139Z'\"", "name": "AzTestDSWE1352", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -172,7 +172,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1360", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A13.4685716Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A13.4685716Z'\"", "name": "AzTestDSWE1360", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -187,7 +187,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1382", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A19.2840543Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A19.2840543Z'\"", "name": "AzTestDSWE1382", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -202,7 +202,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1410", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A42.7070374Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A42.7070374Z'\"", "name": "AzTestDSWE1410", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -217,7 +217,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1417", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A06.8922838Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A06.8922838Z'\"", "name": "AzTestDSWE1417", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -232,7 +232,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1560", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A26.6932412Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A26.6932412Z'\"", "name": "AzTestDSWE1560", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -247,7 +247,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1618", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A07.1422661Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A07.1422661Z'\"", "name": "AzTestDSWE1618", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -262,7 +262,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1662", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A09.5980265Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A09.5980265Z'\"", "name": "AzTestDSWE1662", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -277,7 +277,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1675", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A39.6167744Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A39.6167744Z'\"", "name": "AzTestDSWE1675", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -292,7 +292,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE169", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A50.1064668Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A50.1064668Z'\"", "name": "AzTestDSWE169", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -307,7 +307,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1735", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A02.4954752Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A02.4954752Z'\"", "name": "AzTestDSWE1735", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -322,7 +322,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1742", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A08.0452997Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A08.0452997Z'\"", "name": "AzTestDSWE1742", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -337,7 +337,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1815", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A46.5966089Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A46.5966089Z'\"", "name": "AzTestDSWE1815", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -352,7 +352,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1828", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A23.6529754Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A23.6529754Z'\"", "name": "AzTestDSWE1828", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -367,7 +367,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE188", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A20.7216320Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A20.7216320Z'\"", "name": "AzTestDSWE188", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -382,7 +382,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1962", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A17.9341560Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A17.9341560Z'\"", "name": "AzTestDSWE1962", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -397,7 +397,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE1997", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A17.3081821Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A17.3081821Z'\"", "name": "AzTestDSWE1997", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -412,7 +412,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2046", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A49.2918213Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A49.2918213Z'\"", "name": "AzTestDSWE2046", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -427,7 +427,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2056", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A52.4111189Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A52.4111189Z'\"", "name": "AzTestDSWE2056", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -442,7 +442,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2116", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A54.7598026Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A54.7598026Z'\"", "name": "AzTestDSWE2116", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -457,7 +457,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2142", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A07.2711237Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A07.2711237Z'\"", "name": "AzTestDSWE2142", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -472,7 +472,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE22", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A48.2064500Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A48.2064500Z'\"", "name": "AzTestDSWE22", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -487,7 +487,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2208", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A08.7849248Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A08.7849248Z'\"", "name": "AzTestDSWE2208", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -502,7 +502,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2221", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A51.3306230Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A51.3306230Z'\"", "name": "AzTestDSWE2221", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -517,7 +517,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2226", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A25.5991266Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A25.5991266Z'\"", "name": "AzTestDSWE2226", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -532,7 +532,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2231", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A15.3592513Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A15.3592513Z'\"", "name": "AzTestDSWE2231", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -547,7 +547,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2242", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A06.0641077Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A06.0641077Z'\"", "name": "AzTestDSWE2242", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -562,7 +562,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2263", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A11.7829226Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A11.7829226Z'\"", "name": "AzTestDSWE2263", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -577,7 +577,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2369", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A21.5874093Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A21.5874093Z'\"", "name": "AzTestDSWE2369", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -592,7 +592,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE240", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A06.6266574Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A06.6266574Z'\"", "name": "AzTestDSWE240", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -607,7 +607,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2423", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A23.4752361Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A23.4752361Z'\"", "name": "AzTestDSWE2423", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -622,7 +622,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2463", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A36.5611370Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A36.5611370Z'\"", "name": "AzTestDSWE2463", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -637,7 +637,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2499", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A13.7187131Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A13.7187131Z'\"", "name": "AzTestDSWE2499", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -652,7 +652,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2509", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A09.3324224Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A09.3324224Z'\"", "name": "AzTestDSWE2509", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -667,7 +667,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2541", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A29.2312540Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A29.2312540Z'\"", "name": "AzTestDSWE2541", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -682,7 +682,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2578", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A05.3117461Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A05.3117461Z'\"", "name": "AzTestDSWE2578", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -697,7 +697,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2619", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A38.5379572Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A38.5379572Z'\"", "name": "AzTestDSWE2619", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -712,7 +712,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE274", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A05.0735592Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A05.0735592Z'\"", "name": "AzTestDSWE274", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -727,7 +727,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2754", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A30.6297451Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A30.6297451Z'\"", "name": "AzTestDSWE2754", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -742,7 +742,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE281", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A05.2972963Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A05.2972963Z'\"", "name": "AzTestDSWE281", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -757,7 +757,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2818", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A33.3820072Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A33.3820072Z'\"", "name": "AzTestDSWE2818", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -772,7 +772,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2860", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A14.0876077Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A14.0876077Z'\"", "name": "AzTestDSWE2860", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -787,7 +787,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2867", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A30.9266089Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A30.9266089Z'\"", "name": "AzTestDSWE2867", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -802,7 +802,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2923", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A27.9342580Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A27.9342580Z'\"", "name": "AzTestDSWE2923", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -817,7 +817,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE2979", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A44.4311007Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A44.4311007Z'\"", "name": "AzTestDSWE2979", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -832,7 +832,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3009", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A08.5349323Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A08.5349323Z'\"", "name": "AzTestDSWE3009", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -847,7 +847,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3033", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A24.9696296Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A24.9696296Z'\"", "name": "AzTestDSWE3033", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -862,7 +862,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3095", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A18.2006423Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A18.2006423Z'\"", "name": "AzTestDSWE3095", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -877,7 +877,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3114", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A38.2879169Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A38.2879169Z'\"", "name": "AzTestDSWE3114", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -892,7 +892,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3132", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A37.6889867Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A37.6889867Z'\"", "name": "AzTestDSWE3132", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -907,7 +907,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3147", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A58.9331954Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A58.9331954Z'\"", "name": "AzTestDSWE3147", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -922,7 +922,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3159", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A35.6843083Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A35.6843083Z'\"", "name": "AzTestDSWE3159", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -937,7 +937,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE317", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A17.4118415Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A17.4118415Z'\"", "name": "AzTestDSWE317", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -952,7 +952,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3175", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A35.0592573Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A35.0592573Z'\"", "name": "AzTestDSWE3175", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -967,7 +967,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3183", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A12.6247906Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A12.6247906Z'\"", "name": "AzTestDSWE3183", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -982,7 +982,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3217", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A14.4938899Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A14.4938899Z'\"", "name": "AzTestDSWE3217", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -997,7 +997,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3220", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A21.7373059Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A21.7373059Z'\"", "name": "AzTestDSWE3220", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1012,7 +1012,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3228", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A18.7785353Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A18.7785353Z'\"", "name": "AzTestDSWE3228", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1027,7 +1027,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3395", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A54.4936956Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A54.4936956Z'\"", "name": "AzTestDSWE3395", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1042,7 +1042,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3416", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A22.0032694Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A22.0032694Z'\"", "name": "AzTestDSWE3416", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1057,7 +1057,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3506", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A28.8251658Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A28.8251658Z'\"", "name": "AzTestDSWE3506", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1072,7 +1072,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3517", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A11.2153209Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A11.2153209Z'\"", "name": "AzTestDSWE3517", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1087,7 +1087,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3528", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A12.0402565Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A12.0402565Z'\"", "name": "AzTestDSWE3528", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1102,7 +1102,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3530", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A43.8027590Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A43.8027590Z'\"", "name": "AzTestDSWE3530", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1117,7 +1117,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3594", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A01.9173304Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A01.9173304Z'\"", "name": "AzTestDSWE3594", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1132,7 +1132,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3615", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A00.8990889Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A00.8990889Z'\"", "name": "AzTestDSWE3615", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1147,7 +1147,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3645", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A16.0877829Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A16.0877829Z'\"", "name": "AzTestDSWE3645", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1162,7 +1162,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3676", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A07.8068460Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A07.8068460Z'\"", "name": "AzTestDSWE3676", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1177,7 +1177,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3700", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A49.5439700Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A49.5439700Z'\"", "name": "AzTestDSWE3700", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1192,7 +1192,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3738", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A38.0363694Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A38.0363694Z'\"", "name": "AzTestDSWE3738", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1207,7 +1207,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3740", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A50.6390339Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A50.6390339Z'\"", "name": "AzTestDSWE3740", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1222,7 +1222,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3754", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A31.5203823Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A31.5203823Z'\"", "name": "AzTestDSWE3754", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1237,7 +1237,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3761", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A31.7860159Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A31.7860159Z'\"", "name": "AzTestDSWE3761", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1252,7 +1252,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3787", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A20.0966078Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A20.0966078Z'\"", "name": "AzTestDSWE3787", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1267,7 +1267,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3880", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A57.8394298Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A57.8394298Z'\"", "name": "AzTestDSWE3880", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1282,7 +1282,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3887", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A51.0806178Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A51.0806178Z'\"", "name": "AzTestDSWE3887", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1297,7 +1297,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3899", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A16.6987634Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A16.6987634Z'\"", "name": "AzTestDSWE3899", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1312,7 +1312,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE3928", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A41.4223363Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A41.4223363Z'\"", "name": "AzTestDSWE3928", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1327,7 +1327,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4005", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A59.1831854Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A59.1831854Z'\"", "name": "AzTestDSWE4005", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1342,7 +1342,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4021", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A31.5314824Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A31.5314824Z'\"", "name": "AzTestDSWE4021", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1357,7 +1357,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4054", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A01.6667691Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A01.6667691Z'\"", "name": "AzTestDSWE4054", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1372,7 +1372,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE406", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A42.9581303Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A42.9581303Z'\"", "name": "AzTestDSWE406", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1387,7 +1387,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4128", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A29.4890798Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A29.4890798Z'\"", "name": "AzTestDSWE4128", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1402,7 +1402,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4140", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A00.2051432Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A00.2051432Z'\"", "name": "AzTestDSWE4140", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1417,7 +1417,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4209", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A58.3706603Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A58.3706603Z'\"", "name": "AzTestDSWE4209", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1432,7 +1432,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4216", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A23.1240354Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A23.1240354Z'\"", "name": "AzTestDSWE4216", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1447,7 +1447,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4240", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A33.5368097Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A33.5368097Z'\"", "name": "AzTestDSWE4240", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1462,7 +1462,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4279", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A30.3641074Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A30.3641074Z'\"", "name": "AzTestDSWE4279", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1477,7 +1477,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4289", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A26.3963554Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A26.3963554Z'\"", "name": "AzTestDSWE4289", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1492,7 +1492,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4317", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A47.6751803Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A47.6751803Z'\"", "name": "AzTestDSWE4317", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1507,7 +1507,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4324", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A05.8120517Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A05.8120517Z'\"", "name": "AzTestDSWE4324", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1522,7 +1522,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4362", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A04.1208323Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A04.1208323Z'\"", "name": "AzTestDSWE4362", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1537,7 +1537,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4416", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A08.3109506Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A08.3109506Z'\"", "name": "AzTestDSWE4416", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1552,7 +1552,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4424", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A48.9744951Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A48.9744951Z'\"", "name": "AzTestDSWE4424", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1567,7 +1567,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4466", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A19.0457713Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A19.0457713Z'\"", "name": "AzTestDSWE4466", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1582,7 +1582,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4467", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A15.0936374Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A15.0936374Z'\"", "name": "AzTestDSWE4467", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1597,7 +1597,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4503", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A41.9399246Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A41.9399246Z'\"", "name": "AzTestDSWE4503", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1612,7 +1612,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4521", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A27.2714771Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A27.2714771Z'\"", "name": "AzTestDSWE4521", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1627,7 +1627,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4530", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A26.7419933Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A26.7419933Z'\"", "name": "AzTestDSWE4530", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1642,7 +1642,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4600", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A37.4227966Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A37.4227966Z'\"", "name": "AzTestDSWE4600", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1657,7 +1657,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4644", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A43.5519204Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A43.5519204Z'\"", "name": "AzTestDSWE4644", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1672,7 +1672,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4694", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A51.6431386Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A51.6431386Z'\"", "name": "AzTestDSWE4694", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1687,7 +1687,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4715", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A06.0530002Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A06.0530002Z'\"", "name": "AzTestDSWE4715", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1702,7 +1702,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE472", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A24.3989962Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A24.3989962Z'\"", "name": "AzTestDSWE472", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1717,7 +1717,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4721", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A16.3706498Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A16.3706498Z'\"", "name": "AzTestDSWE4721", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1732,7 +1732,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4734", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A33.8337155Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A33.8337155Z'\"", "name": "AzTestDSWE4734", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1747,7 +1747,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4755", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A25.2712759Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A25.2712759Z'\"", "name": "AzTestDSWE4755", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1762,7 +1762,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4779", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A27.5076680Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A27.5076680Z'\"", "name": "AzTestDSWE4779", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1777,7 +1777,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4791", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A04.6828938Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A04.6828938Z'\"", "name": "AzTestDSWE4791", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1792,7 +1792,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4798", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A54.0073520Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A54.0073520Z'\"", "name": "AzTestDSWE4798", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1807,7 +1807,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE480", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A22.9077505Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A22.9077505Z'\"", "name": "AzTestDSWE480", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1822,7 +1822,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4847", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A11.7028912Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A11.7028912Z'\"", "name": "AzTestDSWE4847", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1837,7 +1837,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4876", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A04.9847854Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A04.9847854Z'\"", "name": "AzTestDSWE4876", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1852,7 +1852,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4900", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A23.4029367Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A23.4029367Z'\"", "name": "AzTestDSWE4900", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1867,7 +1867,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4918", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A34.5280091Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A34.5280091Z'\"", "name": "AzTestDSWE4918", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1882,7 +1882,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4928", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A34.2882196Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A34.2882196Z'\"", "name": "AzTestDSWE4928", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1897,7 +1897,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4930", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A33.2381803Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A33.2381803Z'\"", "name": "AzTestDSWE4930", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1912,7 +1912,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4945", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A36.8423994Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A36.8423994Z'\"", "name": "AzTestDSWE4945", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1927,7 +1927,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4967", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A08.9379456Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A08.9379456Z'\"", "name": "AzTestDSWE4967", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1942,7 +1942,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4969", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A57.5893926Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A57.5893926Z'\"", "name": "AzTestDSWE4969", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1957,7 +1957,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE4983", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A19.5497139Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A19.5497139Z'\"", "name": "AzTestDSWE4983", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1972,7 +1972,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5011", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A48.4588661Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A48.4588661Z'\"", "name": "AzTestDSWE5011", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -1987,7 +1987,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5082", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A32.2694295Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A32.2694295Z'\"", "name": "AzTestDSWE5082", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2002,7 +2002,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5136", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A17.8863220Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A17.8863220Z'\"", "name": "AzTestDSWE5136", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2017,7 +2017,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5141", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A05.5484906Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A05.5484906Z'\"", "name": "AzTestDSWE5141", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2032,7 +2032,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5166", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A23.9283342Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A23.9283342Z'\"", "name": "AzTestDSWE5166", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2047,7 +2047,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5207", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A29.4970655Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A29.4970655Z'\"", "name": "AzTestDSWE5207", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2062,7 +2062,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5223", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A04.7146038Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A04.7146038Z'\"", "name": "AzTestDSWE5223", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2077,7 +2077,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5233", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A10.3237629Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A10.3237629Z'\"", "name": "AzTestDSWE5233", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2092,7 +2092,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5253", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A18.1831872Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A18.1831872Z'\"", "name": "AzTestDSWE5253", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2107,7 +2107,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5255", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A30.9049829Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A30.9049829Z'\"", "name": "AzTestDSWE5255", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2122,7 +2122,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5263", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A12.8904269Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A12.8904269Z'\"", "name": "AzTestDSWE5263", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2137,7 +2137,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5351", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A20.4543884Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A20.4543884Z'\"", "name": "AzTestDSWE5351", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2152,7 +2152,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5385", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A19.7997319Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A19.7997319Z'\"", "name": "AzTestDSWE5385", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2167,7 +2167,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5394", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A29.7703365Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A29.7703365Z'\"", "name": "AzTestDSWE5394", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2182,7 +2182,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE541", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A09.4692151Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A09.4692151Z'\"", "name": "AzTestDSWE541", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2197,7 +2197,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5439", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A15.7994161Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A15.7994161Z'\"", "name": "AzTestDSWE5439", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2212,7 +2212,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5460", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A10.3032105Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A10.3032105Z'\"", "name": "AzTestDSWE5460", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2227,7 +2227,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5479", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A24.6802546Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A24.6802546Z'\"", "name": "AzTestDSWE5479", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2242,7 +2242,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5483", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A01.1670463Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A01.1670463Z'\"", "name": "AzTestDSWE5483", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2257,7 +2257,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5486", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A37.1393156Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A37.1393156Z'\"", "name": "AzTestDSWE5486", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2272,7 +2272,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5554", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A41.1205470Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A41.1205470Z'\"", "name": "AzTestDSWE5554", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2287,7 +2287,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5559", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A20.7200407Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A20.7200407Z'\"", "name": "AzTestDSWE5559", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2302,7 +2302,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5585", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A18.4534330Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A18.4534330Z'\"", "name": "AzTestDSWE5585", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2317,7 +2317,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE568", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A40.8861587Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A40.8861587Z'\"", "name": "AzTestDSWE568", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2332,7 +2332,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5741", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A12.3059271Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A12.3059271Z'\"", "name": "AzTestDSWE5741", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2347,7 +2347,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE58", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A39.0692471Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A39.0692471Z'\"", "name": "AzTestDSWE58", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2362,7 +2362,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5810", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A16.9117573Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A16.9117573Z'\"", "name": "AzTestDSWE5810", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2377,7 +2377,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5815", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A45.4055476Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A45.4055476Z'\"", "name": "AzTestDSWE5815", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2392,7 +2392,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5858", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A55.0097893Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A55.0097893Z'\"", "name": "AzTestDSWE5858", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2407,7 +2407,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5866", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A18.9931389Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A18.9931389Z'\"", "name": "AzTestDSWE5866", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2422,7 +2422,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5888", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A59.4332080Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A59.4332080Z'\"", "name": "AzTestDSWE5888", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2437,7 +2437,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE5905", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A09.7599986Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A09.7599986Z'\"", "name": "AzTestDSWE5905", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2452,7 +2452,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6027", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A10.6395291Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A10.6395291Z'\"", "name": "AzTestDSWE6027", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2467,7 +2467,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE607", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A13.7282386Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A13.7282386Z'\"", "name": "AzTestDSWE607", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2482,7 +2482,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6099", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A33.1319662Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A33.1319662Z'\"", "name": "AzTestDSWE6099", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2497,7 +2497,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6122", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A06.3186640Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A06.3186640Z'\"", "name": "AzTestDSWE6122", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2512,7 +2512,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6218", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A11.4528829Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A11.4528829Z'\"", "name": "AzTestDSWE6218", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2527,7 +2527,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE622", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A47.9407875Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A47.9407875Z'\"", "name": "AzTestDSWE622", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2542,7 +2542,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6222", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A06.3453921Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A06.3453921Z'\"", "name": "AzTestDSWE6222", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2557,7 +2557,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6240", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A21.2372832Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A21.2372832Z'\"", "name": "AzTestDSWE6240", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2572,7 +2572,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6251", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A08.2849036Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A08.2849036Z'\"", "name": "AzTestDSWE6251", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2587,7 +2587,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6274", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A02.1829375Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A02.1829375Z'\"", "name": "AzTestDSWE6274", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2602,7 +2602,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6296", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A32.3491070Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A32.3491070Z'\"", "name": "AzTestDSWE6296", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2617,7 +2617,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6301", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A22.1811938Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A22.1811938Z'\"", "name": "AzTestDSWE6301", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2632,7 +2632,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6404", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A06.7093003Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A06.7093003Z'\"", "name": "AzTestDSWE6404", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2647,7 +2647,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6406", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A05.5617435Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A05.5617435Z'\"", "name": "AzTestDSWE6406", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2662,7 +2662,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6432", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A40.2886854Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A40.2886854Z'\"", "name": "AzTestDSWE6432", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2677,7 +2677,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6439", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A35.9811949Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A35.9811949Z'\"", "name": "AzTestDSWE6439", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2692,7 +2692,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6451", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A13.1344490Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A13.1344490Z'\"", "name": "AzTestDSWE6451", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2707,7 +2707,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6486", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A10.9653354Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A10.9653354Z'\"", "name": "AzTestDSWE6486", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2722,7 +2722,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6505", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A10.0582011Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A10.0582011Z'\"", "name": "AzTestDSWE6505", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2737,7 +2737,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6514", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A52.8955201Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A52.8955201Z'\"", "name": "AzTestDSWE6514", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2752,7 +2752,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6518", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A10.9395226Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A10.9395226Z'\"", "name": "AzTestDSWE6518", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2767,7 +2767,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6537", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A24.0123335Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A24.0123335Z'\"", "name": "AzTestDSWE6537", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2782,7 +2782,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6547", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A57.3394082Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A57.3394082Z'\"", "name": "AzTestDSWE6547", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2797,7 +2797,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6556", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A33.9457044Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A33.9457044Z'\"", "name": "AzTestDSWE6556", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2812,7 +2812,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6718", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A13.4313542Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A13.4313542Z'\"", "name": "AzTestDSWE6718", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2827,7 +2827,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6724", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A35.4186784Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A35.4186784Z'\"", "name": "AzTestDSWE6724", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2842,7 +2842,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6741", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A12.3279180Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A12.3279180Z'\"", "name": "AzTestDSWE6741", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2857,7 +2857,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6796", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A24.5764501Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A24.5764501Z'\"", "name": "AzTestDSWE6796", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2872,7 +2872,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6826", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A35.2579899Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A35.2579899Z'\"", "name": "AzTestDSWE6826", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2887,7 +2887,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6829", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A34.6319483Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A34.6319483Z'\"", "name": "AzTestDSWE6829", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2902,7 +2902,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6893", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A28.5887776Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A28.5887776Z'\"", "name": "AzTestDSWE6893", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2917,7 +2917,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE6974", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A16.1249736Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A16.1249736Z'\"", "name": "AzTestDSWE6974", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2932,7 +2932,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE7008", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A28.3876585Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A28.3876585Z'\"", "name": "AzTestDSWE7008", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2947,7 +2947,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE7014", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A29.1220764Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A29.1220764Z'\"", "name": "AzTestDSWE7014", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2962,7 +2962,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE7068", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A26.0213457Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A26.0213457Z'\"", "name": "AzTestDSWE7068", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2977,7 +2977,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE7080", - "eTag": "W/\"datetime'2017-10-02T23%3A21%3A21.8686663Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A21%3A21.8686663Z'\"", "name": "AzTestDSWE7080", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -2992,7 +2992,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE7166", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A40.5423724Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A40.5423724Z'\"", "name": "AzTestDSWE7166", "type": "Microsoft.OperationalInsights/workspaces/datasources" }, @@ -3007,7 +3007,7 @@ ] }, "id": "/subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/OIAutoRest7887/providers/Microsoft.OperationalInsights/workspaces/AzTest218/datasources/AzTestDSWE7178", - "eTag": "W/\"datetime'2017-10-02T23%3A20%3A16.3906307Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A20%3A16.3906307Z'\"", "name": "AzTestDSWE7178", "type": "Microsoft.OperationalInsights/workspaces/datasources" } diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/SavedSearchesListByWorkspace.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/SavedSearchesListByWorkspace.json index 25158ff857e8..9240ce652512 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/SavedSearchesListByWorkspace.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/SavedSearchesListByWorkspace.json @@ -10,7 +10,7 @@ "body": [ { "id": "subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/AtlantisDemo/savedSearches/test-new-saved-search-id-2015", - "eTag": "W/\"datetime'2017-10-02T23%3A15%3A41.0709875Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A15%3A41.0709875Z'\"", "properties": { "Category": " Saved Search Test Category", "DisplayName": "Create or Update Saved Search Test", diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/WorkspacesSavedSearchesCreateOrUpdate.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/WorkspacesSavedSearchesCreateOrUpdate.json index 0c49ad9f5aa6..e9bcba71fee5 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/WorkspacesSavedSearchesCreateOrUpdate.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/WorkspacesSavedSearchesCreateOrUpdate.json @@ -27,7 +27,7 @@ "200": { "body": { "id": "subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/AtlantisDemo/savedSearches/test-new-saved-search-id-2015", - "eTag": "W/\"datetime'2017-10-02T23%3A15%3A41.0709875Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A15%3A41.0709875Z'\"", "properties": { "category": "Saved Search Test Category", "displayName": "Create or Update Saved Search Test", diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/WorkspacesSavedSearchesGet.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/WorkspacesSavedSearchesGet.json index 7bbd32bc60e8..77a69171831c 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/WorkspacesSavedSearchesGet.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/WorkspacesSavedSearchesGet.json @@ -11,7 +11,7 @@ "200": { "body": { "id": "subscriptions/00000000-0000-0000-0000-000000000005/resourceGroups/mms-eus/providers/Microsoft.OperationalInsights/workspaces/AtlantisDemo/savedSearches/test-new-saved-search-id-2015", - "eTag": "W/\"datetime'2017-10-02T23%3A15%3A41.0709875Z'\"", + "etag": "W/\"datetime'2017-10-02T23%3A15%3A41.0709875Z'\"", "properties": { "category": " Saved Search Test Category", "displayName": "Create or Update Saved Search Test", From b4d86c9b275bc33e17184f6eddcbafa85b613e14 Mon Sep 17 00:00:00 2001 From: tofriedl <50571149+tofriedl@users.noreply.github.com> Date: Thu, 4 Jun 2020 09:00:27 +0300 Subject: [PATCH 082/318] IngestionMode Flag (#9654) * IngestionMode Flag * fix for missing bracket * diganostic with an A --- .../preview/2018-05-01-preview/components_API.json | 14 ++++++++++++++ .../examples/ComponentsCreate.json | 6 ++++-- .../2018-05-01-preview/examples/ComponentsGet.json | 3 ++- .../examples/ComponentsList.json | 6 ++++-- .../examples/ComponentsListByResourceGroup.json | 6 ++++-- .../examples/ComponentsUpdate.json | 6 ++++-- .../examples/ComponentsUpdateTagsOnly.json | 6 ++++-- .../preview/2020-02-02-preview/components_API.json | 14 ++++++++++++++ .../examples/ComponentsCreate.json | 3 ++- .../2020-02-02-preview/examples/ComponentsGet.json | 3 ++- .../examples/ComponentsList.json | 6 ++++-- .../examples/ComponentsListByResourceGroup.json | 6 ++++-- .../examples/ComponentsUpdate.json | 3 ++- .../examples/ComponentsUpdateTagsOnly.json | 3 ++- .../stable/2015-05-01/components_API.json | 14 ++++++++++++++ .../2015-05-01/examples/ComponentsCreate.json | 3 ++- .../stable/2015-05-01/examples/ComponentsGet.json | 3 ++- .../stable/2015-05-01/examples/ComponentsList.json | 6 ++++-- .../examples/ComponentsListByResourceGroup.json | 6 ++++-- .../2015-05-01/examples/ComponentsUpdate.json | 3 ++- .../examples/ComponentsUpdateTagsOnly.json | 3 ++- 21 files changed, 96 insertions(+), 27 deletions(-) diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/components_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/components_API.json index fc10d313cfce..8ba066afb183 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/components_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/components_API.json @@ -532,6 +532,20 @@ "publicNetworkAccessForQuery": { "description": "The network access type for accessing Application Insights query.", "$ref": "#/definitions/PublicNetworkAccessType" + }, + "IngestionMode": { + "type": "string", + "description": "Indicates the flow of the ingestion.", + "default": "ApplicationInsights", + "enum": [ + "ApplicationInsights", + "ApplicationInsightsWithDiagnosticSettings", + "LogAnalytics" + ], + "x-ms-enum": { + "name": "IngestionMode", + "modelAsString": true + } } }, "required": [ diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsCreate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsCreate.json index 17a28fdee20e..70a74516f4e0 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsCreate.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsCreate.json @@ -41,7 +41,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } } }, @@ -71,7 +72,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsGet.json index 3ace22b9672d..68d5f62719a7 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsGet.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsGet.json @@ -32,7 +32,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsList.json index 281a057d8188..d9790161b4a4 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsList.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsList.json @@ -32,7 +32,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } }, { @@ -60,7 +61,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } } ], diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsListByResourceGroup.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsListByResourceGroup.json index cee24e3764c9..8a34e64eb8a2 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsListByResourceGroup.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsListByResourceGroup.json @@ -33,7 +33,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } }, { @@ -61,7 +62,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } } ], diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdate.json index b9df659a3d3f..30c8ce16a5e9 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdate.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdate.json @@ -43,7 +43,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } } }, @@ -76,7 +77,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdateTagsOnly.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdateTagsOnly.json index 9d8d07877055..911c023ab0a9 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdateTagsOnly.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2018-05-01-preview/examples/ComponentsUpdateTagsOnly.json @@ -47,7 +47,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } } }, @@ -83,7 +84,8 @@ "DisableIpMasking": false, "ImmediatePurgeDataOn30Days": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "ApplicationInsights" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json index 71cb6350a36c..c8606af89280 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json @@ -524,6 +524,20 @@ "publicNetworkAccessForQuery": { "description": "The network access type for accessing Application Insights query.", "$ref": "#/definitions/PublicNetworkAccessType" + }, + "IngestionMode": { + "type": "string", + "description": "Indicates the flow of the ingestion.", + "default": "LogAnalytics", + "enum": [ + "ApplicationInsights", + "ApplicationInsightsWithDiagnosticSettings", + "LogAnalytics" + ], + "x-ms-enum": { + "name": "IngestionMode", + "modelAsString": true + } } }, "required": [ diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsCreate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsCreate.json index b60e0da5861a..fbc47f63d6ab 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsCreate.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsCreate.json @@ -41,7 +41,8 @@ "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsGet.json index 8dc5e137725f..bbb10c0b9ceb 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsGet.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsGet.json @@ -31,7 +31,8 @@ "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsList.json index 1a0e3d80e2eb..e1b8fef73125 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsList.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsList.json @@ -31,7 +31,8 @@ "ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc", "DisableIpMasking": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" } }, { @@ -58,7 +59,8 @@ "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" } } ], diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsListByResourceGroup.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsListByResourceGroup.json index 93423a2b9955..26738b90bc39 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsListByResourceGroup.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsListByResourceGroup.json @@ -32,7 +32,8 @@ "ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc", "DisableIpMasking": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" } }, { @@ -59,7 +60,8 @@ "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" } } ], diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdate.json index e02186407ca7..bb68a86b7bfb 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdate.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdate.json @@ -42,7 +42,8 @@ "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdateTagsOnly.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdateTagsOnly.json index 806476c3cf96..7ca0781617d0 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdateTagsOnly.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/examples/ComponentsUpdateTagsOnly.json @@ -46,7 +46,8 @@ "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, "publicNetworkAccessForQuery": "Enabled", - "publicNetworkAccessForIngestion": "Enabled" + "publicNetworkAccessForIngestion": "Enabled", + "IngestionMode": "LogAnalytics" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json index 507d3910d1b1..73eb9e993907 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/components_API.json @@ -512,6 +512,20 @@ "$ref": "#/definitions/PrivateLinkScopedResource" }, "description": "List of linked private link scope resources." + }, + "IngestionMode": { + "type": "string", + "description": "Indicates the flow of the ingestion.", + "default": "ApplicationInsights", + "enum": [ + "ApplicationInsights", + "ApplicationInsightsWithDiagnosticSettings", + "LogAnalytics" + ], + "x-ms-enum": { + "name": "IngestionMode", + "modelAsString": true + } } }, "required": [ diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsCreate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsCreate.json index a2603e240382..88bcfebb39ce 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsCreate.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsCreate.json @@ -39,7 +39,8 @@ "RetentionInDays": 90, "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, - "ImmediatePurgeDataOn30Days": false + "ImmediatePurgeDataOn30Days": false, + "IngestionMode": "ApplicationInsights" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsGet.json index ea7eb18ea7d0..c00693fd1988 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsGet.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsGet.json @@ -30,7 +30,8 @@ "RetentionInDays": 90, "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, - "ImmediatePurgeDataOn30Days": false + "ImmediatePurgeDataOn30Days": false, + "IngestionMode": "ApplicationInsights" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsList.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsList.json index ccb105e6cac0..3b8fbf90a8ee 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsList.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsList.json @@ -30,7 +30,8 @@ "RetentionInDays": 90, "ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc", "DisableIpMasking": false, - "ImmediatePurgeDataOn30Days": false + "ImmediatePurgeDataOn30Days": false, + "IngestionMode": "ApplicationInsights" } }, { @@ -56,7 +57,8 @@ "RetentionInDays": 90, "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, - "ImmediatePurgeDataOn30Days": false + "ImmediatePurgeDataOn30Days": false, + "IngestionMode": "ApplicationInsights" } } ], diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsListByResourceGroup.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsListByResourceGroup.json index dc9c2b395132..92bc4f1c5498 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsListByResourceGroup.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsListByResourceGroup.json @@ -31,7 +31,8 @@ "RetentionInDays": 90, "ConnectionString": "InstrumentationKey=dc5931c7-a7ad-4ad0-89d6-123456789abc", "DisableIpMasking": false, - "ImmediatePurgeDataOn30Days": false + "ImmediatePurgeDataOn30Days": false, + "IngestionMode": "ApplicationInsights" } }, { @@ -57,7 +58,8 @@ "RetentionInDays": 90, "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, - "ImmediatePurgeDataOn30Days": false + "ImmediatePurgeDataOn30Days": false, + "IngestionMode": "ApplicationInsights" } } ], diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdate.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdate.json index ac92ef81e926..9ab62afd13e7 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdate.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdate.json @@ -41,7 +41,8 @@ "RetentionInDays": 90, "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, - "ImmediatePurgeDataOn30Days": false + "ImmediatePurgeDataOn30Days": false, + "IngestionMode": "ApplicationInsights" } } } diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdateTagsOnly.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdateTagsOnly.json index 3487365d9a29..8bbbfec88eb7 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdateTagsOnly.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/stable/2015-05-01/examples/ComponentsUpdateTagsOnly.json @@ -45,7 +45,8 @@ "RetentionInDays": 90, "ConnectionString": "InstrumentationKey=bc095013-3cf2-45ac-ab47-123456789abc", "DisableIpMasking": false, - "ImmediatePurgeDataOn30Days": false + "ImmediatePurgeDataOn30Days": false, + "IngestionMode": "ApplicationInsights" } } } From 2bb5fa7b4e52c5e2b6176c76acdd46d00b6eb7c4 Mon Sep 17 00:00:00 2001 From: Pan Li Date: Thu, 4 Jun 2020 14:43:35 +0800 Subject: [PATCH 083/318] Update property range due to tier sensitive. (#9422) Signed-off-by: Pan Li --- .../preview/2019-05-01-preview/appplatform.json | 12 +++--------- 1 file changed, 3 insertions(+), 9 deletions(-) diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json index 77f3b8fb53e2..603eec484d3f 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json @@ -3186,18 +3186,14 @@ "properties": { "cpu": { "format": "int32", - "description": "Required CPU", + "description": "Required CPU, basic tier should be 1, standard tier should be in range (1, 4)", "default": 1, - "maximum": 4.0, - "minimum": 1.0, "type": "integer" }, "memoryInGB": { "format": "int32", - "description": "Required Memory size in GB", + "description": "Required Memory size in GB, basic tier should be in range (1, 2), standard tier should be in range (1, 8)", "default": 1, - "maximum": 8.0, - "minimum": 1.0, "type": "integer" }, "jvmOptions": { @@ -3206,10 +3202,8 @@ }, "instanceCount": { "format": "int32", - "description": "Instance count", + "description": "Instance count, basic tier should be in range (1, 25), standard tier should be in range (1, 500)", "default": 1, - "maximum": 20.0, - "minimum": 1.0, "type": "integer" }, "environmentVariables": { From 7a2c7d75dbbc94ea7a788d5d0527a4b810ef6335 Mon Sep 17 00:00:00 2001 From: Zihong Date: Thu, 4 Jun 2020 14:46:54 +0800 Subject: [PATCH 084/318] fix swagger bug (#9709) --- .../preview/2019-05-01-preview/appplatform.json | 3 --- 1 file changed, 3 deletions(-) diff --git a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json index 603eec484d3f..773e65c8d69f 100644 --- a/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json +++ b/specification/appplatform/resource-manager/Microsoft.AppPlatform/preview/2019-05-01-preview/appplatform.json @@ -2336,9 +2336,6 @@ }, "Sku": { "description": "Sku of Azure Spring Cloud", - "required": [ - "name" - ], "type": "object", "properties": { "name": { From e521d49bb1d1f262bd2131b57eea5c1436047650 Mon Sep 17 00:00:00 2001 From: xuzhang3 <57888764+xuzhang3@users.noreply.github.com> Date: Thu, 4 Jun 2020 15:56:47 +0800 Subject: [PATCH 085/318] Update GraphQuery location property readOnly=false (#9568) * remove location readOnly property * set location readOnly false --- .../preview/2018-09-01-preview/graphquery.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/graphquery.json b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/graphquery.json index d31c784ea472..79dfb25c2b9e 100644 --- a/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/graphquery.json +++ b/specification/resourcegraph/resource-manager/Microsoft.ResourceGraph/preview/2018-09-01-preview/graphquery.json @@ -269,7 +269,7 @@ }, "location": { "type": "string", - "readOnly": true, + "readOnly": false, "description": "The location of the resource" }, "type": { From 13f90d4c973d4f3e3f98f6c89aaa3b54d64b8b28 Mon Sep 17 00:00:00 2001 From: lapradh <66009265+lapradh@users.noreply.github.com> Date: Thu, 4 Jun 2020 15:57:46 +0530 Subject: [PATCH 086/318] Update bms.json (#9711) Azure Backup Health --- .../stable/2019-06-15/bms.json | 58 ++++++++++++++++++- 1 file changed, 55 insertions(+), 3 deletions(-) diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json index aa358fefa44b..d9b32439141c 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json @@ -1303,11 +1303,16 @@ } }, "healthStatus": { - "description": "backups running status for this backup item.", + "description": "Health status of protected item.", "enum": [ "Passed", "ActionRequired", "ActionSuggested", + "Healthy", + "TransientDegraded", + "PersistentDegraded", + "TransientUnhealthy", + "PersistentUnhealthy", "Invalid" ], "type": "string", @@ -1316,6 +1321,13 @@ "modelAsString": true } }, + "healthDetails": { + "description": "Health details on this backup item.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthDetails" + } + }, "lastBackupStatus": { "description": "Last backup operation status. Possible values: Healthy, Unhealthy.", "type": "string" @@ -1618,8 +1630,8 @@ } } }, - "AzureIaaSVMHealthDetails": { - "description": "Azure IaaS VM workload-specific Health Details.", + "HealthDetails": { + "description": "Health Details for backup items.", "type": "object", "properties": { "code": { @@ -1648,6 +1660,15 @@ } } }, + "AzureIaaSVMHealthDetails": { + "description": "Azure IaaS VM workload-specific Health Details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/HealthDetails" + } + ] + }, "AzureIaaSVMJob": { "description": "Azure IaaS VM workload-specific job object.", "type": "object", @@ -1821,6 +1842,11 @@ "Passed", "ActionRequired", "ActionSuggested", + "Healthy", + "TransientDegraded", + "PersistentDegraded", + "TransientUnhealthy", + "PersistentUnhealthy", "Invalid" ], "type": "string", @@ -2182,6 +2208,32 @@ "modelAsString": true } }, + "healthStatus": { + "description": "Health status of protected item.", + "enum": [ + "Passed", + "ActionRequired", + "ActionSuggested", + "Healthy", + "TransientDegraded", + "PersistentDegraded", + "TransientUnhealthy", + "PersistentUnhealthy", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "HealthStatus", + "modelAsString": true + } + }, + "healthDetails": { + "description": "Health details on this backup item.", + "type": "array", + "items": { + "$ref": "#/definitions/HealthDetails" + } + }, "extendedInfo": { "$ref": "#/definitions/AzureVmWorkloadProtectedItemExtendedInfo", "description": "Additional information for this backup item." From c3dd5df2863101b56eef256b810927cdcc4e44d2 Mon Sep 17 00:00:00 2001 From: Brian Crawford Date: Thu, 4 Jun 2020 10:58:22 -0700 Subject: [PATCH 087/318] Azure Digital Twins 2020-05-31-preview (#9622) * Azure Digital Twins 2020-05-31-preview swagger. * Updates. * Updates. * Update host name. * Add custom words. * Fix host name so that verification tools work. * Prettier updates. * Try file name without spaces. * Update md files. * Add missing api-version. * Fix readme.go.md. --- custom-words.txt | 4 + .../2020-05-31-preview/digitaltwins.json | 1497 +++++++++++++++++ .../CreateRelationshipAdvancedExample.json | 25 + .../CreateRelationshipBasicExample.json | 21 + .../examples/DeleteModel.json | 9 + .../examples/DeleteRelationship.json | 10 + .../examples/DeleteTwin.json | 9 + .../examples/EventRouteDelete.json | 9 + .../examples/EventRouteGet.json | 15 + .../examples/EventRoutePut.json | 13 + .../examples/EventRoutePutWithFilter.json | 13 + .../examples/EventRoutesList.json | 24 + .../examples/GetComponent.json | 53 + .../examples/GetIncomingRelationship.json | 27 + .../examples/GetRelationship.json | 29 + .../examples/GetRelationshipById.json | 18 + .../GetRelationshipByRelationshipName.json | 30 + .../2020-05-31-preview/examples/GetTwin.json | 53 + .../2020-05-31-preview/examples/ModelAdd.json | 47 + .../examples/ModelGetById.json | 15 + ...odelGetByIdWithIncludeModelDefinition.json | 41 + .../examples/ModelUpdateDecommissioned.json | 16 + .../examples/ModelsGet.json | 35 + ...DependenciesAndIncludeModelDefinition.json | 70 + .../PatchComponentAdvancedExample.json | 27 + .../examples/PatchComponentBasicExample.json | 18 + .../PatchRelationshipAdvancedExample.json | 26 + .../PatchRelationshipBasicExample.json | 17 + .../examples/PatchTwinAdvancedExample.json | 26 + .../examples/PatchTwinBasicExample.json | 17 + .../examples/PutTwinAdvancedExample.json | 71 + .../examples/PutTwinBasicExample.json | 22 + .../examples/QueryFirstPage.json | 44 + .../examples/QueryJoin.json | 56 + .../examples/QueryNextPage.json | 43 + .../examples/SendTelemetry.json | 14 + .../examples/SendTelemetryFromComponent.json | 15 + .../digitaltwins/data-plane/readme.csharp.md | 15 + .../digitaltwins/data-plane/readme.go.md | 19 + .../digitaltwins/data-plane/readme.md | 79 + .../digitaltwins/data-plane/readme.python.md | 21 + .../digitaltwins/data-plane/readme.ruby.md | 19 + .../data-plane/readme.typescript.md | 13 + 43 files changed, 2645 insertions(+) create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/digitaltwins.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/CreateRelationshipAdvancedExample.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/CreateRelationshipBasicExample.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteModel.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteRelationship.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteTwin.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRouteDelete.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRouteGet.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutePut.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutePutWithFilter.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutesList.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetComponent.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetIncomingRelationship.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationship.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationshipById.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationshipByRelationshipName.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetTwin.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelAdd.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelGetById.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelGetByIdWithIncludeModelDefinition.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelUpdateDecommissioned.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelsGet.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchComponentAdvancedExample.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchComponentBasicExample.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchRelationshipAdvancedExample.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchRelationshipBasicExample.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchTwinAdvancedExample.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchTwinBasicExample.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PutTwinAdvancedExample.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PutTwinBasicExample.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryFirstPage.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryJoin.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryNextPage.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/SendTelemetry.json create mode 100644 specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/SendTelemetryFromComponent.json create mode 100644 specification/digitaltwins/data-plane/readme.csharp.md create mode 100644 specification/digitaltwins/data-plane/readme.go.md create mode 100644 specification/digitaltwins/data-plane/readme.md create mode 100644 specification/digitaltwins/data-plane/readme.python.md create mode 100644 specification/digitaltwins/data-plane/readme.ruby.md create mode 100644 specification/digitaltwins/data-plane/readme.typescript.md diff --git a/custom-words.txt b/custom-words.txt index 67cd81c107c0..2e9c5fa304cf 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -466,6 +466,7 @@ domainservices DOTALL DRMs dsmax +DTDL Dtus duration'PT EAPMSCHA @@ -507,6 +508,7 @@ ErrorSchema Español estaba Etag +etags Ethereum evalue evaluateautoscale @@ -515,6 +517,7 @@ eventgrid Eventhub eventhubconnections eventhubs +eventroutes eventtime eventtypes EWDG @@ -688,6 +691,7 @@ imagesearch IMDS importdevices Inbuild +incomingrelationships indic inferencing Informations diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/digitaltwins.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/digitaltwins.json new file mode 100644 index 000000000000..b17bda728464 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/digitaltwins.json @@ -0,0 +1,1497 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-05-31-preview", + "title": "Azure Digital Twins API", + "description": "A service for managing and querying digital twins and digital twin models." + }, + "host": "digitaltwins-name.digitaltwins.azure.net", + "schemes": [ + "https" + ], + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ], + "paths": { + "/models": { + "post": { + "tags": [ + "Models" + ], + "description": "Uploads one or more models. When any error occurs, no models are uploaded.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n409 (Conflict): One or more of the provided models already exist.", + "operationId": "DigitalTwinModels_Add", + "x-ms-examples": { + "ModelAdd": { + "$ref": "./examples/ModelAdd.json" + } + }, + "parameters": [ + { + "name": "models", + "in": "body", + "description": "An array of models to add.", + "required": false, + "schema": { + "type": "array", + "minItems": 1, + "uniqueItems": true, + "items": { + "type": "object" + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NonPagedModelDataCollection" + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "Models" + ], + "description": "Retrieves model metadata and, optionally, model definitions.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "DigitalTwinModels_List", + "x-ms-examples": { + "ModelsGet": { + "$ref": "./examples/ModelsGet.json" + }, + "ModelsGetWithContextAndIncludeModelDefinition": { + "$ref": "./examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json" + } + }, + "parameters": [ + { + "name": "dependenciesFor", + "in": "query", + "description": "The set of the models which will have their dependencies retrieved. If omitted, all models are retrieved.", + "required": false, + "type": "array", + "collectionFormat": "multi", + "items": { + "type": "string" + } + }, + { + "$ref": "#/parameters/includeModelDefinition" + }, + { + "$ref": "#/parameters/max-item-count" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/PagedModelDataCollection" + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/models/{id}": { + "get": { + "tags": [ + "Models" + ], + "description": "Retrieves model metadata and optionally the model definition.\nStatus codes:\n200 (OK): Success.\n404 (Not Found): There is no model with the provided id.", + "operationId": "DigitalTwinModels_GetById", + "x-ms-examples": { + "ModelGetById": { + "$ref": "./examples/ModelGetById.json" + }, + "ModelGetByIdWithIncludeModelDefinition": { + "$ref": "./examples/ModelGetByIdWithIncludeModelDefinition.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/modelId" + }, + { + "$ref": "#/parameters/includeModelDefinition" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ModelData" + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Models" + ], + "description": "Updates the metadata for a model.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is no model with the provided id.", + "operationId": "DigitalTwinModels_Update", + "consumes": [ + "application/json-patch+json" + ], + "x-ms-examples": { + "ModelUpdateDecommissioned": { + "$ref": "./examples/ModelUpdateDecommissioned.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/modelId" + }, + { + "name": "updateModel", + "description": "An update specification described by JSON Patch. Only the decommissioned property can be replaced.", + "in": "body", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "object" + } + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Models" + ], + "operationId": "DigitalTwinModels_Delete", + "description": "Deletes a model. A model can only be deleted if no other models reference it.\nStatus codes:\n204 (No Content): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is no model with the provided id.\n409 (Conflict): There are dependencies on the model that prevent it from being deleted.", + "x-ms-examples": { + "DeleteModel": { + "$ref": "./examples/DeleteModel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/modelId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_QueryTwins", + "description": "Executes a query that allows traversing relationships and filtering by property values.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.", + "x-ms-examples": { + "QueryFirstPage": { + "$ref": "./examples/QueryFirstPage.json" + }, + "QueryNextPage": { + "$ref": "./examples/QueryNextPage.json" + }, + "QueryJoin": { + "$ref": "./examples/QueryJoin.json" + } + }, + "parameters": [ + { + "name": "querySpecification", + "in": "body", + "description": "The query specification to execute.", + "required": true, + "schema": { + "$ref": "#/definitions/QuerySpecification" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/QueryResult" + }, + "headers": { + "query-charge": { + "description": "The query charge.", + "type": "number" + } + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/digitaltwins/{id}": { + "get": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_GetById", + "description": "Retrieves a digital twin.\nStatus codes:\n200 (OK): Success.\n404 (Not Found): There is no digital twin with the provided id.", + "x-ms-examples": { + "GetTwin": { + "$ref": "./examples/GetTwin.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object" + }, + "headers": { + "ETag": { + "description": "Weak Etag.", + "type": "string" + } + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_Add", + "description": "Adds or replaces a digital twin.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n412 (Precondition Failed): The model is decommissioned or the digital twin already exists (when using If-None-Match: *).", + "x-ms-examples": { + "PutTwinBasicExample": { + "$ref": "./examples/PutTwinBasicExample.json" + }, + "PutTwinAdvancedExample": { + "$ref": "./examples/PutTwinAdvancedExample.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "name": "twin", + "description": "The digital twin instance being added. If provided, the $dtId property is ignored.", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + }, + { + "$ref": "#/parameters/if-none-match-star" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object" + }, + "headers": { + "ETag": { + "description": "Weak Etag.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_Delete", + "description": "Deletes a digital twin. All relationships referencing the digital twin must already be deleted.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is no digital twin with the provided id.", + "x-ms-examples": { + "DeleteTwin": { + "$ref": "./examples/DeleteTwin.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "$ref": "#/parameters/if-match" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_Update", + "description": "Updates a digital twin.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is no digital twin with the provided id.", + "consumes": [ + "application/json-patch+json" + ], + "x-ms-examples": { + "PatchTwinBasicExample": { + "$ref": "./examples/PatchTwinBasicExample.json" + }, + "PatchTwinAdvancedExample": { + "$ref": "./examples/PatchTwinAdvancedExample.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "name": "patchDocument", + "description": "An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove.", + "in": "body", + "required": true, + "schema": { + "type": "array", + "items": { + "type": "object" + } + } + }, + { + "$ref": "#/parameters/if-match" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success", + "headers": { + "ETag": { + "description": "Weak Etag.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/digitaltwins/{id}/relationships/{relationshipId}": { + "get": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_GetRelationshipById", + "description": "Retrieves a relationship between two digital twins.\nStatus codes:\n200 (OK): Success.\n404 (Not Found): There is either no digital twin or relationship with the provided id.", + "x-ms-examples": { + "GetRelationshipById": { + "$ref": "./examples/GetRelationshipById.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "$ref": "#/parameters/relationshipId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object" + }, + "headers": { + "ETag": { + "description": "Weak Etag.", + "type": "string" + } + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_AddRelationship", + "description": "Adds a relationship between two digital twins.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is either no digital twin, target digital twin, or relationship with the provided id.\n409 (Conflict): A relationship with the provided id already exists.", + "x-ms-examples": { + "CreateRelationshipBasicExample": { + "$ref": "./examples/CreateRelationshipBasicExample.json" + }, + "CreateRelationshipAdvancedExample": { + "$ref": "./examples/CreateRelationshipAdvancedExample.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "$ref": "#/parameters/relationshipId" + }, + { + "name": "relationship", + "in": "body", + "description": "The data for the relationship.", + "required": false, + "schema": { + "type": "object" + } + }, + { + "$ref": "#/parameters/if-none-match-star" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object" + }, + "headers": { + "ETag": { + "description": "Weak Etag.", + "type": "string" + } + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_DeleteRelationship", + "description": "Deletes a relationship between two digital twins.\nStatus codes:\n200 (OK): Success.\n404 (Not Found): There is either no digital twin or relationship with the provided id.", + "x-ms-examples": { + "DeleteRelationship": { + "$ref": "./examples/DeleteRelationship.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "$ref": "#/parameters/relationshipId" + }, + { + "$ref": "#/parameters/if-match" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Twins" + ], + "consumes": [ + "application/json-patch+json" + ], + "operationId": "DigitalTwins_UpdateRelationship", + "description": "Updates the properties on a relationship between two digital twins.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is either no digital twin or relationship with the provided id.", + "x-ms-examples": { + "PatchRelationshipBasicExample": { + "$ref": "./examples/PatchRelationshipBasicExample.json" + }, + "PatchRelationshipAdvancedExample": { + "$ref": "./examples/PatchRelationshipAdvancedExample.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "$ref": "#/parameters/relationshipId" + }, + { + "name": "patchDocument", + "description": "JSON Patch description of the update to the relationship properties.", + "in": "body", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "object" + } + } + }, + { + "$ref": "#/parameters/if-match" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success", + "headers": { + "ETag": { + "description": "Weak Etag.", + "type": "string" + } + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/digitaltwins/{id}/relationships": { + "get": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_ListRelationships", + "description": "Retrieves the relationships from a digital twin.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is no digital twin with the provided id.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetRelationship": { + "$ref": "./examples/GetRelationship.json" + }, + "GetRelationshipByName": { + "$ref": "./examples/GetRelationshipByRelationshipName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "name": "relationshipName", + "description": "The name of the relationship.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/RelationshipCollection" + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/digitaltwins/{id}/incomingrelationships": { + "get": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_ListIncomingRelationships", + "description": "Retrieves all incoming relationship for a digital twin.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is no digital twin with the provided id.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "GetIncomingRelationship": { + "$ref": "./examples/GetIncomingRelationship.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/IncomingRelationshipCollection" + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/digitaltwins/{id}/telemetry": { + "post": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_SendTelemetry", + "description": "Sends telemetry on behalf of a digital twin.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is no digital twin with the provided id.", + "x-ms-examples": { + "SendTelemetry": { + "$ref": "./examples/SendTelemetry.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "name": "telemetry", + "in": "body", + "description": "The telemetry measurements to send from the digital twin.", + "required": true, + "schema": { + "type": "object" + } + }, + { + "name": "dt-id", + "in": "header", + "description": "A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages.", + "required": true, + "type": "string" + }, + { + "name": "dt-timestamp", + "in": "header", + "description": "An RFC 3339 timestamp that identifies the time the telemetry was measured.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/digitaltwins/{id}/components/{componentPath}/telemetry": { + "post": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_SendComponentTelemetry", + "description": "Sends telemetry on behalf of a component in a digital twin.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is either no digital twin with the provided id or the component path is invalid.", + "x-ms-examples": { + "SendTelemetry": { + "$ref": "./examples/SendTelemetryFromComponent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "$ref": "#/parameters/componentPath" + }, + { + "name": "telemetry", + "in": "body", + "description": "The telemetry measurements to send from the digital twin's component.", + "required": true, + "schema": { + "type": "object" + } + }, + { + "name": "dt-id", + "in": "header", + "description": "A unique message identifier (in the scope of the digital twin id) that is commonly used for de-duplicating messages.", + "required": true, + "type": "string" + }, + { + "name": "dt-timestamp", + "in": "header", + "description": "An RFC 3339 timestamp that identifies the time the telemetry was measured.", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/digitaltwins/{id}/components/{componentPath}": { + "get": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_GetComponent", + "description": "Retrieves a component from a digital twin.\nStatus codes:\n200 (OK): Success.\n404 (Not Found): There is either no digital twin with the provided id or the component path is invalid.", + "x-ms-examples": { + "GetComponent": { + "$ref": "./examples/GetComponent.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "$ref": "#/parameters/componentPath" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "type": "object" + }, + "headers": { + "ETag": { + "description": "Weak Etag.", + "type": "string" + } + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Twins" + ], + "operationId": "DigitalTwins_UpdateComponent", + "description": "Updates a component on a digital twin.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.\n404 (Not Found): There is either no digital twin with the provided id or the component path is invalid.", + "x-ms-examples": { + "PatchComponentBasicExample": { + "$ref": "./examples/PatchComponentBasicExample.json" + }, + "PatchComponentAdvancedExample": { + "$ref": "./examples/PatchComponentAdvancedExample.json" + } + }, + "consumes": [ + "application/json-patch+json" + ], + "parameters": [ + { + "$ref": "#/parameters/digitalTwinId" + }, + { + "$ref": "#/parameters/componentPath" + }, + { + "name": "patchDocument", + "description": "An update specification described by JSON Patch. Updates to property values and $model elements may happen in the same request. Operations are limited to add, replace and remove.", + "in": "body", + "required": false, + "schema": { + "type": "array", + "items": { + "type": "object" + } + } + }, + { + "$ref": "#/parameters/if-match" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success", + "headers": { + "ETag": { + "description": "Weak Etag.", + "type": "string" + } + } + }, + "202": { + "description": "Asynchronous Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/eventroutes": { + "get": { + "tags": [ + "EventRoutes" + ], + "description": "Retrieves all event routes.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.", + "operationId": "EventRoutes_List", + "x-ms-examples": { + "EventRoutesList": { + "$ref": "./examples/EventRoutesList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/max-item-count" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EventRouteCollection" + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/eventroutes/{id}": { + "get": { + "tags": [ + "EventRoutes" + ], + "description": "Retrieves an event route.\nStatus codes:\n200 (OK): Success.\n404 (Not Found): There is no event route with the provided id.", + "operationId": "EventRoutes_GetById", + "x-ms-examples": { + "EventRouteGet": { + "$ref": "./examples/EventRouteGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/eventRouteId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/EventRoute" + } + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "EventRoutes" + ], + "description": "Adds or replaces an event route.\nStatus codes:\n200 (OK): Success.\n400 (Bad Request): The request is invalid.", + "operationId": "EventRoutes_Add", + "x-ms-examples": { + "EventRoutePut": { + "$ref": "./examples/EventRoutePut.json" + }, + "EventRouteWithFilter": { + "$ref": "./examples/EventRoutePutWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/eventRouteId" + }, + { + "name": "eventRoute", + "description": "The event route data", + "in": "body", + "schema": { + "$ref": "#/definitions/EventRoute" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "EventRoutes" + ], + "description": "Deletes an event route.\nStatus codes:\n200 (OK): Success.\n404 (Not Found): There is no event route with the provided id.", + "operationId": "EventRoutes_Delete", + "x-ms-examples": { + "EventRouteDelete": { + "$ref": "./examples/EventRouteDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/eventRouteId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "204": { + "description": "Success" + }, + "default": { + "description": "Default response.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "EventRoute": { + "description": "A route which directs notification and telemetry events to an endpoint. Endpoints are a destination outside of Azure Digital Twins such as an EventHub.", + "type": "object", + "required": [ + "endpointName" + ], + "properties": { + "id": { + "description": "The id of the event route.", + "type": "string", + "readOnly": true + }, + "endpointName": { + "description": "The name of the endpoint this event route is bound to.", + "type": "string" + }, + "filter": { + "description": "An expression which describes the events which are routed to the endpoint.", + "type": "string" + } + } + }, + "EventRouteCollection": { + "description": "A collection of EventRoute objects.", + "type": "object", + "properties": { + "value": { + "description": "The EventRoute objects.", + "type": "array", + "items": { + "$ref": "#/definitions/EventRoute" + } + }, + "nextLink": { + "description": "A URI to retrieve the next page of results.", + "type": "string" + } + } + }, + "NonPagedModelDataCollection": { + "description": "A collection of ModelData objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelData" + } + }, + "PagedModelDataCollection": { + "description": "A collection of ModelData objects.", + "type": "object", + "properties": { + "value": { + "description": "The ModelData objects.", + "type": "array", + "items": { + "$ref": "#/definitions/ModelData" + } + }, + "nextLink": { + "description": "A URI to retrieve the next page of objects.", + "type": "string" + } + } + }, + "ModelData": { + "description": "A model definition and metadata for that model.", + "required": [ + "id" + ], + "type": "object", + "properties": { + "displayName": { + "description": "A language map that contains the localized display names as specified in the model definition.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "description": { + "description": "A language map that contains the localized descriptions as specified in the model definition.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "id": { + "description": "The id of the model as specified in the model definition.", + "type": "string" + }, + "uploadTime": { + "description": "The time the model was uploaded to the service.", + "format": "date-time", + "type": "string" + }, + "decommissioned": { + "description": "Indicates if the model is decommissioned. Decommissioned models cannot be referenced by newly created digital twins.", + "type": "boolean", + "default": false + }, + "model": { + "description": "The model definition.", + "type": "object" + } + } + }, + "RelationshipCollection": { + "description": "A collection of relationships which relate digital twins together.", + "type": "object", + "properties": { + "value": { + "description": "The relationship objects.", + "type": "array", + "items": { + "description": "The relationship JSON document.", + "type": "object" + } + }, + "nextLink": { + "description": "A URI to retrieve the next page of objects.", + "type": "string" + } + } + }, + "IncomingRelationshipCollection": { + "description": "A collection of incoming relationships which relate digital twins together.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IncomingRelationship" + } + }, + "nextLink": { + "type": "string", + "description": "A URI to retrieve the next page of objects." + } + } + }, + "IncomingRelationship": { + "type": "object", + "description": "An incoming relationship.", + "properties": { + "$relationshipId": { + "type": "string", + "description": "A user-provided string representing the id of this relationship, unique in the context of the source digital twin, i.e. sourceId + relationshipId is unique in the context of the service." + }, + "$sourceId": { + "type": "string", + "description": "The id of the source digital twin." + }, + "$relationshipName": { + "type": "string", + "description": "The name of the relationship." + }, + "$relationshipLink": { + "type": "string", + "description": "Link to the relationship, to be used for deletion." + } + } + }, + "QuerySpecification": { + "description": "A query specification containing either a query statement or a continuation token from a previous query result.", + "type": "object", + "properties": { + "query": { + "description": "The query to execute. This value is ignored if a continuation token is provided.", + "type": "string" + }, + "continuationToken": { + "description": "A token which is used to retrieve the next set of results from a previous query.", + "type": "string" + } + } + }, + "QueryResult": { + "description": "The results of a query operation and an optional continuation token.", + "type": "object", + "properties": { + "items": { + "description": "The query results.", + "type": "array", + "items": { + "type": "object" + } + }, + "continuationToken": { + "description": "A token which can be used to construct a new QuerySpecification to retrieve the next set of results.", + "type": "string" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/Error", + "description": "The error details." + } + } + }, + "Error": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "A human-readable representation of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/Error" + }, + "readOnly": true + }, + "innererror": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerError" + } + } + }, + "InnerError": { + "description": "A more specific error description than was provided by the containing error.", + "properties": { + "code": { + "description": "A more specific error code than was provided by the containing error.", + "type": "string" + }, + "innererror": { + "description": "An object containing more specific information than the current object about the error.", + "$ref": "#/definitions/InnerError" + } + } + } + }, + "securityDefinitions": { + "oauth2": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize?resource=0b07f429-9f4b-4714-9392-cc5e8e80c8b0", + "type": "oauth2" + } + }, + "parameters": { + "eventRouteId": { + "name": "id", + "in": "path", + "required": true, + "type": "string", + "description": "The id for an event route. The id is unique within event routes and case sensitive.", + "x-ms-parameter-location": "method" + }, + "includeModelDefinition": { + "name": "includeModelDefinition", + "description": "When true the model definition will be returned as part of the result.", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "x-ms-parameter-location": "method" + }, + "digitalTwinId": { + "name": "id", + "in": "path", + "description": "The id of the digital twin. The id is unique within the service and case sensitive.", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "modelId": { + "name": "id", + "in": "path", + "description": "The id for the model. The id is globally unique and case sensitive.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "relationshipId": { + "name": "relationshipId", + "description": "The id of the relationship. The id is unique within the digital twin and case sensitive.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "componentPath": { + "name": "componentPath", + "in": "path", + "description": "The name of the DTDL component.", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The requested API version.", + "required": true, + "type": "string", + "enum": [ + "2020-05-31-preview" + ] + }, + "max-item-count": { + "name": "x-ms-max-item-count", + "in": "header", + "description": "The maximum number of items to retrieve per request. The server may choose to return less than the requested max.", + "required": false, + "type": "integer", + "default": -1, + "x-ms-client-name": "MaxItemCount", + "x-ms-parameter-location": "method", + "x-ms-parameter-grouping": { + "postfix": "Options" + } + }, + "if-none-match-star": { + "name": "If-None-Match", + "in": "header", + "description": "Only perform the operation if the entity does not already exist.", + "required": false, + "type": "string", + "enum": [ + "*" + ], + "x-ms-parameter-location": "method" + }, + "if-match": { + "name": "If-Match", + "in": "header", + "description": "Only perform the operation if the entity's etag matches one of the etags provided or * is provided.", + "required": false, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "security": [ + { + "oauth2": [] + } + ] +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/CreateRelationshipAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/CreateRelationshipAdvancedExample.json new file mode 100644 index 000000000000..1f6ec28e906c --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/CreateRelationshipAdvancedExample.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "mySourceTwin", + "relationshipId": "myRelationshipId", + "relationship": { + "$targetId": "myTargetTwin", + "$relationshipName": "myRelationship", + "relationshipProperty1": 1, + "relationshipProperty2": "some value" + } + }, + "responses": { + "200": { + "body": { + "$relationshipId": "myRelationshipId", + "$sourceId": "mySourceTwin", + "$targetId": "myTargetTwin", + "$relationshipName": "myRelationship", + "relationshipProperty1": 1, + "relationshipProperty2": "some value" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/CreateRelationshipBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/CreateRelationshipBasicExample.json new file mode 100644 index 000000000000..5ab5127bfb36 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/CreateRelationshipBasicExample.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "mySourceTwin", + "relationshipId": "myRelationshipId", + "relationship": { + "$targetId": "myTargetTwin", + "$relationshipName": "myRelationship" + } + }, + "responses": { + "200": { + "body": { + "$relationshipId": "myRelationshipId", + "$sourceId": "mySourceTwin", + "$targetId": "myTargetTwin", + "$relationshipName": "myRelationship" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteModel.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteModel.json new file mode 100644 index 000000000000..4a0428b03fb4 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteModel.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "dtmi:com:example:Sample;1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteRelationship.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteRelationship.json new file mode 100644 index 000000000000..d9acb6cc90a8 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteRelationship.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myTwinId", + "relationshipId": "myRelationshipId" + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteTwin.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteTwin.json new file mode 100644 index 000000000000..bb55048e32c3 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/DeleteTwin.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myTwinId" + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRouteDelete.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRouteDelete.json new file mode 100644 index 000000000000..2ca8cfd3f824 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRouteDelete.json @@ -0,0 +1,9 @@ +{ + "parameters": { + "id": "eventroute-001", + "api-version": "2020-05-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRouteGet.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRouteGet.json new file mode 100644 index 000000000000..be0dc040a850 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRouteGet.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "id": "eventroute-001", + "api-version": "2020-05-31-preview" + }, + "responses": { + "200": { + "body": { + "id": "eventroute-001", + "endpointName": "endpoint-001", + "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutePut.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutePut.json new file mode 100644 index 000000000000..b652891c1b31 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutePut.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "id": "eventroute-001", + "eventRoute": { + "endpointName": "endpoint-001", + "filter": "true" + }, + "api-version": "2020-05-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutePutWithFilter.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutePutWithFilter.json new file mode 100644 index 000000000000..21f265e6ca92 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutePutWithFilter.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "id": "eventroute-001", + "eventRoute": { + "endpointName": "endpoint-001", + "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'" + }, + "api-version": "2020-05-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutesList.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutesList.json new file mode 100644 index 000000000000..44c31910f394 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/EventRoutesList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "eventroute-001", + "endpointName": "endpoint-001", + "filter": "type = 'Microsoft.DigitalTwins.Twin.Create'" + }, + { + "id": "eventroute-002", + "endpointName": "endpoint-002", + "filter": "type = 'Microsoft.DigitalTwins.Twin.Create' OR type = 'microsoft.iot.telemetry'" + } + ], + "nextLink": "url-to-next-page" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetComponent.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetComponent.json new file mode 100644 index 000000000000..655246856feb --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetComponent.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myTwinId", + "componentPath": "myComponent" + }, + "responses": { + "200": { + "body": { + "$metadata": { + "$model": "dtmi:com:example:interfaces:interfaceName;1", + "property1": { + "desiredValue": 1, + "desiredVersion": 1, + "ackVersion": 1, + "ackCode": 200, + "ackDescription": "description", + "lastUpdateTime": "2020-05-23T21:44:02Z" + }, + "property2": { + "desiredValue": { + "subProperty1": "some value", + "subProperty2": "some other value" + }, + "desiredVersion": 1, + "ackVersion": 1, + "ackCode": 200, + "ackDescription": "description", + "lastUpdateTime": "2020-05-23T21:44:02Z" + } + }, + "property1": 1, + "property2": { + "subProperty1": "some value", + "subProperty2": "some other value" + }, + "component1": { + "$metadata": { + "$model": "dtmi:com:example:interfaces:subInterfaceName;1", + "componentProperty": { + "desiredValue": "some value", + "desiredVersion": 1, + "ackVersion": 1, + "ackCode": 200, + "ackDescription": "description", + "lastUpdateTime": "2020-05-23T21:44:02Z" + } + } + } + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetIncomingRelationship.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetIncomingRelationship.json new file mode 100644 index 000000000000..a50ceb94c675 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetIncomingRelationship.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "mySourceTwin" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "$sourceId": "mySourceTwin", + "$relationshipId": "firstRelationshipId", + "$relationshipName": "myRelationship", + "$relationshipLink": "/digitaltwins/mySourceTwin/relationships/myRelationship/firstRelationshipId" + }, + { + "$sourceId": "mySourceTwin", + "$relationshipId": "secondRelationshipId", + "$relationshipName": "myRelationship", + "$relationshipLink": "/digitaltwins/mySourceTwin/relationships/myRelationship/secondRelationshipId" + } + ], + "nextLink": "url-to-next-page" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationship.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationship.json new file mode 100644 index 000000000000..259950edf17d --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationship.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "mySourceTwin" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "$sourceId": "mySourceTwin", + "$relationshipId": "firstRelationshipId", + "$targetId": "targetTwinId", + "$relationshipName": "myRelationship", + "property": "value" + }, + { + "$sourceId": "mySourceTwin", + "$relationshipId": "secondRelationshipId", + "$targetId": "targetTwinId", + "$relationshipName": "myRelationship", + "property": "value" + } + ], + "nextLink": "url-to-next-page" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationshipById.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationshipById.json new file mode 100644 index 000000000000..28a5a08c9784 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationshipById.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "mySourceTwin", + "relationshipId": "myRelationshipId" + }, + "responses": { + "200": { + "body": { + "$relationshipId": "myRelationshipId", + "$sourceId": "mySourceTwin", + "$targetId": "myTargetTwin", + "$relationshipName": "myRelationship", + "relationshipProperty": "some value" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationshipByRelationshipName.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationshipByRelationshipName.json new file mode 100644 index 000000000000..591dc7ae4b71 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetRelationshipByRelationshipName.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "mySourceTwin", + "relationshipName": "myRelationship" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "$sourceId": "mySourceTwin", + "$relationshipId": "firstRelationshipId", + "$targetId": "targetTwinId", + "$relationshipName": "myRelationship", + "property": "value" + }, + { + "$sourceId": "mySourceTwin", + "$relationshipId": "secondRelationshipId", + "$targetId": "targetTwinId", + "$relationshipName": "myRelationship", + "property": "value" + } + ], + "nextLink": "url-to-next-page" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetTwin.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetTwin.json new file mode 100644 index 000000000000..7dce0f94a6e8 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/GetTwin.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myTwinId" + }, + "responses": { + "200": { + "body": { + "$dtId": "myTwinId", + "$metadata": { + "$model": "dtmi:com:example:interfaces:interfaceName;1", + "property1": { + "desiredValue": 1, + "desiredVersion": 1, + "ackVersion": 1, + "ackCode": 200, + "ackDescription": "description", + "lastUpdateTime": "2020-05-23T21:44:02Z" + }, + "property2": { + "desiredValue": { + "subProperty1": "some value", + "subProperty2": "some other value" + }, + "desiredVersion": 1, + "ackVersion": 1, + "ackCode": 200, + "ackDescription": "description", + "lastUpdateTime": "2020-05-23T21:44:02Z" + } + }, + "property1": 1, + "property2": { + "subProperty1": "some value", + "subProperty2": "some other value" + }, + "component1": { + "$metadata": { + "$model": "dtmi:com:example:interfaces:subInterfaceName;1", + "componentProperty": { + "desiredValue": "some value", + "desiredVersion": 1, + "ackVersion": 1, + "ackCode": 200, + "ackDescription": "description", + "lastUpdateTime": "2020-05-23T21:44:02Z" + } + } + } + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelAdd.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelAdd.json new file mode 100644 index 000000000000..b376ddb14860 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelAdd.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "models": [ + { + "@id": "dtmi:com:example:Sample;1", + "@type": "Interface", + "displayName": "Sample Interface", + "contents": [ + { + "@type": "Property", + "name": "name", + "displayName": "Sample instance name", + "schema": "string" + }, + { + "@type": "Property", + "name": "temp", + "displayName": "Sample instance temperature", + "schema": "integer" + }, + { + "@type": "Property", + "name": "comfortIndex", + "displayName": "Sample instance comfort index", + "schema": "integer" + } + ], + "@context": "dtmi:dtdl:context;2" + } + ], + "api-version": "2020-05-31-preview" + }, + "responses": { + "200": { + "body": [ + { + "id": "dtmi:com:example:Sample;1", + "displayName": { + "en": "Sample Interface" + }, + "uploadTime": "2020-03-01T17:32:28Z", + "decommissioned": false + } + ] + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelGetById.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelGetById.json new file mode 100644 index 000000000000..6de5d0f71a6e --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelGetById.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "id": "dtmi:com:example:Sample;1", + "api-version": "2020-05-31-preview" + }, + "responses": { + "200": { + "body": { + "id": "dtmi:com:example:Sample;1", + "uploadTime": "2020-03-01T17:32:28Z", + "decommissioned": false + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelGetByIdWithIncludeModelDefinition.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelGetByIdWithIncludeModelDefinition.json new file mode 100644 index 000000000000..da0330cc5288 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelGetByIdWithIncludeModelDefinition.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "id": "dtmi:com:example:Sample;1", + "includeModelDefinition": true, + "api-version": "2020-05-31-preview" + }, + "responses": { + "200": { + "body": { + "id": "dtmi:com:example:Sample;1", + "uploadTime": "2020-03-01T17:32:28Z", + "decommissioned": false, + "model": { + "@id": "dtmi:com:example:Sample;1", + "@type": "Interface", + "contents": [ + { + "@type": "Property", + "name": "name", + "displayName": "Sample instance name", + "schema": "string" + }, + { + "@type": "Property", + "name": "temp", + "displayName": "Sample instance temperature", + "schema": "integer" + }, + { + "@type": "Property", + "name": "comfortIndex", + "displayName": "Sample instance comfort index", + "schema": "integer" + } + ], + "@context": "dtmi:dtdl:context;2" + } + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelUpdateDecommissioned.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelUpdateDecommissioned.json new file mode 100644 index 000000000000..513e272d1f54 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelUpdateDecommissioned.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "id": "dtmi:com:example:Sample;1", + "updateModel": [ + { + "op": "replace", + "path": "/decommissioned", + "value": true + } + ], + "api-version": "2020-05-31-preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelsGet.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelsGet.json new file mode 100644 index 000000000000..e4fd22da2eec --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelsGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "dtmi:com:example:Sample;1", + "uploadTime": "2020-03-01T17:32:28Z", + "decommissioned": false + }, + { + "id": "dtmi:com:example:SampleDeviceModel;1", + "displayName": { + "en": "My Device Model" + }, + "uploadTime": "2020-05-01T17:32:28Z", + "decommissioned": false + }, + { + "id": "dtmi:com:example:AnotherSample;1", + "displayName": { + "en": "My Sample" + }, + "uploadTime": "2020-03-01T17:32:28Z", + "decommissioned": false + } + ], + "nextLink": "url-to-next-page" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json new file mode 100644 index 000000000000..72f41ae288cd --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/ModelsGetWithDependenciesAndIncludeModelDefinition.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "includeModelDefinition": true, + "dependenciesFor": [ + "dtmi:com:example:SampleDeviceModel;1" + ], + "x-ms-max-item-count": 20, + "api-version": "2020-05-31-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "dtmi:com:example:Sample;1", + "uploadTime": "2020-03-01T17:32:28Z", + "decommissioned": false, + "model": { + "@id": "dtmi:com:example:Sample;1", + "@type": "Interface", + "contents": [ + { + "@type": "Property", + "name": "name", + "displayName": "Sample instance name", + "schema": "string" + }, + { + "@type": "Property", + "name": "temp", + "displayName": "Sample instance temperature", + "schema": "integer" + }, + { + "@type": "Property", + "name": "comfortIndex", + "displayName": "Sample instance comfort index", + "schema": "integer" + } + ], + "@context": "dtmi:dtdl:context;2" + } + }, + { + "id": "dtmi:com:example:SampleDeviceModel;1", + "displayName": { + "en": "My Device Model" + }, + "uploadTime": "2020-03-01T17:32:28Z", + "decommissioned": false, + "model": { + "@id": "dtmi:com:example:SampleDeviceModel;1", + "@type": "Interface", + "displayName": "My Device Model", + "contents": [ + { + "@type": "Component", + "name": "Sample", + "schema": "dtmi:com:example:Sample;1" + } + ], + "@context": "dtmi:dtdl:context;2" + } + } + ], + "nextLink": "url-to-next-page" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchComponentAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchComponentAdvancedExample.json new file mode 100644 index 000000000000..195387a5d378 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchComponentAdvancedExample.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myTwinId", + "componentPath": "myComponent", + "patchDocument": [ + { + "op": "add", + "path": "/property1", + "value": 1 + }, + { + "op": "remove", + "path": "/property2" + }, + { + "op": "replace", + "path": "/property3/subProperty1", + "value": "new value" + } + ] + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchComponentBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchComponentBasicExample.json new file mode 100644 index 000000000000..c2a0624b8c35 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchComponentBasicExample.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myTwinId", + "componentPath": "myComponent", + "patchDocument": [ + { + "op": "add", + "path": "/property", + "value": 1 + } + ] + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchRelationshipAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchRelationshipAdvancedExample.json new file mode 100644 index 000000000000..59e611092081 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchRelationshipAdvancedExample.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myTwinId", + "relationshipId": "myRelationshipId", + "patchDocument": [ + { + "op": "add", + "path": "/property1", + "value": 1 + }, + { + "op": "remove", + "path": "/property2" + }, + { + "op": "replace", + "path": "/property3/subProperty1", + "value": "new value" + } + ] + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchRelationshipBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchRelationshipBasicExample.json new file mode 100644 index 000000000000..f5294ae496de --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchRelationshipBasicExample.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myTwinId", + "relationshipId": "myRelationshipId", + "patchDocument": [ + { + "op": "add", + "path": "/property", + "value": 1 + } + ] + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchTwinAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchTwinAdvancedExample.json new file mode 100644 index 000000000000..3a33baa321bb --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchTwinAdvancedExample.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myNewTwinId", + "patchDocument": [ + { + "op": "replace", + "path": "/property1", + "value": 1 + }, + { + "op": "add", + "path": "/property2/subProperty1", + "value": 1 + }, + { + "op": "remove", + "path": "/property3" + } + ] + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchTwinBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchTwinBasicExample.json new file mode 100644 index 000000000000..477251dce783 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PatchTwinBasicExample.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myNewTwinId", + "patchDocument": [ + { + "op": "replace", + "path": "/property1", + "value": 1 + } + ] + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PutTwinAdvancedExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PutTwinAdvancedExample.json new file mode 100644 index 000000000000..7639f575e1dc --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PutTwinAdvancedExample.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myNewTwinId", + "If-None-Match": "*", + "twin": { + "$metadata": { + "$model": "dtmi:com:example:interfaces:interfaceName;1" + }, + "property1": 1, + "property2": { + "subProperty1": "some value", + "subProperty2": "some other value" + }, + "component1": { + "$metadata": { + "$model": "dtmi:com:example:interfaces:subInterfaceName;1" + }, + "componentProperty": "some value" + } + } + }, + "responses": { + "200": { + "body": { + "$dtId": "myNewTwinId", + "$metadata": { + "$model": "dtmi:com:example:interfaces:interfaceName;1", + "property1": { + "desiredValue": 1, + "desiredVersion": 1, + "ackVersion": 1, + "ackCode": 200, + "ackDescription": "description", + "lastUpdateTime": "2020-05-23T21:44:02Z" + }, + "property2": { + "desiredValue": { + "subProperty1": "some value", + "subProperty2": "some other value" + }, + "desiredVersion": 1, + "ackVersion": 1, + "ackCode": 200, + "ackDescription": "description", + "lastUpdateTime": "2020-05-23T21:44:02Z" + } + }, + "property1": 1, + "property2": { + "subProperty1": "some value", + "subProperty2": "some other value" + }, + "component1": { + "$metadata": { + "$model": "dtmi:com:example:interfaces:subInterfaceName;1", + "componentProperty": { + "desiredValue": "some value", + "desiredVersion": 1, + "ackVersion": 1, + "ackCode": 200, + "ackDescription": "description", + "lastUpdateTime": "2020-05-23T21:44:02Z" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PutTwinBasicExample.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PutTwinBasicExample.json new file mode 100644 index 000000000000..b1ee99c8ecfc --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/PutTwinBasicExample.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myNewTwinId", + "twin": { + "$metadata": { + "$model": "dtmi:com:example:interfaces:interfaceName;1" + } + } + }, + "responses": { + "200": { + "body": { + "$dtId": "myNewTwinId", + "$metadata": { + "$model": "dtmi:com:example:interfaces:interfaceName;1" + } + } + }, + "202": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryFirstPage.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryFirstPage.json new file mode 100644 index 000000000000..fe1106c5608b --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryFirstPage.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "querySpecification": { + "query": "SELECT * FROM DIGITALTWINS WHERE temp = 79" + }, + "api-version": "2020-05-31-preview" + }, + "responses": { + "200": { + "body": { + "items": [ + { + "$dtId": "Twin-01", + "$metadata": { + "$model": "dtmi:com:example:Sample;1" + }, + "name": "Sample01", + "temp": 79, + "comfortIndex": 50 + }, + { + "$dtId": "Twin-02", + "$metadata": { + "$model": "dtmi:com:example:Sample;1" + }, + "name": "Sample02", + "temp": 79, + "comfortIndex": 50 + }, + { + "$dtId": "Twin-03", + "$metadata": { + "$model": "dtmi:com:example:Sample;1" + }, + "name": "Sample03", + "temp": 79, + "comfortIndex": 50 + } + ], + "continuationToken": "" + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryJoin.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryJoin.json new file mode 100644 index 000000000000..d40910417c06 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryJoin.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "querySpecification": { + "query": "SELECT Widget, Gadget FROM DIGITALTWINS Widget JOIN Gadget RELATED Widget.Contains WHERE Widget.$dtId = 'Twin-01'" + }, + "api-version": "2020-05-31-preview" + }, + "responses": { + "200": { + "body": { + "items": [ + { + "Widget": { + "$dtId": "Twin-01", + "$metadata": { + "$model": "dtmi:com:example:Sample;1" + }, + "name": "Sample01", + "temp": 79, + "comfortIndex": 50 + }, + "Gadget": { + "$dtId": "Twin-02", + "$metadata": { + "$model": "dtmi:com:example:Sample;1" + }, + "name": "Sample02", + "temp": 79, + "comfortIndex": 50 + } + }, + { + "Widget": { + "$dtId": "Twin-01", + "$metadata": { + "$model": "dtmi:com:example:Sample;1" + }, + "name": "Sample01", + "temp": 79, + "comfortIndex": 50 + }, + "Gadget": { + "$dtId": "Twin-10", + "$metadata": { + "$model": "dtmi:com:example:Sample;1" + }, + "name": "Sample10", + "temp": 79, + "comfortIndex": 50 + } + } + ] + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryNextPage.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryNextPage.json new file mode 100644 index 000000000000..d7ecc8ad39c6 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/QueryNextPage.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "querySpecification": { + "continuationToken": "" + }, + "api-version": "2020-05-31-preview" + }, + "responses": { + "200": { + "body": { + "items": [ + { + "$dtId": "Twin-04", + "$metadata": { + "$model": "dtmi:com:example:Sample;1" + }, + "name": "Sample04", + "temp": 79, + "comfortIndex": 50 + }, + { + "$dtId": "Twin-05", + "$metadata": { + "$model": "dtmi:com:example:Sample;1" + }, + "name": "Sample05", + "temp": 79, + "comfortIndex": 50 + }, + { + "$dtId": "Twin-06", + "$metadata": { + "$model": "dtmi:com:example:Sample;1" + }, + "name": "Sample06", + "temp": 79, + "comfortIndex": 50 + } + ] + } + } + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/SendTelemetry.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/SendTelemetry.json new file mode 100644 index 000000000000..941a77beffa3 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/SendTelemetry.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myTwinId", + "dt-id": "e5ca50dd-ca31-4fae-8d84-3af5a72b10c5", + "dt-timestamp": "1985-04-12T23:20:50.52Z", + "telemetry": { + "temperature": 1 + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/SendTelemetryFromComponent.json b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/SendTelemetryFromComponent.json new file mode 100644 index 000000000000..dfec5fa53273 --- /dev/null +++ b/specification/digitaltwins/data-plane/Microsoft.DigitalTwins/preview/2020-05-31-preview/examples/SendTelemetryFromComponent.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-05-31-preview", + "id": "myTwinId", + "componentPath": "myComponent", + "dt-id": "e5ca50dd-ca31-4fae-8d84-3af5a72b10c5", + "dt-timestamp": "1985-04-12T23:20:50.52Z", + "telemetry": { + "temperature": 1 + } + }, + "responses": { + "204": {} + } +} diff --git a/specification/digitaltwins/data-plane/readme.csharp.md b/specification/digitaltwins/data-plane/readme.csharp.md new file mode 100644 index 000000000000..709f03e21efe --- /dev/null +++ b/specification/digitaltwins/data-plane/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: Azure.DigitalTwins.Core + output-folder: $(csharp-sdks-folder)/digitaltwins/Generated +``` diff --git a/specification/digitaltwins/data-plane/readme.go.md b/specification/digitaltwins/data-plane/readme.go.md new file mode 100644 index 000000000000..a14e87ce02a3 --- /dev/null +++ b/specification/digitaltwins/data-plane/readme.go.md @@ -0,0 +1,19 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: digitaltwins + clear-output-folder: true +``` + +### Tag: package-2020-05-31-preview and go + +These settings apply only when `--tag=package-2020-05-31-preview --go` is specified on the command line. +Please also specify `--go-sdks-folder=`. + +```yaml $(tag) == 'package-2020-05-31-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/2020-05-31/$(namespace) +``` diff --git a/specification/digitaltwins/data-plane/readme.md b/specification/digitaltwins/data-plane/readme.md new file mode 100644 index 000000000000..f39f368708dd --- /dev/null +++ b/specification/digitaltwins/data-plane/readme.md @@ -0,0 +1,79 @@ +# Azure Digital Twins + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Azure Digital Twins. + +## 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 Azure Digital Twins. + +```yaml +openapi-type: data-plane +tag: package-2020-05-31-preview +``` + +### Tag: package-2020-05-31-preview + +These settings apply only when `--tag=package-2020-05-31-preview` is specified on the command line. + +```yaml $(tag) == 'package-2020-05-31-preview' +input-file: + - Microsoft.DigitalTwins/preview/2020-05-31-preview/digitaltwins.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['digitaltwins'] +``` + +## Go + +See configuration in [readme.go.md](./readme.go.md) + +## Python + +See configuration in [readme.python.md](./readme.python.md) + +## Ruby + +See configuration in [readme.ruby.md](./readme.ruby.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/digitaltwins/data-plane/readme.python.md b/specification/digitaltwins/data-plane/readme.python.md new file mode 100644 index 000000000000..bd4257d4dc87 --- /dev/null +++ b/specification/digitaltwins/data-plane/readme.python.md @@ -0,0 +1,21 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Azure.DigitalTwins.Core + package-name: digitaltwins + package-version: 2020-05-31-preview + clear-output-folder: true +``` + +```yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/digitaltwins +``` diff --git a/specification/digitaltwins/data-plane/readme.ruby.md b/specification/digitaltwins/data-plane/readme.ruby.md new file mode 100644 index 000000000000..bb2999f471ac --- /dev/null +++ b/specification/digitaltwins/data-plane/readme.ruby.md @@ -0,0 +1,19 @@ +## Ruby + +These settings apply only when `--ruby` is specified on the command line. + +```yaml +package-name: digitaltwins +package-version: 2020-05-31-preview +azure-arm: true +``` + +### Tag: package-2020-05-31-preview and ruby + +These settings apply only when `--tag=package-2020-05-31-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2020-05-31-preview' && $(ruby) +namespace: Azure.DigitalTwins.Core +output-folder: $(ruby-sdks-folder)/digitaltwins +``` diff --git a/specification/digitaltwins/data-plane/readme.typescript.md b/specification/digitaltwins/data-plane/readme.typescript.md new file mode 100644 index 000000000000..3154decaf68e --- /dev/null +++ b/specification/digitaltwins/data-plane/readme.typescript.md @@ -0,0 +1,13 @@ +## TypeScript + +These settings apply only when `--typescript` is specified on the command line. +Please also specify `--typescript-sdks-folder=`. + +```yaml $(typescript) +typescript: + azure-arm: true + package-name: "digitaltwins" + output-folder: "$(typescript-sdks-folder)/packages/digitaltwins" + payload-flattening-threshold: 1 + generate-metadata: true +``` From fdf4bbfd7a73b28960d3a62490440345d6f2e8e3 Mon Sep 17 00:00:00 2001 From: Dongwei Wang Date: Fri, 5 Jun 2020 08:02:45 +0800 Subject: [PATCH 088/318] [Synapse] - Update data plane Swagger specs (#9534) * Update Synapse Swagger data plane specs * Fix notebook * Create three clients in Readme * Update Readme for managed Vnet * Rename scheme name * Minor change * Update example * Rename development to artifact Co-authored-by: Dongwei Wang Co-authored-by: Laurent Mazuel --- custom-words.txt | 1 + .../artifacts.json} | 252 ++++----- .../entityTypes/DataFlow.json | 8 +- .../entityTypes/Dataset.json | 8 +- .../entityTypes/LinkedService.json | 268 +++++----- .../entityTypes/Notebook.json} | 6 +- .../entityTypes/Pipeline.json | 100 ++-- .../entityTypes/SparkJobDefinition.json | 6 +- .../entityTypes/SqlScript.json | 4 +- .../entityTypes/Trigger.json | 14 +- .../ActivityRuns_QueryByPipelineRun.json | 5 +- .../DataFlowDebugSession_AddDataFlow.json | 5 +- .../examples/DataFlowDebugSession_Create.json | 7 +- .../examples/DataFlowDebugSession_Delete.json | 5 +- .../DataFlowDebugSession_ExecuteCommand.json | 7 +- ...DataFlowDebugSession_QueryByWorkspace.json | 5 +- .../examples/DataFlows_Create.json | 5 +- .../examples/DataFlows_Delete.json | 11 + .../examples/DataFlows_Get.json | 5 +- .../examples/DataFlows_ListByWorkspace.json | 5 +- .../examples/DataFlows_Update.json | 5 +- .../examples/Datasets_Create.json | 5 +- .../examples/Datasets_Delete.json | 11 + .../examples/Datasets_Get.json | 5 +- .../examples/Datasets_ListByWorkspace.json | 5 +- .../examples/Datasets_Update.json | 5 +- .../examples/LinkedServices_Create.json | 5 +- .../examples/LinkedServices_Delete.json | 11 + .../examples/LinkedServices_Get.json | 5 +- .../LinkedServices_ListByWorkspace.json | 5 +- .../examples/LinkedServices_Update.json | 5 +- .../examples/Notebooks_Create.json} | 19 +- .../examples/Notebooks_Delete.json | 11 + .../examples/Notebooks_Get.json} | 15 +- .../examples/Notebooks_ListByWorkspace.json} | 13 +- .../Notebooks_ListSummaryByWorkSpace.json} | 13 +- .../examples/Notebooks_Update.json} | 15 +- .../examples/PipelineRuns_Cancel.json | 10 + .../examples/PipelineRuns_Get.json | 5 +- .../PipelineRuns_QueryByWorkspace.json | 5 +- .../examples/Pipelines_Create.json | 5 +- .../examples/Pipelines_CreateRun.json | 5 +- .../examples/Pipelines_Delete.json | 11 + .../examples/Pipelines_Get.json | 5 +- .../examples/Pipelines_ListByWorkspace.json | 5 +- .../examples/Pipelines_Update.json | 5 +- .../examples/SparkJobDefinitions_Create.json | 5 +- .../examples/SparkJobDefinitions_Debug.json | 7 +- .../examples/SparkJobDefinitions_Delete.json | 5 +- .../examples/SparkJobDefinitions_Execute.json | 7 +- .../examples/SparkJobDefinitions_Get.json | 5 +- .../SparkJobDefinitions_ListByWorkspace.json | 5 +- .../examples/SparkJobDefinitions_Update.json | 5 +- .../examples/SqlScripts_Create.json | 5 +- .../examples/SqlScripts_Delete.json | 11 + .../examples/SqlScripts_Get.json | 5 +- .../examples/SqlScripts_ListByWorkspace.json | 5 +- .../examples/SqlScripts_Update.json | 5 +- .../TriggerRuns_QueryByWorkspace.json | 5 +- .../examples/TriggerRuns_Rerun.json | 5 +- .../examples/Triggers_Create.json | 5 +- .../examples/Triggers_Delete.json | 11 + .../examples/Triggers_Get.json | 5 +- .../Triggers_GetEventSubscriptionStatus.json | 5 +- .../examples/Triggers_ListByWorkspace.json | 5 +- .../examples/Triggers_Start.json | 10 + .../examples/Triggers_Stop.json | 10 + .../examples/Triggers_SubscribeToEvents.json | 7 +- .../Triggers_UnsubscribeFromEvents.json | 7 +- .../examples/Triggers_Update.json | 5 +- .../adf/examples/DataFlows_Delete.json | 12 - .../adf/examples/Datasets_Delete.json | 12 - .../adf/examples/LinkedServices_Delete.json | 12 - .../adf/examples/NoteBooks_Delete.json | 12 - .../adf/examples/PipelineRuns_Cancel.json | 11 - .../adf/examples/Pipelines_Delete.json | 12 - .../adf/examples/SqlScripts_Delete.json | 12 - .../adf/examples/Triggers_Delete.json | 12 - .../adf/examples/Triggers_Start.json | 11 - .../adf/examples/Triggers_Stop.json | 11 - .../SparkFrontend_SparkBatch_Create.json | 5 +- .../SparkFrontend_SparkBatch_Delete.json | 3 +- .../SparkFrontend_SparkBatch_Get.json | 3 +- .../SparkFrontend_SparkBatch_List.json | 3 +- .../SparkFrontend_SparkSession_Create.json | 5 +- ...Frontend_SparkSession_CreateStatement.json | 5 +- .../SparkFrontend_SparkSession_Delete.json | 3 +- ...Frontend_SparkSession_DeleteStatement.json | 3 +- .../SparkFrontend_SparkSession_Get.json | 3 +- ...arkFrontend_SparkSession_GetStatement.json | 3 +- .../SparkFrontend_SparkSession_List.json | 3 +- ...kFrontend_SparkSession_ListStatements.json | 3 +- ...arkFrontend_SparkSession_ResetTimeout.json | 3 +- .../{sparkFrontend.json => sparkJob.json} | 494 +++++++++--------- .../RoleAssignments_CreateRoleAssignment.json | 5 +- ...eAssignments_DeleteRoleAssignmentById.json | 3 +- ...RoleAssignments_GetRoleAssignmentById.json | 3 +- ...Assignments_ListCallerRoleAssignments.json | 3 +- .../RoleAssignments_ListRoleAssignments.json | 3 +- .../examples/Roles_GetRoleById.json | 3 +- .../examples/Roles_ListRoles.json | 3 +- .../roleAssignments.json | 64 +-- .../roles.json | 49 +- specification/synapse/data-plane/readme.md | 100 ++-- .../synapse/data-plane/readme.python.md | 23 +- .../synapse/data-plane/readme.typescript.md | 4 + 106 files changed, 950 insertions(+), 1055 deletions(-) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf/datafactory.json => 2019-06-01-preview/artifacts.json} (95%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/entityTypes/DataFlow.json (94%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/entityTypes/Dataset.json (99%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/entityTypes/LinkedService.json (96%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf/entityTypes/NoteBook.json => 2019-06-01-preview/entityTypes/Notebook.json} (98%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/entityTypes/Pipeline.json (98%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/entityTypes/SparkJobDefinition.json (96%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/entityTypes/SqlScript.json (97%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/entityTypes/Trigger.json (97%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/ActivityRuns_QueryByPipelineRun.json (96%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/DataFlowDebugSession_AddDataFlow.json (95%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/DataFlowDebugSession_Create.json (87%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/DataFlowDebugSession_Delete.json (78%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/DataFlowDebugSession_ExecuteCommand.json (83%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/DataFlowDebugSession_QueryByWorkspace.json (87%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/DataFlows_Create.json (97%) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Delete.json rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/DataFlows_Get.json (95%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/DataFlows_ListByWorkspace.json (95%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/DataFlows_Update.json (97%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Datasets_Create.json (95%) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Delete.json rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Datasets_Get.json (92%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Datasets_ListByWorkspace.json (93%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Datasets_Update.json (94%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/LinkedServices_Create.json (92%) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/LinkedServices_Get.json (91%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/LinkedServices_ListByWorkspace.json (91%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/LinkedServices_Update.json (93%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf/examples/NoteBooks_Create.json => 2019-06-01-preview/examples/Notebooks_Create.json} (88%) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf/examples/NoteBooks_Get.json => 2019-06-01-preview/examples/Notebooks_Get.json} (84%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf/examples/NoteBooks_ListByWorkspace.json => 2019-06-01-preview/examples/Notebooks_ListByWorkspace.json} (86%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf/examples/NoteBooks_ListSummaryByWorkSpace.json => 2019-06-01-preview/examples/Notebooks_ListSummaryByWorkSpace.json} (86%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf/examples/NoteBooks_Update.json => 2019-06-01-preview/examples/Notebooks_Update.json} (90%) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Cancel.json rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/PipelineRuns_Get.json (89%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/PipelineRuns_QueryByWorkspace.json (94%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Pipelines_Create.json (97%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Pipelines_CreateRun.json (83%) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Pipelines_Get.json (95%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Pipelines_ListByWorkspace.json (95%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Pipelines_Update.json (97%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SparkJobDefinitions_Create.json (95%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SparkJobDefinitions_Debug.json (97%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SparkJobDefinitions_Delete.json (51%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SparkJobDefinitions_Execute.json (97%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SparkJobDefinitions_Get.json (93%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SparkJobDefinitions_ListByWorkspace.json (93%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SparkJobDefinitions_Update.json (95%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SqlScripts_Create.json (93%) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Delete.json rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SqlScripts_Get.json (91%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SqlScripts_ListByWorkspace.json (91%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/SqlScripts_Update.json (92%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/TriggerRuns_QueryByWorkspace.json (91%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/TriggerRuns_Rerun.json (79%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Triggers_Create.json (94%) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Triggers_Get.json (92%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Triggers_GetEventSubscriptionStatus.json (60%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Triggers_ListByWorkspace.json (93%) create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Start.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Stop.json rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Triggers_SubscribeToEvents.json (76%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Triggers_UnsubscribeFromEvents.json (76%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview/adf => 2019-06-01-preview}/examples/Triggers_Update.json (94%) delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Delete.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Delete.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Delete.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Delete.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Cancel.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Delete.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Delete.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Delete.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Start.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Stop.json rename specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/{sparkFrontend.json => sparkJob.json} (75%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview => 2020-02-01-preview}/examples/RoleAssignments_CreateRoleAssignment.json (85%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview => 2020-02-01-preview}/examples/RoleAssignments_DeleteRoleAssignmentById.json (81%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview => 2020-02-01-preview}/examples/RoleAssignments_GetRoleAssignmentById.json (87%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview => 2020-02-01-preview}/examples/RoleAssignments_ListCallerRoleAssignments.json (81%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview => 2020-02-01-preview}/examples/RoleAssignments_ListRoleAssignments.json (91%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview => 2020-02-01-preview}/examples/Roles_GetRoleById.json (84%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview => 2020-02-01-preview}/examples/Roles_ListRoles.json (87%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview => 2020-02-01-preview}/roleAssignments.json (88%) rename specification/synapse/data-plane/Microsoft.Synapse/preview/{2019-11-01-preview => 2020-02-01-preview}/roles.json (83%) diff --git a/custom-words.txt b/custom-words.txt index 2e9c5fa304cf..44054866df7b 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1787,3 +1787,4 @@ sessionhosts hostpool sparkr ambari +dotnetspark diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/datafactory.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json similarity index 95% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/datafactory.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json index ecb09e0842b3..f78900be895d 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/datafactory.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json @@ -1,25 +1,18 @@ { "swagger": "2.0", "info": { - "version": "2019-11-01-preview", - "title": "SynapseClient", + "version": "2019-06-01-preview", + "title": "ArtifactsClient", "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, "x-ms-parameterized-host": { - "hostTemplate": "{workspaceName}.{SynapseDnsSuffix}", + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, "parameters": [ { - "name": "workspaceName", - "description": "The name of the workspace to execute operations on.", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/SynapseDnsSuffixInPath" + "$ref": "#/parameters/Endpoint" } ] }, @@ -38,7 +31,7 @@ "tags": [ "linkedServices" ], - "operationId": "LinkedServices_ListByWorkspace", + "operationId": "LinkedService_GetLinkedServicesByWorkspace", "x-ms-examples": { "LinkedServices_ListByWorkspace": { "$ref": "./examples/LinkedServices_ListByWorkspace.json" @@ -74,7 +67,7 @@ "tags": [ "linkedServices" ], - "operationId": "LinkedServices_CreateOrUpdate", + "operationId": "LinkedService_CreateOrUpdateLinkedService", "x-ms-examples": { "LinkedServices_Create": { "$ref": "./examples/LinkedServices_Create.json" @@ -127,7 +120,7 @@ "tags": [ "linkedServices" ], - "operationId": "LinkedServices_Get", + "operationId": "LinkedService_GetLinkedService", "x-ms-examples": { "LinkedServices_Get": { "$ref": "./examples/LinkedServices_Get.json" @@ -171,7 +164,7 @@ "tags": [ "linkedServices" ], - "operationId": "LinkedServices_Delete", + "operationId": "LinkedService_DeleteLinkedService", "x-ms-examples": { "LinkedServices_Delete": { "$ref": "./examples/LinkedServices_Delete.json" @@ -207,7 +200,7 @@ "tags": [ "datasets" ], - "operationId": "Datasets_ListByWorkspace", + "operationId": "Dataset_GetDatasetsByWorkspace", "x-ms-examples": { "Datasets_ListByWorkspace": { "$ref": "./examples/Datasets_ListByWorkspace.json" @@ -243,7 +236,7 @@ "tags": [ "datasets" ], - "operationId": "Datasets_CreateOrUpdate", + "operationId": "Dataset_CreateOrUpdateDataset", "x-ms-examples": { "Datasets_Create": { "$ref": "./examples/Datasets_Create.json" @@ -296,7 +289,7 @@ "tags": [ "datasets" ], - "operationId": "Datasets_Get", + "operationId": "Dataset_GetDataset", "x-ms-examples": { "Datasets_Get": { "$ref": "./examples/Datasets_Get.json" @@ -340,7 +333,7 @@ "tags": [ "datasets" ], - "operationId": "Datasets_Delete", + "operationId": "Dataset_DeleteDataset", "x-ms-examples": { "Datasets_Delete": { "$ref": "./examples/Datasets_Delete.json" @@ -376,7 +369,7 @@ "tags": [ "pipelines" ], - "operationId": "Pipelines_ListByWorkspace", + "operationId": "Pipeline_GetPipelinesByWorkspace", "x-ms-examples": { "Pipelines_ListByWorkspace": { "$ref": "./examples/Pipelines_ListByWorkspace.json" @@ -412,7 +405,7 @@ "tags": [ "pipelines" ], - "operationId": "Pipelines_CreateOrUpdate", + "operationId": "Pipeline_CreateOrUpdatePipeline", "x-ms-examples": { "Pipelines_Create": { "$ref": "./examples/Pipelines_Create.json" @@ -465,7 +458,7 @@ "tags": [ "pipelines" ], - "operationId": "Pipelines_Get", + "operationId": "Pipeline_GetPipeline", "x-ms-examples": { "Pipelines_Get": { "$ref": "./examples/Pipelines_Get.json" @@ -509,7 +502,7 @@ "tags": [ "pipelines" ], - "operationId": "Pipelines_Delete", + "operationId": "Pipeline_DeletePipeline", "x-ms-examples": { "Pipelines_Delete": { "$ref": "./examples/Pipelines_Delete.json" @@ -545,7 +538,7 @@ "tags": [ "pipelines" ], - "operationId": "Pipelines_CreateRun", + "operationId": "Pipeline_CreatePipelineRun", "x-ms-examples": { "Pipelines_CreateRun": { "$ref": "./examples/Pipelines_CreateRun.json" @@ -611,7 +604,7 @@ }, "/queryPipelineRuns": { "post": { - "operationId": "PipelineRuns_QueryByWorkspace", + "operationId": "PipelineRun_QueryPipelineRunsByWorkspace", "x-ms-examples": { "PipelineRuns_QueryByWorkspace": { "$ref": "./examples/PipelineRuns_QueryByWorkspace.json" @@ -653,7 +646,7 @@ }, "/pipelineruns/{runId}": { "get": { - "operationId": "PipelineRuns_Get", + "operationId": "PipelineRun_GetPipelineRun", "x-ms-examples": { "PipelineRuns_Get": { "$ref": "./examples/PipelineRuns_Get.json" @@ -689,7 +682,7 @@ }, "/pipelines/{pipelineName}/pipelineruns/{runId}/queryActivityruns": { "post": { - "operationId": "ActivityRuns_QueryByPipelineRun", + "operationId": "PipelineRun_QueryActivityRuns", "x-ms-examples": { "ActivityRuns_QueryByPipelineRun": { "$ref": "./examples/ActivityRuns_QueryByPipelineRun.json" @@ -737,7 +730,7 @@ }, "/pipelineruns/{runId}/cancel": { "post": { - "operationId": "PipelineRuns_Cancel", + "operationId": "PipelineRun_CancelPipelineRun", "x-ms-examples": { "PipelineRuns_Cancel": { "$ref": "./examples/PipelineRuns_Cancel.json" @@ -780,7 +773,7 @@ "tags": [ "triggers" ], - "operationId": "Triggers_ListByWorkspace", + "operationId": "Trigger_GetTriggersByWorkspace", "x-ms-examples": { "Triggers_ListByWorkspace": { "$ref": "./examples/Triggers_ListByWorkspace.json" @@ -816,7 +809,7 @@ "tags": [ "triggers" ], - "operationId": "Triggers_CreateOrUpdate", + "operationId": "Trigger_CreateOrUpdateTrigger", "x-ms-examples": { "Triggers_Create": { "$ref": "./examples/Triggers_Create.json" @@ -869,7 +862,7 @@ "tags": [ "trigger" ], - "operationId": "Triggers_Get", + "operationId": "Trigger_GetTrigger", "x-ms-examples": { "Triggers_Get": { "$ref": "./examples/Triggers_Get.json" @@ -913,7 +906,7 @@ "tags": [ "triggers" ], - "operationId": "Triggers_Delete", + "operationId": "Trigger_DeleteTrigger", "x-ms-examples": { "Triggers_Delete": { "$ref": "./examples/Triggers_Delete.json" @@ -949,7 +942,7 @@ "tags": [ "triggers" ], - "operationId": "Triggers_SubscribeToEvents", + "operationId": "Trigger_SubscribeTriggerToEvents", "x-ms-examples": { "Triggers_SubscribeToEvents": { "$ref": "./examples/Triggers_SubscribeToEvents.json" @@ -989,7 +982,7 @@ "tags": [ "triggers" ], - "operationId": "Triggers_GetEventSubscriptionStatus", + "operationId": "Trigger_GetEventSubscriptionStatus", "x-ms-examples": { "Triggers_GetEventSubscriptionStatus": { "$ref": "./examples/Triggers_GetEventSubscriptionStatus.json" @@ -1025,7 +1018,7 @@ "tags": [ "triggers" ], - "operationId": "Triggers_UnsubscribeFromEvents", + "operationId": "Trigger_UnsubscribeTriggerFromEvents", "x-ms-examples": { "Triggers_UnsubscribeFromEvents": { "$ref": "./examples/Triggers_UnsubscribeFromEvents.json" @@ -1065,7 +1058,7 @@ "tags": [ "triggers" ], - "operationId": "Triggers_Start", + "operationId": "Trigger_StartTrigger", "x-ms-examples": { "Triggers_Start": { "$ref": "./examples/Triggers_Start.json" @@ -1099,7 +1092,7 @@ "tags": [ "triggers" ], - "operationId": "Triggers_Stop", + "operationId": "Trigger_StopTrigger", "x-ms-examples": { "Triggers_Stop": { "$ref": "./examples/Triggers_Stop.json" @@ -1133,7 +1126,7 @@ "tags": [ "triggerruns" ], - "operationId": "TriggerRuns_Rerun", + "operationId": "TriggerRun_RerunTriggerInstance", "x-ms-examples": { "Triggers_Rerun": { "$ref": "./examples/TriggerRuns_Rerun.json" @@ -1169,7 +1162,7 @@ "tags": [ "triggerruns" ], - "operationId": "TriggerRuns_QueryByWorkspace", + "operationId": "TriggerRun_QueryTriggerRunsByWorkspace", "x-ms-examples": { "TriggerRuns_QueryByWorkspace": { "$ref": "./examples/TriggerRuns_QueryByWorkspace.json" @@ -1211,7 +1204,7 @@ "tags": [ "dataFlows" ], - "operationId": "DataFlows_CreateOrUpdate", + "operationId": "DataFlow_CreateOrUpdateDataFlow", "x-ms-examples": { "DataFlows_Create": { "$ref": "./examples/DataFlows_Create.json" @@ -1264,7 +1257,7 @@ "tags": [ "dataFlows" ], - "operationId": "DataFlows_Get", + "operationId": "DataFlow_GetDataFlow", "x-ms-examples": { "DataFlows_Get": { "$ref": "./examples/DataFlows_Get.json" @@ -1305,7 +1298,7 @@ "tags": [ "dataFlows" ], - "operationId": "DataFlows_Delete", + "operationId": "DataFlow_DeleteDataFlow", "x-ms-examples": { "DataFlows_Delete": { "$ref": "./examples/DataFlows_Delete.json" @@ -1341,7 +1334,7 @@ "tags": [ "dataFlows" ], - "operationId": "DataFlows_ListByWorkspace", + "operationId": "DataFlow_GetDataFlowsByWorkspace", "x-ms-examples": { "DataFlows_ListByWorkspace": { "$ref": "./examples/DataFlows_ListByWorkspace.json" @@ -1377,7 +1370,7 @@ "tags": [ "dataFlowDebugSession" ], - "operationId": "DataFlowDebugSession_Create", + "operationId": "DataFlowDebugSession_CreateDataFlowDebugSession", "x-ms-examples": { "DataFlowDebugSession_Create": { "$ref": "./examples/DataFlowDebugSession_Create.json" @@ -1429,7 +1422,7 @@ "tags": [ "dataFlowDebugSession" ], - "operationId": "DataFlowDebugSession_QueryByWorkspace", + "operationId": "DataFlowDebugSession_QueryDataFlowDebugSessionsByWorkspace", "x-ms-examples": { "DataFlowDebugSession_QueryByWorkspace": { "$ref": "./examples/DataFlowDebugSession_QueryByWorkspace.json" @@ -1507,7 +1500,7 @@ "tags": [ "dataFlowDebugSession" ], - "operationId": "DataFlowDebugSession_Delete", + "operationId": "DataFlowDebugSession_DeleteDataFlowDebugSession", "x-ms-examples": { "DataFlowDebugSession_Delete": { "$ref": "./examples/DataFlowDebugSession_Delete.json" @@ -1598,7 +1591,7 @@ "tags": [ "sqlScripts" ], - "operationId": "SqlScripts_ListByWorkspace", + "operationId": "SqlScript_GetSqlScriptsByWorkspace", "x-ms-examples": { "SqlScripts_ListByWorkspace": { "$ref": "./examples/SqlScripts_ListByWorkspace.json" @@ -1634,7 +1627,7 @@ "tags": [ "sqlScripts" ], - "operationId": "SqlScripts_CreateOrUpdate", + "operationId": "SqlScript_CreateOrUpdateSqlScript", "x-ms-examples": { "SqlScripts_Create": { "$ref": "./examples/SqlScripts_Create.json" @@ -1687,7 +1680,7 @@ "tags": [ "sqlScripts" ], - "operationId": "SqlScripts_Get", + "operationId": "SqlScript_GetSqlScript", "x-ms-examples": { "SqlScripts_Get": { "$ref": "./examples/SqlScripts_Get.json" @@ -1731,7 +1724,7 @@ "tags": [ "sqlScripts" ], - "operationId": "SqlScripts_Delete", + "operationId": "SqlScript_DeleteSqlScript", "x-ms-examples": { "SqlScripts_Delete": { "$ref": "./examples/SqlScripts_Delete.json" @@ -1767,7 +1760,7 @@ "tags": [ "sparkJobDefinitions" ], - "operationId": "SparkJobDefinitions_ListByWorkspace", + "operationId": "SparkJobDefinition_GetSparkJobDefinitionsByWorkspace", "x-ms-examples": { "SparkJobDefinitions_ListByWorkspace": { "$ref": "./examples/SparkJobDefinitions_ListByWorkspace.json" @@ -1803,7 +1796,7 @@ "tags": [ "sparkJobDefinitions" ], - "operationId": "SparkJobDefinitions_CreateOrUpdate", + "operationId": "SparkJobDefinition_CreateOrUpdateSparkJobDefinition", "x-ms-examples": { "SparkJobDefinitions_Create": { "$ref": "./examples/SparkJobDefinitions_Create.json" @@ -1856,7 +1849,7 @@ "tags": [ "sparkJobDefinitions" ], - "operationId": "SparkJobDefinitions_Get", + "operationId": "SparkJobDefinition_GetSparkJobDefinition", "x-ms-examples": { "SparkJobDefinitions_Get": { "$ref": "./examples/SparkJobDefinitions_Get.json" @@ -1900,7 +1893,7 @@ "tags": [ "sparkJobDefinitions" ], - "operationId": "SparkJobDefinitions_Delete", + "operationId": "SparkJobDefinition_DeleteSparkJobDefinition", "x-ms-examples": { "SparkJobDefinitions_Delete": { "$ref": "./examples/SparkJobDefinitions_Delete.json" @@ -1936,7 +1929,7 @@ "tags": [ "sparkJobDefinitions" ], - "operationId": "SparkJobDefinitions_Execute", + "operationId": "SparkJobDefinition_ExecuteSparkJobDefinition", "x-ms-examples": { "SparkJobDefinitions_Execute": { "$ref": "./examples/SparkJobDefinitions_Execute.json" @@ -1959,13 +1952,13 @@ "202": { "description": "Accepted.", "schema": { - "$ref": "../sparkFrontend.json#/definitions/ExtendedLivyBatchResponse" + "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob" } }, "200": { "description": "OK.", "schema": { - "$ref": "../sparkFrontend.json#/definitions/ExtendedLivyBatchResponse" + "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob" } }, "default": { @@ -1982,7 +1975,7 @@ "tags": [ "sparkJobDefinitions" ], - "operationId": "SparkJobDefinitions_Debug", + "operationId": "SparkJobDefinition_DebugSparkJobDefinition", "x-ms-examples": { "SparkJobDefinitions_Debug": { "$ref": "./examples/SparkJobDefinitions_Debug.json" @@ -2011,13 +2004,13 @@ "202": { "description": "Accepted.", "schema": { - "$ref": "../sparkFrontend.json#/definitions/ExtendedLivyBatchResponse" + "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob" } }, "200": { "description": "OK.", "schema": { - "$ref": "../sparkFrontend.json#/definitions/ExtendedLivyBatchResponse" + "$ref": "../2019-11-01-preview/sparkJob.json#/definitions/SparkBatchJob" } }, "default": { @@ -2032,15 +2025,15 @@ "/notebooks": { "get": { "tags": [ - "noteBooks" + "notebooks" ], - "operationId": "NoteBooks_ListByWorkspace", + "operationId": "Notebook_GetNotebooksByWorkspace", "x-ms-examples": { - "NoteBooks_ListByWorkspace": { - "$ref": "./examples/NoteBooks_ListByWorkspace.json" + "Notebooks_ListByWorkspace": { + "$ref": "./examples/Notebooks_ListByWorkspace.json" } }, - "description": "Lists notebooks.", + "description": "Lists Notebooks.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2050,7 +2043,7 @@ "200": { "description": "OK.", "schema": { - "$ref": "#/definitions/NoteBookListResponse" + "$ref": "#/definitions/NotebookListResponse" } }, "default": { @@ -2068,15 +2061,15 @@ "/notebooks/summary": { "get": { "tags": [ - "noteBooks" + "notebooks" ], - "operationId": "NoteBooks_ListSummaryByWorkSpace", + "operationId": "Notebook_GetNotebookSummaryByWorkSpace", "x-ms-examples": { - "NoteBooks_ListSummaryByWorkSpace": { - "$ref": "./examples/NoteBooks_ListSummaryByWorkSpace.json" + "Notebooks_ListSummaryByWorkSpace": { + "$ref": "./examples/Notebooks_ListSummaryByWorkSpace.json" } }, - "description": "Lists a summary of notebooks.", + "description": "Lists a summary of Notebooks.", "parameters": [ { "$ref": "#/parameters/ApiVersionParameter" @@ -2086,7 +2079,7 @@ "200": { "description": "OK.", "schema": { - "$ref": "#/definitions/NoteBookListResponse" + "$ref": "#/definitions/NotebookListResponse" } }, "default": { @@ -2101,24 +2094,24 @@ } } }, - "/notebooks/{noteBookName}": { + "/notebooks/{notebookName}": { "put": { "tags": [ - "noteBooks" + "notebooks" ], - "operationId": "NoteBooks_CreateOrUpdate", + "operationId": "Notebook_CreateOrUpdateNotebook", "x-ms-examples": { - "NoteBooks_Create": { - "$ref": "./examples/NoteBooks_Create.json" + "Notebooks_Create": { + "$ref": "./examples/Notebooks_Create.json" }, - "NoteBooks_Update": { - "$ref": "./examples/NoteBooks_Update.json" + "Notebooks_Update": { + "$ref": "./examples/Notebooks_Update.json" } }, "description": "Creates or updates a Note Book.", "parameters": [ { - "$ref": "#/parameters/noteBookName" + "$ref": "#/parameters/NotebookName" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -2131,12 +2124,12 @@ "description": "ETag of the Note book entity. Should only be specified for update, for which it should match existing entity or can be * for unconditional update." }, { - "name": "noteBook", + "name": "Notebook", "description": "Note book resource definition.", "in": "body", "required": true, "schema": { - "$ref": "#/definitions/NoteBookResource" + "$ref": "#/definitions/NotebookResource" } } ], @@ -2144,7 +2137,7 @@ "200": { "description": "OK.", "schema": { - "$ref": "#/definitions/NoteBookResource" + "$ref": "#/definitions/NotebookResource" } }, "default": { @@ -2157,18 +2150,18 @@ }, "get": { "tags": [ - "noteBooks" + "notebooks" ], - "operationId": "NoteBooks_Get", + "operationId": "Notebook_GetNotebook", "x-ms-examples": { - "NoteBooks_Get": { - "$ref": "./examples/NoteBooks_Get.json" + "Notebooks_Get": { + "$ref": "./examples/Notebooks_Get.json" } }, "description": "Gets a Note Book.", "parameters": [ { - "$ref": "#/parameters/noteBookName" + "$ref": "#/parameters/NotebookName" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -2178,14 +2171,14 @@ "in": "header", "required": false, "type": "string", - "description": "ETag of the notebook entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." + "description": "ETag of the Notebook entity. Should only be specified for get. If the ETag matches the existing entity tag, or if * was provided, then no content will be returned." } ], "responses": { "200": { "description": "OK.", "schema": { - "$ref": "#/definitions/NoteBookResource" + "$ref": "#/definitions/NotebookResource" } }, "304": { @@ -2201,18 +2194,18 @@ }, "delete": { "tags": [ - "noteBooks" + "notebooks" ], - "operationId": "NoteBooks_Delete", + "operationId": "Notebook_DeleteNotebook", "x-ms-examples": { - "NoteBooks_Delete": { - "$ref": "./examples/NoteBooks_Delete.json" + "Notebooks_Delete": { + "$ref": "./examples/Notebooks_Delete.json" } }, "description": "Deletes a Note book.", "parameters": [ { - "$ref": "#/parameters/noteBookName" + "$ref": "#/parameters/NotebookName" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -3177,7 +3170,7 @@ "DatasetReference" ], "x-ms-enum": { - "name": "Type", + "name": "DatasetReferenceType", "modelAsString": true } }, @@ -3365,8 +3358,8 @@ "properties" ] }, - "NoteBookListResponse": { - "description": "A list of notebook resources.", + "NotebookListResponse": { + "description": "A list of Notebook resources.", "type": "object", "required": [ "value" @@ -3374,9 +3367,9 @@ "properties": { "value": { "type": "array", - "description": "List of notebooks.", + "description": "List of Notebooks.", "items": { - "$ref": "#/definitions/NoteBookResource" + "$ref": "#/definitions/NotebookResource" } }, "nextLink": { @@ -3385,8 +3378,8 @@ } } }, - "NoteBookResource": { - "description": "NoteBook resource type.", + "NotebookResource": { + "description": "Notebook resource type.", "allOf": [ { "$ref": "#/definitions/SubResource" @@ -3394,8 +3387,8 @@ ], "properties": { "properties": { - "$ref": "./entityTypes/NoteBook.json#/definitions/NoteBook", - "description": "Properties of NoteBook." + "$ref": "./entityTypes/Notebook.json#/definitions/Notebook", + "description": "Properties of Notebook." } }, "required": [ @@ -4136,24 +4129,6 @@ } }, "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "description": "The subscription identifier.", - "in": "path", - "required": true, - "type": "string" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "description": "The resource group name.", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[-\\w\\._\\(\\)]+$", - "minLength": 1, - "maxLength": 90, - "x-ms-parameter-location": "method" - }, "workspaceName": { "name": "workspaceName", "description": "The workspace name.", @@ -4162,22 +4137,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "sqlComputeName": { - "name": "sqlComputeName", - "description": "The sql compute name.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "sparkComputeName": { - "name": "sparkComputeName", - "description": "The spark compute name.", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "sqlScriptName": { "name": "sqlScriptName", "description": "The sql script name.", @@ -4194,9 +4153,9 @@ "type": "string", "x-ms-parameter-location": "method" }, - "noteBookName": { - "name": "noteBookName", - "description": "The note book name.", + "NotebookName": { + "name": "notebookName", + "description": "The notebook name.", "in": "path", "required": true, "type": "string", @@ -4318,14 +4277,13 @@ "type": "string", "description": "The Synapse client API Version." }, - "SynapseDnsSuffixInPath": { - "name": "SynapseDnsSuffix", - "in": "path", + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", "required": true, "type": "string", - "default": "dev.azuresynapse.net", + "in": "path", "x-ms-skip-url-encoding": true, - "description": "Gets the DNS suffix used as the base for all Synapse service requests.", "x-ms-parameter-location": "client" } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/DataFlow.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/DataFlow.json similarity index 94% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/DataFlow.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/DataFlow.json index d1317f5bd0e2..cc6adc44e2fd 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/DataFlow.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/DataFlow.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "SynapseClient", - "version": "2019-11-01-preview" + "title": "ArtifactsClient", + "version": "2019-06-01-preview" }, "paths": {}, "definitions": { @@ -115,7 +115,7 @@ "properties": { "dataset": { "description": "Dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" + "$ref": "../artifacts.json#/definitions/DatasetReference" } } }, @@ -129,7 +129,7 @@ "properties": { "dataset": { "description": "Dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" + "$ref": "../artifacts.json#/definitions/DatasetReference" } } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Dataset.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json similarity index 99% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Dataset.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json index 29f8b205d98f..1aa9e4d000f2 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Dataset.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Dataset.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "SynapseClient", - "version": "2019-11-01-preview" + "title": "ArtifactsClient", + "version": "2019-06-01-preview" }, "paths": {}, "definitions": { @@ -29,10 +29,10 @@ }, "linkedServiceName": { "description": "Linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "parameters": { - "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", + "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification", "description": "Parameters for dataset." }, "annotations": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/LinkedService.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/LinkedService.json similarity index 96% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/LinkedService.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/LinkedService.json index bbee397ae546..8f54c7fb088c 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/LinkedService.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/LinkedService.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "SynapseClient", - "version": "2019-11-01-preview" + "title": "ArtifactsClient", + "version": "2019-06-01-preview" }, "paths": {}, "definitions": { @@ -17,14 +17,14 @@ }, "connectVia": { "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" }, "description": { "description": "Linked service description.", "type": "string" }, "parameters": { - "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", + "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification", "description": "Parameters for linked service." }, "annotations": { @@ -110,7 +110,7 @@ "type": "object" }, "accountKey": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of accountKey in connection string." }, "sasUri": { @@ -118,7 +118,7 @@ "type": "object" }, "sasToken": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of sasToken in sas uri." }, "encryptedCredential": { @@ -135,7 +135,7 @@ "description": "The connection string. It is mutually exclusive with sasUri, serviceEndpoint property. Type: string, SecureString or AzureKeyVaultSecretReference." }, "accountKey": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of accountKey in connection string." }, "sasUri": { @@ -143,7 +143,7 @@ "type": "object" }, "sasToken": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of sasToken in sas uri." }, "serviceEndpoint": { @@ -155,7 +155,7 @@ "description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse." }, "tenant": { @@ -196,7 +196,7 @@ "type": "object" }, "password": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "servicePrincipalId": { @@ -204,7 +204,7 @@ "description": "The ID of the service principal used to authenticate against Azure SQL Data Warehouse. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Data Warehouse." }, "tenant": { @@ -253,7 +253,7 @@ }, "password": { "description": "The on-premises Windows authentication password.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -292,7 +292,7 @@ "type": "object" }, "password": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "servicePrincipalId": { @@ -300,7 +300,7 @@ "description": "The ID of the service principal used to authenticate against Azure SQL Database. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Database." }, "tenant": { @@ -344,7 +344,7 @@ "type": "object" }, "password": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "servicePrincipalId": { @@ -352,7 +352,7 @@ "description": "The ID of the service principal used to authenticate against Azure SQL Managed Instance. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Azure SQL Managed Instance." }, "tenant": { @@ -397,7 +397,7 @@ }, "accessKey": { "description": "The Azure Batch account access key.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "batchUri": { "type": "object", @@ -409,7 +409,7 @@ }, "linkedServiceName": { "description": "The Azure Storage linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "encryptedCredential": { "type": "object", @@ -491,7 +491,7 @@ "type": "object" }, "accountKey": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The account key of the Azure CosmosDB account. Type: SecureString or AzureKeyVaultSecretReference." }, "encryptedCredential": { @@ -570,7 +570,7 @@ }, "password": { "description": "Password to access the Dynamics instance.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "servicePrincipalId": { "type": "object", @@ -589,7 +589,7 @@ "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "encryptedCredential": { @@ -672,7 +672,7 @@ }, "password": { "description": "Password to access the Dynamics CRM instance.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "servicePrincipalId": { "type": "object", @@ -691,7 +691,7 @@ "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "encryptedCredential": { @@ -774,7 +774,7 @@ }, "password": { "description": "Password to access the Common Data Service for Apps instance.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "servicePrincipalId": { "type": "object", @@ -793,7 +793,7 @@ "description": "The service principal credential type to use in Server-To-Server authentication. 'ServicePrincipalKey' for key/secret, 'ServicePrincipalCert' for certificate. Type: string (or Expression with resultType string)." }, "servicePrincipalCredential": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The credential of the service principal object in Azure Active Directory. If servicePrincipalCredentialType is 'ServicePrincipalKey', servicePrincipalCredential can be SecureString or AzureKeyVaultSecretReference. If servicePrincipalCredentialType is 'ServicePrincipalCert', servicePrincipalCredential can only be AzureKeyVaultSecretReference." }, "encryptedCredential": { @@ -839,15 +839,15 @@ }, "password": { "description": "HDInsight cluster password.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "linkedServiceName": { "description": "The Azure Storage linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "hcatalogLinkedServiceName": { "description": "A reference to the Azure SQL linked service that points to the HCatalog database.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "encryptedCredential": { "type": "object", @@ -899,7 +899,7 @@ }, "password": { "description": "Password to logon the server.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -943,7 +943,7 @@ }, "password": { "description": "Password to logon the server.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -983,7 +983,7 @@ }, "secretAccessKey": { "description": "The secret access key of the Google Cloud Storage Identity and Access Management (IAM) user.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "serviceUrl": { "type": "object", @@ -1023,7 +1023,7 @@ "type": "object" }, "password": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -1063,7 +1063,7 @@ "type": "object" }, "password": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -1103,7 +1103,7 @@ "type": "object" }, "password": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -1143,7 +1143,7 @@ "type": "object" }, "password": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -1208,7 +1208,7 @@ }, "password": { "description": "Password for authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -1268,7 +1268,7 @@ }, "password": { "description": "Password for authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "packageCollection": { "type": "object", @@ -1337,7 +1337,7 @@ }, "password": { "description": "Password for authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -1374,7 +1374,7 @@ }, "apiKey": { "description": "The API key for accessing the Azure ML model endpoint.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "updateResourceEndpoint": { "type": "object", @@ -1385,7 +1385,7 @@ "description": "The ID of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against the ARM-based updateResourceEndpoint of an Azure ML Studio web service." }, "tenant": { @@ -1442,7 +1442,7 @@ "description": "The ID of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against the endpoint of a published Azure ML Service pipeline." }, "tenant": { @@ -1493,7 +1493,7 @@ }, "credential": { "description": "The access credential portion of the connection string specified in driver-specific property-value format.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "userName": { "type": "object", @@ -1501,7 +1501,7 @@ }, "password": { "description": "Password for Basic authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -1545,7 +1545,7 @@ }, "credential": { "description": "The access credential portion of the connection string specified in driver-specific property-value format.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "userName": { "type": "object", @@ -1553,7 +1553,7 @@ }, "password": { "description": "Password for Basic authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -1597,7 +1597,7 @@ }, "credential": { "description": "The access credential portion of the connection string specified in driver-specific property-value format.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "userName": { "type": "object", @@ -1605,7 +1605,7 @@ }, "password": { "description": "Password for Basic authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -1657,7 +1657,7 @@ }, "password": { "description": "Password for Windows authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" } }, "required": [ @@ -1712,7 +1712,7 @@ }, "password": { "description": "Password of the OData service.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "tenant": { "type": "object", @@ -1740,15 +1740,15 @@ }, "servicePrincipalKey": { "description": "Specify the secret of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "servicePrincipalEmbeddedCert": { "description": "Specify the base64 encoded certificate of your application registered in Azure Active Directory. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "servicePrincipalEmbeddedCertPassword": { "description": "Specify the password of your certificate if your certificate has a password and you are using AadServicePrincipal authentication. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -1830,7 +1830,7 @@ }, "password": { "description": "The password for Basic authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" } }, "required": [ @@ -1849,11 +1849,11 @@ "properties": { "pfx": { "description": "Base64-encoded contents of a PFX file.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "password": { "description": "Password for the PFX file.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" } }, "required": [ @@ -1902,7 +1902,7 @@ }, "password": { "description": "Password for authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -1962,7 +1962,7 @@ }, "password": { "description": "Password for authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "authSource": { "type": "object", @@ -2097,7 +2097,7 @@ }, "servicePrincipalKey": { "description": "The Key of the application used to authenticate against the Azure Data Lake Store account.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "tenant": { "type": "object", @@ -2161,7 +2161,7 @@ }, "servicePrincipalKey": { "description": "The Key of the application used to authenticate against the Azure Data Lake Storage Gen2 account.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "tenant": { "type": "object", @@ -2213,7 +2213,7 @@ }, "servicePrincipalKey": { "description": "Specify the application's key.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -2260,11 +2260,11 @@ }, "password": { "description": "The password for Basic authentication of the Salesforce instance.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "securityToken": { "description": "The security token is required to remotely access Salesforce instance.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -2305,11 +2305,11 @@ }, "password": { "description": "The password for Basic authentication of the Salesforce instance.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "securityToken": { "description": "The security token is required to remotely access Salesforce instance.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "extendedProperties": { "type": "object", @@ -2354,7 +2354,7 @@ }, "password": { "description": "The password for Basic authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -2398,7 +2398,7 @@ }, "password": { "description": "The password for Basic authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "string", @@ -2454,7 +2454,7 @@ }, "password": { "description": "Password to access the SAP BW server where the open hub destination is located.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -2518,7 +2518,7 @@ }, "password": { "description": "The password used in Basic authentication type.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "servicePrincipalId": { "description": "The application's client ID used in AadServicePrincipal authentication type.", @@ -2526,7 +2526,7 @@ }, "servicePrincipalKey": { "description": "The application's key used in AadServicePrincipal authentication type.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "tenant": { "description": "The tenant information (domain name or tenant ID) used in AadServicePrincipal authentication type under which your application resides.", @@ -2575,7 +2575,7 @@ }, "secretAccessKey": { "description": "The secret access key of the Amazon S3 Identity and Access Management (IAM) user.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "serviceUrl": { "type": "object", @@ -2620,7 +2620,7 @@ }, "password": { "description": "The password of the Amazon Redshift source.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "database": { "type": "object", @@ -2689,7 +2689,7 @@ }, "key": { "description": "Admin Key for Azure Search service", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -2748,7 +2748,7 @@ }, "password": { "description": "Password for Basic, Digest, Windows, or ClientCertificate with EmbeddedCertData authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "embeddedCertData": { "type": "object", @@ -2820,7 +2820,7 @@ }, "password": { "description": "Password to logon the FTP server.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -2888,7 +2888,7 @@ }, "password": { "description": "Password to logon the SFTP server for Basic authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -2900,11 +2900,11 @@ }, "privateKeyContent": { "description": "Base64 encoded SSH private key content for SshPublicKey authentication. For on-premises copy with SshPublicKey authentication, either PrivateKeyPath or PrivateKeyContent should be specified. SSH private key should be OpenSSH format.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "passPhrase": { "description": "The password to decrypt the SSH private key if the SSH private key is encrypted.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "skipHostKeyValidation": { "type": "object", @@ -2960,7 +2960,7 @@ }, "password": { "description": "Password to access the SAP BW server.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -3022,7 +3022,7 @@ }, "password": { "description": "Password to access the SAP HANA server.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "type": "object", @@ -3070,7 +3070,7 @@ }, "mwsAuthToken": { "description": "The Amazon MWS authentication token.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "accessKeyId": { "description": "The access key id used to access data.", @@ -3078,7 +3078,7 @@ }, "secretKey": { "description": "The secret key used to access data.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -3132,7 +3132,7 @@ "type": "object" }, "password": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -3174,7 +3174,7 @@ }, "password": { "description": "The password corresponding to the user name that you provided in the username field.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -3226,7 +3226,7 @@ "type": "object" }, "credString": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of credString in connection string." }, "encryptedCredential": { @@ -3263,7 +3263,7 @@ "type": "object" }, "pwd": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -3305,7 +3305,7 @@ }, "password": { "description": "The password corresponding to the user name.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -3378,7 +3378,7 @@ }, "refreshToken": { "description": "The refresh token obtained from Google for authorizing access to BigQuery for UserAuthentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "clientId": { "description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).", @@ -3386,7 +3386,7 @@ }, "clientSecret": { "description": "The client secret of the google application used to acquire the refresh token.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "email": { "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.", @@ -3442,7 +3442,7 @@ "type": "object" }, "pwd": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -3504,7 +3504,7 @@ }, "password": { "description": "The password corresponding to the user name.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", @@ -3621,7 +3621,7 @@ }, "password": { "description": "The password corresponding to the user name that you provided in the Username field", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "httpPath": { "description": "The partial URL corresponding to the Hive server.", @@ -3686,15 +3686,15 @@ }, "clientSecret": { "description": "The client secret associated with your Hubspot application.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "accessToken": { "description": "The access token obtained when initially authenticating your OAuth integration.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "refreshToken": { "description": "The refresh token obtained when initially authenticating your OAuth integration.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -3767,7 +3767,7 @@ }, "password": { "description": "The password corresponding to the user name when using UsernameAndPassword.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", @@ -3836,7 +3836,7 @@ }, "password": { "description": "The password corresponding to the user name that you provided in the username field.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -3889,7 +3889,7 @@ }, "accessToken": { "description": "The access token from Magento.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -3940,7 +3940,7 @@ "type": "object" }, "pwd": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -3977,7 +3977,7 @@ "type": "object" }, "pwd": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -4019,7 +4019,7 @@ }, "clientSecret": { "description": "The client secret of your Marketo service.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -4076,7 +4076,7 @@ }, "clientSecret": { "description": "The client secret associated with your PayPal application.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -4154,7 +4154,7 @@ }, "password": { "description": "The password corresponding to the user name.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", @@ -4243,7 +4243,7 @@ }, "password": { "description": "The password corresponding to the user name.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "enableSsl": { "description": "Specifies whether the connections to the server are encrypted using SSL. The default value is false.", @@ -4318,15 +4318,15 @@ }, "consumerSecret": { "description": "The consumer secret for OAuth 1.0 authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "accessToken": { "description": "The access token for OAuth 1.0 authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "accessTokenSecret": { "description": "The access token secret for OAuth 1.0 authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -4391,7 +4391,7 @@ }, "password": { "description": "The password corresponding to the user name for Basic and OAuth2 authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "clientId": { "description": "The client id for OAuth2 authentication.", @@ -4399,7 +4399,7 @@ }, "clientSecret": { "description": "The client secret for OAuth2 authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -4452,7 +4452,7 @@ }, "accessToken": { "description": "The API access token that can be used to access Shopify’s data. The token won't expire if it is offline mode.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -4552,7 +4552,7 @@ }, "password": { "description": "The password corresponding to the user name that you provided in the Username field", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "httpPath": { "description": "The partial URL corresponding to the Spark server.", @@ -4622,7 +4622,7 @@ }, "clientSecret": { "description": "The client secret associated with your Square application.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "redirectUri": { "description": "The redirect URL assigned in the Square application dashboard. (i.e. http://localhost:2500)", @@ -4680,11 +4680,11 @@ }, "consumerKey": { "description": "The consumer key associated with the Xero application.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "privateKey": { "description": "The private key from the .pem file that was generated for your Xero private application. You must include all the text from the .pem file, including the Unix line endings(\n).", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -4736,7 +4736,7 @@ }, "accessToken": { "description": "The access token for Zoho authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true.", @@ -4787,7 +4787,7 @@ "type": "object" }, "pwd": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -4824,7 +4824,7 @@ "type": "object" }, "pwd": { - "$ref": "../datafactory.json#/definitions/AzureKeyVaultSecretReference", + "$ref": "../artifacts.json#/definitions/AzureKeyVaultSecretReference", "description": "The Azure key vault secret reference of password in connection string." }, "encryptedCredential": { @@ -4862,7 +4862,7 @@ }, "clientSecret": { "description": "The client secret associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", @@ -4922,7 +4922,7 @@ }, "linkedServiceName": { "description": "Azure Storage linked service to be used by the on-demand cluster for storing and processing data.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "hostSubscriptionId": { "type": "object", @@ -4934,7 +4934,7 @@ }, "servicePrincipalKey": { "description": "The key for the service principal id.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "tenant": { "type": "object", @@ -4954,7 +4954,7 @@ }, "clusterPassword": { "description": "The password to access the cluster.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "clusterSshUserName": { "type": "object", @@ -4962,18 +4962,18 @@ }, "clusterSshPassword": { "description": "The password to SSH remotely connect cluster’s node (for Linux).", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "additionalLinkedServiceNames": { "description": "Specifies additional storage accounts for the HDInsight linked service so that the Data Factory service can register them on your behalf.", "type": "array", "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" } }, "hcatalogLinkedServiceName": { "description": "The name of Azure SQL linked service that point to the HCatalog database. The on-demand HDInsight cluster is created by using the Azure SQL database as the metastore.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "clusterType": { "type": "object", @@ -5126,7 +5126,7 @@ }, "servicePrincipalKey": { "description": "The Key of the application used to authenticate against the Azure Data Lake Analytics account.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "tenant": { "type": "object", @@ -5183,7 +5183,7 @@ }, "accessToken": { "description": "Access token for databricks REST API. Refer to https://docs.azuredatabricks.net/api/latest/authentication.html. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "existingClusterId": { "type": "object", @@ -5284,7 +5284,7 @@ }, "clientSecret": { "description": "The client secret associated with the Responsys application. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", @@ -5341,7 +5341,7 @@ }, "servicePrincipalKey": { "description": "Specify the application's key. Mark this field as a SecureString to store it securely in Data Factory, or reference a secret stored in Azure Key Vault. Type: string (or Expression with resultType string).", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "tenant": { "description": "Specify the tenant information (domain name or tenant ID) under which your application resides. Retrieve it by hovering the mouse in the top-right corner of the Azure portal. Type: string (or Expression with resultType string).", @@ -5397,7 +5397,7 @@ }, "password": { "description": "The password corresponding to the user name that you provided in the username key.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "useEncryptedEndpoints": { "description": "Specifies whether the data source endpoints are encrypted using HTTPS. The default value is true. Type: boolean (or Expression with resultType boolean).", @@ -5451,7 +5451,7 @@ }, "developerToken": { "description": "The developer token associated with the manager account that you use to grant access to the AdWords API.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "authenticationType": { "description": "The OAuth 2.0 authentication mechanism used for authentication. ServiceAuthentication can only be used on self-hosted IR.", @@ -5467,7 +5467,7 @@ }, "refreshToken": { "description": "The refresh token obtained from Google for authorizing access to AdWords for UserAuthentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "clientId": { "description": "The client id of the google application used to acquire the refresh token. Type: string (or Expression with resultType string).", @@ -5475,7 +5475,7 @@ }, "clientSecret": { "description": "The client secret of the google application used to acquire the refresh token.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "email": { "description": "The service account email ID that is used for ServiceAuthentication and can only be used on self-hosted IR.", @@ -5553,7 +5553,7 @@ }, "password": { "description": "Password to access the SAP server where the table is located.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "messageServer": { "type": "object", @@ -5625,7 +5625,7 @@ "description": "The ID of the service principal used to authenticate against Azure Data Explorer. Type: string (or Expression with resultType string)." }, "servicePrincipalKey": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "The key of the service principal used to authenticate against Kusto." }, "database": { @@ -5674,7 +5674,7 @@ }, "functionKey": { "description": "Function or Host key for Azure Function App.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "encryptedCredential": { "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/NoteBook.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Notebook.json similarity index 98% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/NoteBook.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Notebook.json index 1958284c390e..9035e958e8b9 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/NoteBook.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Notebook.json @@ -1,12 +1,12 @@ { "swagger": "2.0", "info": { - "title": "SynapseClient", - "version": "2019-11-01-preview" + "title": "ArtifactsClient", + "version": "2019-06-01-preview" }, "paths": {}, "definitions": { - "NoteBook": { + "Notebook": { "description": "Notebook.", "type": "object", "properties": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Pipeline.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json similarity index 98% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Pipeline.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json index a2f4d1c618bb..2f1930156943 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Pipeline.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Pipeline.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "SynapseClient", - "version": "2019-11-01-preview" + "title": "ArtifactsClient", + "version": "2019-06-01-preview" }, "paths": {}, "definitions": { @@ -22,11 +22,11 @@ } }, "parameters": { - "$ref": "../datafactory.json#/definitions/ParameterDefinitionSpecification", + "$ref": "../artifacts.json#/definitions/ParameterDefinitionSpecification", "description": "List of parameters for pipeline." }, "variables": { - "$ref": "../datafactory.json#/definitions/VariableDefinitionSpecification", + "$ref": "../artifacts.json#/definitions/VariableDefinitionSpecification", "description": "List of variables for pipeline." }, "concurrency": { @@ -174,7 +174,7 @@ "properties": { "linkedServiceName": { "description": "Linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "policy": { "$ref": "#/definitions/ActivityPolicy", @@ -966,14 +966,14 @@ "type": "array", "description": "List of inputs for the activity.", "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" + "$ref": "../artifacts.json#/definitions/DatasetReference" } }, "outputs": { "type": "array", "description": "List of outputs for the activity.", "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" + "$ref": "../artifacts.json#/definitions/DatasetReference" } } }, @@ -2820,7 +2820,7 @@ "properties": { "s3LinkedServiceName": { "description": "The name of the Amazon S3 linked service which will be used for the unload operation when copying from the Amazon Redshift source.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "bucketName": { "type": "object", @@ -3362,7 +3362,7 @@ "properties": { "linkedServiceName": { "description": "Log storage linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "path": { "type": "object", @@ -3382,7 +3382,7 @@ "properties": { "linkedServiceName": { "description": "Staging linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "path": { "type": "object", @@ -3810,7 +3810,7 @@ "description": "Storage linked service references.", "type": "array", "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" } }, "arguments": { @@ -3831,7 +3831,7 @@ }, "scriptLinkedService": { "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "defines": { "description": "Allows user to specify defines for Hive job request.", @@ -3894,7 +3894,7 @@ "description": "Storage linked service references.", "type": "array", "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" } }, "arguments": { @@ -3911,7 +3911,7 @@ }, "scriptLinkedService": { "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "defines": { "description": "Allows user to specify defines for Pig job request.", @@ -3949,7 +3949,7 @@ "description": "Storage linked service references.", "type": "array", "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" } }, "arguments": { @@ -3974,7 +3974,7 @@ }, "jarLinkedService": { "description": "Jar linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "jarLibs": { "description": "Jar libs.", @@ -4024,7 +4024,7 @@ "description": "Storage linked service references.", "type": "array", "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" } }, "arguments": { @@ -4065,7 +4065,7 @@ }, "fileLinkedService": { "description": "Linked service reference where the files are located.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "combiner": { "type": "object", @@ -4140,7 +4140,7 @@ }, "sparkJobLinkedService": { "description": "The storage linked service for uploading the entry file and dependencies, and for receiving logs.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "className": { "description": "The application's Java/Spark main class.", @@ -4208,7 +4208,7 @@ }, "connectVia": { "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" }, "projectParameters": { "description": "The project level parameters to execute the SSIS package.", @@ -4288,7 +4288,7 @@ "type": "object", "properties": { "packagePassword": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "Password of the package." }, "accessCredential": { @@ -4370,7 +4370,7 @@ "description": "UseName for windows authentication." }, "password": { - "$ref": "../datafactory.json#/definitions/SecureString", + "$ref": "../artifacts.json#/definitions/SecureString", "description": "Password for windows authentication." } }, @@ -4393,7 +4393,7 @@ "description": "UseName for windows authentication." }, "password": { - "$ref": "../datafactory.json#/definitions/SecretBase", + "$ref": "../artifacts.json#/definitions/SecretBase", "description": "Password for windows authentication." } }, @@ -4502,7 +4502,7 @@ }, "resourceLinkedService": { "description": "Resource linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "folderPath": { "type": "object", @@ -4536,14 +4536,14 @@ "description": "Linked service references.", "type": "array", "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" } }, "datasets": { "description": "Dataset references.", "type": "array", "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" + "$ref": "../artifacts.json#/definitions/DatasetReference" } } } @@ -4611,11 +4611,11 @@ "properties": { "pipeline": { "description": "Pipeline reference.", - "$ref": "../datafactory.json#/definitions/PipelineReference" + "$ref": "../artifacts.json#/definitions/PipelineReference" }, "parameters": { "description": "Pipeline parameters.", - "$ref": "../datafactory.json#/definitions/ParameterValueSpecification" + "$ref": "../artifacts.json#/definitions/ParameterValueSpecification" }, "waitOnCompletion": { "description": "Defines whether activity execution will wait for the dependent pipeline execution to finish. Default is false.", @@ -4667,7 +4667,7 @@ }, "dataset": { "description": "Delete activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" + "$ref": "../artifacts.json#/definitions/DatasetReference" } }, "required": [ @@ -4737,7 +4737,7 @@ }, "dataset": { "description": "Lookup activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" + "$ref": "../artifacts.json#/definitions/DatasetReference" }, "firstRowOnly": { "type": "object", @@ -4791,7 +4791,7 @@ }, "pfx": { "description": "Base64-encoded contents of a PFX file.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "username": { "description": "Web activity authentication user name for basic authentication.", @@ -4799,7 +4799,7 @@ }, "password": { "description": "Password for the PFX file or basic authentication.", - "$ref": "../datafactory.json#/definitions/SecretBase" + "$ref": "../artifacts.json#/definitions/SecretBase" }, "resource": { "description": "Resource for which Azure Auth token will be requested when using MSI Authentication.", @@ -4837,19 +4837,19 @@ "type": "array", "description": "List of datasets passed to web endpoint.", "items": { - "$ref": "../datafactory.json#/definitions/DatasetReference" + "$ref": "../artifacts.json#/definitions/DatasetReference" } }, "linkedServices": { "type": "array", "description": "List of linked services passed to web endpoint.", "items": { - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" } }, "connectVia": { "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" } }, "required": [ @@ -4881,7 +4881,7 @@ "properties": { "dataset": { "description": "GetMetadata activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" + "$ref": "../artifacts.json#/definitions/DatasetReference" }, "fieldList": { "description": "Fields of metadata to get from dataset.", @@ -4920,7 +4920,7 @@ "properties": { "expression": { "description": "An expression that would evaluate to Boolean. This is used to determine the block of activities (ifTrueActivities or ifFalseActivities) that will be executed.", - "$ref": "../datafactory.json#/definitions/Expression" + "$ref": "../artifacts.json#/definitions/Expression" }, "ifTrueActivities": { "type": "array", @@ -4965,7 +4965,7 @@ "properties": { "on": { "description": "An expression that would evaluate to a string or integer. This is used to determine the block of activities in cases that will be executed.", - "$ref": "../datafactory.json#/definitions/Expression" + "$ref": "../artifacts.json#/definitions/Expression" }, "cases": { "type": "array", @@ -5036,7 +5036,7 @@ }, "items": { "description": "Collection to iterate.", - "$ref": "../datafactory.json#/definitions/Expression" + "$ref": "../artifacts.json#/definitions/Expression" }, "activities": { "type": "array", @@ -5107,7 +5107,7 @@ }, "linkedServiceName": { "description": "Reference to an Azure Storage LinkedService, where Azure ML WebService Input/Output file located.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" } }, "required": [ @@ -5143,7 +5143,7 @@ }, "trainedModelLinkedServiceName": { "description": "Name of Azure Storage linked service holding the .ilearner file that will be uploaded by the update operation.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "trainedModelFilePath": { "type": "object", @@ -5239,7 +5239,7 @@ }, "scriptLinkedService": { "description": "Script linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" }, "degreeOfParallelism": { "type": "object", @@ -5326,7 +5326,7 @@ "properties": { "expression": { "description": "An expression that would evaluate to Boolean. The loop will continue until this expression evaluates to true", - "$ref": "../datafactory.json#/definitions/Expression" + "$ref": "../artifacts.json#/definitions/Expression" }, "timeout": { "type": "object", @@ -5385,7 +5385,7 @@ }, "dataset": { "description": "Validation activity dataset reference.", - "$ref": "../datafactory.json#/definitions/DatasetReference" + "$ref": "../artifacts.json#/definitions/DatasetReference" } }, "required": [ @@ -5416,11 +5416,11 @@ "properties": { "items": { "description": "Input array on which filter should be applied.", - "$ref": "../datafactory.json#/definitions/Expression" + "$ref": "../artifacts.json#/definitions/Expression" }, "condition": { "description": "Condition to be used for filtering the input.", - "$ref": "../datafactory.json#/definitions/Expression" + "$ref": "../artifacts.json#/definitions/Expression" } }, "required": [ @@ -5448,7 +5448,7 @@ ] }, "DatabricksNotebookActivityTypeProperties": { - "description": "Databricks Notebook activity properties.", + "description": "Databricks notebook activity properties.", "properties": { "notebookPath": { "type": "object", @@ -5794,15 +5794,15 @@ "properties": { "dataFlow": { "description": "Data flow reference.", - "$ref": "../datafactory.json#/definitions/DataFlowReference" + "$ref": "../artifacts.json#/definitions/DataFlowReference" }, "staging": { "description": "Staging info for execute data flow activity.", - "$ref": "../datafactory.json#/definitions/DataFlowStagingInfo" + "$ref": "../artifacts.json#/definitions/DataFlowStagingInfo" }, "integrationRuntime": { "description": "The integration runtime reference.", - "$ref": "../datafactory.json#/definitions/IntegrationRuntimeReference" + "$ref": "../artifacts.json#/definitions/IntegrationRuntimeReference" }, "compute": { "description": "Compute properties for data flow activity.", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SparkJobDefinition.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SparkJobDefinition.json similarity index 96% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SparkJobDefinition.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SparkJobDefinition.json index 87caabcdaced..32c5484c99cd 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SparkJobDefinition.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SparkJobDefinition.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "SynapseClient", - "version": "2019-11-01-preview" + "title": "ArtifactsClient", + "version": "2019-06-01-preview" }, "paths": {}, "definitions": { @@ -16,7 +16,7 @@ }, "targetBigDataPool": { "description": "Big data pool reference.", - "$ref": "./NoteBook.json#/definitions/BigDataPoolReference" + "$ref": "./Notebook.json#/definitions/BigDataPoolReference" }, "requiredSparkVersion": { "description": "The required Spark version of the application.", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SqlScript.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SqlScript.json similarity index 97% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SqlScript.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SqlScript.json index ba7c44589f83..ab23bc7f45ff 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/SqlScript.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/SqlScript.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "SynapseClient", - "version": "2019-11-01-preview" + "title": "ArtifactsClient", + "version": "2019-06-01-preview" }, "paths": {}, "definitions": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Trigger.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json similarity index 97% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Trigger.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json index f8f4ac9763e2..37376429432c 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/Trigger.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/entityTypes/Trigger.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "SynapseClient", - "version": "2019-11-01-preview" + "title": "ArtifactsClient", + "version": "2019-06-01-preview" }, "paths": {}, "definitions": { @@ -64,7 +64,7 @@ "pipelines": { "type": "array", "items": { - "$ref": "../datafactory.json#/definitions/TriggerPipelineReference" + "$ref": "../artifacts.json#/definitions/TriggerPipelineReference" }, "description": "Pipelines that need to be started." } @@ -268,7 +268,7 @@ }, "linkedService": { "description": "The Azure Storage linked service reference.", - "$ref": "../datafactory.json#/definitions/LinkedServiceReference" + "$ref": "../artifacts.json#/definitions/LinkedServiceReference" } }, "required": [ @@ -351,7 +351,7 @@ ], "properties": { "pipeline": { - "$ref": "../datafactory.json#/definitions/TriggerPipelineReference", + "$ref": "../artifacts.json#/definitions/TriggerPipelineReference", "description": "Pipeline for which runs are created when an event is fired for trigger window that is ready." }, "typeProperties": { @@ -604,7 +604,7 @@ ], "properties": { "pipeline": { - "$ref": "../datafactory.json#/definitions/TriggerPipelineReference", + "$ref": "../artifacts.json#/definitions/TriggerPipelineReference", "description": "Pipeline for which runs are created when all upstream pipelines complete successfully." }, "typeProperties": { @@ -614,7 +614,7 @@ "dependsOn": { "type": "array", "items": { - "$ref": "../datafactory.json#/definitions/PipelineReference" + "$ref": "../artifacts.json#/definitions/PipelineReference" }, "description": "Upstream Pipelines." }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/ActivityRuns_QueryByPipelineRun.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/ActivityRuns_QueryByPipelineRun.json similarity index 96% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/ActivityRuns_QueryByPipelineRun.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/ActivityRuns_QueryByPipelineRun.json index 1d0e4bb38f62..f5662d347497 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/ActivityRuns_QueryByPipelineRun.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/ActivityRuns_QueryByPipelineRun.json @@ -1,14 +1,13 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "pipelineName": "examplePipeline", "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", "filterParameters": { "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z" }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_AddDataFlow.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_AddDataFlow.json similarity index 95% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_AddDataFlow.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_AddDataFlow.json index 3fe211fe4d36..adf054457fcc 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_AddDataFlow.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_AddDataFlow.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "request": { "dataFlow": { "name": "dataflow1", @@ -90,7 +89,7 @@ }, "sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e" }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json similarity index 87% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Create.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json index 2b8e9fb98143..b1644c6737c5 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Create.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "request": { "dataFlowName": "dataflow", "existingClusterId": "1221221", @@ -21,7 +20,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "202": { @@ -31,7 +30,7 @@ "x-ms-ratelimit-remaining-subscription-reads": "14989", "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", - "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationStatuses/dfCreateSession$$229c688c-944c-44ac-b31a-82d50f347154?api-version=2019-11-01-preview" + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationStatuses/dfCreateSession$$229c688c-944c-44ac-b31a-82d50f347154?api-version=2019-06-01-preview" } }, "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Delete.json similarity index 78% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Delete.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Delete.json index be1da7df23ce..7eecf68ab320 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_Delete.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_Delete.json @@ -1,11 +1,10 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "request": { "sessionId": "91fb57e0-8292-47be-89ff-c8f2d2bb2a7e" }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_ExecuteCommand.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json similarity index 83% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_ExecuteCommand.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json index 45e86f142046..9c88adb10bde 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_ExecuteCommand.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_ExecuteCommand.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "request": { "dataFlowName": "dataFlowName", "commandPayload": { @@ -11,7 +10,7 @@ "commandName": "executePreviewQuery", "sessionId": "f06ed247-9d07-49b2-b05e-2cb4a2fc871e" }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "202": { @@ -21,7 +20,7 @@ "x-ms-ratelimit-remaining-subscription-reads": "14989", "x-ms-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", "x-ms-correlation-request-id": "2f955e10-c6df-45a7-97d4-81acdb8540cd", - "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/dfCommandOutput$$f06ed247-9d07-49b2-b05e-2cb4a2fc871e$$e5328ee7-c524-4207-8ba4-b709010db33d$$ace5eaf0-3e93-45ba-ada3-bf77da321a7b?api-version=2019-11-01-preview" + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/dfCommandOutput$$f06ed247-9d07-49b2-b05e-2cb4a2fc871e$$e5328ee7-c524-4207-8ba4-b709010db33d$$ace5eaf0-3e93-45ba-ada3-bf77da321a7b?api-version=2019-06-01-preview" } }, "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_QueryByWorkspace.json similarity index 87% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_QueryByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_QueryByWorkspace.json index 8489bf43ada4..fee006e7bfa3 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlowDebugSession_QueryByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlowDebugSession_QueryByWorkspace.json @@ -1,8 +1,7 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Create.json similarity index 97% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Create.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Create.json index b7ed67fcc853..d684ba316241 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Create.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "dataFlowName": "exampleDataFlow", "ifMatch": null, "dataFlow": { @@ -45,7 +44,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Delete.json new file mode 100644 index 000000000000..6adacca27788 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "dataFlowName": "exampleDataFlow", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Get.json similarity index 95% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Get.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Get.json index 62b69ff0b194..5320762f2207 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Get.json @@ -1,10 +1,9 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "dataFlowName": "exampleDataFlow", "ifNoneMatch": "15004c4f-0000-0200-0000-5cbe090e0000", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_ListByWorkspace.json similarity index 95% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_ListByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_ListByWorkspace.json index 822e92e95dcc..24af45cebd60 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_ListByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_ListByWorkspace.json @@ -1,8 +1,7 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Update.json similarity index 97% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Update.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Update.json index 7dd8812dadde..f3c5fc5a031e 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/DataFlows_Update.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "dataFlowName": "exampleDataFlow", "ifMatch": null, "dataFlow": { @@ -45,7 +44,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Create.json similarity index 95% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Create.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Create.json index ac06a1b294d9..20f9a9b778ff 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Create.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "datasetName": "exampleDataset", "ifMatch": null, "dataset": { @@ -34,7 +33,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Delete.json new file mode 100644 index 000000000000..ecbb3fd65993 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "datasetName": "exampleDataset", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Get.json similarity index 92% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Get.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Get.json index e144948c6a4a..9ff129e80acb 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Get.json @@ -1,10 +1,9 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "datasetName": "exampleDataset", "ifNoneMatch": "15004c4f-0000-0200-0000-5cbe090e0000", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "304": {}, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_ListByWorkspace.json similarity index 93% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_ListByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_ListByWorkspace.json index f447e965203b..9600e887321c 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_ListByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_ListByWorkspace.json @@ -1,8 +1,7 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Update.json similarity index 94% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Update.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Update.json index bbb243a3e705..c17bc775bed6 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Datasets_Update.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "datasetName": "exampleDataset", "ifMatch": null, "dataset": { @@ -35,7 +34,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json similarity index 92% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Create.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json index a390ebc6a97a..83813ca2dbd3 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Create.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "linkedServiceName": "exampleLinkedService", "ifMatch": null, "linkedService": { @@ -15,7 +14,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json new file mode 100644 index 000000000000..d18fa82e8963 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "linkedServiceName": "exampleLinkedService", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Get.json similarity index 91% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Get.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Get.json index 0febc6bb3664..a1f58bc731fd 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Get.json @@ -1,10 +1,9 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "linkedServiceName": "exampleLinkedService", "ifNoneMatch": "1500474f-0000-0200-0000-5cbe090d0000", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "304": {}, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_ListByWorkspace.json similarity index 91% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_ListByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_ListByWorkspace.json index 2624517adc08..73b500bfb22e 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_ListByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_ListByWorkspace.json @@ -1,8 +1,7 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json similarity index 93% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Update.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json index a5b3f337bcf1..217788a059e1 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/LinkedServices_Update.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "linkedServiceName": "exampleLinkedService", "ifMatch": null, "linkedService": { @@ -16,7 +15,7 @@ "description": "Example description" } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json similarity index 88% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Create.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json index 6e096bebb3de..6dfcafc232ee 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Create.json @@ -1,12 +1,11 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "noteBookName": "exampleNoteBook", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", "ifMatch": null, - "noteBook": { + "Notebook": { "properties": { - "description": "A sample notebook", + "description": "A sample Notebook", "nbformat": 4, "nbformat_minor": 2, "bigDataPool": { @@ -54,7 +53,7 @@ ] } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { @@ -66,11 +65,11 @@ "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" }, "body": { - "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNoteBook", - "name": "exampleNoteBook", - "type": "Microsoft.Synapse/workspaces/notebooks", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/Notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", "properties": { - "description": "A sample notebook", + "description": "A sample Notebook", "nbformat": 4, "nbformat_minor": 2, "bigDataPool": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json new file mode 100644 index 000000000000..58395fa417a1 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Get.json similarity index 84% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Get.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Get.json index 1231f1525ebb..c60e7f3695a6 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Get.json @@ -1,10 +1,9 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "noteBookName": "exampleNoteBook", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { @@ -16,11 +15,11 @@ "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" }, "body": { - "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNoteBook", - "name": "exampleNoteBook", - "type": "Microsoft.Synapse/workspaces/notebooks", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", "properties": { - "description": "A sample notebook", + "description": "A sample Notebook", "nbformat": 4, "nbformat_minor": 2, "bigDataPool": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListByWorkspace.json similarity index 86% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListByWorkspace.json index b45c79479777..e339a9103d65 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListByWorkspace.json @@ -1,8 +1,7 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2019-06-01-preview" }, "responses": { "200": { @@ -16,11 +15,11 @@ "body": { "value": [ { - "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNoteBook", - "name": "exampleNoteBook", - "type": "Microsoft.Synapse/workspaces/notebooks", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", "properties": { - "description": "A sample notebook", + "description": "A sample Notebook", "nbformat": 4, "nbformat_minor": 2, "bigDataPool": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListSummaryByWorkSpace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListSummaryByWorkSpace.json similarity index 86% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListSummaryByWorkSpace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListSummaryByWorkSpace.json index b45c79479777..e339a9103d65 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_ListSummaryByWorkSpace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_ListSummaryByWorkSpace.json @@ -1,8 +1,7 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2019-06-01-preview" }, "responses": { "200": { @@ -16,11 +15,11 @@ "body": { "value": [ { - "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNoteBook", - "name": "exampleNoteBook", - "type": "Microsoft.Synapse/workspaces/notebooks", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", "properties": { - "description": "A sample notebook", + "description": "A sample Notebook", "nbformat": 4, "nbformat_minor": 2, "bigDataPool": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json similarity index 90% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Update.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json index 3add275201f5..c84e1a5f1741 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Notebooks_Update.json @@ -1,10 +1,9 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "noteBookName": "exampleNoteBook", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "notebookName": "exampleNotebook", "ifMatch": null, - "noteBook": { + "Notebook": { "properties": { "description": "Modified description", "nbformat": 4, @@ -54,7 +53,7 @@ ] } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { @@ -66,9 +65,9 @@ "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264" }, "body": { - "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNoteBook", - "name": "exampleNoteBook", - "type": "Microsoft.Synapse/workspaces/notebooks", + "id": "/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/notebooks/exampleNotebook", + "name": "exampleNotebook", + "type": "Microsoft.Synapse/workspaces/Notebooks", "properties": { "description": "Modified description", "nbformat": 4, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Cancel.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Cancel.json new file mode 100644 index 000000000000..223ee4eea674 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Cancel.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Get.json similarity index 89% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Get.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Get.json index c70c28bcd545..23b48073aed1 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_Get.json @@ -1,9 +1,8 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_QueryByWorkspace.json similarity index 94% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_QueryByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_QueryByWorkspace.json index 729a2293c584..c93f18b8301c 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_QueryByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/PipelineRuns_QueryByWorkspace.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "filterParameters": { "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z", @@ -15,7 +14,7 @@ } ] }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json similarity index 97% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Create.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json index aa5d08c13e96..399eb460bf34 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Create.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "pipelineName": "examplePipeline", "ifMatch": null, "pipeline": { @@ -78,7 +77,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_CreateRun.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json similarity index 83% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_CreateRun.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json index 9ccab2c1f7a4..7c4ec522a5a3 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_CreateRun.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_CreateRun.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "pipelineName": "examplePipeline", "referencePipelineRunId": null, "parameters": { @@ -9,7 +8,7 @@ "exampleoutput.csv" ] }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json new file mode 100644 index 000000000000..4a7573f09103 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "pipelineName": "examplePipeline", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Get.json similarity index 95% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Get.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Get.json index 5336cd82dc2b..48e8f695574e 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Get.json @@ -1,10 +1,9 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "pipelineName": "examplePipeline", "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "304": {}, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_ListByWorkspace.json similarity index 95% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_ListByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_ListByWorkspace.json index d5ecfa79951a..e9b5dfc8816d 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_ListByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_ListByWorkspace.json @@ -1,8 +1,7 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json similarity index 97% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Update.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json index 831858484fd3..b5718b15aa75 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Pipelines_Update.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "pipelineName": "examplePipeline", "ifMatch": null, "pipeline": { @@ -65,7 +64,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Create.json similarity index 95% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Create.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Create.json index 6572cbb38414..d969cd11b3e3 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Create.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "sparkJobDefinitionName": "exampleSparkJobDefinition", "ifMatch": null, "sparkJobDefinition": { @@ -32,7 +31,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Debug.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Debug.json similarity index 97% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Debug.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Debug.json index e274b30ea43a..d470f6b59a75 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Debug.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Debug.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "sparkJobDefinitionAzureResource": { "properties": { "description": "A sample spark job definition", @@ -23,7 +22,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "202": { @@ -33,7 +32,7 @@ "x-ms-ratelimit-remaining-subscription-writes": "1192", "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", - "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2019-11-01-preview" + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2019-06-01-preview" }, "body": { "livyInfo": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Delete.json similarity index 51% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Delete.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Delete.json index 5ebb9f424a2a..37e6bcc064e8 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Delete.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Delete.json @@ -1,9 +1,8 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "sparkJobDefinitionName": "exampleSparkJobDefinition", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": {}, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Execute.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Execute.json similarity index 97% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Execute.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Execute.json index 0c8aabb09867..8ba9acd78875 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Execute.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Execute.json @@ -1,9 +1,8 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "sparkJobDefinitionName": "exampleSparkJobDefinition", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "202": { @@ -13,7 +12,7 @@ "x-ms-ratelimit-remaining-subscription-writes": "1192", "x-ms-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", "x-ms-correlation-request-id": "e4c589b7-a9fe-4c28-981c-3855ec27d264", - "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2019-11-01-preview" + "location": "https://exampleWorkspaceName.dev.azuresynapse.net/operationResults/arcadiaSpark$$exampleBigDataPool$$batch$$1?api-version=2019-06-01-preview" }, "body": { "livyInfo": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Get.json similarity index 93% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Get.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Get.json index d36ba238c79a..fb4857b4d515 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Get.json @@ -1,10 +1,9 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "sparkJobDefinitionName": "exampleSparkJobDefinition", "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_ListByWorkspace.json similarity index 93% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_ListByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_ListByWorkspace.json index f05b845f65ba..1e021182a881 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_ListByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_ListByWorkspace.json @@ -1,8 +1,7 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Update.json similarity index 95% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Update.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Update.json index 005764c7dc47..61f620544311 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SparkJobDefinitions_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SparkJobDefinitions_Update.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "sparkJobDefinitionName": "exampleSparkJobDefinition", "ifMatch": null, "sparkJobDefinition": { @@ -32,7 +31,7 @@ } } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Create.json similarity index 93% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Create.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Create.json index 5dc6861614b9..aa96d82b50df 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Create.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "sqlScriptName": "exampleSqlScript", "ifMatch": null, "sqlScript": { @@ -20,7 +19,7 @@ "type": "SqlQuery" } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Delete.json new file mode 100644 index 000000000000..b01abf40c85b --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "sqlScriptName": "exampleSqlScript", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Get.json similarity index 91% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Get.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Get.json index 829447fd448f..58b0d64cc81b 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Get.json @@ -1,10 +1,9 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "sqlScriptName": "exampleSqlScript", "ifNoneMatch": "1500504f-0000-0200-0000-5cbe090f0000", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "304": {}, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_ListByWorkspace.json similarity index 91% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_ListByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_ListByWorkspace.json index c999df7b1828..7625964f4a73 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_ListByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_ListByWorkspace.json @@ -1,8 +1,7 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Update.json similarity index 92% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Update.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Update.json index 0c377a063cbd..cd482ba8c7e9 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/SqlScripts_Update.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "sqlScriptName": "exampleSqlScript", "ifMatch": null, "sqlScript": { @@ -20,7 +19,7 @@ "type": "SqlQuery" } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_QueryByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_QueryByWorkspace.json similarity index 91% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_QueryByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_QueryByWorkspace.json index 48c13c4038c3..e90f9a56ffbf 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_QueryByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_QueryByWorkspace.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "filterParameters": { "lastUpdatedAfter": "2018-06-16T00:36:44.3345758Z", "lastUpdatedBefore": "2018-06-16T00:49:48.3686473Z", @@ -15,7 +14,7 @@ } ] }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_Rerun.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_Rerun.json similarity index 79% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_Rerun.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_Rerun.json index edd3551ad448..169d70a4e4b5 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/TriggerRuns_Rerun.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/TriggerRuns_Rerun.json @@ -1,10 +1,9 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "triggerName": "exampleTrigger", "runId": "2f7fdb90-5df1-4b8e-ac2f-064cfa58202b", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json similarity index 94% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Create.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json index d7210bda0148..c93a8820594c 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Create.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "triggerName": "exampleTrigger", "ifMatch": null, "trigger": { @@ -31,7 +30,7 @@ ] } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json new file mode 100644 index 000000000000..b3a88c1cd75e --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Delete.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Get.json similarity index 92% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Get.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Get.json index bc4d1d09b735..d0a33e28322e 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Get.json @@ -1,10 +1,9 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "triggerName": "exampleTrigger", "ifNoneMatch": "1500544f-0000-0200-0000-5cbe09100000", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "304": {}, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_GetEventSubscriptionStatus.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_GetEventSubscriptionStatus.json similarity index 60% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_GetEventSubscriptionStatus.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_GetEventSubscriptionStatus.json index 89e4b4c407c0..b53d893ae8dc 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_GetEventSubscriptionStatus.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_GetEventSubscriptionStatus.json @@ -1,9 +1,8 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "triggerName": "exampleTrigger", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_ListByWorkspace.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_ListByWorkspace.json similarity index 93% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_ListByWorkspace.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_ListByWorkspace.json index ec31d1d1ad90..cd9b246ab465 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_ListByWorkspace.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_ListByWorkspace.json @@ -1,8 +1,7 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Start.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Start.json new file mode 100644 index 000000000000..b4062d3fb605 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Start.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Stop.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Stop.json new file mode 100644 index 000000000000..b4062d3fb605 --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Stop.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "exampleWorkspace.dev.azuresynapse.net", + "triggerName": "exampleTrigger", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_SubscribeToEvents.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_SubscribeToEvents.json similarity index 76% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_SubscribeToEvents.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_SubscribeToEvents.json index 012cdd41ae33..6fc40f69c0fb 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_SubscribeToEvents.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_SubscribeToEvents.json @@ -1,14 +1,13 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "triggerName": "exampleTrigger", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-11-01-preview" + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-06-01-preview" } }, "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_UnsubscribeFromEvents.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_UnsubscribeFromEvents.json similarity index 76% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_UnsubscribeFromEvents.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_UnsubscribeFromEvents.json index c3df05a1a218..d2d6e6b8e538 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_UnsubscribeFromEvents.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_UnsubscribeFromEvents.json @@ -1,14 +1,13 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "triggerName": "exampleTrigger", - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "202": { "headers": { - "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-11-01-preview" + "Location": "https://management.azure.com/subscriptions/12345678-1234-1234-1234-12345678abc/resourceGroups/exampleResourceGroup/providers/Microsoft.Synapse/workspaces/exampleWorkspaceName/triggers/exampleTrigger/getEventSubscriptionStatus?api-version=2019-06-01-preview" } }, "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Update.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Update.json similarity index 94% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Update.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Update.json index ae377e99c8c9..a86583945183 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Update.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/examples/Triggers_Update.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "triggerName": "exampleTrigger", "ifMatch": null, "trigger": { @@ -32,7 +31,7 @@ "description": "Example description" } }, - "api-version": "2019-11-01-preview" + "api-version": "2019-06-01-preview" }, "responses": { "200": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Delete.json deleted file mode 100644 index c17410917a90..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/DataFlows_Delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "dataFlowName": "exampleDataFlow", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Delete.json deleted file mode 100644 index e82de485176e..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Datasets_Delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "datasetName": "exampleDataset", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Delete.json deleted file mode 100644 index e4cc97bbd8e9..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/LinkedServices_Delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "linkedServiceName": "exampleLinkedService", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Delete.json deleted file mode 100644 index 5b9d485f645f..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/NoteBooks_Delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "noteBookName": "exampleNoteBook", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Cancel.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Cancel.json deleted file mode 100644 index 240fccae8866..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/PipelineRuns_Cancel.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "runId": "16ac5348-ff82-4f95-a80d-638c1d47b721", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Delete.json deleted file mode 100644 index cb459371f543..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Pipelines_Delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "pipelineName": "examplePipeline", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Delete.json deleted file mode 100644 index e67581c0ef4d..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/SqlScripts_Delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "sqlScriptName": "exampleSqlScript", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Delete.json deleted file mode 100644 index 430e2cfba554..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Delete.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "triggerName": "exampleTrigger", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Start.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Start.json deleted file mode 100644 index 8d61a0a08228..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Start.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "triggerName": "exampleTrigger", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Stop.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Stop.json deleted file mode 100644 index 8d61a0a08228..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/adf/examples/Triggers_Stop.json +++ /dev/null @@ -1,11 +0,0 @@ -{ - "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "triggerName": "exampleTrigger", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Create.json index c00010474fcd..55db4134cc83 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Create.json @@ -1,11 +1,10 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "detailed": true, - "livyRequest": { + "sparkBatchJobOptions": { "tags": null, "artifactId": "fill in here", "name": "jobname", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Delete.json index 2d724570df6f..4065e60cf5ca 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Delete.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Delete.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "batchId": 123, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Get.json index bf6362b33a76..2efdc6815217 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_Get.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "batchId": 123, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_List.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_List.json index a112d816c54d..008b004dfb27 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_List.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkBatch_List.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "from": 0, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Create.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Create.json index 40aa196c6d1c..392544470614 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Create.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Create.json @@ -1,11 +1,10 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "detailed": true, - "livyRequest": { + "SparkSessionOptions": { "tags": null, "artifactId": "fill in here", "name": "jobname", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_CreateStatement.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_CreateStatement.json index a5fd2a5fc372..1c9c2cef0441 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_CreateStatement.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_CreateStatement.json @@ -1,11 +1,10 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "sessionId": 123, - "livyRequest": { + "SparkStatementOptions": { "code": "fill in here", "kind": "fill in here" } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Delete.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Delete.json index d74f7b31bdc8..50dcbafe48eb 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Delete.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Delete.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "sessionId": 123, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_DeleteStatement.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_DeleteStatement.json index 09f511d90fbd..0f4624035909 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_DeleteStatement.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_DeleteStatement.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "sessionId": 123, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Get.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Get.json index c7a828d05e7f..56fb7dd2ae81 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Get.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_Get.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "sessionId": 123, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_GetStatement.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_GetStatement.json index d45676affe42..86d5cb20c081 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_GetStatement.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_GetStatement.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "sessionId": 123, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_List.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_List.json index a112d816c54d..008b004dfb27 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_List.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_List.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "from": 0, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ListStatements.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ListStatements.json index e59988a5549f..4603d8c5feef 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ListStatements.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ListStatements.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "sessionId": 123 diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ResetTimeout.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ResetTimeout.json index b9406468d90b..f6cdbf056b23 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ResetTimeout.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/SparkFrontend_SparkSession_ResetTimeout.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "livyApiVersion": "2019-11-01-preview", "sparkPoolName": "mySparkPool", "sessionId": 123 diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json similarity index 75% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json index 537b1b03a4df..7f1d16f415b7 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json @@ -2,24 +2,23 @@ "swagger": "2.0", "info": { "version": "2019-11-01-preview", - "title": "SynapseClient", + "title": "SparkClient", "x-ms-code-generation-settings": { "useDateTimeOffset": true } }, "x-ms-parameterized-host": { - "hostTemplate": "{workspaceName}.{SynapseDnsSuffix}", + "hostTemplate": "{endpoint}/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}", + "useSchemePrefix": false, "parameters": [ { - "name": "workspaceName", - "description": "The name of the workspace to execute operations on.", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true + "$ref": "#/parameters/Endpoint" }, { - "$ref": "#/parameters/SynapseDnsSuffixInPath" + "$ref": "#/parameters/LivyApiVersion" + }, + { + "$ref": "#/parameters/SparkPoolName" } ] }, @@ -33,13 +32,13 @@ "application/json" ], "paths": { - "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches": { + "/batches": { "get": { "tags": [ "SparkBatch" ], "description": "List all spark batch jobs which are running under a particular spark pool.", - "operationId": "SparkBatch_List", + "operationId": "SparkBatch_GetSparkBatchJobs", "x-ms-examples": { "List all spark batch jobs": { "$ref": "./examples/SparkFrontend_SparkBatch_List.json" @@ -52,16 +51,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "from", "in": "query", @@ -90,7 +79,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ExtendedLivyListBatchResponse" + "$ref": "#/definitions/SparkBatchJobCollection" } } } @@ -100,7 +89,7 @@ "SparkBatch" ], "description": "Create new spark batch job.", - "operationId": "SparkBatch_Create", + "operationId": "SparkBatch_CreateSparkBatchJob", "x-ms-examples": { "Create new spark batch job.": { "$ref": "./examples/SparkFrontend_SparkBatch_Create.json" @@ -113,16 +102,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "detailed", "in": "query", @@ -131,12 +110,12 @@ "type": "boolean" }, { - "name": "livyRequest", + "name": "sparkBatchJobOptions", "in": "body", "description": "Livy compatible batch job request payload.", "required": true, "schema": { - "$ref": "#/definitions/ExtendedLivyBatchRequest" + "$ref": "#/definitions/sparkBatchJobOptions" } } ], @@ -144,19 +123,19 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ExtendedLivyBatchResponse" + "$ref": "#/definitions/SparkBatchJob" } } } } }, - "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/batches/{batchId}": { + "/batches/{batchId}": { "get": { "tags": [ "SparkBatch" ], "description": "Gets a single spark batch job.", - "operationId": "SparkBatch_Get", + "operationId": "SparkBatch_GetSparkBatchJob", "x-ms-examples": { "Gets a single spark batch job.": { "$ref": "./examples/SparkFrontend_SparkBatch_Get.json" @@ -169,16 +148,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "batchId", "in": "path", @@ -199,7 +168,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ExtendedLivyBatchResponse" + "$ref": "#/definitions/SparkBatchJob" } } } @@ -209,7 +178,7 @@ "SparkBatch" ], "description": "Cancels a running spark batch job.", - "operationId": "SparkBatch_Delete", + "operationId": "SparkBatch_CancelSparkBatchJob", "x-ms-examples": { "Cancels a running spark batch job.": { "$ref": "./examples/SparkFrontend_SparkBatch_Delete.json" @@ -222,16 +191,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "batchId", "in": "path", @@ -248,13 +207,13 @@ } } }, - "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions": { + "/sessions": { "get": { "tags": [ "SparkSession" ], "description": "List all spark sessions which are running under a particular spark pool.", - "operationId": "SparkSession_List", + "operationId": "SparkSession_GetSparkSessions", "x-ms-examples": { "List all spark session jobs": { "$ref": "./examples/SparkFrontend_SparkSession_List.json" @@ -267,16 +226,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "from", "in": "query", @@ -305,7 +254,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ExtendedLivyListSessionResponse" + "$ref": "#/definitions/SparkSessionCollection" } } } @@ -315,7 +264,7 @@ "SparkSession" ], "description": "Create new spark session.", - "operationId": "SparkSession_Create", + "operationId": "SparkSession_CreateSparkSession", "x-ms-examples": { "Create new spark session.": { "$ref": "./examples/SparkFrontend_SparkSession_Create.json" @@ -328,16 +277,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "detailed", "in": "query", @@ -346,12 +285,12 @@ "type": "boolean" }, { - "name": "livyRequest", + "name": "SparkSessionOptions", "in": "body", "description": "Livy compatible batch job request payload.", "required": true, "schema": { - "$ref": "#/definitions/ExtendedLivySessionRequest" + "$ref": "#/definitions/SparkSessionOptions" } } ], @@ -359,19 +298,19 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ExtendedLivySessionResponse" + "$ref": "#/definitions/SparkSession" } } } } }, - "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}": { + "/sessions/{sessionId}": { "get": { "tags": [ "SparkSession" ], "description": "Gets a single spark session.", - "operationId": "SparkSession_Get", + "operationId": "SparkSession_GetSparkSession", "x-ms-examples": { "Gets a single spark session.": { "$ref": "./examples/SparkFrontend_SparkSession_Get.json" @@ -384,16 +323,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "sessionId", "in": "path", @@ -414,7 +343,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/ExtendedLivySessionResponse" + "$ref": "#/definitions/SparkSession" } } } @@ -424,7 +353,7 @@ "SparkSession" ], "description": "Cancels a running spark session.", - "operationId": "SparkSession_Delete", + "operationId": "SparkSession_CancelSparkSession", "x-ms-examples": { "Cancels a running spark session.": { "$ref": "./examples/SparkFrontend_SparkSession_Delete.json" @@ -437,16 +366,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\"\r\n targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "sessionId", "in": "path", @@ -463,13 +382,13 @@ } } }, - "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/reset-timeout": { + "/sessions/{sessionId}/reset-timeout": { "put": { "tags": [ "SparkSession" ], "description": "Sends a keep alive call to the current session to reset the session timeout.", - "operationId": "SparkSession_ResetTimeout", + "operationId": "SparkSession_ResetSparkSessionTimeout", "x-ms-examples": { "Reset the session timeout.": { "$ref": "./examples/SparkFrontend_SparkSession_ResetTimeout.json" @@ -482,16 +401,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\"\r\n targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "sessionId", "in": "path", @@ -508,13 +417,13 @@ } } }, - "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements": { + "/sessions/{sessionId}/statements": { "get": { "tags": [ "SparkSession" ], "description": "Gets a list of statements within a spark session.", - "operationId": "SparkSession_ListStatements", + "operationId": "SparkSession_GetSparkStatements", "x-ms-examples": { "Gets a list of statements within a spark session.": { "$ref": "./examples/SparkFrontend_SparkSession_ListStatements.json" @@ -527,16 +436,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "sessionId", "in": "path", @@ -550,7 +449,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/LivyStatementsResponseBody" + "$ref": "#/definitions/SparkStatementCollection" } } } @@ -560,7 +459,7 @@ "SparkSession" ], "description": "Create statement within a spark session.", - "operationId": "SparkSession_CreateStatement", + "operationId": "SparkSession_CreateSparkStatement", "x-ms-examples": { "Create statement within a spark session.": { "$ref": "./examples/SparkFrontend_SparkSession_CreateStatement.json" @@ -573,16 +472,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "sessionId", "in": "path", @@ -592,12 +481,12 @@ "format": "int32" }, { - "name": "livyRequest", + "name": "SparkStatementOptions", "in": "body", "description": "Livy compatible batch job request payload.", "required": true, "schema": { - "$ref": "#/definitions/LivyStatementRequestBody" + "$ref": "#/definitions/SparkStatementOptions" } } ], @@ -605,19 +494,19 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/LivyStatementResponseBody" + "$ref": "#/definitions/SparkStatement" } } } } }, - "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}": { + "/sessions/{sessionId}/statements/{statementId}": { "get": { "tags": [ "SparkSession" ], "description": "Gets a single statement within a spark session.", - "operationId": "SparkSession_GetStatement", + "operationId": "SparkSession_GetSparkStatement", "x-ms-examples": { "Gets a single statement within a spark session.": { "$ref": "./examples/SparkFrontend_SparkSession_GetStatement.json" @@ -630,16 +519,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "sessionId", "in": "path", @@ -661,19 +540,19 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/LivyStatementResponseBody" + "$ref": "#/definitions/SparkStatement" } } } } }, - "/livyApi/versions/{livyApiVersion}/sparkPools/{sparkPoolName}/sessions/{sessionId}/statements/{statementId}/cancel": { + "/sessions/{sessionId}/statements/{statementId}/cancel": { "post": { "tags": [ "SparkSession" ], "description": "Kill a statement within a session.", - "operationId": "SparkSession_DeleteStatement", + "operationId": "SparkSession_CancelSparkStatement", "x-ms-examples": { "Kill a statement within a session.": { "$ref": "./examples/SparkFrontend_SparkSession_DeleteStatement.json" @@ -686,16 +565,6 @@ "application/json" ], "parameters": [ - { - "$ref": "#/parameters/LivyApiVersionInPath" - }, - { - "name": "sparkPoolName", - "in": "path", - "description": "Name of the spark pool. \"ondemand\" targets the ondemand pool.", - "required": true, - "type": "string" - }, { "name": "sessionId", "in": "path", @@ -717,7 +586,7 @@ "200": { "description": "Success", "schema": { - "$ref": "#/definitions/LivyStatementCancellationResponse" + "$ref": "#/definitions/SparkStatementCancellationResult" } } } @@ -725,49 +594,63 @@ } }, "definitions": { - "ExtendedLivyListBatchResponse": { + "SparkBatchJobCollection": { "type": "object", "properties": { "from": { "format": "int32", - "type": "integer" + "type": "integer", + "description": "The start index of fetched sessions." }, "total": { "format": "int32", - "type": "integer" + "type": "integer", + "description": "Number of sessions fetched." }, "sessions": { "uniqueItems": false, "type": "array", + "description": "Batch list", "items": { - "$ref": "#/definitions/ExtendedLivyBatchResponse" + "$ref": "#/definitions/SparkBatchJob" } } - } + }, + "required": [ + "from", + "total" + ], + "description": "Response for batch list operation." }, - "ExtendedLivyBatchResponse": { + "SparkBatchJob": { "type": "object", "properties": { "livyInfo": { - "$ref": "#/definitions/LivyBatchStateInformation" + "$ref": "#/definitions/SparkBatchJobState" }, "name": { - "type": "string" + "type": "string", + "description": "The batch name." }, "workspaceName": { - "type": "string" + "type": "string", + "description": "The workspace name." }, "sparkPoolName": { - "type": "string" + "type": "string", + "description": "The Spark pool name." }, "submitterName": { - "type": "string" + "type": "string", + "description": "The submitter name." }, "submitterId": { - "type": "string" + "type": "string", + "description": "The submitter identifier." }, "artifactId": { - "type": "string" + "type": "string", + "description": "The artifact identifier." }, "jobType": { "enum": [ @@ -775,10 +658,11 @@ "SparkSession" ], "x-ms-enum": { - "name": "JobType", + "name": "SparkJobType", "modelAsString": true }, - "type": "string" + "type": "string", + "description": "The job type." }, "result": { "enum": [ @@ -788,95 +672,121 @@ "Cancelled" ], "x-ms-enum": { - "name": "JobResult", + "name": "SparkBatchJobResultType", "modelAsString": true }, - "type": "string" + "type": "string", + "description": "The Spark batch job result." }, "schedulerInfo": { - "$ref": "#/definitions/SchedulerInformation" + "x-ms-client-name": "scheduler", + "$ref": "#/definitions/SparkScheduler", + "description": "The scheduler information." }, "pluginInfo": { - "$ref": "#/definitions/SparkServicePluginInformation" + "x-ms-client-name": "plugin", + "$ref": "#/definitions/SparkServicePlugin", + "description": "The plugin information." }, "errorInfo": { + "x-ms-client-name": "errors", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ErrorInformation" - } + "$ref": "#/definitions/SparkServiceError" + }, + "description": "The error information." }, "tags": { "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "The tags." }, "id": { "format": "int32", - "type": "integer" + "type": "integer", + "description": "The session Id." }, "appId": { - "type": "string" + "type": "string", + "description": "The application id of this session" }, "appInfo": { "type": "object", "additionalProperties": { "type": "string" - } + }, + "description": "The detailed application info." }, "state": { - "type": "string" + "type": "string", + "description": "The batch state" }, "log": { + "x-ms-client-name": "logLines", "uniqueItems": false, "type": "array", "items": { "type": "string" - } + }, + "description": "The log lines." } - } + }, + "required": [ + "id" + ] }, - "LivyBatchStateInformation": { + "SparkBatchJobState": { "type": "object", "properties": { "notStartedAt": { "format": "date-time", - "type": "string" + "type": "string", + "description": "the time that at which \"not_started\" livy state was first seen." }, "startingAt": { "format": "date-time", - "type": "string" + "type": "string", + "description": "the time that at which \"starting\" livy state was first seen." }, "runningAt": { "format": "date-time", - "type": "string" + "type": "string", + "description": "the time that at which \"running\" livy state was first seen." }, "deadAt": { "format": "date-time", - "type": "string" + "type": "string", + "description": "time that at which \"dead\" livy state was first seen." }, "successAt": { "format": "date-time", - "type": "string" + "type": "string", + "description": "the time that at which \"success\" livy state was first seen." }, "killedAt": { + "x-ms-client-name": "terminatedAt", "format": "date-time", - "type": "string" + "type": "string", + "description": "the time that at which \"killed\" livy state was first seen." }, "recoveringAt": { "format": "date-time", - "type": "string" + "type": "string", + "description": "the time that at which \"recovering\" livy state was first seen." }, "currentState": { - "type": "string" + "type": "string", + "description": "the Spark job state." }, "jobCreationRequest": { - "$ref": "#/definitions/LivyRequestBase" + "$ref": "#/definitions/SparkRequest" } } }, - "SchedulerInformation": { + "SparkScheduler": { "type": "object", "properties": { "submittedAt": { @@ -909,7 +819,7 @@ } } }, - "SparkServicePluginInformation": { + "SparkServicePlugin": { "type": "object", "properties": { "preparationStartedAt": { @@ -950,7 +860,7 @@ } } }, - "ErrorInformation": { + "SparkServiceError": { "type": "object", "properties": { "message": { @@ -967,14 +877,14 @@ "Dependency" ], "x-ms-enum": { - "name": "ErrorSource", + "name": "SparkErrorSource", "modelAsString": true }, "type": "string" } } }, - "LivyRequestBase": { + "SparkRequest": { "type": "object", "properties": { "name": { @@ -987,6 +897,7 @@ "type": "string" }, "args": { + "x-ms-client-name": "arguments", "uniqueItems": false, "type": "array", "items": { @@ -1000,6 +911,14 @@ "type": "string" } }, + "pyFiles": { + "x-ms-client-name": "pythonFiles", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, "files": { "uniqueItems": false, "type": "array", @@ -1015,6 +934,7 @@ } }, "conf": { + "x-ms-client-name": "configuration", "type": "object", "additionalProperties": { "type": "string" @@ -1035,12 +955,13 @@ "type": "integer" }, "numExecutors": { + "x-ms-client-name": "executorCount", "format": "int32", "type": "integer" } } }, - "ExtendedLivyBatchRequest": { + "sparkBatchJobOptions": { "type": "object", "properties": { "tags": { @@ -1062,6 +983,7 @@ "type": "string" }, "args": { + "x-ms-client-name": "arguments", "uniqueItems": false, "type": "array", "items": { @@ -1075,6 +997,14 @@ "type": "string" } }, + "pyFiles": { + "x-ms-client-name": "pythonFiles", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, "files": { "uniqueItems": false, "type": "array", @@ -1090,6 +1020,7 @@ } }, "conf": { + "x-ms-client-name": "configuration", "type": "object", "additionalProperties": { "type": "string" @@ -1110,12 +1041,17 @@ "type": "integer" }, "numExecutors": { + "x-ms-client-name": "executorCount", "format": "int32", "type": "integer" } - } + }, + "required": [ + "name", + "file" + ] }, - "ExtendedLivyListSessionResponse": { + "SparkSessionCollection": { "type": "object", "properties": { "from": { @@ -1130,16 +1066,20 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ExtendedLivySessionResponse" + "$ref": "#/definitions/SparkSession" } } - } + }, + "required": [ + "from", + "total" + ] }, - "ExtendedLivySessionResponse": { + "SparkSession": { "type": "object", "properties": { "livyInfo": { - "$ref": "#/definitions/LivySessionStateInformation" + "$ref": "#/definitions/SparkSessionState" }, "name": { "type": "string" @@ -1165,7 +1105,7 @@ "SparkSession" ], "x-ms-enum": { - "name": "JobType", + "name": "SparkJobType", "modelAsString": true }, "type": "string" @@ -1178,22 +1118,25 @@ "Cancelled" ], "x-ms-enum": { - "name": "JobResult", + "name": "SparkSessionResultType", "modelAsString": true }, "type": "string" }, "schedulerInfo": { - "$ref": "#/definitions/SchedulerInformation" + "x-ms-client-name": "scheduler", + "$ref": "#/definitions/SparkScheduler" }, "pluginInfo": { - "$ref": "#/definitions/SparkServicePluginInformation" + "x-ms-client-name": "plugin", + "$ref": "#/definitions/SparkServicePlugin" }, "errorInfo": { + "x-ms-client-name": "errors", "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/ErrorInformation" + "$ref": "#/definitions/SparkServiceError" } }, "tags": { @@ -1219,15 +1162,19 @@ "type": "string" }, "log": { + "x-ms-client-name": "logLines", "uniqueItems": false, "type": "array", "items": { "type": "string" } } - } + }, + "required": [ + "id" + ] }, - "LivySessionStateInformation": { + "SparkSessionState": { "type": "object", "properties": { "notStartedAt": { @@ -1251,6 +1198,7 @@ "type": "string" }, "killedAt": { + "x-ms-client-name": "terminatedAt", "format": "date-time", "type": "string" }, @@ -1270,11 +1218,11 @@ "type": "string" }, "jobCreationRequest": { - "$ref": "#/definitions/LivyRequestBase" + "$ref": "#/definitions/SparkRequest" } } }, - "ExtendedLivySessionRequest": { + "SparkSessionOptions": { "type": "object", "properties": { "tags": { @@ -1296,6 +1244,7 @@ "type": "string" }, "args": { + "x-ms-client-name": "arguments", "uniqueItems": false, "type": "array", "items": { @@ -1309,6 +1258,14 @@ "type": "string" } }, + "pyFiles": { + "x-ms-client-name": "pythonFiles", + "uniqueItems": false, + "type": "array", + "items": { + "type": "string" + } + }, "files": { "uniqueItems": false, "type": "array", @@ -1324,6 +1281,7 @@ } }, "conf": { + "x-ms-client-name": "configuration", "type": "object", "additionalProperties": { "type": "string" @@ -1344,15 +1302,20 @@ "type": "integer" }, "numExecutors": { + "x-ms-client-name": "executorCount", "format": "int32", "type": "integer" } - } + }, + "required": [ + "name" + ] }, - "LivyStatementsResponseBody": { + "SparkStatementCollection": { "type": "object", "properties": { "total_statements": { + "x-ms-client-name": "total", "format": "int32", "type": "integer" }, @@ -1360,12 +1323,15 @@ "uniqueItems": false, "type": "array", "items": { - "$ref": "#/definitions/LivyStatementResponseBody" + "$ref": "#/definitions/SparkStatement" } } - } + }, + "required": [ + "total_statements" + ] }, - "LivyStatementResponseBody": { + "SparkStatement": { "type": "object", "properties": { "id": { @@ -1379,11 +1345,14 @@ "type": "string" }, "output": { - "$ref": "#/definitions/LivyStatementOutput" + "$ref": "#/definitions/SparkStatementOutput" } - } + }, + "required": [ + "id" + ] }, - "LivyStatementOutput": { + "SparkStatementOutput": { "type": "object", "properties": { "status": { @@ -1397,9 +1366,11 @@ "type": "object" }, "ename": { + "x-ms-client-name": "errorName", "type": "string" }, "evalue": { + "x-ms-client-name": "errorValue", "type": "string" }, "traceback": { @@ -1409,20 +1380,33 @@ "type": "string" } } - } + }, + "required": [ + "execution_count" + ] }, - "LivyStatementRequestBody": { + "SparkStatementOptions": { "type": "object", "properties": { "code": { "type": "string" }, "kind": { + "enum": [ + "spark", + "pyspark", + "dotnetspark", + "sql" + ], + "x-ms-enum": { + "name": "SparkStatementLanguageType", + "modelAsString": true + }, "type": "string" } } }, - "LivyStatementCancellationResponse": { + "SparkStatementCancellationResult": { "type": "object", "properties": { "msg": { @@ -1432,7 +1416,16 @@ } }, "parameters": { - "LivyApiVersionInPath": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, + "LivyApiVersion": { "name": "livyApiVersion", "in": "path", "description": "Valid api-version for the request.", @@ -1442,14 +1435,13 @@ "x-ms-skip-url-encoding": true, "x-ms-parameter-location": "client" }, - "SynapseDnsSuffixInPath": { - "name": "SynapseDnsSuffix", + "SparkPoolName": { + "name": "sparkPoolName", "in": "path", + "description": "Name of the spark pool.", "required": true, "type": "string", - "default": "dev.azuresynapse.net", "x-ms-skip-url-encoding": true, - "description": "Gets the DNS suffix used as the base for all Synapse service requests.", "x-ms-parameter-location": "client" } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_CreateRoleAssignment.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_CreateRoleAssignment.json similarity index 85% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_CreateRoleAssignment.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_CreateRoleAssignment.json index 97212e8071ce..bca528607878 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_CreateRoleAssignment.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_CreateRoleAssignment.json @@ -1,9 +1,8 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "api-version": "2020-02-01-preview", - "request": { + "createRoleAssignmentOptions": { "roleId": "00000000-0000-0000-0000-000000000000", "principalId": "00000000-0000-0000-0000-000000000000" } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json similarity index 81% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json index ba09f1f27aa0..0171f555a8cf 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_DeleteRoleAssignmentById.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "roleAssignmentId": "00000000-0000-0000-0000-000000000000-00000000-0000-0000-0000-000000000000", "api-version": "2020-02-01-preview" }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json similarity index 87% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json index 4374be7f52ec..2e0e8d8896bf 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_GetRoleAssignmentById.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "roleAssignmentId": "00000000-0000-0000-0000-000000000000-00000000-0000-0000-0000-000000000000", "api-version": "2020-02-01-preview" }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json similarity index 81% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json index 2dca414a3784..becbc1cd5b26 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListCallerRoleAssignments.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "api-version": "2020-02-01-preview" }, "responses": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListRoleAssignments.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListRoleAssignments.json similarity index 91% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListRoleAssignments.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListRoleAssignments.json index f1af57ba8b4b..c9a190167d43 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/RoleAssignments_ListRoleAssignments.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/RoleAssignments_ListRoleAssignments.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "api-version": "2020-02-01-preview", "roleId": "00000000-0000-0000-0000-000000000000", "principalId": "00000000-0000-0000-0000-000000000000" diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_GetRoleById.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_GetRoleById.json similarity index 84% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_GetRoleById.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_GetRoleById.json index 5c6f07d2e9f0..7b709acbdfff 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_GetRoleById.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_GetRoleById.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "roleId": "00000000-0000-0000-0000-000000000000", "api-version": "2020-02-01-preview" }, diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_ListRoles.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_ListRoles.json similarity index 87% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_ListRoles.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_ListRoles.json index 74838831ed04..305559688c49 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Roles_ListRoles.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/examples/Roles_ListRoles.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "exampleWorkspace", - "SynapseDnsSuffix": "azuresynapse.net", + "endpoint": "exampleWorkspace.dev.azuresynapse.net", "api-version": "2020-02-01-preview" }, "responses": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roleAssignments.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json similarity index 88% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roleAssignments.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json index 922d6074a432..634133c68370 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roleAssignments.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json @@ -1,22 +1,15 @@ { "swagger": "2.0", "info": { - "version": "2019-11-01-preview", - "title": "SynapseClient" + "version": "2020-02-01-preview", + "title": "AccessControlClient" }, "x-ms-parameterized-host": { - "hostTemplate": "{workspaceName}.{SynapseDnsSuffix}", + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, "parameters": [ { - "name": "workspaceName", - "description": "The name of the workspace to execute operations on.", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/SynapseDnsSuffixInPath" + "$ref": "#/parameters/Endpoint" } ] }, @@ -29,7 +22,7 @@ "tags": [ "RoleAssignments" ], - "operationId": "RoleAssignments_CreateRoleAssignment", + "operationId": "AccessControl_CreateRoleAssignment", "description": "Create role assignment.", "x-ms-examples": { "Create role assignment": { @@ -44,12 +37,12 @@ ], "parameters": [ { - "name": "request", + "name": "createRoleAssignmentOptions", "in": "body", "required": true, "description": "Details of role id and object id.", "schema": { - "$ref": "#/definitions/RoleAssignmentRequest" + "$ref": "#/definitions/RoleAssignmentOptions" } }, { @@ -75,7 +68,7 @@ "tags": [ "RoleAssignments" ], - "operationId": "RoleAssignments_ListRoleAssignments", + "operationId": "AccessControl_GetRoleAssignments", "description": "List role assignments.", "x-ms-examples": { "Get role assignment information": { @@ -127,7 +120,7 @@ "tags": [ "RoleAssignments" ], - "operationId": "RoleAssignments_GetRoleAssignmentById", + "operationId": "AccessControl_GetRoleAssignmentById", "description": "Get role assignment by role assignment Id.", "x-ms-examples": { "Get role assignment information": { @@ -141,6 +134,9 @@ "parameters": [ { "$ref": "#/parameters/RoleAssignmentIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -162,7 +158,7 @@ "tags": [ "RoleAssignments" ], - "operationId": "RoleAssignments_DeleteRoleAssignmentById", + "operationId": "AccessControl_DeleteRoleAssignmentById", "description": "Delete role assignment by role assignment Id.", "x-ms-examples": { "Delete role assignment": { @@ -176,6 +172,9 @@ "parameters": [ { "$ref": "#/parameters/RoleAssignmentIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -199,7 +198,7 @@ "tags": [ "RoleAssignments" ], - "operationId": "RoleAssignments_ListCallerRoleAssignments", + "operationId": "AccessControl_GetCallerRoleAssignments", "description": "List role assignments of the caller.", "x-ms-examples": { "Get caller role assignments": { @@ -222,7 +221,6 @@ "type": "array", "items": { "description": "Role ID of the Synapse Built-In Role", - "format": "uuid", "type": "string" } } @@ -298,18 +296,16 @@ "$ref": "#/definitions/RoleAssignmentDetails" } }, - "RoleAssignmentRequest": { + "RoleAssignmentOptions": { "description": "Role Assignment request details", "type": "object", "properties": { "roleId": { "description": "Role ID of the Synapse Built-In Role", - "format": "uuid", "type": "string" }, "principalId": { "description": "Object ID of the AAD principal or security-group", - "format": "uuid", "type": "string" } }, @@ -328,18 +324,25 @@ }, "roleId": { "description": "Role ID of the Synapse Built-In Role", - "format": "uuid", "type": "string" }, "principalId": { "description": "Object ID of the AAD principal or security-group", - "format": "uuid", "type": "string" } } } }, "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", @@ -347,16 +350,6 @@ "type": "string", "description": "The Synapse client API Version." }, - "SynapseDnsSuffixInPath": { - "name": "SynapseDnsSuffix", - "in": "path", - "required": true, - "type": "string", - "default": "dev.azuresynapse.net", - "x-ms-skip-url-encoding": true, - "description": "Gets the DNS suffix used as the base for all Synapse service requests.", - "x-ms-parameter-location": "client" - }, "RoleIdParameterInQuery": { "name": "roleId", "in": "query", @@ -384,6 +377,7 @@ }, "XMsContinuationToken": { "name": "x-ms-continuation", + "x-ms-client-name": "continuationToken", "in": "header", "required": false, "type": "string", diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roles.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roles.json similarity index 83% rename from specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roles.json rename to specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roles.json index f566e171de1f..f17f83f41ade 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/roles.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roles.json @@ -1,22 +1,15 @@ { "swagger": "2.0", "info": { - "version": "2019-11-01-preview", - "title": "SynapseClient" + "version": "2020-02-01-preview", + "title": "AccessControlClient" }, "x-ms-parameterized-host": { - "hostTemplate": "{workspaceName}.{SynapseDnsSuffix}", + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, "parameters": [ { - "name": "workspaceName", - "description": "The name of the workspace to execute operations on.", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/SynapseDnsSuffixInPath" + "$ref": "#/parameters/Endpoint" } ] }, @@ -29,7 +22,7 @@ "tags": [ "SynapseRoles" ], - "operationId": "Roles_ListRoles", + "operationId": "AccessControl_GetRoleDefinitions", "description": "List roles.", "x-ms-examples": { "Get access control information": { @@ -69,7 +62,7 @@ "tags": [ "SynapseRoles" ], - "operationId": "Roles_GetRoleById", + "operationId": "AccessControl_GetRoleDefinitionById", "description": "Get role by role Id.", "x-ms-examples": { "Get access control information": { @@ -83,6 +76,9 @@ "parameters": [ { "$ref": "#/parameters/RoleIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -129,7 +125,6 @@ "properties": { "id": { "description": "Role ID", - "format": "uuid", "type": "string" }, "name": { @@ -140,10 +135,22 @@ "description": "Is a built-in role or not", "type": "boolean" } - } + }, + "required": [ + "isBuiltIn" + ] } }, "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", @@ -151,16 +158,6 @@ "type": "string", "description": "The Synapse client API Version." }, - "SynapseDnsSuffixInPath": { - "name": "SynapseDnsSuffix", - "in": "path", - "required": true, - "type": "string", - "default": "dev.azuresynapse.net", - "x-ms-skip-url-encoding": true, - "description": "Gets the DNS suffix used as the base for all Synapse service requests.", - "x-ms-parameter-location": "client" - }, "RoleIdParameter": { "name": "roleId", "in": "path", diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md index 52fa367be5eb..27db372758be 100644 --- a/specification/synapse/data-plane/readme.md +++ b/specification/synapse/data-plane/readme.md @@ -20,8 +20,6 @@ To see additional help and options, run: ## Configuration - - ### Basic Information These are the global settings for the Azure Synapse Analytics API. @@ -29,48 +27,48 @@ These are the global settings for the Azure Synapse Analytics API. openapi-type: data-plane ``` -``` yaml $(package-others) -tag: package-2019-11-01-preview +``` yaml $(package-spark) +tag: package-spark-2019-11-01-preview +``` + +``` yaml $(package-artifacts) +tag: package-artifacts-2019-06-01-preview +``` + +``` yaml $(package-access-control) +tag: package-access-control-2020-02-01-preview ``` ``` yaml $(package-vnet) tag: package-vnet-2019-06-01-preview ``` -## Suppression -``` yaml -directive: - - suppress: DefinitionsPropertiesNamesCamelCase - reason: This would require a breaking change, and need to be consistent with the response from RP side. - from: Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json - where: - - $.definitions.LivyStatementsResponseBody.properties.total_statements - - $.definitions.LivyStatementOutput.properties.execution_count +### Tag: package-spark-2019-11-01-preview - - suppress: DefinitionsPropertiesNamesCamelCase - reason: These properties need to keep the same with jupyter notebook. Rp can't change these proeprties. - from: Microsoft.Synapse/preview/2019-11-01-preview/adf/entityTypes/NoteBook.json - where: - - $.definitions.NotebookCellOutputItem.properties.execution_count - - $.definitions.NotebookCellOutputItem.properties.output_type - - $.definitions.NotebookCell.properties.cell_type - - $.definitions.NotebookLanguageInfo.properties.codemirror_mode - - $.definitions.NotebookKernelSpec.properties.display_name - - $.definitions.NotebookMetadata.properties.language_info - - $.definitions.NoteBook.properties.nbformat_minor +These settings apply only when `--tag=package-spark-2019-11-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-spark-2019-11-01-preview' +input-file: +- Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json ``` -### Tag: package-2019-11-01-preview +### Tag: package-artifacts-2019-06-01-preview -These settings apply only when `--tag=package-2019-11-01-preview` is specified on the command line +These settings apply only when `--tag=package-artifacts-2019-06-01-preview` is specified on the command line. -``` yaml $(tag) == 'package-2019-11-01-preview' +``` yaml $(tag) == 'package-artifacts-2019-06-01-preview' input-file: -- Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json -- Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json -- Microsoft.Synapse/preview/2019-11-01-preview/roles.json -- Microsoft.Synapse/preview/2019-11-01-preview/roleAssignments.json -- Microsoft.Synapse/preview/2019-11-01-preview/adf/datafactory.json +- Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json +``` + +### Tag: package-access-control-2020-02-01-preview + +These settings apply only when `--tag=package-access-control-2020-02-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-access-control-2020-02-01-preview' +input-file: +- Microsoft.Synapse/preview/2020-02-01-preview/roles.json +- Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json ``` ### Tag: package-vnet-2019-06-01-preview @@ -82,6 +80,29 @@ input-file: - Microsoft.Synapse/preview/2019-06-01-preview/managedPrivateEndpoints.json ``` +## Suppression +``` yaml +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + reason: This would require a breaking change, and need to be consistent with the response from RP side. + from: sparkJob.json + where: + - $.definitions.SparkStatementCollection.properties.total_statements + - $.definitions.SparkStatementOutput.properties.execution_count + + - suppress: DefinitionsPropertiesNamesCamelCase + reason: These properties need to keep the same with jupyter Notebook. Rp can't change these proeprties. + from: Notebook.json + where: + - $.definitions.NotebookCellOutputItem.properties.execution_count + - $.definitions.NotebookCellOutputItem.properties.output_type + - $.definitions.NotebookCell.properties.cell_type + - $.definitions.NotebookLanguageInfo.properties.codemirror_mode + - $.definitions.NotebookKernelSpec.properties.display_name + - $.definitions.NotebookMetadata.properties.language_info + - $.definitions.Notebook.properties.nbformat_minor +``` + --- # Code Generation @@ -102,8 +123,9 @@ csharp: output-folder: $(csharp-sdks-folder)/synapse/Microsoft.Azure.Synapse/src/Generated clear-output-folder: true batch: -- package-others: true -- package-vnet: true + - package-spark: true + - package-artifacts: true + - package-access-control: true ``` ## TypeScript @@ -121,13 +143,11 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json + - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json - - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/sparkFrontend.json - - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/roles.json - - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/roleAssignments.json - - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/adf/datafactory.json - - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/managedPrivateEndpoints.json - + - $(this-folder)/Microsoft.Synapse/preview/2020-02-01-preview/roles.json + - $(this-folder)/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/synapse/data-plane/readme.python.md b/specification/synapse/data-plane/readme.python.md index cf2ba5dbe061..30169a5bf708 100644 --- a/specification/synapse/data-plane/readme.python.md +++ b/specification/synapse/data-plane/readme.python.md @@ -5,21 +5,30 @@ Please also specify `--python-sdks-folder= Date: Thu, 4 Jun 2020 18:50:48 -0700 Subject: [PATCH 089/318] New API version for Iot Hub Get Endpoint Health (#9680) * Adds base for updating Microsoft.Devices from version stable/2020-03-01 to version 2020-04-01 * Updates readme * Updates API version in new specs and examples * initial version * camel case * reviewed comments Co-authored-by: Juan Carpio Castellanos --- .../examples/IotHub_ManualFailover.json | 15 + .../examples/checkNameAvailability.json | 20 + .../iothub_certificatescreateorupdate.json | 46 + .../examples/iothub_certificatesdelete.json | 14 + .../examples/iothub_certverify.json | 31 + .../examples/iothub_createOrUpdate.json | 226 + .../examples/iothub_createconsumergroup.json | 23 + .../2020-04-01/examples/iothub_delete.json | 164 + .../examples/iothub_deleteconsumergroup.json | 13 + ...othub_deleteprivateendpointconnection.json | 46 + .../examples/iothub_exportdevices.json | 23 + .../iothub_generateverificationcode.json | 26 + .../2020-04-01/examples/iothub_get.json | 96 + .../examples/iothub_getcertificate.json | 27 + .../examples/iothub_getconsumergroup.json | 23 + .../2020-04-01/examples/iothub_getjob.json | 20 + .../2020-04-01/examples/iothub_getkey.json | 19 + .../iothub_getprivateendpointconnection.json | 28 + .../iothub_getprivatelinkresources.json | 27 + .../2020-04-01/examples/iothub_getskus.json | 53 + .../examples/iothub_importdevices.json | 23 + .../2020-04-01/examples/iothub_listbyrg.json | 90 + .../examples/iothub_listbysubscription.json | 89 + .../examples/iothub_listcertificates.json | 30 + .../examples/iothub_listehgroups.json | 26 + .../2020-04-01/examples/iothub_listjobs.json | 23 + .../2020-04-01/examples/iothub_listkeys.json | 46 + ...iothub_listprivateendpointconnections.json | 29 + .../iothub_listprivatelinkresources.json | 30 + .../examples/iothub_operations.json | 328 ++ .../2020-04-01/examples/iothub_patch.json | 95 + .../examples/iothub_quotametrics.json | 26 + .../iothub_routingendpointhealth.json | 34 + .../2020-04-01/examples/iothub_stats.json | 17 + .../examples/iothub_testallroutes.json | 38 + .../examples/iothub_testnewroute.json | 52 + ...othub_updateprivateendpointconnection.json | 53 + .../2020-04-01/examples/iothub_usages.json | 25 + .../stable/2020-04-01/iothub.json | 4168 +++++++++++++++++ .../iothub/resource-manager/readme.md | 13 +- 40 files changed, 6173 insertions(+), 2 deletions(-) create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/IotHub_ManualFailover.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/checkNameAvailability.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certificatescreateorupdate.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certificatesdelete.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certverify.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_createOrUpdate.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_createconsumergroup.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_delete.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_deleteconsumergroup.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_deleteprivateendpointconnection.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_exportdevices.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_generateverificationcode.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_get.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getcertificate.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getconsumergroup.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getjob.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getkey.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getprivateendpointconnection.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getprivatelinkresources.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getskus.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_importdevices.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listbyrg.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listbysubscription.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listcertificates.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listehgroups.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listjobs.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listkeys.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listprivateendpointconnections.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listprivatelinkresources.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_operations.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_patch.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_quotametrics.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_routingendpointhealth.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_stats.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_testallroutes.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_testnewroute.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_updateprivateendpointconnection.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_usages.json create mode 100644 specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/iothub.json diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/IotHub_ManualFailover.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/IotHub_ManualFailover.json new file mode 100644 index 000000000000..a1c04b705fe5 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/IotHub_ManualFailover.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "failoverInput": { + "failoverRegion": "testHub" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/checkNameAvailability.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/checkNameAvailability.json new file mode 100644 index 000000000000..6581d7844be9 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/checkNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "operationInputs": { + "name": "test-request" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "Invalid", + "message": "" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certificatescreateorupdate.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certificatescreateorupdate.json new file mode 100644 index 000000000000..441418d317ce --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certificatescreateorupdate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "iothub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "certificateDescription": { + "certificate": "############################################" + } + }, + "responses": { + "201": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + }, + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServives/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certificatesdelete.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certificatesdelete.json new file mode 100644 index 000000000000..a6298b08f0c8 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certificatesdelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceName": "myhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certverify.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certverify.json new file mode 100644 index 000000000000..c21b660ba2cf --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_certverify.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "resourceName": "myFirstProvisioningService", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=", + "certificateVerificationBody": { + "certificate": "#####################################" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": true, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/ProvisioningServices/myFirstProvisioningService/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpTQ=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_createOrUpdate.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_createOrUpdate.json new file mode 100644 index 000000000000..2cd2c5b5f4b5 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_createOrUpdate.json @@ -0,0 +1,226 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "iotHubDescription": { + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "ipFilterRules": [], + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2 + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_createconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_createconsumergroup.json new file mode 100644 index 000000000000..5bade20d43d0 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_createconsumergroup.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test" + }, + "responses": { + "200": { + "body": { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "test", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_delete.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_delete.json new file mode 100644 index 000000000000..cc1a6c150d79 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_delete.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "204": {}, + "202": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + }, + "404": { + "body": {} + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_deleteconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_deleteconsumergroup.json new file mode 100644 index 000000000000..255f559176e0 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_deleteconsumergroup.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test" + }, + "responses": { + "200": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_deleteprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_deleteprivateendpointconnection.json new file mode 100644 index 000000000000..a7f5281224b8 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_deleteprivateendpointconnection.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + } + }, + "202": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Disconnected", + "description": "Deleted", + "actionsRequired": "None" + } + } + } + }, + "204": {} + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_exportdevices.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_exportdevices.json new file mode 100644 index 000000000000..b14348ff03cd --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_exportdevices.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "exportDevicesParameters": { + "exportBlobContainerUri": "testBlob", + "excludeKeys": true + } + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_generateverificationcode.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_generateverificationcode.json new file mode 100644 index 000000000000..c30d68e5a172 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_generateverificationcode.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert", + "If-Match": "AAAAAAAADGk=" + }, + "responses": { + "200": { + "body": { + "name": "cert", + "properties": { + "verificationCode": "##################################", + "subject": "CN=andbucdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "##############################", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:26:56 GMT" + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_get.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_get.json new file mode 100644 index 000000000000..d6774f3b969f --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_get.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None", + "locations": [ + { + "location": "West US", + "role": "primary" + }, + { + "location": "East US", + "role": "secondary" + } + ], + "minTlsVersion": "1.2" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getcertificate.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getcertificate.json new file mode 100644 index 000000000000..29fea7c21df0 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getcertificate.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "testhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "certificateName": "cert" + }, + "responses": { + "200": { + "body": { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getconsumergroup.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getconsumergroup.json new file mode 100644 index 000000000000..5bade20d43d0 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getconsumergroup.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "name": "test" + }, + "responses": { + "200": { + "body": { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "test", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getjob.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getjob.json new file mode 100644 index 000000000000..515879a8e488 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getjob.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "jobId": "test" + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getkey.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getkey.json new file mode 100644 index 000000000000..15de768f8a86 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getkey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "keyName": "iothubowner" + }, + "responses": { + "200": { + "body": { + "keyName": "iothubowner", + "primaryKey": "2aWPrKloLLdcug12ZHNpA0e07yJmRRmYMXDLpEOTd/Y=", + "secondaryKey": "DLyFnDTGMDK0BU2QjT5TCkNBQ4h08mi20vOqWMC7TxU=", + "rights": "RegistryWrite, ServiceConnect, DeviceConnect" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getprivateendpointconnection.json new file mode 100644 index 000000000000..15d808b0a0b0 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getprivateendpointconnection.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getprivatelinkresources.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getprivatelinkresources.json new file mode 100644 index 000000000000..4d836ee7745b --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getprivatelinkresources.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "groupId": "iotHub" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateLinkResources/iotHub", + "name": "iotHub", + "type": "Microsoft.Devices/IotHubs/PrivateLinkResources", + "properties": { + "groupId": "iotHub", + "requiredMembers": [ + "iotHub" + ], + "requiredZoneNames": [ + "privatelink.azure-devices.net" + ] + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getskus.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getskus.json new file mode 100644 index 000000000000..df66c6ab9b14 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_getskus.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S1", + "tier": "Standard" + }, + "capacity": { + "default": 1, + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S2", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 200, + "default": 1, + "scaleType": "Manual" + } + }, + { + "resourceType": "Microsoft.Devices/IotHubs", + "sku": { + "name": "S3", + "tier": "Standard" + }, + "capacity": { + "minimum": 1, + "maximum": 10, + "default": 1, + "scaleType": "Manual" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_importdevices.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_importdevices.json new file mode 100644 index 000000000000..dc1dca139ab5 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_importdevices.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "importDevicesParameters": { + "inputBlobContainerUri": "testBlob", + "outputBlobContainerUri": "testBlob" + } + }, + "responses": { + "200": { + "body": { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listbyrg.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listbyrg.json new file mode 100644 index 000000000000..1665155c13ea --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listbyrg.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listbysubscription.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listbysubscription.json new file mode 100644 index 000000000000..8c498ded46de --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listbysubscription.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "resourceName": "testHub", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": {}, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listcertificates.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listcertificates.json new file mode 100644 index 000000000000..0bd695f362be --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listcertificates.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceName": "testhub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "subject": "CN=testdevice1", + "expiry": "Sat, 31 Dec 2039 23:59:59 GMT", + "thumbprint": "97388663832D0393C9246CAB4FBA2C8677185A25", + "isVerified": false, + "created": "Thu, 12 Oct 2017 19:23:50 GMT", + "updated": "Thu, 12 Oct 2017 19:23:50 GMT" + }, + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/andbuc-hub/certificates/cert", + "name": "cert", + "type": "Microsoft.Devices/IotHubs/Certificates", + "etag": "AAAAAAExpNs=" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listehgroups.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listehgroups.json new file mode 100644 index 000000000000..9a2a42b7b7a6 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listehgroups.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "eventHubEndpointName": "events", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "created": "Thu, 15 Jun 2017 19:20:58 GMT" + }, + "id": "/subscriptions/cmd-sub-1/resourceGroups/cmd-rg-1/providers/Microsoft.Devices/IotHubs/test-hub-2/eventHubEndpoints/events/ConsumerGroups/%24Default", + "name": "$Default", + "type": "Microsoft.Devices/IotHubs/EventHubEndpoints/ConsumerGroups", + "etag": "AAAAAAFD6M4=" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listjobs.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listjobs.json new file mode 100644 index 000000000000..dcbab89398be --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listjobs.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "jobId": "test", + "startTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "endTimeUtc": "Thu, 15 Jun 2017 19:20:58 GMT", + "type": "unknown", + "status": "unknown" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listkeys.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listkeys.json new file mode 100644 index 000000000000..835b1270ebb7 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listkeys.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "keyName": "iothubowner", + "primaryKey": "2aWPrKloLLdcug12ZHNpA0e07yJmRRmYMXDLpEOTd/Y=", + "secondaryKey": "DLyFnDTGMDK0BU2QjT5TCkNBQ4h08mi20vOqWMC7TxU=", + "rights": "RegistryWrite, ServiceConnect, DeviceConnect" + }, + { + "keyName": "service", + "primaryKey": "DinqxWW+s814W2Pc3dLxleelksqSYGy8Jfymt8J7a4c=", + "secondaryKey": "5G8KgJ9Wx2T0f6HRIn25TgYcFmJnBSivawNaHssiP9Y=", + "rights": "ServiceConnect" + }, + { + "keyName": "device", + "primaryKey": "o/9gPc0oD8LY/r2lRurgl9U/sKFcL2c/tmFLKAiz+e0=", + "secondaryKey": "YOeBMHnYP95vH+ykR8OeapnhS6W8raMsXOdNFwqg4lg=", + "rights": "DeviceConnect" + }, + { + "keyName": "registryRead", + "primaryKey": "h2d4mPxy6jPCWX6mO+katV9QPNJivzt4aFq0iGVc1A8=", + "secondaryKey": "3TdcalZNTB7BZHl88LGsG1Z5T6+ElEODunrs1vylwGg=", + "rights": "RegistryRead" + }, + { + "keyName": "registryReadWrite", + "primaryKey": "tyNRcaI38fXL+gQTjCmrVZGTP4YFF7uACk7pppWLWzY=", + "secondaryKey": "6P6DXOp0W3HO5/IotzcPS1kx7PHiOdesaND07Im5cYI=", + "rights": "RegistryWrite" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listprivateendpointconnections.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listprivateendpointconnections.json new file mode 100644 index 000000000000..0de50750b7bc --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listprivateendpointconnections.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Please approve my request!", + "actionsRequired": "None" + } + } + } + ] + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listprivatelinkresources.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listprivatelinkresources.json new file mode 100644 index 000000000000..d7aa5421fc46 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_listprivatelinkresources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateLinkResources/iotHub", + "name": "iotHub", + "type": "Microsoft.Devices/IotHubs/PrivateLinkResources", + "properties": { + "groupId": "iotHub", + "requiredMembers": [ + "iotHub" + ], + "requiredZoneNames": [ + "privatelink.azure-devices.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_operations.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_operations.json new file mode 100644 index 000000000000..c3373a3cad9e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_operations.json @@ -0,0 +1,328 @@ +{ + "parameters": { + "api-version": "2020-04-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Devices/register/action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Register Resource Provider", + "description": "Register the subscription for the IotHub resource provider and enables the creation of IotHub resources" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/IotHubs/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/IotHubs/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service metric definitions", + "description": "Gets the available metrics for the IotHub service" + } + }, + { + "name": "Microsoft.Devices/IotHubs/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read IotHub service log definitions", + "description": "Gets the available log definitions for the IotHub Service" + } + }, + { + "name": "Microsoft.Devices/operations/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get All ResourceProvider Operations", + "description": "Get All ResourceProvider Operations" + } + }, + { + "name": "Microsoft.Devices/checkNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Check If IotHub name is available", + "description": "Check If IotHub name is available" + } + }, + { + "name": "Microsoft.Devices/usages/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Subscription Usages", + "description": "Get subscription usage details for this provider." + } + }, + { + "name": "Microsoft.Devices/iotHubs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub(s)", + "description": "Gets the IotHub resource(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create or update IotHub Resource", + "description": "Create or update IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete IotHub Resource", + "description": "Delete IotHub Resource" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubStats/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Statistics", + "description": "Get IotHub Statistics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get valid IotHub Skus", + "description": "Get valid IotHub Skus" + } + }, + { + "name": "Microsoft.Devices/iotHubs/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get all IotHub Keys", + "description": "Get all IotHub Keys" + } + }, + { + "name": "Microsoft.Devices/iotHubs/iotHubKeys/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get IotHub Key for the given name", + "description": "Get IotHub Key for the given name" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Create EventHub Consumer Group", + "description": "Create EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get EventHub Consumer Group(s)", + "description": "Get EventHub Consumer Group(s)" + } + }, + { + "name": "Microsoft.Devices/iotHubs/eventHubEndpoints/consumerGroups/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Delete EventHub Consumer Group", + "description": "Delete EventHub Consumer Group" + } + }, + { + "name": "Microsoft.Devices/iotHubs/exportDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Export Devices", + "description": "Export Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/importDevices/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Import Devices", + "description": "Import Devices" + } + }, + { + "name": "Microsoft.Devices/iotHubs/jobs/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get the Job(s) on IotHub", + "description": "Get Job(s) details submitted on given IotHub" + } + }, + { + "name": "Microsoft.Devices/iotHubs/quotaMetrics/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Quota Metrics", + "description": "Get Quota Metrics" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testall/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test All", + "description": "Test a message against all existing Routes" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routing/routes/$testnew/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Routing Rule Test Route", + "description": "Test a message against a provided test Route" + } + }, + { + "name": "Microsoft.Devices/iotHubs/routingEndpointsHealth/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Endpoint Health", + "description": "Gets the health of all routing Endpoints for an IotHub" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Get Diagnostic Setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/diagnosticSettings/write", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Set Diagnostic Setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/metricDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service metric definitions", + "description": "Gets the available metrics for the DPS service" + } + }, + { + "name": "Microsoft.Devices/ProvisioningServices/logDefinitions/read", + "display": { + "provider": "Microsoft Devices", + "resource": "IotHubs", + "operation": "Read DPS service log definitions", + "description": "Gets the available log definitions for the DPS Service" + } + }, + { + "name": "Microsoft.Devices/checkProvisioningServiceNameAvailability/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServives", + "operation": "Check If Provisioning Service name is available", + "description": "Check If Provisioning Service name is available" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Get Provisioning Service resource", + "description": "Get Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Write", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Create Provisioning Service resource", + "description": "Create Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/Delete", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource", + "description": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/skus/Read", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "Delete Provisioning Service resource", + "description": "Delete Provisioning Service resource" + } + }, + { + "name": "Microsoft.Devices/provisioningServices/listkeys/Action", + "display": { + "provider": "Microsoft Devices", + "resource": "ProvisioningServices", + "operation": "get security related metadata", + "description": "get security related metadata" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_patch.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_patch.json new file mode 100644 index 000000000000..1638859936f7 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_patch.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "resourceName": "myHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "location": "East US", + "type": "Microsoft.Devices/IotHubs", + "IotHubTags": { + "tags": { + "foo": "bar" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/ae24ff83-d2ca-4fc8-9717-05dae4bba489/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub", + "name": "testHub", + "type": "Microsoft.Devices/IotHubs", + "location": "centraluseuap", + "tags": { + "foo": "bar" + }, + "etag": "AAAAAAFD6M4=", + "properties": { + "state": "Active", + "provisioningState": "Succeeded", + "ipFilterRules": [], + "hostName": "iot-dps-cit-hub-1.azure-devices.net", + "eventHubEndpoints": { + "events": { + "retentionTimeInDays": 1, + "partitionCount": 2, + "partitionIds": [ + "0", + "1" + ], + "path": "iot-dps-cit-hub-1", + "endpoint": "sb://iothub-ns-iot-dps-ci-245306-76aca8e13b.servicebus.windows.net/" + } + }, + "routing": { + "endpoints": { + "serviceBusQueues": [], + "serviceBusTopics": [], + "eventHubs": [], + "storageContainers": [] + }, + "routes": [], + "fallbackRoute": { + "name": "$fallback", + "source": "DeviceMessages", + "condition": "true", + "endpointNames": [ + "events" + ], + "isEnabled": true + } + }, + "storageEndpoints": { + "$default": { + "sasTtlAsIso8601": "PT1H", + "connectionString": "", + "containerName": "" + } + }, + "messagingEndpoints": { + "fileNotifications": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "enableFileUploadNotifications": false, + "cloudToDevice": { + "maxDeliveryCount": 10, + "defaultTtlAsIso8601": "PT1H", + "feedback": { + "lockDurationAsIso8601": "PT1M", + "ttlAsIso8601": "PT1H", + "maxDeliveryCount": 10 + } + }, + "features": "None" + }, + "sku": { + "name": "S1", + "tier": "Standard", + "capacity": 1 + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_quotametrics.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_quotametrics.json new file mode 100644 index 000000000000..1a8cda78bde2 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_quotametrics.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "TotalMessages", + "currentValue": 0, + "maxValue": 400000 + }, + { + "name": "TotalDeviceCount", + "currentValue": 0, + "maxValue": 500000 + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_routingendpointhealth.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_routingendpointhealth.json new file mode 100644 index 000000000000..5a498fd47625 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_routingendpointhealth.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "endpointId": "id1", + "healthStatus": "healthy", + "lastSuccessfulSendAttemptTime": "2020-03-26T21:20:57Z", + "lastSendAttemptTime": "2020-03-26T21:24:57Z" + }, + { + "endpointId": "id2", + "healthStatus": "unknown" + }, + { + "endpointId": "id3", + "healthStatus": "unhealthy", + "lastKnownError": "NotFound", + "lastKnownErrorTime": "2020-03-26T21:24:57Z", + "lastSuccessfulSendAttemptTime": "2020-03-26T21:20:57Z", + "lastSendAttemptTime": "2020-03-26T21:24:57Z" + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_stats.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_stats.json new file mode 100644 index 000000000000..1a7bcb918e7e --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_stats.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "totalDeviceCount": 0, + "enabledDeviceCount": 0, + "disabledDeviceCount": 0 + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_testallroutes.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_testallroutes.json new file mode 100644 index 000000000000..467482e1ac0f --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_testallroutes.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "routingSource": "DeviceMessages", + "message": { + "body": "Body of message", + "appProperties": { + "key1": "value1" + }, + "systemProperties": { + "key1": "value1" + } + } + } + }, + "responses": { + "200": { + "body": { + "routes": [ + { + "properties": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": [ + "id1" + ], + "isEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_testnewroute.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_testnewroute.json new file mode 100644 index 000000000000..0a8d8c65611d --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_testnewroute.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "iotHubName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "input": { + "message": { + "body": "Body of message", + "appProperties": { + "key1": "value1" + }, + "systemProperties": { + "key1": "value1" + } + }, + "route": { + "name": "Routeid", + "source": "DeviceMessages", + "endpointNames": [ + "id1" + ], + "isEnabled": true + } + } + }, + "responses": { + "200": { + "body": { + "result": "false", + "details": { + "compilationErrors": [ + { + "message": "string response", + "severity": "error", + "location": { + "start": { + "line": 12, + "column": 12 + }, + "end": { + "line": 12, + "column": 24 + } + } + } + ] + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_updateprivateendpointconnection.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_updateprivateendpointconnection.json new file mode 100644 index 000000000000..b4563a4991cb --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_updateprivateendpointconnection.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceName": "testHub", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0", + "privateEndpointConnectionName": "myPrivateEndpointConnection", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/91d12660-3dec-467a-be2a-213b5544ddc0/resourceGroups/myResourceGroup/providers/Microsoft.Devices/IotHubs/testHub/PrivateEndpointConnections/myPrivateEndpointConnection", + "name": "myPrivateEndpointConnection", + "type": "Microsoft.Devices/IotHubs/PrivateEndpointConnections", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/a9eba280-4734-4d49-878f-b5549d1d0453/resourceGroups/networkResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approved by johndoe@contoso.com", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_usages.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_usages.json new file mode 100644 index 000000000000..d5a118a3b06f --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/examples/iothub_usages.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-04-01", + "subscriptionId": "91d12660-3dec-467a-be2a-213b5544ddc0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages/freeHubCount", + "type": "/subscription/91d12660-3dec-467a-be2a-213b5544ddc0/providers/Microsoft.Devices/usages", + "unit": "count", + "currentValue": 1, + "limit": 1, + "name": { + "value": "FreeHubCount", + "localizedValue": "Free Hub Count" + } + } + ] + } + } + } +} diff --git a/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/iothub.json b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/iothub.json new file mode 100644 index 000000000000..044be4a4acf5 --- /dev/null +++ b/specification/iothub/resource-manager/Microsoft.Devices/stable/2020-04-01/iothub.json @@ -0,0 +1,4168 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-04-01", + "title": "iotHubClient", + "description": "Use this API to manage the IoT hubs in your Azure subscription.", + "x-ms-code-generation-settings": { + "header": "MICROSOFT_MIT_NO_VERSION" + } + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Devices/operations": { + "get": { + "tags": [ + "Operations" + ], + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/iothub_operations.json" + } + }, + "operationId": "Operations_List", + "description": "Lists all of the available IoT Hub REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the non-security related metadata of an IoT hub", + "description": "Get the non-security related metadata of an IoT hub.", + "operationId": "IotHubResource_Get", + "x-ms-examples": { + "IotHubResource_Get": { + "$ref": "./examples/iothub_get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the non-security properties of the IoT hub. Security-related properties are set to null.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Create or update the metadata of an IoT hub.", + "description": "Create or update the metadata of an Iot hub. The usual pattern to modify a property is to retrieve the IoT hub metadata and security metadata, and then combine them with the modified values in a new body to update the IoT hub.", + "operationId": "IotHubResource_CreateOrUpdate", + "x-ms-examples": { + "IotHubResource_CreateOrUpdate": { + "$ref": "./examples/iothub_createOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "iotHubDescription", + "in": "body", + "description": "The IoT hub metadata and security metadata.", + "required": true, + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the IoT Hub. Do not specify for creating a brand new IoT Hub. Required to update an existing IoT Hub." + } + ], + "responses": { + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the create or update operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "patch": { + "tags": [ + "PATCH" + ], + "summary": "Update an existing IoT Hubs tags.", + "description": "Update an existing IoT Hub tags. to update other fields use the CreateOrUpdate method", + "x-ms-long-running-operation": true, + "operationId": "IotHubResource_Update", + "x-ms-examples": { + "IotHubResource_Update": { + "$ref": "./examples/iothub_patch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "Resource group identifier." + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of iot hub to update." + }, + { + "name": "IotHubTags", + "in": "body", + "required": true, + "description": "Updated tag information to set into the iot hub instance.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Iot Hub was successfully updated", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete an IoT hub", + "description": "Delete an IoT hub.", + "operationId": "IotHubResource_Delete", + "x-ms-examples": { + "IotHubResource_Delete": { + "$ref": "./examples/iothub_delete.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "202": { + "description": "The Iot Hub resource provider always returns a 202 Accepted status code with valid Location and Retry-After headers. The resource provider also sets the Azure-AsyncOperation header with a URL that points to the operation resource for this operation. Subsequent GET attempts on the resource after a DELETE operation return a resource representation that indicates a transitional provisioning state (such as Terminating). To retrieve the status of the operation, a client can either poll the URL returned in the Location header after the Retry-After interval, get the IoT Hub service status directly, or query the operation resource.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation. The body contains the resource representation that indicates a transitional provisioning state.", + "schema": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "204": { + "description": "Once the long running delete operation completes successfully, a 204 No Content status code is returned when the status polling request finds the Iot hub metadata in the service and the status of the delete operation is set to a completed state." + }, + "404": { + "description": "After the long running delete operation completes successfully, a 404 Not Found is returned when the status polling request no longer finds the Iot hub metadata in the service.", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/IotHubs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get all the IoT hubs in a subscription", + "description": "Get all the IoT hubs in a subscription.", + "operationId": "IotHubResource_ListBySubscription", + "x-ms-examples": { + "IotHubResource_ListBySubscription": { + "$ref": "./examples/iothub_listbysubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT hubs in the subscription.", + "schema": { + "$ref": "#/definitions/IotHubDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get all the IoT hubs in a resource group", + "description": "Get all the IoT hubs in a resource group.", + "operationId": "IotHubResource_ListByResourceGroup", + "x-ms-examples": { + "IotHubResource_ListByResourceGroup": { + "$ref": "./examples/iothub_listbyrg.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the metadata from all the IoT hubs in the resource group.", + "schema": { + "$ref": "#/definitions/IotHubDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubStats": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the statistics from an IoT hub", + "description": "Get the statistics from an IoT hub.", + "operationId": "IotHubResource_GetStats", + "x-ms-examples": { + "IotHubResource_GetStats": { + "$ref": "./examples/iothub_stats.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains JSON-serialized statistics from the identity registry in the IoT hub.", + "schema": { + "$ref": "#/definitions/RegistryStatistics" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/skus": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the list of valid SKUs for an IoT hub", + "description": "Get the list of valid SKUs for an IoT hub.", + "operationId": "IotHubResource_GetValidSkus", + "x-ms-examples": { + "IotHubResource_GetValidSkus": { + "$ref": "./examples/iothub_getskus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of the valid SKUs for this IoT hub.", + "schema": { + "$ref": "#/definitions/IotHubSkuDescriptionListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub", + "description": "Get a list of the consumer groups in the Event Hub-compatible device-to-cloud endpoint in an IoT hub.", + "operationId": "IotHubResource_ListEventHubConsumerGroups", + "x-ms-examples": { + "IotHubResource_ListEventHubConsumerGroups": { + "$ref": "./examples/iothub_listehgroups.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized list of the consumer groups in the Event Hub-compatible endpoint in this IoT hub", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupsListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/eventHubEndpoints/{eventHubEndpointName}/ConsumerGroups/{name}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub", + "description": "Get a consumer group from the Event Hub-compatible device-to-cloud endpoint for an IoT hub.", + "operationId": "IotHubResource_GetEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_ListEventHubConsumerGroups": { + "$ref": "./examples/iothub_getconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to retrieve.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized consumer group.", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub", + "description": "Add a consumer group to an Event Hub-compatible endpoint in an IoT hub.", + "operationId": "IotHubResource_CreateEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_CreateEventHubConsumerGroup": { + "$ref": "./examples/iothub_createconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to add.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation.", + "schema": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub", + "description": "Delete a consumer group from an Event Hub-compatible endpoint in an IoT hub.", + "operationId": "IotHubResource_DeleteEventHubConsumerGroup", + "x-ms-examples": { + "IotHubResource_DeleteEventHubConsumerGroup": { + "$ref": "./examples/iothub_deleteconsumergroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "eventHubEndpointName", + "in": "path", + "description": "The name of the Event Hub-compatible endpoint in the IoT hub.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The name of the consumer group to delete.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry", + "description": "Get a list of all the jobs in an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", + "operationId": "IotHubResource_ListJobs", + "x-ms-examples": { + "IotHubResource_ListJobs": { + "$ref": "./examples/iothub_listjobs.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized array of all the jobs in the IoT hub.", + "schema": { + "$ref": "#/definitions/JobResponseListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/jobs/{jobId}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry", + "description": "Get the details of a job from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry.", + "operationId": "IotHubResource_GetJob", + "x-ms-examples": { + "IotHubResource_GetJob": { + "$ref": "./examples/iothub_getjob.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "jobId", + "in": "path", + "description": "The job identifier.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized description of the job in the IoT hub.", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/quotaMetrics": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the quota metrics for an IoT hub", + "description": "Get the quota metrics for an IoT hub.", + "operationId": "IotHubResource_GetQuotaMetrics", + "x-ms-examples": { + "IotHubResource_GetQuotaMetrics": { + "$ref": "./examples/iothub_quotametrics.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The response contains a JSON-serialized array of the quota metrics for the IoT hub.", + "schema": { + "$ref": "#/definitions/IotHubQuotaMetricInfoListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routingEndpointsHealth": { + "get": { + "tags": [ + "GET" + ], + "operationId": "IotHubResource_GetEndpointHealth", + "summary": "Get the health for routing endpoints", + "description": "Get the health for routing endpoints.", + "x-ms-examples": { + "IotHubResource_GetEndpointHealth": { + "$ref": "./examples/iothub_routingendpointhealth.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "iotHubName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EndpointHealthDataListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/checkNameAvailability": { + "post": { + "tags": [ + "POST" + ], + "summary": "Check if an IoT hub name is available", + "description": "Check if an IoT hub name is available.", + "operationId": "IotHubResource_CheckNameAvailability", + "x-ms-examples": { + "IotHubResource_CheckNameAvailability": { + "$ref": "./examples/checkNameAvailability.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "operationInputs", + "in": "body", + "description": "Set the name parameter in the OperationInputs structure to the name of the IoT hub to check.", + "required": true, + "schema": { + "$ref": "#/definitions/OperationInputs" + } + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized response that specifies whether the IoT hub name is available. If the name is not available, the body contains the reason.", + "schema": { + "$ref": "#/definitions/IotHubNameAvailabilityInfo" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Devices/usages": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the number of iot hubs in the subscription", + "description": "Get the number of free and paid iot hubs in the subscription", + "operationId": "ResourceProviderCommon_GetSubscriptionQuota", + "x-ms-examples": { + "ResourceProviderCommon_GetSubscriptionQuota": { + "$ref": "./examples/iothub_usages.json" + } + }, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSubscriptionQuotaListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testall": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHubResource_TestAllRoutes", + "summary": "Test all routes", + "description": "Test all routes configured in this Iot Hub", + "x-ms-examples": { + "IotHubResource_TestAllRoutes": { + "$ref": "./examples/iothub_testallroutes.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "description": "Input for testing all routes", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestAllRoutesInput" + } + }, + { + "name": "iotHubName", + "description": "IotHub to be tested", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "resource group which Iot Hub belongs to", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TestAllRoutesResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/routing/routes/$testnew": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHubResource_TestRoute", + "summary": "Test the new route", + "description": "Test the new route for this Iot Hub", + "x-ms-examples": { + "IotHubResource_TestRoute": { + "$ref": "./examples/iothub_testnewroute.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "input", + "description": "Route that needs to be tested", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TestRouteInput" + } + }, + { + "name": "iotHubName", + "description": "IotHub to be tested", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "resource group which Iot Hub belongs to", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TestRouteResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/listkeys": { + "post": { + "tags": [ + "POST" + ], + "summary": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", + "description": "Get the security metadata for an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", + "operationId": "IotHubResource_ListKeys", + "x-ms-examples": { + "IotHubResource_ListKeys": { + "$ref": "./examples/iothub_listkeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized array of shared access policies, including keys, that you can use to access the IoT hub endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRuleListResult" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/IotHubKeys/{keyName}/listkeys": { + "post": { + "tags": [ + "POST" + ], + "summary": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security", + "description": "Get a shared access policy by name from an IoT hub. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-security.", + "operationId": "IotHubResource_GetKeysForKeyName", + "x-ms-examples": { + "IotHubResource_GetKeysForKeyName": { + "$ref": "./examples/iothub_getkey.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "keyName", + "in": "path", + "description": "The name of the shared access policy.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "This is a synchronous operation. The body contains a JSON-serialized shared access policy, including keys, that you can use to access one or more IoT hub endpoints.", + "schema": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/exportDevices": { + "post": { + "tags": [ + "POST" + ], + "summary": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities", + "description": "Exports all the device identities in the IoT hub identity registry to an Azure Storage blob container. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", + "operationId": "IotHubResource_ExportDevices", + "x-ms-examples": { + "IotHubResource_ExportDevices": { + "$ref": "./examples/iothub_exportdevices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "exportDevicesParameters", + "in": "body", + "description": "The parameters that specify the export devices operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ExportDevicesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/importDevices": { + "post": { + "tags": [ + "POST" + ], + "summary": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities", + "description": "Import, update, or delete device identities in the IoT hub identity registry from a blob. For more information, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-identity-registry#import-and-export-device-identities.", + "operationId": "IotHubResource_ImportDevices", + "x-ms-examples": { + "IotHubResource_ImportDevices": { + "$ref": "./examples/iothub_importdevices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "name": "importDevicesParameters", + "in": "body", + "description": "The parameters that specify the import devices operation.", + "required": true, + "schema": { + "$ref": "#/definitions/ImportDevicesRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobResponse" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get the certificate list.", + "description": "Returns the list of certificates.", + "operationId": "Certificates_ListByIotHub", + "x-ms-examples": { + "Certificates_ListByIotHub": { + "$ref": "./examples/iothub_listcertificates.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains all the certificate list.", + "schema": { + "$ref": "#/definitions/CertificateListDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}": { + "get": { + "tags": [ + "Certificates" + ], + "summary": "Get the certificate.", + "description": "Returns the certificate.", + "operationId": "Certificates_Get", + "x-ms-examples": { + "Certificates_Get": { + "$ref": "./examples/iothub_getcertificate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "Certificates" + ], + "summary": "Upload the certificate to the IoT hub.", + "description": "Adds new or replaces existing certificate.", + "operationId": "Certificates_CreateOrUpdate", + "x-ms-examples": { + "Certificates_CreateOrUpdate": { + "$ref": "./examples/iothub_certificatescreateorupdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "certificateDescription", + "in": "body", + "description": "The certificate body.", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateBodyDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "ETag of the Certificate. Do not specify for creating a brand new certificate. Required to update an existing certificate." + } + ], + "responses": { + "201": { + "description": "If certificate didn't exist creation was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "200": { + "description": "If certificate already exist and update was successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "Certificates" + ], + "summary": "Delete an X509 certificate.", + "description": "Deletes an existing X509 certificate or does nothing if it does not exist.", + "operationId": "Certificates_Delete", + "x-ms-examples": { + "Certificates_Delete": { + "$ref": "./examples/iothub_certificatesdelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "Certificate has been deleted." + }, + "204": { + "description": "Certificate does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/generateVerificationCode": { + "post": { + "tags": [ + "Certificates" + ], + "summary": "Generate verification code for proof of possession flow.", + "description": "Generates verification code for proof of possession flow. The verification code will be used to generate a leaf certificate.", + "operationId": "Certificates_GenerateVerificationCode", + "x-ms-examples": { + "Certificates_GenerateVerificationCode": { + "$ref": "./examples/iothub_generateverificationcode.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateWithNonceDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{resourceName}/certificates/{certificateName}/verify": { + "post": { + "tags": [ + "Certificates" + ], + "summary": "Verify certificate's private key possession.", + "description": "Verifies the certificate's private key possession by providing the leaf cert issued by the verifying pre uploaded certificate.", + "operationId": "Certificates_Verify", + "x-ms-examples": { + "Certificates_Verify": { + "$ref": "./examples/iothub_certverify.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/certificateName" + }, + { + "name": "certificateVerificationBody", + "in": "body", + "description": "The name of the certificate", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateVerificationDescription" + } + }, + { + "name": "If-Match", + "in": "header", + "required": true, + "type": "string", + "description": "ETag of the Certificate." + } + ], + "responses": { + "200": { + "description": "The body contains the certificate.", + "schema": { + "$ref": "#/definitions/CertificateDescription" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/IotHubs/{iotHubName}/failover": { + "post": { + "tags": [ + "POST" + ], + "operationId": "IotHub_ManualFailover", + "summary": "Manually initiate a failover for the IoT Hub to its secondary region", + "description": "Manually initiate a failover for the IoT Hub to its secondary region. To learn more, see https://aka.ms/manualfailover", + "x-ms-examples": { + "IotHub_ManualFailover": { + "$ref": "./examples/IotHub_ManualFailover.json" + } + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "x-ms-long-running-operation": true, + "parameters": [ + { + "name": "iotHubName", + "description": "Name of the IoT hub to failover", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "failoverInput", + "description": "Region to failover to. Must be the Azure paired region. Get the value from the secondary location in the locations property. To learn more, see https://aka.ms/manualfailover/region", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverInput" + } + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "name": "resourceGroupName", + "description": "Name of the resource group containing the IoT hub resource", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/api-version" + } + ], + "responses": { + "200": { + "description": "Long running manual failover operation for the IoT hub completed" + }, + "202": { + "description": "Manual failover initiated" + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private link resources", + "description": "List private link resources for the given IotHub", + "operationId": "PrivateLinkResources_List", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/iothub_listprivatelinkresources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private link resources", + "schema": { + "$ref": "#/definitions/PrivateLinkResources" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateLinkResources/{groupId}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get the specified private link resource", + "description": "Get the specified private link resource for the given IotHub", + "operationId": "PrivateLinkResources_Get", + "x-ms-examples": { + "PrivateLinkResources_List": { + "$ref": "./examples/iothub_getprivatelinkresources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/groupId" + } + ], + "responses": { + "200": { + "description": "The body contains the specified of private link resource", + "schema": { + "$ref": "#/definitions/GroupIdInformation" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "GET" + ], + "summary": "List private endpoint connections", + "description": "List private endpoint connection properties", + "operationId": "PrivateEndpointConnections_List", + "x-ms-examples": { + "PrivateEndpointConnections_List": { + "$ref": "./examples/iothub_listprivateendpointconnections.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + } + ], + "responses": { + "200": { + "description": "The body contains the list of private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionsList" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Devices/iotHubs/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "GET" + ], + "summary": "Get private endpoint connection", + "description": "Get private endpoint connection properties", + "operationId": "PrivateEndpointConnections_Get", + "x-ms-examples": { + "PrivateEndpointConnection_Get": { + "$ref": "./examples/iothub_getprivateendpointconnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "200": { + "description": "The body contains the private endpoint connection properties", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "put": { + "tags": [ + "PUT" + ], + "summary": "Update private endpoint connection", + "description": "Update the status of a private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Update", + "x-ms-examples": { + "PrivateEndpointConnection_Update": { + "$ref": "./examples/iothub_updateprivateendpointconnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection with updated properties", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "201": { + "description": "This is a long running operation. The operation returns a 201 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation. If successful, the operation returns HTTP status code of 201 (OK).", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the update operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + }, + "delete": { + "tags": [ + "DELETE" + ], + "summary": "Delete private endpoint connection", + "description": "Delete private endpoint connection with the specified name", + "operationId": "PrivateEndpointConnections_Delete", + "x-ms-examples": { + "PrivateEndpointConnection_Delete": { + "$ref": "./examples/iothub_deleteprivateendpointconnection.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/api-version" + }, + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/resourceName" + }, + { + "$ref": "#/parameters/privateEndpointConnectionName" + } + ], + "responses": { + "202": { + "description": "This is a long running operation. The operation returns a 202 if the validation is complete. The response includes an Azure-AsyncOperation header that contains a status URL. Clients are expected to poll the status URL for the status of the operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "200": { + "description": "This is returned as a response to the status polling request for the delete operation.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "204": { + "description": "PrivateEndpoint does not exist." + }, + "default": { + "description": "DefaultErrorResponse", + "schema": { + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "deprecated": false + } + } + }, + "definitions": { + "CertificateVerificationDescription": { + "description": "The JSON-serialized leaf certificate", + "type": "object", + "properties": { + "certificate": { + "description": "base-64 representation of X509 certificate .cer file or just .pem file content.", + "type": "string" + } + } + }, + "CertificateListDescription": { + "description": "The JSON-serialized array of Certificate objects.", + "type": "object", + "properties": { + "value": { + "description": "The array of Certificate objects.", + "type": "array", + "items": { + "$ref": "#/definitions/CertificateDescription" + } + } + } + }, + "CertificateBodyDescription": { + "description": "The JSON-serialized X509 Certificate.", + "type": "object", + "properties": { + "certificate": { + "description": "base-64 representation of the X509 leaf certificate .cer file or just .pem file content.", + "type": "string" + } + } + }, + "CertificateDescription": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificateProperties" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "description": "The name of the certificate.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The entity tag.", + "type": "string", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "x-ms-azure-resource": true + }, + "CertificateWithNonceDescription": { + "description": "The X509 Certificate.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/CertificatePropertiesWithNonce" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "description": "The name of the certificate.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The entity tag.", + "type": "string", + "readOnly": true + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "x-ms-azure-resource": true + }, + "SharedAccessSignatureAuthorizationRule": { + "description": "The properties of an IoT hub shared access policy.", + "type": "object", + "properties": { + "keyName": { + "description": "The name of the shared access policy.", + "type": "string" + }, + "primaryKey": { + "description": "The primary key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary key.", + "type": "string" + }, + "rights": { + "description": "The permissions assigned to the shared access policy.", + "enum": [ + "RegistryRead", + "RegistryWrite", + "ServiceConnect", + "DeviceConnect", + "RegistryRead, RegistryWrite", + "RegistryRead, ServiceConnect", + "RegistryRead, DeviceConnect", + "RegistryWrite, ServiceConnect", + "RegistryWrite, DeviceConnect", + "ServiceConnect, DeviceConnect", + "RegistryRead, RegistryWrite, ServiceConnect", + "RegistryRead, RegistryWrite, DeviceConnect", + "RegistryRead, ServiceConnect, DeviceConnect", + "RegistryWrite, ServiceConnect, DeviceConnect", + "RegistryRead, RegistryWrite, ServiceConnect, DeviceConnect" + ], + "type": "string", + "x-ms-enum": { + "name": "AccessRights", + "modelAsString": false + } + } + }, + "required": [ + "keyName", + "rights" + ] + }, + "CertificateProperties": { + "description": "The description of an X509 CA Certificate.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean", + "readOnly": true + }, + "created": { + "description": "The certificate's create date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "updated": { + "description": "The certificate's last update date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "certificate": { + "description": "The certificate content", + "type": "string" + } + } + }, + "CertificatePropertiesWithNonce": { + "description": "The description of an X509 CA Certificate including the challenge nonce issued for the Proof-Of-Possession flow.", + "type": "object", + "properties": { + "subject": { + "description": "The certificate's subject name.", + "type": "string", + "readOnly": true + }, + "expiry": { + "description": "The certificate's expiration date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "thumbprint": { + "description": "The certificate's thumbprint.", + "type": "string", + "readOnly": true + }, + "isVerified": { + "description": "Determines whether certificate has been verified.", + "type": "boolean", + "readOnly": true + }, + "created": { + "description": "The certificate's create date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "updated": { + "description": "The certificate's last update date and time.", + "type": "string", + "format": "date-time-rfc1123", + "readOnly": true + }, + "verificationCode": { + "description": "The certificate's verification code that will be used for proof of possession.", + "type": "string", + "readOnly": true + }, + "certificate": { + "description": "The certificate content", + "type": "string", + "readOnly": true + } + } + }, + "IotHubProperties": { + "description": "The properties of an IoT hub.", + "type": "object", + "properties": { + "authorizationPolicies": { + "description": "The shared access policies you can use to secure a connection to the IoT hub.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "publicNetworkAccess": { + "type": "string", + "description": "Whether requests from Public Network are allowed", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "ipFilterRules": { + "description": "The IP filter rules.", + "type": "array", + "items": { + "$ref": "#/definitions/IpFilterRule" + } + }, + "minTlsVersion": { + "type": "string", + "description": "Specifies the minimum TLS version to support for this hub. Can be set to \"1.2\" to have clients that use a TLS version below 1.2 to be rejected." + }, + "privateEndpointConnections": { + "description": "Private endpoint connections created on this IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "provisioningState": { + "description": "The provisioning state.", + "type": "string", + "readOnly": true + }, + "state": { + "description": "The hub state.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "The name of the host.", + "type": "string", + "readOnly": true + }, + "eventHubEndpoints": { + "description": "The Event Hub-compatible endpoint properties. The only possible keys to this dictionary is events. This key has to be present in the dictionary while making create or update calls for the IoT hub.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/EventHubProperties" + } + }, + "routing": { + "$ref": "#/definitions/RoutingProperties" + }, + "storageEndpoints": { + "description": "The list of Azure Storage endpoints where you can upload files. Currently you can configure only one Azure Storage account and that MUST have its key as $default. Specifying more than one storage account causes an error to be thrown. Not specifying a value for this property when the enableFileUploadNotifications property is set to True, causes an error to be thrown.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/StorageEndpointProperties" + } + }, + "messagingEndpoints": { + "description": "The messaging endpoint properties for the file upload notification queue.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/MessagingEndpointProperties" + } + }, + "enableFileUploadNotifications": { + "description": "If True, file upload notifications are enabled.", + "type": "boolean" + }, + "cloudToDevice": { + "$ref": "#/definitions/CloudToDeviceProperties" + }, + "comments": { + "description": "IoT hub comments.", + "type": "string" + }, + "features": { + "description": "The capabilities and features enabled for the IoT hub.", + "enum": [ + "None", + "DeviceManagement" + ], + "type": "string", + "x-ms-enum": { + "name": "Capabilities", + "modelAsString": true + } + }, + "locations": { + "description": "Primary and secondary location for iot hub", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/IotHubLocationDescription" + } + } + } + }, + "IotHubSkuInfo": { + "description": "Information about the SKU of the IoT hub.", + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU.", + "enum": [ + "F1", + "S1", + "S2", + "S3", + "B1", + "B2", + "B3" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubSku", + "modelAsString": true + } + }, + "tier": { + "description": "The billing tier for the IoT hub.", + "enum": [ + "Free", + "Standard", + "Basic" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IotHubSkuTier", + "modelAsString": false + } + }, + "capacity": { + "format": "int64", + "description": "The number of provisioned IoT Hub units. See: https://docs.microsoft.com/azure/azure-subscription-service-limits#iot-hub-limits.", + "type": "integer" + } + }, + "required": [ + "name" + ] + }, + "EventHubProperties": { + "description": "The properties of the provisioned Event Hub-compatible endpoint used by the IoT hub.", + "type": "object", + "properties": { + "retentionTimeInDays": { + "format": "int64", + "description": "The retention time for device-to-cloud messages in days. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages", + "type": "integer" + }, + "partitionCount": { + "format": "int32", + "description": "The number of partitions for receiving device-to-cloud messages in the Event Hub-compatible endpoint. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#device-to-cloud-messages.", + "type": "integer" + }, + "partitionIds": { + "description": "The partition ids in the Event Hub-compatible endpoint.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "path": { + "description": "The Event Hub-compatible name.", + "type": "string", + "readOnly": true + }, + "endpoint": { + "description": "The Event Hub-compatible endpoint.", + "type": "string", + "readOnly": true + } + } + }, + "StorageEndpointProperties": { + "description": "The properties of the Azure Storage endpoint for file upload.", + "type": "object", + "properties": { + "sasTtlAsIso8601": { + "description": "The period of time for which the SAS URI generated by IoT Hub for file upload is valid. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload#file-upload-notification-configuration-options.", + "type": "string", + "format": "duration" + }, + "connectionString": { + "description": "The connection string for the Azure Storage account to which files are uploaded.", + "type": "string" + }, + "containerName": { + "description": "The name of the root container where you upload files. The container need not exist but should be creatable using the connectionString specified.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + } + }, + "required": [ + "connectionString", + "containerName" + ] + }, + "MessagingEndpointProperties": { + "description": "The properties of the messaging endpoints used by this IoT hub.", + "type": "object", + "properties": { + "lockDurationAsIso8601": { + "description": "The lock duration. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "type": "string", + "format": "duration" + }, + "ttlAsIso8601": { + "description": "The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "type": "string", + "format": "duration" + }, + "maxDeliveryCount": { + "description": "The number of times the IoT hub attempts to deliver a message. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-file-upload.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + } + } + }, + "CloudToDeviceProperties": { + "description": "The IoT hub cloud-to-device messaging properties.", + "type": "object", + "properties": { + "maxDeliveryCount": { + "description": "The max delivery count for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + }, + "defaultTtlAsIso8601": { + "description": "The default time to live for cloud-to-device messages in the device queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "feedback": { + "$ref": "#/definitions/FeedbackProperties" + } + } + }, + "IpFilterRule": { + "description": "The IP filter rules for the IoT hub.", + "type": "object", + "properties": { + "filterName": { + "description": "The name of the IP filter rule.", + "type": "string" + }, + "action": { + "description": "The desired action for requests captured by this rule.", + "enum": [ + "Accept", + "Reject" + ], + "type": "string", + "x-ms-enum": { + "name": "IpFilterActionType", + "modelAsString": false + } + }, + "ipMask": { + "description": "A string that contains the IP address range in CIDR notation for the rule.", + "type": "string" + } + }, + "required": [ + "filterName", + "action", + "ipMask" + ] + }, + "PrivateLinkResources": { + "description": "The available private link resources for an IotHub", + "type": "object", + "properties": { + "value": { + "description": "The list of available private link resources for an IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/GroupIdInformation" + } + } + } + }, + "GroupIdInformation": { + "description": "The group information for creating a private endpoint on an IotHub", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/GroupIdInformationProperties" + } + }, + "required": [ + "properties" + ] + }, + "GroupIdInformationProperties": { + "description": "The properties for a group information object", + "type": "object", + "properties": { + "groupId": { + "type": "string", + "description": "The group id" + }, + "requiredMembers": { + "description": "The required members for a specific group id", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "The required DNS zones for a specific group id", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "PrivateEndpointConnectionsList": { + "description": "The list of private endpoint connections for an IotHub", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "PrivateEndpointConnection": { + "description": "The private endpoint connection of an IotHub", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties" + } + }, + "required": [ + "properties" + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "The properties of a private endpoint connection", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState" + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "description": "The private endpoint property of a private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The current state of a private endpoint connection", + "type": "object", + "properties": { + "status": { + "description": "The status of a private endpoint connection", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The description for the current state of a private endpoint connection" + }, + "actionsRequired": { + "type": "string", + "description": "Actions required for a private endpoint connection" + } + }, + "required": [ + "status", + "description" + ] + }, + "FeedbackProperties": { + "description": "The properties of the feedback queue for cloud-to-device messages.", + "type": "object", + "properties": { + "lockDurationAsIso8601": { + "description": "The lock duration for the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "ttlAsIso8601": { + "description": "The period of time for which a message is available to consume before it is expired by the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "type": "string", + "format": "duration" + }, + "maxDeliveryCount": { + "description": "The number of times the IoT hub attempts to deliver a message on the feedback queue. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging#cloud-to-device-messages.", + "format": "int32", + "type": "integer", + "minimum": 1, + "maximum": 100 + } + } + }, + "RoutingProperties": { + "description": "The routing related properties of the IoT hub. See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-messaging", + "type": "object", + "properties": { + "endpoints": { + "$ref": "#/definitions/RoutingEndpoints" + }, + "routes": { + "description": "The list of user-provided routing rules that the IoT hub uses to route messages to built-in and custom endpoints. A maximum of 100 routing rules are allowed for paid hubs and a maximum of 5 routing rules are allowed for free hubs.", + "type": "array", + "items": { + "$ref": "#/definitions/RouteProperties" + } + }, + "fallbackRoute": { + "description": "The properties of the route that is used as a fall-back route when none of the conditions specified in the 'routes' section are met. This is an optional parameter. When this property is not set, the messages which do not meet any of the conditions specified in the 'routes' section get routed to the built-in eventhub endpoint.", + "$ref": "#/definitions/FallbackRouteProperties" + }, + "enrichments": { + "description": "The list of user-provided enrichments that the IoT hub applies to messages to be delivered to built-in and custom endpoints. See: https://aka.ms/telemetryoneventgrid", + "type": "array", + "items": { + "$ref": "#/definitions/EnrichmentProperties" + } + } + } + }, + "RoutingEndpoints": { + "description": "The properties related to the custom endpoints to which your IoT hub routes messages based on the routing rules. A maximum of 10 custom endpoints are allowed across all endpoint types for paid hubs and only 1 custom endpoint is allowed across all endpoint types for free hubs.", + "type": "object", + "properties": { + "serviceBusQueues": { + "description": "The list of Service Bus queue endpoints that IoT hub routes the messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingServiceBusQueueEndpointProperties" + } + }, + "serviceBusTopics": { + "description": "The list of Service Bus topic endpoints that the IoT hub routes the messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingServiceBusTopicEndpointProperties" + } + }, + "eventHubs": { + "description": "The list of Event Hubs endpoints that IoT hub routes messages to, based on the routing rules. This list does not include the built-in Event Hubs endpoint.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingEventHubProperties" + } + }, + "storageContainers": { + "description": "The list of storage container endpoints that IoT hub routes messages to, based on the routing rules.", + "type": "array", + "items": { + "$ref": "#/definitions/RoutingStorageContainerProperties" + } + } + } + }, + "RoutingServiceBusQueueEndpointProperties": { + "description": "The properties related to service bus queue endpoint types.", + "type": "object", + "properties": { + "id": { + "description": "Id of the service bus queue endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the service bus queue endpoint.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the service bus queue endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Queue name on the service bus namespace", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the service bus queue endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual queue name.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the service bus queue endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the service bus queue endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingServiceBusTopicEndpointProperties": { + "description": "The properties related to service bus topic endpoint types.", + "type": "object", + "properties": { + "id": { + "description": "Id of the service bus topic endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the service bus topic endpoint.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the service bus topic endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Queue name on the service bus topic", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the service bus topic endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types. The name need not be the same as the actual topic name.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the service bus topic endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the service bus topic endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingEventHubProperties": { + "description": "The properties related to an event hub endpoint.", + "type": "object", + "properties": { + "id": { + "description": "Id of the event hub endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the event hub endpoint. ", + "type": "string" + }, + "endpointUri": { + "description": "The url of the event hub endpoint. It must include the protocol sb://", + "type": "string" + }, + "entityPath": { + "description": "Event hub name on the event hub namespace", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the event hub endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the event hub endpoint.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the event hub endpoint.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "RoutingStorageContainerProperties": { + "description": "The properties related to a storage container endpoint.", + "type": "object", + "properties": { + "id": { + "description": "Id of the storage container endpoint", + "type": "string" + }, + "connectionString": { + "description": "The connection string of the storage account.", + "type": "string" + }, + "endpointUri": { + "description": "The url of the storage endpoint. It must include the protocol https://", + "type": "string" + }, + "authenticationType": { + "description": "Method used to authenticate against the storage endpoint", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true + } + }, + "name": { + "description": "The name that identifies this endpoint. The name can only include alphanumeric characters, periods, underscores, hyphens and has a maximum length of 64 characters. The following names are reserved: events, fileNotifications, $default. Endpoint names must be unique across endpoint types.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "subscriptionId": { + "description": "The subscription identifier of the storage account.", + "type": "string" + }, + "resourceGroup": { + "description": "The name of the resource group of the storage account.", + "type": "string" + }, + "containerName": { + "description": "The name of storage container in the storage account.", + "type": "string" + }, + "fileNameFormat": { + "description": "File name format for the blob. Default format is {iothub}/{partition}/{YYYY}/{MM}/{DD}/{HH}/{mm}. All parameters are mandatory but can be reordered.", + "type": "string" + }, + "batchFrequencyInSeconds": { + "description": "Time interval at which blobs are written to storage. Value should be between 60 and 720 seconds. Default value is 300 seconds.", + "format": "int32", + "type": "integer", + "maximum": 720, + "minimum": 60 + }, + "maxChunkSizeInBytes": { + "description": "Maximum number of bytes for each blob written to storage. Value should be between 10485760(10MB) and 524288000(500MB). Default value is 314572800(300MB).", + "format": "int32", + "type": "integer", + "maximum": 524288000, + "minimum": 10485760 + }, + "encoding": { + "description": "Encoding that is used to serialize messages to blobs. Supported values are 'avro', 'avrodeflate', and 'JSON'. Default value is 'avro'.", + "type": "string", + "enum": [ + "Avro", + "AvroDeflate", + "JSON" + ] + } + }, + "required": [ + "name", + "containerName" + ] + }, + "RouteProperties": { + "description": "The properties of a routing rule that your IoT hub uses to route messages to endpoints.", + "type": "object", + "properties": { + "name": { + "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$" + }, + "source": { + "description": "The source that the routing rule is to be applied to, such as DeviceMessages.", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "condition": { + "description": "The condition that is evaluated to apply the routing rule. If no condition is provided, it evaluates to true by default. For grammar, see: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints to which messages that satisfy the condition are routed. Currently only one endpoint is allowed.", + "minItems": 1, + "maxItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "isEnabled": { + "description": "Used to specify whether a route is enabled.", + "type": "boolean" + } + }, + "required": [ + "name", + "endpointNames", + "source", + "isEnabled" + ] + }, + "FallbackRouteProperties": { + "description": "The properties of the fallback route. IoT Hub uses these properties when it routes messages to the fallback endpoint.", + "type": "object", + "properties": { + "name": { + "description": "The name of the route. The name can only include alphanumeric characters, periods, underscores, hyphens, has a maximum length of 64 characters, and must be unique.", + "type": "string" + }, + "source": { + "description": "The source to which the routing rule is to be applied to. For example, DeviceMessages", + "enum": [ + "DeviceMessages" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "condition": { + "description": "The condition which is evaluated in order to apply the fallback route. If the condition is not provided it will evaluate to true by default. For grammar, See: https://docs.microsoft.com/azure/iot-hub/iot-hub-devguide-query-language", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints to which the messages that satisfy the condition are routed to. Currently only 1 endpoint is allowed.", + "minItems": 1, + "maxItems": 1, + "type": "array", + "items": { + "type": "string" + } + }, + "isEnabled": { + "description": "Used to specify whether the fallback route is enabled.", + "type": "boolean" + } + }, + "required": [ + "endpointNames", + "source", + "isEnabled" + ] + }, + "EnrichmentProperties": { + "description": "The properties of an enrichment that your IoT hub applies to messages delivered to endpoints.", + "type": "object", + "properties": { + "key": { + "description": "The key or name for the enrichment property.", + "type": "string" + }, + "value": { + "description": "The value for the enrichment property.", + "type": "string" + }, + "endpointNames": { + "description": "The list of endpoints for which the enrichment is applied to the message.", + "minItems": 1, + "type": "array", + "items": { + "type": "string" + } + } + }, + "required": [ + "key", + "value", + "endpointNames" + ] + }, + "IotHubDescription": { + "description": "The description of the IoT hub.", + "type": "object", + "properties": { + "etag": { + "description": "The Etag field is *not* required. If it is provided in the response body, it must also be provided as a header per the normal ETag convention.", + "type": "string" + }, + "properties": { + "description": "IotHub properties", + "$ref": "#/definitions/IotHubProperties" + }, + "sku": { + "description": "IotHub SKU info", + "$ref": "#/definitions/IotHubSkuInfo" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku" + ] + }, + "Resource": { + "description": "The common properties of an Azure resource.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource identifier." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name.", + "pattern": "^(?![0-9]+$)(?!-)[a-zA-Z0-9-]{2,49}[a-zA-Z0-9]$" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true, + "required": [ + "location" + ] + }, + "SharedAccessSignatureAuthorizationRuleListResult": { + "description": "The list of shared access policies with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The list of shared access policies.", + "type": "array", + "items": { + "$ref": "#/definitions/SharedAccessSignatureAuthorizationRule" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "OperationListResult": { + "description": "Result of the request to list IoT Hub operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of IoT Hub operations supported by the Microsoft.Devices resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "IoT Hub REST API operation", + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Operation name: {provider}/{resource}/{read | write | action | delete}" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "readOnly": true, + "type": "string", + "description": "Service provider: Microsoft Devices" + }, + "resource": { + "readOnly": true, + "type": "string", + "description": "Resource Type: IotHubs" + }, + "operation": { + "readOnly": true, + "type": "string", + "description": "Name of the operation" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the operation" + } + } + } + } + }, + "ErrorDetails": { + "description": "Error details.", + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "type": "string", + "readOnly": true + }, + "httpStatusCode": { + "description": "The HTTP status code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The error message.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "The error details.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubQuotaMetricInfoListResult": { + "description": "The JSON-serialized array of IotHubQuotaMetricInfo objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of quota metrics objects.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubQuotaMetricInfo" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "EndpointHealthDataListResult": { + "description": "The JSON-serialized array of EndpointHealthData objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "JSON-serialized array of Endpoint health data", + "type": "array", + "items": { + "$ref": "#/definitions/EndpointHealthData" + } + }, + "nextLink": { + "description": "Link to more results", + "type": "string", + "readOnly": true + } + } + }, + "EndpointHealthData": { + "description": "The health data for an endpoint", + "type": "object", + "properties": { + "endpointId": { + "description": "Id of the endpoint", + "type": "string" + }, + "healthStatus": { + "description": "Health statuses have following meanings. The 'healthy' status shows that the endpoint is accepting messages as expected. The 'unhealthy' status shows that the endpoint is not accepting messages as expected and IoT Hub is retrying to send data to this endpoint. The status of an unhealthy endpoint will be updated to healthy when IoT Hub has established an eventually consistent state of health. The 'dead' status shows that the endpoint is not accepting messages, after IoT Hub retried sending messages for the retrial period. See IoT Hub metrics to identify errors and monitor issues with endpoints. The 'unknown' status shows that the IoT Hub has not established a connection with the endpoint. No messages have been delivered to or rejected from this endpoint", + "enum": [ + "unknown", + "healthy", + "degraded", + "unhealthy", + "dead" + ], + "type": "string", + "x-ms-enum": { + "name": "EndpointHealthStatus", + "modelAsString": true + } + }, + "lastKnownError": { + "description": "Last error obtained when a message failed to be delivered to iot hub", + "type": "string" + }, + "lastKnownErrorTime": { + "description": "Time at which the last known error occurred", + "type": "string", + "format": "date-time-rfc1123" + }, + "lastSuccessfulSendAttemptTime": { + "description": "Last time iot hub successfully sent a message to the endpoint", + "type": "string", + "format": "date-time-rfc1123" + }, + "lastSendAttemptTime": { + "description": "Last time iot hub tried to send a message to the endpoint", + "type": "string", + "format": "date-time-rfc1123" + } + } + }, + "RegistryStatistics": { + "description": "Identity registry statistics.", + "type": "object", + "properties": { + "totalDeviceCount": { + "format": "int64", + "description": "The total count of devices in the identity registry.", + "type": "integer", + "readOnly": true + }, + "enabledDeviceCount": { + "format": "int64", + "description": "The count of enabled devices in the identity registry.", + "type": "integer", + "readOnly": true + }, + "disabledDeviceCount": { + "format": "int64", + "description": "The count of disabled devices in the identity registry.", + "type": "integer", + "readOnly": true + } + } + }, + "JobResponseListResult": { + "description": "The JSON-serialized array of JobResponse objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of JobResponse objects.", + "type": "array", + "items": { + "$ref": "#/definitions/JobResponse" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubSkuDescription": { + "description": "SKU properties.", + "type": "object", + "properties": { + "resourceType": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "sku": { + "description": "The type of the resource.", + "$ref": "#/definitions/IotHubSkuInfo" + }, + "capacity": { + "description": "IotHub capacity", + "$ref": "#/definitions/IotHubCapacity" + } + }, + "required": [ + "sku", + "capacity" + ] + }, + "TagsResource": { + "properties": { + "tags": { + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "A container holding only the Tags for a resource, allowing the user to update the tags on an IoT Hub instance." + }, + "IotHubCapacity": { + "description": "IoT Hub capacity information.", + "type": "object", + "properties": { + "minimum": { + "format": "int64", + "description": "The minimum number of units.", + "type": "integer", + "minimum": 1, + "maximum": 1, + "readOnly": true + }, + "maximum": { + "format": "int64", + "description": "The maximum number of units.", + "type": "integer", + "readOnly": true + }, + "default": { + "format": "int64", + "description": "The default number of units.", + "type": "integer", + "readOnly": true + }, + "scaleType": { + "description": "The type of the scaling enabled.", + "enum": [ + "Automatic", + "Manual", + "None" + ], + "readOnly": true, + "type": "string", + "x-ms-enum": { + "name": "IotHubScaleType", + "modelAsString": false + } + } + } + }, + "EventHubConsumerGroupsListResult": { + "description": "The JSON-serialized array of Event Hub-compatible consumer group names with a next link.", + "type": "object", + "properties": { + "value": { + "description": "List of consumer groups objects", + "type": "array", + "items": { + "$ref": "#/definitions/EventHubConsumerGroupInfo" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "EventHubConsumerGroupInfo": { + "description": "The properties of the EventHubConsumerGroupInfo object.", + "x-ms-azure-resource": true, + "type": "object", + "properties": { + "properties": { + "description": "The tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "id": { + "description": "The Event Hub-compatible consumer group identifier.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Event Hub-compatible consumer group name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "the resource type.", + "type": "string", + "readOnly": true + }, + "etag": { + "description": "The etag.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubSkuDescriptionListResult": { + "description": "The JSON-serialized array of IotHubSkuDescription objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of IotHubSkuDescription.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubSkuDescription" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "JobResponse": { + "description": "The properties of the Job Response object.", + "type": "object", + "properties": { + "jobId": { + "description": "The job identifier.", + "type": "string", + "readOnly": true + }, + "startTimeUtc": { + "format": "date-time-rfc1123", + "description": "The start time of the job.", + "type": "string", + "readOnly": true + }, + "endTimeUtc": { + "format": "date-time-rfc1123", + "description": "The time the job stopped processing.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the job.", + "enum": [ + "unknown", + "export", + "import", + "backup", + "readDeviceProperties", + "writeDeviceProperties", + "updateDeviceConfiguration", + "rebootDevice", + "factoryResetDevice", + "firmwareUpdate" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "status": { + "description": "The status of the job.", + "enum": [ + "unknown", + "enqueued", + "running", + "completed", + "failed", + "cancelled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": false + } + }, + "failureReason": { + "description": "If status == failed, this string containing the reason for the failure.", + "type": "string", + "readOnly": true + }, + "statusMessage": { + "description": "The status message for the job.", + "type": "string", + "readOnly": true + }, + "parentJobId": { + "description": "The job identifier of the parent job, if any.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubDescriptionListResult": { + "description": "The JSON-serialized array of IotHubDescription objects with a next link.", + "type": "object", + "properties": { + "value": { + "description": "The array of IotHubDescription objects.", + "type": "array", + "items": { + "$ref": "#/definitions/IotHubDescription" + } + }, + "nextLink": { + "description": "The next link.", + "type": "string", + "readOnly": true + } + } + }, + "IotHubQuotaMetricInfo": { + "description": "Quota metrics properties.", + "type": "object", + "properties": { + "name": { + "description": "The name of the quota metric.", + "type": "string", + "readOnly": true + }, + "currentValue": { + "format": "int64", + "description": "The current value for the quota metric.", + "type": "integer", + "readOnly": true + }, + "maxValue": { + "format": "int64", + "description": "The maximum value of the quota metric.", + "type": "integer", + "readOnly": true + } + } + }, + "OperationInputs": { + "description": "Input values.", + "type": "object", + "properties": { + "name": { + "description": "The name of the IoT hub to check.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "IotHubNameAvailabilityInfo": { + "description": "The properties indicating whether a given IoT hub name is available.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value which indicates whether the provided name is available.", + "type": "boolean", + "readOnly": true + }, + "reason": { + "description": "The reason for unavailability.", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "IotHubNameUnavailabilityReason", + "modelAsString": false + } + }, + "message": { + "description": "The detailed reason message.", + "type": "string" + } + } + }, + "UserSubscriptionQuotaListResult": { + "type": "object", + "description": "Json-serialized array of User subscription quota response", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UserSubscriptionQuota" + } + }, + "nextLink": { + "type": "string", + "readOnly": true + } + } + }, + "UserSubscriptionQuota": { + "description": "User subscription quota response", + "type": "object", + "properties": { + "id": { + "description": "IotHub type id", + "type": "string" + }, + "type": { + "description": "Response type", + "type": "string" + }, + "unit": { + "description": "Unit of IotHub type", + "type": "string" + }, + "currentValue": { + "description": "Current number of IotHub type", + "format": "int32", + "type": "integer" + }, + "limit": { + "description": "Numerical limit on IotHub type", + "format": "int32", + "type": "integer" + }, + "name": { + "description": "IotHub type", + "$ref": "#/definitions/Name" + } + } + }, + "Name": { + "description": "Name of Iot Hub type", + "type": "object", + "properties": { + "value": { + "description": "IotHub type", + "type": "string" + }, + "localizedValue": { + "description": "Localized value of name", + "type": "string" + } + } + }, + "TestAllRoutesInput": { + "description": "Input for testing all routes", + "type": "object", + "properties": { + "routingSource": { + "description": "Routing source", + "enum": [ + "Invalid", + "DeviceMessages", + "TwinChangeEvents", + "DeviceLifecycleEvents", + "DeviceJobLifecycleEvents" + ], + "type": "string", + "x-ms-enum": { + "name": "RoutingSource", + "modelAsString": true + } + }, + "message": { + "description": "Routing message", + "$ref": "#/definitions/RoutingMessage" + }, + "twin": { + "description": "Routing Twin Reference", + "$ref": "#/definitions/RoutingTwin" + } + } + }, + "RoutingTwin": { + "description": "Twin reference input parameter. This is an optional parameter", + "type": "object", + "properties": { + "tags": { + "description": "Twin Tags", + "type": "object" + }, + "properties": { + "properties": { + "desired": { + "description": "Twin desired properties", + "type": "object" + }, + "reported": { + "description": "Twin desired properties", + "type": "object" + } + } + } + } + }, + "RoutingMessage": { + "description": "Routing message", + "type": "object", + "properties": { + "body": { + "description": "Body of routing message", + "type": "string" + }, + "appProperties": { + "description": "App properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "systemProperties": { + "description": "System properties", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TestAllRoutesResult": { + "description": "Result of testing all routes", + "type": "object", + "properties": { + "routes": { + "description": "JSON-serialized array of matched routes", + "type": "array", + "items": { + "$ref": "#/definitions/MatchedRoute" + } + } + } + }, + "MatchedRoute": { + "description": "Routes that matched", + "type": "object", + "properties": { + "properties": { + "description": "Properties of routes that matched", + "$ref": "#/definitions/RouteProperties" + } + } + }, + "TestRouteInput": { + "required": [ + "route" + ], + "description": "Input for testing route", + "type": "object", + "properties": { + "message": { + "description": "Routing message", + "$ref": "#/definitions/RoutingMessage" + }, + "route": { + "description": "Route properties", + "$ref": "#/definitions/RouteProperties" + }, + "twin": { + "description": "Routing Twin Reference", + "$ref": "#/definitions/RoutingTwin" + } + } + }, + "TestRouteResult": { + "description": "Result of testing one route", + "type": "object", + "properties": { + "result": { + "description": "Result of testing route", + "enum": [ + "undefined", + "false", + "true" + ], + "type": "string", + "x-ms-enum": { + "name": "TestResultStatus", + "modelAsString": true + } + }, + "details": { + "description": "Detailed result of testing route", + "$ref": "#/definitions/TestRouteResultDetails" + } + } + }, + "TestRouteResultDetails": { + "description": "Detailed result of testing a route", + "type": "object", + "properties": { + "compilationErrors": { + "description": "JSON-serialized list of route compilation errors", + "type": "array", + "items": { + "$ref": "#/definitions/RouteCompilationError" + } + } + } + }, + "RouteCompilationError": { + "description": "Compilation error when evaluating route", + "type": "object", + "properties": { + "message": { + "description": "Route error message", + "type": "string" + }, + "severity": { + "description": "Severity of the route error", + "enum": [ + "error", + "warning" + ], + "type": "string", + "x-ms-enum": { + "name": "RouteErrorSeverity", + "modelAsString": true + } + }, + "location": { + "description": "Location where the route error happened", + "$ref": "#/definitions/RouteErrorRange" + } + } + }, + "RouteErrorRange": { + "description": "Range of route errors", + "type": "object", + "properties": { + "start": { + "description": "Start where the route error happened", + "$ref": "#/definitions/RouteErrorPosition" + }, + "end": { + "description": "End where the route error happened", + "$ref": "#/definitions/RouteErrorPosition" + } + } + }, + "RouteErrorPosition": { + "description": "Position where the route error happened", + "type": "object", + "properties": { + "line": { + "description": "Line where the route error happened", + "format": "int32", + "type": "integer" + }, + "column": { + "description": "Column where the route error happened", + "format": "int32", + "type": "integer" + } + } + }, + "ExportDevicesRequest": { + "description": "Use to provide parameters when requesting an export of all devices in the IoT hub.", + "type": "object", + "properties": { + "exportBlobContainerUri": { + "description": "The export blob container URI.", + "type": "string" + }, + "excludeKeys": { + "description": "The value indicating whether keys should be excluded during export.", + "type": "boolean" + }, + "exportBlobName": { + "description": "The name of the blob that will be created in the provided output blob container. This blob will contain the exported device registry information for the IoT Hub.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + } + }, + "required": [ + "exportBlobContainerUri", + "excludeKeys" + ] + }, + "ImportDevicesRequest": { + "description": "Use to provide parameters when requesting an import of all devices in the hub.", + "type": "object", + "properties": { + "inputBlobContainerUri": { + "description": "The input blob container URI.", + "type": "string" + }, + "outputBlobContainerUri": { + "description": "The output blob container URI.", + "type": "string" + }, + "inputBlobName": { + "description": "The blob name to be used when importing from the provided input blob container.", + "type": "string" + }, + "outputBlobName": { + "description": "The blob name to use for storing the status of the import job.", + "type": "string" + }, + "authenticationType": { + "description": "Specifies authentication type being used for connecting to the storage account.", + "enum": [ + "keyBased", + "identityBased" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + } + }, + "required": [ + "inputBlobContainerUri", + "outputBlobContainerUri" + ] + }, + "FailoverInput": { + "description": "Use to provide failover region when requesting manual Failover for a hub.", + "type": "object", + "properties": { + "failoverRegion": { + "description": "Region the hub will be failed over to", + "type": "string" + } + }, + "required": [ + "failoverRegion" + ] + }, + "IotHubLocationDescription": { + "description": "Public representation of one of the locations where a resource is provisioned.", + "type": "object", + "properties": { + "location": { + "description": "The name of the Azure region", + "type": "string" + }, + "role": { + "description": "The role of the region, can be either primary or secondary. The primary region is where the IoT hub is currently provisioned. The secondary region is the Azure disaster recovery (DR) paired region and also the region where the IoT hub can failover to.", + "enum": [ + "primary", + "secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "IotHubReplicaRoleType", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "subscriptionId": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription identifier.", + "required": true, + "type": "string" + }, + "api-version": { + "name": "api-version", + "in": "query", + "description": "The version of the API.", + "required": true, + "type": "string" + }, + "resourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group that contains the IoT hub.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the IoT hub.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "certificateName": { + "name": "certificateName", + "in": "path", + "description": "The name of the certificate", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9-._]{1,64}$", + "x-ms-parameter-location": "method" + }, + "groupId": { + "name": "groupId", + "in": "path", + "description": "The name of the private link resource", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "privateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/iothub/resource-manager/readme.md b/specification/iothub/resource-manager/readme.md index 8e78febbb821..cc0782d00196 100644 --- a/specification/iothub/resource-manager/readme.md +++ b/specification/iothub/resource-manager/readme.md @@ -26,18 +26,27 @@ These are the global settings for the IotHub API. ``` yaml openapi-type: arm -tag: package-2020-03 +tag: package-2020-04 ``` +### Tag: package-2020-04 + +These settings apply only when `--tag=package-2020-04` is specified on the command line. + +```yaml $(tag) == 'package-2020-04' +input-file: + - Microsoft.Devices/stable/2020-04-01/iothub.json +``` ### Tag: package-2020-03 These settings apply only when `--tag=package-2020-03` is specified on the command line. -```yaml $(tag) == 'package-2020-03' +``` yaml $(tag) == 'package-2020-03' input-file: - Microsoft.Devices/stable/2020-03-01/iothub.json ``` + ### Tag: package-2019-11 These settings apply only when `--tag=package-2019-11` is specified on the command line. From 6e5e3da124cbe48aabc304e0458c30f278b66c4b Mon Sep 17 00:00:00 2001 From: Richard Li Date: Thu, 4 Jun 2020 19:51:10 -0700 Subject: [PATCH 090/318] remove whitespace (#9703) * remove whitespace * fix example Co-authored-by: Richard Li --- .../preview/2020-04-01-preview/machineLearningServices.json | 4 +++- .../stable/2020-04-01/examples/createBasicAmlCompute.json | 2 +- .../stable/2020-04-01/examples/getAmlCompute.json | 2 +- .../stable/2020-04-01/examples/updateAmlCompute.json | 2 +- .../stable/2020-04-01/machineLearningServices.json | 2 +- 5 files changed, 7 insertions(+), 5 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json index c744d1dc2d46..0b6a2b9f8378 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json @@ -2139,7 +2139,9 @@ "description": "The identity type.", "enum": [ "SystemAssigned", - "SystemAssigned,UserAssigned" + "SystemAssigned,UserAssigned", + "UserAssigned", + "None" ], "x-ms-enum": { "name": "ResourceIdentityType", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/createBasicAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/createBasicAmlCompute.json index 8b852df15fce..eb2d99ff150d 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/createBasicAmlCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/createBasicAmlCompute.json @@ -21,7 +21,7 @@ } }, "identity": { - "type": "SystemAssigned, UserAssigned", + "type": "SystemAssigned,UserAssigned", "userAssignedIdentities": { "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/getAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/getAmlCompute.json index 6560c277ae76..f147f3668488 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/getAmlCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/getAmlCompute.json @@ -46,7 +46,7 @@ "identity": { "principalId": "00000000-0000-0000-0000-000000000000", "tenantId": "00000000-0000-0000-0000-000000000000", - "type": "SystemAssigned, UserAssigned", + "type": "SystemAssigned,UserAssigned", "userAssignedIdentities": { "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { "clientId": "00000000-0000-0000-0000-000000000000", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/updateAmlCompute.json index 382f1b97334e..1aae9348e524 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/updateAmlCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/updateAmlCompute.json @@ -18,7 +18,7 @@ } }, "identity": { - "type": "SystemAssigned, UserAssigned", + "type": "SystemAssigned,UserAssigned", "userAssignedIdentities": { "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json index 3e1faf470e29..f51a3a500861 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json @@ -1946,7 +1946,7 @@ "enum": [ "SystemAssigned", "UserAssigned", - "SystemAssigned, UserAssigned", + "SystemAssigned,UserAssigned", "None" ], "x-ms-enum": { From a2c7ec57045be5fbeb49be994f252d80ad68e63b Mon Sep 17 00:00:00 2001 From: Cecile Robert-Michon Date: Thu, 4 Jun 2020 19:55:20 -0700 Subject: [PATCH 091/318] Fix VirtualMachineScaleSetIPConfigurationProperties Load Balancer description (#9675) --- .../Microsoft.Compute/stable/2019-12-01/compute.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json index 1eb32c641214..f1433d61b827 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json @@ -9236,14 +9236,14 @@ "items": { "$ref": "#/definitions/SubResource" }, - "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer." + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." }, "loadBalancerInboundNatPools": { "type": "array", "items": { "$ref": "#/definitions/SubResource" }, - "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same load balancer" + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." } }, "description": "Describes a virtual machine scale set network profile's IP configuration properties." From adacd4a327c0e583e6d0cfa5090a756ed6bfad8d Mon Sep 17 00:00:00 2001 From: Rodge Fu Date: Fri, 5 Jun 2020 12:33:28 +0800 Subject: [PATCH 092/318] add codegen config for GuesConfiguration (#9692) * add codegen config * enable pipeline --- .../resource-manager/readme.az.md | 21 +++++++++++++++ .../resource-manager/readme.cli.md | 9 +++++++ .../resource-manager/readme.md | 11 ++++++++ .../resource-manager/readme.python.md | 27 +++++++++++++++++++ 4 files changed, 68 insertions(+) create mode 100644 specification/guestconfiguration/resource-manager/readme.az.md create mode 100644 specification/guestconfiguration/resource-manager/readme.cli.md create mode 100644 specification/guestconfiguration/resource-manager/readme.python.md diff --git a/specification/guestconfiguration/resource-manager/readme.az.md b/specification/guestconfiguration/resource-manager/readme.az.md new file mode 100644 index 000000000000..319a17cc5022 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/readme.az.md @@ -0,0 +1,21 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) +az: + extensions: guestconfig + namespace: azure.mgmt.guestconfig + package-name: azure-mgmt-guestconfig +az-output-folder: $(azure-cli-extension-folder)/src/guestconfig +python-sdk-output-folder: "$(az-output-folder)/azext_guestconfig/vendored_sdks/guestconfig" + +cli: + cli-directive: + - where: + type: 'GuestConfigurationAssignment' + prop: 'properties' + flatten: true + + +``` diff --git a/specification/guestconfiguration/resource-manager/readme.cli.md b/specification/guestconfiguration/resource-manager/readme.cli.md new file mode 100644 index 000000000000..a9e918eefe21 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/readme.cli.md @@ -0,0 +1,9 @@ + CLI + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +#cli: +# test-scenario: +# - name: Factories_CreateOrUpdate +``` diff --git a/specification/guestconfiguration/resource-manager/readme.md b/specification/guestconfiguration/resource-manager/readme.md index 0951302918bc..8c7d94f58edd 100644 --- a/specification/guestconfiguration/resource-manager/readme.md +++ b/specification/guestconfiguration/resource-manager/readme.md @@ -96,6 +96,17 @@ directive: # 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-cli-extensions +``` + + ## C# These settings apply only when `--csharp` is specified on the command line. diff --git a/specification/guestconfiguration/resource-manager/readme.python.md b/specification/guestconfiguration/resource-manager/readme.python.md new file mode 100644 index 000000000000..ed4130e79a26 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/readme.python.md @@ -0,0 +1,27 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.guestconfig + package-name: azure-mgmt-guestconfig + package-version: 0.1.0 + clear-output-folder: true +``` +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/machinelearning/azure-mgmt-guestconfig/azure/mgmt/guestconfig +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/machinelearning/azure-mgmt-guestconfig +``` From cfc03a6201967d351dc2e13ed6c77d8f855a0502 Mon Sep 17 00:00:00 2001 From: Subrahmanyam Mandavilli Date: Thu, 4 Jun 2020 21:38:34 -0700 Subject: [PATCH 093/318] [Hub Generated] Review request for Microsoft.Databricks to add version stable/2018-04-01 (#9657) --- .../stable/2018-04-01/databricks.json | 347 ++++++++++++++++++ .../WorkspaceVirtualNetPeeringGet.json | 43 +++ .../WorkspaceVirtualNetPeeringList.json | 45 +++ ...ceVirtualNetworkPeeringCreateOrUpdate.json | 84 +++++ .../WorkspaceVirtualNetworkPeeringDelete.json | 14 + 5 files changed, 533 insertions(+) create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetPeeringGet.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetPeeringList.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetworkPeeringDelete.json diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json index 82b602c6b63d..26055abe6cff 100644 --- a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json @@ -316,6 +316,204 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings/{peeringName}": { + "get": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_Get", + "description": "Gets the workspace vNet Peering.", + "x-ms-examples": { + "Get a workspace with vNet Peering Configured": { + "$ref": "./examples/WorkspaceVirtualNetPeeringGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "204": { + "description": "OK - NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_Delete", + "description": "Deletes the workspace vNetPeering.", + "x-ms-examples": { + "Delete a workspace vNet Peering": { + "$ref": "./examples/WorkspaceVirtualNetworkPeeringDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "NoContent" + }, + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_CreateOrUpdate", + "description": "Creates vNet Peering for workspace.", + "x-ms-examples": { + "Create vNet Peering for Workspace": { + "$ref": "./examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json" + } + }, + "parameters": [ + { + "name": "VirtualNetworkPeeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "Parameters supplied to the create workspace vNet Peering." + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PeeringNameParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the workspace vNet peering, including provisioning status.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "200": { + "description": "Update succeeded - Returns information about the workspace vNet peering.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings": { + "get": { + "tags": [ + "vNetPeering" + ], + "operationId": "vNetPeering_ListByWorkspace", + "description": "Lists the workspace vNet Peerings.", + "x-ms-examples": { + "List all vNet Peerings for the workspace": { + "$ref": "./examples/WorkspaceVirtualNetPeeringList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List succeeded. Returns the resulting resource objects in response body.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeeringList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/providers/Microsoft.Databricks/operations": { "get": { "tags": [ @@ -522,6 +720,21 @@ "modelAsString": true } }, + "PeeringProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PeeringProvisioningState", + "modelAsString": true + } + }, "WorkspaceCustomParameterType": { "description": "Provisioning status of the workspace.", "readOnly": true, @@ -788,6 +1001,132 @@ "description": "URL to get the next set of operation list results if there are any." } } + }, + "VirtualNetworkPeeringList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "List of virtual network peerings on workspace." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of virtual network peering list results if there are any." + } + }, + "description": "Gets all virtual network peerings under a workspace." + }, + "VirtualNetworkPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", + "description": "List of properties for vNet Peering" + }, + "name": { + "type": "string", + "description": "Name of the virtual network peering resource", + "readOnly": true + }, + "id": { + "type": "string", + "description": "Resource ID.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "type of the virtual network peering resource", + "readOnly": true + } + }, + "required": [ + "properties" + ], + "description": "Peerings in a VirtualNetwork resource", + "x-ms-azure-resource": true + }, + "VirtualNetworkPeeringPropertiesFormat": { + "properties": { + "allowVirtualNetworkAccess": { + "type": "boolean", + "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space." + }, + "allowForwardedTraffic": { + "type": "boolean", + "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network." + }, + "allowGatewayTransit": { + "type": "boolean", + "description": "If gateway links can be used in remote virtual networking to link to this virtual network." + }, + "useRemoteGateways": { + "type": "boolean", + "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." + }, + "databricksVirtualNetwork": { + "properties": { + "id": { + "type": "string", + "description": "The Id of the databricks virtual network." + } + }, + "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)." + }, + "databricksAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the databricks virtual network address space." + }, + "remoteVirtualNetwork": { + "properties": { + "id": { + "type": "string", + "description": "The Id of the remote virtual network." + } + }, + "description": " The remote virtual network should be in the same region. See here to learn more (https://docs.microsoft.com/en-us/azure/databricks/administration-guide/cloud-configurations/azure/vnet-peering)." + }, + "remoteAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the remote virtual network address space." + }, + "peeringState": { + "type": "string", + "description": "The status of the virtual network peering.", + "enum": [ + "Initiated", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "peeringState", + "modelAsString": true + }, + "readOnly": true + }, + "provisioningState": { + "readOnly": true, + "$ref": "#/definitions/PeeringProvisioningState", + "description": "The provisioning state of the virtual network peering resource." + } + }, + "required": [ + "remoteVirtualNetwork" + ], + "description": "Properties of the virtual network peering." + }, + "AddressSpace": { + "properties": { + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of address blocks reserved for this virtual network in CIDR notation." + } + }, + "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." } }, "parameters": { @@ -825,6 +1164,14 @@ "minLength": 3, "maxLength": 64, "x-ms-parameter-location": "method" + }, + "PeeringNameParameter": { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the workspace vNet peering.", + "x-ms-parameter-location": "method" } } } diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetPeeringGet.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetPeeringGet.json new file mode 100644 index 000000000000..2e5fb6f8e437 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetPeeringGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "peeringName": "vNetPeering", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + }, + "204": {} + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetPeeringList.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetPeeringList.json new file mode 100644 index 000000000000..353bc9fee001 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetPeeringList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2018-04-01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json new file mode 100644 index 000000000000..5623c1f5d88d --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetworkPeeringCreateOrUpdate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "peeringName": "vNetPeeringTest", + "api-version": "2018-04-01", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "allowVirtualNetworkAccess": true, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "useRemoteGateways": false + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Updating" + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Databricks/workspaces/adbworkspace/virtualNetworkPeerings/vNetPeeringTest", + "name": "vNetPeeringTest", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/subramantest/providers/Microsoft.Network/virtualNetworks/subramanvnet" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "10.203.0.0/16" + ] + }, + "databricksVirtualNetwork": { + "id": "/subscriptions/0140911e-1040-48da-8bc9-b99fb3dd88a6/resourceGroups/databricks-rg-adbworkspace-2jsxhmzoyooxm/providers/Microsoft.Network/virtualNetworks/workers-vnet" + }, + "databricksAddressSpace": { + "addressPrefixes": [ + "10.139.0.0/16" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Updating" + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetworkPeeringDelete.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetworkPeeringDelete.json new file mode 100644 index 000000000000..fa342ab7d620 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/WorkspaceVirtualNetworkPeeringDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "peeringName": "vNetPeering", + "api-version": "2018-04-01" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} From 4e744672338f604d8f7193c359d340832074e9e6 Mon Sep 17 00:00:00 2001 From: Rahul Singh <53578268+rahuls-microsoft@users.noreply.github.com> Date: Thu, 4 Jun 2020 21:44:43 -0700 Subject: [PATCH 094/318] 1.Breaking Change - Removing duplicate autoQuotaIncreaseState from supportTicketAction. (#9724) 2. Removing state=enabledForPreview. 3. Updating Example. --- .../2019-07-19/examples/getAutoQuotaIncreaseStatus.json | 3 +-- .../preview/2019-07-19/examples/putAutoQuotaIncrease.json | 6 ++---- .../2019-07-19/examples/putAutoQuotaIncreaseTurnOff.json | 2 -- .../Microsoft.Capacity/preview/2019-07-19/quota.json | 7 +------ 4 files changed, 4 insertions(+), 14 deletions(-) diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getAutoQuotaIncreaseStatus.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getAutoQuotaIncreaseStatus.json index 6ac9a3d0a71c..2c23549bb2dc 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getAutoQuotaIncreaseStatus.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getAutoQuotaIncreaseStatus.json @@ -11,7 +11,7 @@ "name": "Automatic Quota Increase", "properties": { "settings": { - "autoQuotaIncreaseState": "enabledForPreview" + "autoQuotaIncreaseState": "enabled" }, "onSuccess": { "emailActions": { @@ -38,7 +38,6 @@ } }, "supportTicketAction": { - "autoQuotaIncreaseState": "enabledForPreview", "severity": "Minimal", "firstName": "FN", "lastName": "LN", diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putAutoQuotaIncrease.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putAutoQuotaIncrease.json index 9dfc190deec2..d8dc24d500d2 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putAutoQuotaIncrease.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putAutoQuotaIncrease.json @@ -5,7 +5,7 @@ "autoQuotaIncreaseRequest": { "properties": { "settings": { - "autoQuotaIncreaseState": "enabledForPreview" + "autoQuotaIncreaseState": "enabled" }, "onSuccess": { "emailActions": { @@ -32,7 +32,6 @@ } }, "supportTicketAction": { - "autoQuotaIncreaseState": "enabledForPreview", "severity": "Minimal", "firstName": "FN", "lastName": "LN", @@ -57,7 +56,7 @@ "name": "Automatic Quota Increase", "properties": { "settings": { - "autoQuotaIncreaseState": "enabledForPreview" + "autoQuotaIncreaseState": "enabled" }, "onSuccess": { "emailActions": { @@ -84,7 +83,6 @@ } }, "supportTicketAction": { - "autoQuotaIncreaseState": "enabledForPreview", "severity": "Minimal", "firstName": "FN", "lastName": "LN", diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putAutoQuotaIncreaseTurnOff.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putAutoQuotaIncreaseTurnOff.json index c7a2af0a7d21..1675b67ccf58 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putAutoQuotaIncreaseTurnOff.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/putAutoQuotaIncreaseTurnOff.json @@ -32,7 +32,6 @@ } }, "supportTicketAction": { - "autoQuotaIncreaseState": "disabled", "severity": "Minimal", "firstName": "FN", "lastName": "LN", @@ -84,7 +83,6 @@ } }, "supportTicketAction": { - "autoQuotaIncreaseState": "disabled", "severity": "Minimal", "firstName": "FN", "lastName": "LN", diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json index e074aac5279f..a2f2557e130f 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/quota.json @@ -927,10 +927,6 @@ "description": "The SupportRequest action.", "type": "object", "properties": { - "autoQuotaIncreaseState": { - "description": "Is support request action enabled.", - "$ref": "#/definitions/AqiState" - }, "severity": { "description": "The support request severity.", "$ref": "#/definitions/SeverityTypes" @@ -997,10 +993,9 @@ } }, "AqiState": { - "description": "The Auto quota increase feature state - enabled: feature is fully enabled, enabledForPreview: feature enabled for preview only, disabled: feature is disabled.", + "description": "The Auto quota increase feature state - enabled: feature is enabled, disabled: feature is disabled.", "enum": [ "enabled", - "enabledForPreview", "disabled" ], "x-ms-enum": { From 09ac2b33d780dbf2f74de2083012f62aaa33c451 Mon Sep 17 00:00:00 2001 From: Zhiyong Yang Date: Fri, 5 Jun 2020 17:39:19 +0800 Subject: [PATCH 095/318] Add sql parallel read properties (#9712) * add httpRequestTimeout to odata based connector activities * add httpRequestTimeout to odata based connector activities * add sql parallel read properties --- .../2018-06-01/entityTypes/Pipeline.json | 71 +++++++++++++++++++ 1 file changed, 71 insertions(+) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json index 3f87eba0a425..bc89fb5b7d7b 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/Pipeline.json @@ -2111,6 +2111,14 @@ "isolationLevel": { "description": "Specifies the transaction locking behavior for the SQL source. Allowed values: ReadCommitted/ReadUncommitted/RepeatableRead/Serializable/Snapshot. The default value is ReadCommitted. Type: string (or Expression with resultType string).", "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" } } }, @@ -2141,6 +2149,14 @@ "produceAdditionalTypes": { "description": "Which additional types to produce.", "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" } } }, @@ -2171,6 +2187,14 @@ "produceAdditionalTypes": { "description": "Which additional types to produce.", "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" } } }, @@ -2201,6 +2225,14 @@ "produceAdditionalTypes": { "description": "Which additional types to produce.", "type": "object" + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" } } }, @@ -2224,9 +2256,48 @@ "storedProcedureParameters": { "type": "object", "description": "Value and type setting for stored procedure parameters. Example: \"{Parameter1: {value: \"1\", type: \"int\"}}\". Type: object (or Expression with resultType object), itemType: StoredProcedureParameter." + }, + "partitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "$ref": "#/definitions/SqlPartitionOption" + }, + "partitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "$ref": "#/definitions/SqlPartitionSettings" } } }, + "SqlPartitionSettings": { + "description": "The settings that will be leveraged for Sql source partitioning.", + "type": "object", + "properties": { + "partitionColumnName": { + "type": "object", + "description": "The name of the column in integer or datetime type that will be used for proceeding partitioning. If not specified, the primary key of the table is auto-detected and used as the partition column. Type: string (or Expression with resultType string)." + }, + "partitionUpperBound": { + "type": "object", + "description": "The maximum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string)." + }, + "partitionLowerBound": { + "type": "object", + "description": "The minimum value of the partition column for partition range splitting. This value is used to decide the partition stride, not for filtering the rows in table. All rows in the table or query result will be partitioned and copied. Type: string (or Expression with resultType string)." + } + } + }, + "SqlPartitionOption": { + "description": "The partition mechanism that will be used for Sql read in parallel.", + "type": "string", + "enum": [ + "None", + "PhysicalPartitionsOfTable", + "DynamicRange" + ], + "x-ms-enum": { + "name": "SqlPartitionOption", + "modelAsString": true + } + }, "FileSystemSource": { "description": "A copy activity file system source.", "type": "object", From 1467080f2f3b1487d5d64683b9e15e71a8e6507d Mon Sep 17 00:00:00 2001 From: Andrew <30499261+areddish@users.noreply.github.com> Date: Fri, 5 Jun 2020 13:47:57 -0400 Subject: [PATCH 096/318] Custom vision 3 3 (#9522) * Establish base from previous version to compare against * Alphabetize paths * API Updates * Add missing error messages * Fix file type * Spelling fix * Run prettier * Update all apis --- .../CustomVision/Prediction/readme.go.md | 10 + .../CustomVision/Prediction/readme.md | 12 +- .../CustomVision/Prediction/readme.ruby.md | 12 + .../Prediction/stable/v3.1/Prediction.json | 922 +++ .../stable/v3.1/examples/ClassifyImage.json | 33 + .../v3.1/examples/ClassifyImageUrl.json | 35 + .../examples/ClassifyImageUrlWithNoStore.json | 35 + .../examples/ClassifyImageWithNoStore.json | 33 + .../stable/v3.1/examples/DetectImage.json | 45 + .../stable/v3.1/examples/DetectImageUrl.json | 47 + .../examples/DetectImageUrlWithNoStore.json | 47 + .../v3.1/examples/DetectImageWithNoStore.json | 45 + .../CustomVision/Training/readme.go.md | 11 + .../CustomVision/Training/readme.md | 14 +- .../CustomVision/Training/readme.ruby.md | 11 + .../Training/stable/v3.3/Training.json | 5606 +++++++++++++++++ .../v3.3/examples/CreateImageRegions.json | 81 + .../stable/v3.3/examples/CreateImageTags.json | 31 + .../v3.3/examples/CreateImagesFromData.json | 94 + .../v3.3/examples/CreateImagesFromFiles.json | 82 + .../examples/CreateImagesFromPredictions.json | 81 + .../v3.3/examples/CreateImagesFromUrls.json | 82 + .../stable/v3.3/examples/CreateProject.json | 26 + .../stable/v3.3/examples/CreateTag.json | 23 + .../v3.3/examples/DeleteImageRegions.json | 14 + .../stable/v3.3/examples/DeleteImageTags.json | 19 + .../stable/v3.3/examples/DeleteImages.json | 16 + .../stable/v3.3/examples/DeleteIteration.json | 12 + .../v3.3/examples/DeletePrediction.json | 15 + .../stable/v3.3/examples/DeleteProject.json | 11 + .../stable/v3.3/examples/DeleteTag.json | 12 + .../stable/v3.3/examples/ExportIteration.json | 21 + .../stable/v3.3/examples/ExportProject.json | 16 + .../stable/v3.3/examples/GetArtifact.json | 14 + .../stable/v3.3/examples/GetDomain.json | 20 + .../stable/v3.3/examples/GetDomains.json | 70 + .../stable/v3.3/examples/GetExports.json | 22 + .../stable/v3.3/examples/GetImageCount.json | 14 + .../examples/GetImagePerformanceCount.json | 18 + .../v3.3/examples/GetImagePerformances.json | 43 + .../examples/GetImageRegionProposals.json | 29 + .../stable/v3.3/examples/GetImages.json | 47 + .../stable/v3.3/examples/GetImagesByIds.json | 15 + .../stable/v3.3/examples/GetIteration.json | 34 + .../examples/GetIterationPerformance.json | 39 + .../stable/v3.3/examples/GetIterations.json | 74 + .../stable/v3.3/examples/GetProject.json | 24 + .../stable/v3.3/examples/GetProjects.json | 25 + .../Training/stable/v3.3/examples/GetTag.json | 21 + .../v3.3/examples/GetTaggedImageCount.json | 15 + .../stable/v3.3/examples/GetTaggedImages.json | 15 + .../stable/v3.3/examples/GetTags.json | 22 + .../v3.3/examples/GetUntaggedImageCount.json | 15 + .../v3.3/examples/GetUntaggedImages.json | 15 + .../stable/v3.3/examples/ImportProject.json | 25 + .../v3.3/examples/PublishIteration.json | 17 + .../v3.3/examples/QueryPredictions.json | 66 + .../examples/QuerySuggestedImageCount.json | 22 + .../v3.3/examples/QuerySuggestedImages.json | 54 + .../stable/v3.3/examples/QuickTestImage.json | 33 + .../v3.3/examples/QuickTestImageUrl.json | 35 + .../v3.3/examples/SuggestTagsAndRegions.json | 39 + .../stable/v3.3/examples/TrainProject.json | 33 + .../v3.3/examples/UnpublishIteration.json | 12 + .../v3.3/examples/UpdateImageMetadata.json | 43 + .../stable/v3.3/examples/UpdateIteration.json | 37 + .../stable/v3.3/examples/UpdateProject.json | 31 + .../stable/v3.3/examples/UpdateTag.json | 26 + 68 files changed, 8613 insertions(+), 5 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/Prediction.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImage.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrl.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrlWithNoStore.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageWithNoStore.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImage.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrl.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrlWithNoStore.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageWithNoStore.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/Training.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageRegions.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageTags.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromData.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromFiles.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromPredictions.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromUrls.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateTag.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageRegions.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageTags.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImages.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeletePrediction.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteTag.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetArtifact.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomain.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomains.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetExports.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageCount.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformanceCount.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformances.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageRegionProposals.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImages.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagesByIds.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterationPerformance.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterations.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProjects.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTag.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImageCount.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImages.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTags.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImageCount.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImages.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ImportProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/PublishIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QueryPredictions.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImageCount.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImages.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImage.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImageUrl.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/SuggestTagsAndRegions.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/TrainProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UnpublishIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateImageMetadata.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateIteration.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateProject.json create mode 100644 specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateTag.json diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md index 279452db4ec0..33b14c7856fe 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.go.md @@ -15,6 +15,7 @@ go: batch: - tag: release_1_0 - tag: release_3_0 + - tag: release_3_1 ``` ### Tag: release_1_0 and go @@ -34,3 +35,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_3_0' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.1/customvision/$(namespace) +``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md index 74cffe566389..1441a4a7fcad 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.md @@ -4,11 +4,11 @@ Configuration for generating Custom Vision Prediction SDK. -The current release is `release_3_0`. +The current release is `release_3_1`. ``` yaml -tag: release_3_0 +tag: release_3_1 openapi-type: data-plane ``` # Releases @@ -28,6 +28,14 @@ input-file: stable/v3.0/Prediction.json add-credentials: true ``` +### Release 3.1 +These settings apply only when `--tag=release_3_1` is specified on the command line. + +``` yaml $(tag) == 'release_3_1' +input-file: stable/v3.1/Prediction.json +add-credentials: true +``` + # Validation ## Suppression diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md index 3adbf19106d6..4e7d49eafbb3 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/readme.ruby.md @@ -14,6 +14,7 @@ azure-arm: true batch: - tag: release_1_0 - tag: release_3_0 + - tag: release_3_1 ``` ### Tag: release_1_0 and ruby @@ -37,3 +38,14 @@ namespace: "Azure::CognitiveServices::CustomVision::Prediction::V3_0" output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvisionprediction/lib title: "PredictionClient" ``` + +### Tag: release_3_1 and ruby + +These settings apply only when `--tag=release_3_1 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_1_0' && $(ruby) +namespace: "Azure::CognitiveServices::CustomVision::Prediction::V3_1" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvisionprediction/lib +title: "PredictionClient" +``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/Prediction.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/Prediction.json new file mode 100644 index 000000000000..4f5dca22f52d --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/Prediction.json @@ -0,0 +1,922 @@ +{ + "swagger": "2.0", + "info": { + "version": "3.1", + "title": "Custom Vision Prediction Client" + }, + "host": "southcentralus.api.cognitive.microsoft.com", + "basePath": "/customvision/v3.1/prediction", + "schemes": [ + "https" + ], + "paths": { + "/{projectId}/classify/iterations/{publishedName}/image": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Classify an image and saves the result.", + "operationId": "ClassifyImage", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "publishedName", + "in": "path", + "description": "Specifies the name of the model to evaluate against.", + "required": true, + "type": "string" + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint.", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful ClassifyImage request": { + "$ref": "./examples/ClassifyImage.json" + } + } + } + }, + "/{projectId}/classify/iterations/{publishedName}/image/nostore": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Classify an image without saving the result.", + "operationId": "ClassifyImageWithNoStore", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "publishedName", + "in": "path", + "description": "Specifies the name of the model to evaluate against.", + "required": true, + "type": "string" + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint.", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful ClassifyImageWithNoStore request": { + "$ref": "./examples/ClassifyImageWithNoStore.json" + } + } + } + }, + "/{projectId}/classify/iterations/{publishedName}/url": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Classify an image url and saves the result.", + "operationId": "ClassifyImageUrl", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "publishedName", + "in": "path", + "description": "Specifies the name of the model to evaluate against.", + "required": true, + "type": "string" + }, + { + "name": "imageUrl", + "in": "body", + "description": "An ImageUrl that contains the url of the image to be evaluated.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint.", + "required": false, + "type": "string", + "x-nullable": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful ClassifyImageUrl request": { + "$ref": "./examples/ClassifyImageUrl.json" + } + } + } + }, + "/{projectId}/classify/iterations/{publishedName}/url/nostore": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Classify an image url without saving the result.", + "operationId": "ClassifyImageUrlWithNoStore", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "publishedName", + "in": "path", + "description": "Specifies the name of the model to evaluate against.", + "required": true, + "type": "string" + }, + { + "name": "imageUrl", + "in": "body", + "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint.", + "required": false, + "type": "string", + "x-nullable": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful ClassifyImageUrlWithNoStore request": { + "$ref": "./examples/ClassifyImageUrlWithNoStore.json" + } + } + } + }, + "/{projectId}/detect/iterations/{publishedName}/image": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Detect objects in an image and saves the result.", + "operationId": "DetectImage", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "publishedName", + "in": "path", + "description": "Specifies the name of the model to evaluate against.", + "required": true, + "type": "string" + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint.", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DetectImage request": { + "$ref": "./examples/DetectImage.json" + } + } + } + }, + "/{projectId}/detect/iterations/{publishedName}/image/nostore": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Detect objects in an image without saving the result.", + "operationId": "DetectImageWithNoStore", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "publishedName", + "in": "path", + "description": "Specifies the name of the model to evaluate against.", + "required": true, + "type": "string" + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint.", + "required": false, + "type": "string", + "x-nullable": true + }, + { + "name": "imageData", + "in": "formData", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 4MB.", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DetectImageWithNoStore request": { + "$ref": "./examples/DetectImageWithNoStore.json" + } + } + } + }, + "/{projectId}/detect/iterations/{publishedName}/url": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Detect objects in an image url and saves the result.", + "operationId": "DetectImageUrl", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "publishedName", + "in": "path", + "description": "Specifies the name of the model to evaluate against.", + "required": true, + "type": "string" + }, + { + "name": "imageUrl", + "in": "body", + "description": "An ImageUrl that contains the url of the image to be evaluated.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint.", + "required": false, + "type": "string", + "x-nullable": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DetectImageUrl request": { + "$ref": "./examples/DetectImageUrl.json" + } + } + } + }, + "/{projectId}/detect/iterations/{publishedName}/url/nostore": { + "post": { + "tags": [ + "ImagePredictionApi" + ], + "summary": "Detect objects in an image url without saving the result.", + "operationId": "DetectImageUrlWithNoStore", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "publishedName", + "in": "path", + "description": "Specifies the name of the model to evaluate against.", + "required": true, + "type": "string" + }, + { + "name": "imageUrl", + "in": "body", + "description": "An {Iris.Web.Api.Models.ImageUrl} that contains the url of the image to be evaluated.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + { + "name": "application", + "in": "query", + "description": "Optional. Specifies the name of application using the endpoint.", + "required": false, + "type": "string", + "x-nullable": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DetectImageUrlWithNoStore request": { + "$ref": "./examples/DetectImageUrlWithNoStore.json" + } + } + } + } + }, + "definitions": { + "BoundingBox": { + "description": "Bounding box that defines a region of an image.", + "required": [ + "left", + "top", + "width", + "height" + ], + "type": "object", + "properties": { + "left": { + "format": "float", + "description": "Coordinate of the left boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "top": { + "format": "float", + "description": "Coordinate of the top boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "width": { + "format": "float", + "description": "Width.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "height": { + "format": "float", + "description": "Height.", + "type": "number", + "readOnly": false, + "x-nullable": false + } + } + }, + "CustomVisionError": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "enum": [ + "NoError", + "BadRequest", + "BadRequestExceededBatchSize", + "BadRequestNotSupported", + "BadRequestInvalidIds", + "BadRequestProjectName", + "BadRequestProjectNameNotUnique", + "BadRequestProjectDescription", + "BadRequestProjectUnknownDomain", + "BadRequestProjectUnknownClassification", + "BadRequestProjectUnsupportedDomainTypeChange", + "BadRequestProjectUnsupportedExportPlatform", + "BadRequestProjectImagePreprocessingSettings", + "BadRequestProjectDuplicated", + "BadRequestIterationName", + "BadRequestIterationNameNotUnique", + "BadRequestIterationDescription", + "BadRequestIterationIsNotTrained", + "BadRequestIterationValidationFailed", + "BadRequestWorkspaceCannotBeModified", + "BadRequestWorkspaceNotDeletable", + "BadRequestTagName", + "BadRequestTagNameNotUnique", + "BadRequestTagDescription", + "BadRequestTagType", + "BadRequestMultipleNegativeTag", + "BadRequestMultipleGeneralProductTag", + "BadRequestImageTags", + "BadRequestImageRegions", + "BadRequestNegativeAndRegularTagOnSameImage", + "BadRequestUnsupportedDomain", + "BadRequestRequiredParamIsNull", + "BadRequestIterationIsPublished", + "BadRequestInvalidPublishName", + "BadRequestInvalidPublishTarget", + "BadRequestUnpublishFailed", + "BadRequestIterationNotPublished", + "BadRequestSubscriptionApi", + "BadRequestExceedProjectLimit", + "BadRequestExceedIterationPerProjectLimit", + "BadRequestExceedTagPerProjectLimit", + "BadRequestExceedTagPerImageLimit", + "BadRequestExceededQuota", + "BadRequestCannotMigrateProjectWithName", + "BadRequestNotLimitedTrial", + "BadRequestImageBatch", + "BadRequestImageStream", + "BadRequestImageUrl", + "BadRequestImageFormat", + "BadRequestImageSizeBytes", + "BadRequestImageDimensions", + "BadRequestImageExceededCount", + "BadRequestTrainingNotNeeded", + "BadRequestTrainingNotNeededButTrainingPipelineUpdated", + "BadRequestTrainingValidationFailed", + "BadRequestClassificationTrainingValidationFailed", + "BadRequestMultiClassClassificationTrainingValidationFailed", + "BadRequestMultiLabelClassificationTrainingValidationFailed", + "BadRequestDetectionTrainingValidationFailed", + "BadRequestTrainingAlreadyInProgress", + "BadRequestDetectionTrainingNotAllowNegativeTag", + "BadRequestInvalidEmailAddress", + "BadRequestDomainNotSupportedForAdvancedTraining", + "BadRequestExportPlatformNotSupportedForAdvancedTraining", + "BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining", + "BadRequestExportValidationFailed", + "BadRequestExportAlreadyInProgress", + "BadRequestPredictionIdsMissing", + "BadRequestPredictionIdsExceededCount", + "BadRequestPredictionTagsExceededCount", + "BadRequestPredictionResultsExceededCount", + "BadRequestPredictionInvalidApplicationName", + "BadRequestPredictionInvalidQueryParameters", + "BadRequestInvalidImportToken", + "BadRequestExportWhileTraining", + "BadRequestImageMetadataKey", + "BadRequestImageMetadataValue", + "BadRequestOperationNotSupported", + "BadRequestInvalidArtifactUri", + "BadRequestCustomerManagedKeyRevoked", + "BadRequestInvalid", + "UnsupportedMediaType", + "Forbidden", + "ForbiddenUser", + "ForbiddenUserResource", + "ForbiddenUserSignupDisabled", + "ForbiddenUserSignupAllowanceExceeded", + "ForbiddenUserDoesNotExist", + "ForbiddenUserDisabled", + "ForbiddenUserInsufficientCapability", + "ForbiddenDRModeEnabled", + "ForbiddenInvalid", + "NotFound", + "NotFoundProject", + "NotFoundProjectDefaultIteration", + "NotFoundIteration", + "NotFoundIterationPerformance", + "NotFoundTag", + "NotFoundImage", + "NotFoundDomain", + "NotFoundApimSubscription", + "NotFoundInvalid", + "Conflict", + "ConflictInvalid", + "ErrorUnknown", + "ErrorIterationCopyFailed", + "ErrorPreparePerformanceMigrationFailed", + "ErrorProjectInvalidWorkspace", + "ErrorProjectInvalidPipelineConfiguration", + "ErrorProjectInvalidDomain", + "ErrorProjectTrainingRequestFailed", + "ErrorProjectImportRequestFailed", + "ErrorProjectExportRequestFailed", + "ErrorFeaturizationServiceUnavailable", + "ErrorFeaturizationQueueTimeout", + "ErrorFeaturizationInvalidFeaturizer", + "ErrorFeaturizationAugmentationUnavailable", + "ErrorFeaturizationUnrecognizedJob", + "ErrorFeaturizationAugmentationError", + "ErrorExporterInvalidPlatform", + "ErrorExporterInvalidFeaturizer", + "ErrorExporterInvalidClassifier", + "ErrorPredictionServiceUnavailable", + "ErrorPredictionModelNotFound", + "ErrorPredictionModelNotCached", + "ErrorPrediction", + "ErrorPredictionStorage", + "ErrorRegionProposal", + "ErrorUnknownBaseModel", + "ErrorInvalid" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomVisionErrorCodes", + "modelAsString": true + } + }, + "message": { + "description": "A message explaining the error reported by the service.", + "type": "string" + } + } + }, + "ImagePrediction": { + "description": "Result of an image prediction request.", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Prediction Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "project": { + "format": "uuid", + "description": "Project Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "iteration": { + "format": "uuid", + "description": "Iteration Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "description": "Date this prediction was created.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "predictions": { + "description": "List of predictions.", + "type": "array", + "items": { + "$ref": "#/definitions/Prediction", + "x-nullable": false + }, + "readOnly": true + } + } + }, + "ImageUrl": { + "description": "Image url.", + "required": [ + "url" + ], + "type": "object", + "properties": { + "url": { + "description": "Url of the image.", + "type": "string", + "readOnly": false, + "x-nullable": false + } + } + }, + "Prediction": { + "description": "Prediction result.", + "type": "object", + "properties": { + "probability": { + "format": "float", + "description": "Probability of the tag.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "description": "Id of the predicted tag.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "description": "Name of the predicted tag.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "boundingBox": { + "$ref": "#/definitions/BoundingBox", + "description": "Bounding box of the prediction.", + "readOnly": true, + "x-nullable": true + }, + "tagType": { + "description": "Type of the predicted tag.", + "enum": [ + "Regular", + "Negative", + "GeneralProduct" + ], + "type": "string", + "readOnly": true, + "x-nullable": true, + "x-ms-enum": { + "name": "TagType", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Prediction-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImage.json new file mode 100644 index 000000000000..92c8f66b7eec --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImage.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "publishedName": "MyModel1", + "imageData": "multipart-form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2019-03-06T02:15:00Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrl.json new file mode 100644 index 000000000000..a73984bd908b --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrl.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "publishedName": "MyModel1", + "imageUrl": { + "url": "{Image URL}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2019-03-06T02:15:00Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrlWithNoStore.json new file mode 100644 index 000000000000..a73984bd908b --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageUrlWithNoStore.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "publishedName": "MyModel1", + "imageUrl": { + "url": "{Image URL}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2019-03-06T02:15:00Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageWithNoStore.json new file mode 100644 index 000000000000..92c8f66b7eec --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/ClassifyImageWithNoStore.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "publishedName": "MyModel1", + "imageData": "multipart-form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2019-03-06T02:15:00Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.000193528482 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImage.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImage.json new file mode 100644 index 000000000000..53c02746507d --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImage.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "publishedName": "MyModel1", + "imageData": "multipart-form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1", + "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1", + "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957", + "created": "2019-03-10T06:10:28Z", + "predictions": [ + { + "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75", + "tagName": "Tag 1", + "probability": 0.05149666, + "boundingBox": { + "left": 0.955476165, + "top": 0, + "width": 0.0412225723, + "height": 0.156851858 + } + }, + { + "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8", + "tagName": "Tag 2", + "probability": 0.000193528482, + "boundingBox": { + "left": 0.062178582, + "top": 0, + "width": 0.9378114, + "height": 0.6830492 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrl.json new file mode 100644 index 000000000000..2b133a020f80 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrl.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "publishedName": "MyModel1", + "imageUrl": { + "url": "{Image URL}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1", + "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1", + "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957", + "created": "2019-03-10T06:10:28Z", + "predictions": [ + { + "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75", + "tagName": "Tag 1", + "probability": 0.05149666, + "boundingBox": { + "left": 0.955476165, + "top": 0, + "width": 0.0412225723, + "height": 0.156851858 + } + }, + { + "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8", + "tagName": "Tag 2", + "probability": 0.000193528482, + "boundingBox": { + "left": 0.062178582, + "top": 0, + "width": 0.9378114, + "height": 0.6830492 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrlWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrlWithNoStore.json new file mode 100644 index 000000000000..2b133a020f80 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageUrlWithNoStore.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "publishedName": "MyModel1", + "imageUrl": { + "url": "{Image URL}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1", + "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1", + "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957", + "created": "2019-03-10T06:10:28Z", + "predictions": [ + { + "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75", + "tagName": "Tag 1", + "probability": 0.05149666, + "boundingBox": { + "left": 0.955476165, + "top": 0, + "width": 0.0412225723, + "height": 0.156851858 + } + }, + { + "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8", + "tagName": "Tag 2", + "probability": 0.000193528482, + "boundingBox": { + "left": 0.062178582, + "top": 0, + "width": 0.9378114, + "height": 0.6830492 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageWithNoStore.json b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageWithNoStore.json new file mode 100644 index 000000000000..53c02746507d --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Prediction/stable/v3.1/examples/DetectImageWithNoStore.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Prediction-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "publishedName": "MyModel1", + "imageData": "multipart-form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "64615ba1-b53f-e911-b05b-f8633f7a2ef1", + "project": "fb5bc587-b53f-e911-b05b-f8633f7a2ef1", + "iteration": "45c79472-7198-46e1-8ed7-bad2ca111957", + "created": "2019-03-10T06:10:28Z", + "predictions": [ + { + "tagId": "7e703b80-3c7a-4c3c-bf48-9673c6891a75", + "tagName": "Tag 1", + "probability": 0.05149666, + "boundingBox": { + "left": 0.955476165, + "top": 0, + "width": 0.0412225723, + "height": 0.156851858 + } + }, + { + "tagId": "a0d06a54-18e4-4787-a9f9-27a9c13a91e8", + "tagName": "Tag 2", + "probability": 0.000193528482, + "boundingBox": { + "left": 0.062178582, + "top": 0, + "width": 0.9378114, + "height": 0.6830492 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md index 14bda8dd8dca..c61b06fde524 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.go.md @@ -19,6 +19,8 @@ batch: - tag: release_2_2 - tag: release_3_0 - tag: release_3_1 + - tag: release_3_2 + - tag: release_3_3 ``` ### Tag: release_1_0 and go @@ -73,4 +75,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_3_3' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v3.3/customvision/$(namespace) ``` \ No newline at end of file diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md index c27680fff689..c24589d79dc3 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.md @@ -4,11 +4,11 @@ Configuration for generating Custom Vision Training SDK. -The current release is `release_3_2`. +The current release is `release_3_3`. ``` yaml -tag: release_3_2 +tag: release_3_3 openapi-type: data-plane ``` # Releases @@ -56,6 +56,14 @@ input-file: stable/v3.2/Training.json add-credentials: true ``` +### Release 3.3 +These settings apply only when `--tag=release_3_3` is specified on the command line. + +``` yaml $(tag) == 'release_3_3' +input-file: stable/v3.3/Training.json +add-credentials: true +``` + # Validation ## Suppression @@ -163,7 +171,7 @@ input-file: - $(this-folder)/stable/v3.0/Training.json - $(this-folder)/stable/v3.1/Training.json - $(this-folder)/stable/v3.2/Training.json - + - $(this-folder)/stable/v3.3/Training.json ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md index 65b84d38d255..517819d1250a 100644 --- a/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/readme.ruby.md @@ -16,6 +16,7 @@ batch: - tag: release_3_0 - tag: release_3_1 - tag: release_3_2 + - tag: release_3_3 ``` ### Tag: release_1_0 and ruby @@ -62,3 +63,13 @@ output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvisiontrai title: "TrainingClient" ``` +### Tag: release_3_3 and ruby + +These settings apply only when `--tag=release_3_3 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'release_3_3' && $(ruby) +namespace: "Azure::CognitiveServices::CustomVision::Training::V3_3" +output-folder: $(ruby-sdks-folder)/data/azure_cognitiveservices_customvisiontraining/lib +title: "TrainingClient" +``` diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/Training.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/Training.json new file mode 100644 index 000000000000..90ef38fb562b --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/Training.json @@ -0,0 +1,5606 @@ +{ + "swagger": "2.0", + "info": { + "version": "3.3", + "title": "Custom Vision Training Client" + }, + "host": "southcentralus.api.cognitive.microsoft.com", + "basePath": "/customvision/v3.3/training", + "schemes": [ + "https" + ], + "paths": { + "/domains": { + "get": { + "tags": [ + "DomainsApi" + ], + "summary": "Get a list of the available domains.", + "operationId": "GetDomains", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Domain" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetDomains request": { + "$ref": "./examples/GetDomains.json" + } + } + } + }, + "/domains/{domainId}": { + "get": { + "tags": [ + "DomainsApi" + ], + "summary": "Get information about a specific domain.", + "operationId": "GetDomain", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "domainId", + "in": "path", + "description": "The id of the domain to get information about.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Domain" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetDomain request": { + "$ref": "./examples/GetDomain.json" + } + } + } + }, + "/projects": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get your projects.", + "operationId": "GetProjects", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Project" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetProjects request": { + "$ref": "./examples/GetProjects.json" + } + } + }, + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Create a project.", + "operationId": "CreateProject", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "name", + "in": "query", + "description": "Name of the project.", + "required": true, + "type": "string" + }, + { + "name": "description", + "in": "query", + "description": "The description of the project.", + "required": false, + "type": "string" + }, + { + "name": "domainId", + "in": "query", + "description": "The id of the domain to use for this project. Defaults to General.", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "classificationType", + "in": "query", + "description": "The type of classifier to create for this project.", + "required": false, + "type": "string", + "enum": [ + "Multiclass", + "Multilabel" + ] + }, + { + "name": "targetExportPlatforms", + "in": "query", + "description": "List of platforms the trained model is intending exporting to.", + "required": false, + "type": "array", + "items": { + "type": "string", + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX", + "VAIDK" + ] + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful CreateProject request": { + "$ref": "./examples/CreateProject.json" + } + } + } + }, + "/projects/{projectId}": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get a specific project.", + "operationId": "GetProject", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The id of the project to get.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetProject request": { + "$ref": "./examples/GetProject.json" + } + } + }, + "delete": { + "tags": [ + "ProjectApi" + ], + "summary": "Delete a specific project.", + "operationId": "DeleteProject", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DeleteProject request": { + "$ref": "./examples/DeleteProject.json" + } + } + }, + "patch": { + "tags": [ + "ProjectApi" + ], + "summary": "Update a specific project.", + "operationId": "UpdateProject", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The id of the project to update.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "updatedProject", + "in": "body", + "description": "The updated project model.", + "required": true, + "schema": { + "$ref": "#/definitions/Project" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful UpdateProject request": { + "$ref": "./examples/UpdateProject.json" + } + } + } + }, + "/projects/{projectId}/artifacts": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get artifact content from blob storage, based on artifact relative path in the blob.", + "operationId": "GetArtifact", + "consumes": [], + "produces": [ + "application/octet-stream" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "path", + "in": "query", + "description": "The relative path for artifact.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "file" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetArtifact request": { + "$ref": "./examples/GetArtifact.json" + } + } + } + }, + "/projects/{projectId}/export": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Exports a project.", + "operationId": "ExportProject", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id of the project to export.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProjectExport" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful ExportProject request": { + "$ref": "./examples/ExportProject.json" + } + } + } + }, + "/projects/{projectId}/images": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Get images for a given project iteration or workspace.", + "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\r\nThe filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned", + "operationId": "GetImages", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "tagIds", + "in": "query", + "description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 20, + "minItems": 0 + }, + { + "name": "taggingStatus", + "in": "query", + "description": "The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.", + "required": false, + "type": "string", + "enum": [ + "All", + "Tagged", + "Untagged" + ] + }, + { + "name": "$filter", + "in": "query", + "description": "An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response.\r\nThe expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators.\r\nHere is an example, metadata=key1 eq 'value1' and key2 ne 'value2'.", + "required": false, + "type": "string" + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest.", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ] + }, + { + "name": "take", + "in": "query", + "description": "Maximum number of images to return. Defaults to 50, limited to 256.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 256, + "minimum": 0 + }, + { + "name": "skip", + "in": "query", + "description": "Number of images to skip before beginning the image batch. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetImages request": { + "$ref": "./examples/GetImages.json" + } + } + }, + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Add the provided images to the set of training images.", + "description": "This API accepts body content as multipart/form-data and application/octet-stream. When using multipart\r\nmultiple image files can be sent at once, with a maximum of 64 files.\r\nIf all images are successful created, 200(OK) status code will be returned.\r\nOtherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.", + "operationId": "CreateImagesFromData", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagIds", + "in": "query", + "description": "The tags ids with which to tag each image. Limited to 20.", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 20, + "minItems": 0 + }, + { + "name": "imageData", + "in": "formData", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + }, + "207": { + "description": "207", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromData request": { + "$ref": "./examples/CreateImagesFromData.json" + } + } + }, + "delete": { + "tags": [ + "ImageApi" + ], + "summary": "Delete images from the set of training images.", + "operationId": "DeleteImages", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageIds", + "in": "query", + "description": "Ids of the images to be deleted. Limited to 256 images per batch.", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 256, + "minItems": 0 + }, + { + "name": "allImages", + "in": "query", + "description": "Flag to specify delete all images, specify this flag or a list of images. Using this flag will return a 202 response to indicate the images are being deleted.", + "required": false, + "type": "boolean" + }, + { + "name": "allIterations", + "in": "query", + "description": "Removes these images from all iterations, not just the current workspace. Using this flag will return a 202 response to indicate the images are being deleted.", + "required": false, + "type": "boolean" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DeleteImages request": { + "$ref": "./examples/DeleteImages.json" + } + } + } + }, + "/projects/{projectId}/images/{imageId}/regionproposals": { + "post": { + "tags": [ + "ImageRegionProposalApi" + ], + "summary": "Get region proposals for an image. Returns empty array if no proposals are found.", + "description": "This API will get region proposals for an image along with confidences for the region. It returns an empty array if no proposals are found.", + "operationId": "GetImageRegionProposals", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageId", + "in": "path", + "description": "The image id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageRegionProposal" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetImageRegionProposals request": { + "$ref": "./examples/GetImageRegionProposals.json" + } + } + } + }, + "/projects/{projectId}/images/count": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Get the number of images.", + "description": "The filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned", + "operationId": "GetImageCount", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "taggingStatus", + "in": "query", + "description": "The tagging status filter. It can be 'All', 'Tagged', or 'Untagged'. Defaults to 'All'.", + "required": false, + "type": "string", + "enum": [ + "All", + "Tagged", + "Untagged" + ] + }, + { + "name": "$filter", + "in": "query", + "description": "An expression to filter the images against image metadata. Only images where the expression evaluates to true are included in the response.\r\nThe expression supports eq (Equal), ne (Not equal), and (Logical and), or (Logical or) operators.\r\nHere is an example, metadata=key1 eq 'value1' and key2 ne 'value2'.", + "required": false, + "type": "string" + }, + { + "name": "tagIds", + "in": "query", + "description": "A list of tags ids to filter the images to count. Defaults to all tags when null.", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetImageCount request": { + "$ref": "./examples/GetImageCount.json" + } + } + } + }, + "/projects/{projectId}/images/files": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Add the provided batch of images to the set of training images.", + "description": "This API accepts a batch of files, and optionally tags, to create images. There is a limit of 64 images and 20 tags.\r\nIf all images are successful created, 200(OK) status code will be returned.\r\nOtherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.", + "operationId": "CreateImagesFromFiles", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "batch", + "in": "body", + "description": "The batch of image files to add. Limited to 64 images and 20 tags per batch.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageFileCreateBatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + }, + "207": { + "description": "207", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromFiles request": { + "$ref": "./examples/CreateImagesFromFiles.json" + } + } + } + }, + "/projects/{projectId}/images/id": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Get images by id for a given project iteration.", + "description": "This API will return a set of Images for the specified tags and optionally iteration. If no iteration is specified the\r\ncurrent workspace is used.", + "operationId": "GetImagesByIds", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageIds", + "in": "query", + "description": "The list of image ids to retrieve. Limited to 256.", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 256, + "minItems": 0 + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetImagesByIds request": { + "$ref": "./examples/GetImagesByIds.json" + } + } + } + }, + "/projects/{projectId}/images/metadata": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Update metadata of images.", + "description": "This API accepts a batch of image Ids, and metadata, to update images. There is a limit of 64 images.", + "operationId": "UpdateImageMetadata", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageIds", + "in": "query", + "description": "The list of image ids to update. Limited to 64.", + "required": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 256, + "minItems": 0 + }, + { + "name": "metadata", + "in": "body", + "description": "The metadata to be updated to the specified images. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.", + "required": true, + "schema": { + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageMetadataUpdateSummary" + } + }, + "207": { + "description": "207", + "schema": { + "$ref": "#/definitions/ImageMetadataUpdateSummary" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful UpdateImageMetadata request": { + "$ref": "./examples/UpdateImageMetadata.json" + } + } + } + }, + "/projects/{projectId}/images/predictions": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Add the specified predicted images to the set of training images.", + "description": "This API creates a batch of images from predicted images specified. There is a limit of 64 images and 20 tags.\r\nIf all images are successful created, 200(OK) status code will be returned.\r\nOtherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.", + "operationId": "CreateImagesFromPredictions", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "batch", + "in": "body", + "description": "Image, tag ids, and metadata. Limited to 64 images and 20 tags per batch.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageIdCreateBatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + }, + "207": { + "description": "207", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromPredictions request": { + "$ref": "./examples/CreateImagesFromPredictions.json" + } + } + } + }, + "/projects/{projectId}/images/regions": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Create a set of image regions.", + "description": "This API accepts a batch of image regions, and optionally tags, to update existing images with region information.\r\nThere is a limit of 64 entries in the batch.\r\nIf all regions are successful created, 200(OK) status code will be returned.\r\nOtherwise, 207 (Multi-Status) status code will be returned and detail status for each region will be listed in the response payload.", + "operationId": "CreateImageRegions", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "batch", + "in": "body", + "description": "Batch of image regions which include a tag and bounding box. Limited to 64.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageRegionCreateBatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageRegionCreateSummary" + } + }, + "207": { + "description": "207", + "schema": { + "$ref": "#/definitions/ImageRegionCreateSummary" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful CreateImageRegions request": { + "$ref": "./examples/CreateImageRegions.json" + } + } + }, + "delete": { + "tags": [ + "ImageApi" + ], + "summary": "Delete a set of image regions.", + "operationId": "DeleteImageRegions", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "regionIds", + "in": "query", + "description": "Regions to delete. Limited to 64.", + "required": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 64, + "minItems": 0 + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DeleteImageRegions request": { + "$ref": "./examples/DeleteImageRegions.json" + } + } + } + }, + "/projects/{projectId}/images/suggested": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Get untagged images whose suggested tags match given tags. Returns empty array if no images are found.", + "description": "This API will fetch untagged images filtered by suggested tags Ids. It returns an empty array if no images are found.", + "operationId": "QuerySuggestedImages", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "IterationId to use for the suggested tags and regions.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "query", + "in": "body", + "description": "Contains properties we need to query suggested images.", + "required": true, + "schema": { + "$ref": "#/definitions/SuggestedTagAndRegionQueryToken" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SuggestedTagAndRegionQuery" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful QuerySuggestedImages request": { + "$ref": "./examples/QuerySuggestedImages.json" + } + } + } + }, + "/projects/{projectId}/images/suggested/count": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Get count of images whose suggested tags match given tags and their probabilities are greater than or equal to the given threshold. Returns count as 0 if none found.", + "description": "This API takes in tagIds to get count of untagged images per suggested tags for a given threshold.", + "operationId": "QuerySuggestedImageCount", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "IterationId to use for the suggested tags and regions.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "query", + "in": "body", + "description": "Model that contains tagIds, threshold and projectType to query by.", + "required": true, + "schema": { + "$ref": "#/definitions/TagFilter" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "object", + "additionalProperties": { + "format": "int32", + "type": "integer" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful QuerySuggestedImageCount request": { + "$ref": "./examples/QuerySuggestedImageCount.json" + } + } + } + }, + "/projects/{projectId}/images/tagged": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Get tagged images for a given project iteration.", + "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\r\nThe filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned", + "operationId": "GetTaggedImages", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "tagIds", + "in": "query", + "description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 20, + "minItems": 0 + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest.", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ] + }, + { + "name": "take", + "in": "query", + "description": "Maximum number of images to return. Defaults to 50, limited to 256.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 256, + "minimum": 0 + }, + { + "name": "skip", + "in": "query", + "description": "Number of images to skip before beginning the image batch. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetTaggedImages request": { + "$ref": "./examples/GetTaggedImages.json" + } + } + } + }, + "/projects/{projectId}/images/tagged/count": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Gets the number of images tagged with the provided {tagIds}.", + "description": "The filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned", + "operationId": "GetTaggedImageCount", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "tagIds", + "in": "query", + "description": "A list of tags ids to filter the images to count. Defaults to all tags when null.", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetTaggedImageCount request": { + "$ref": "./examples/GetTaggedImageCount.json" + } + } + } + }, + "/projects/{projectId}/images/tags": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Associate a set of images with a set of tags.", + "operationId": "CreateImageTags", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "batch", + "in": "body", + "description": "Batch of image tags. Limited to 128 tags per batch.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageTagCreateBatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageTagCreateSummary" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful CreateImageTags request": { + "$ref": "./examples/CreateImageTags.json" + } + } + }, + "delete": { + "tags": [ + "ImageApi" + ], + "summary": "Remove a set of tags from a set of images.", + "operationId": "DeleteImageTags", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageIds", + "in": "query", + "description": "Image ids. Limited to 64 images.", + "required": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 64, + "minItems": 0 + }, + { + "name": "tagIds", + "in": "query", + "description": "Tags to be deleted from the specified images. Limited to 20 tags.", + "required": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 20, + "minItems": 0 + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DeleteImageTags request": { + "$ref": "./examples/DeleteImageTags.json" + } + } + } + }, + "/projects/{projectId}/images/untagged": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Get untagged images for a given project iteration.", + "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.", + "operationId": "GetUntaggedImages", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest.", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ] + }, + { + "name": "take", + "in": "query", + "description": "Maximum number of images to return. Defaults to 50, limited to 256.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 256, + "minimum": 0 + }, + { + "name": "skip", + "in": "query", + "description": "Number of images to skip before beginning the image batch. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetUntaggedImages request": { + "$ref": "./examples/GetUntaggedImages.json" + } + } + } + }, + "/projects/{projectId}/images/untagged/count": { + "get": { + "tags": [ + "ImageApi" + ], + "summary": "Gets the number of untagged images.", + "description": "This API returns the images which have no tags for a given project and optionally an iteration. If no iteration is specified the\r\ncurrent workspace is used.", + "operationId": "GetUntaggedImageCount", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetUntaggedImageCount request": { + "$ref": "./examples/GetUntaggedImageCount.json" + } + } + } + }, + "/projects/{projectId}/images/urls": { + "post": { + "tags": [ + "ImageApi" + ], + "summary": "Add the provided images urls to the set of training images.", + "description": "This API accepts a batch of urls, and optionally tags, to create images. There is a limit of 64 images and 20 tags.\r\nIf all images are successful created, 200(OK) status code will be returned.\r\nOtherwise, 207 (Multi-Status) status code will be returned and detail status for each image will be listed in the response payload.", + "operationId": "CreateImagesFromUrls", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "batch", + "in": "body", + "description": "Image urls, tag ids, and metadata. Limited to 64 images and 20 tags per batch.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrlCreateBatch" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + }, + "207": { + "description": "207", + "schema": { + "$ref": "#/definitions/ImageCreateSummary" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful CreateImagesFromUrls request": { + "$ref": "./examples/CreateImagesFromUrls.json" + } + } + } + }, + "/projects/{projectId}/iterations": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get iterations for the project.", + "operationId": "GetIterations", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Iteration" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetIterations request": { + "$ref": "./examples/GetIterations.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get a specific iteration.", + "operationId": "GetIteration", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The id of the project the iteration belongs to.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The id of the iteration to get.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetIteration request": { + "$ref": "./examples/GetIteration.json" + } + } + }, + "delete": { + "tags": [ + "ProjectApi" + ], + "summary": "Delete a specific iteration of a project.", + "operationId": "DeleteIteration", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DeleteIteration request": { + "$ref": "./examples/DeleteIteration.json" + } + } + }, + "patch": { + "tags": [ + "ProjectApi" + ], + "summary": "Update a specific iteration.", + "operationId": "UpdateIteration", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "Project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "Iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "updatedIteration", + "in": "body", + "description": "The updated iteration model.", + "required": true, + "schema": { + "$ref": "#/definitions/Iteration" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful UpdateIteration request": { + "$ref": "./examples/UpdateIteration.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/export": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get the list of exports for a specific iteration.", + "operationId": "GetExports", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Export" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetExports request": { + "$ref": "./examples/GetExports.json" + } + } + }, + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Export a trained iteration.", + "operationId": "ExportIteration", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "platform", + "in": "query", + "description": "The target platform.", + "required": true, + "type": "string", + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX", + "VAIDK" + ] + }, + { + "name": "flavor", + "in": "query", + "description": "The flavor of the target platform.", + "required": false, + "type": "string", + "enum": [ + "Linux", + "Windows", + "ONNX10", + "ONNX12", + "ARM", + "TensorFlowNormal", + "TensorFlowLite" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful ExportIteration request": { + "$ref": "./examples/ExportIteration.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/performance": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get detailed performance information about an iteration.", + "operationId": "GetIterationPerformance", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The id of the project the iteration belongs to.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The id of the iteration to get.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "threshold", + "in": "query", + "description": "The threshold used to determine true predictions.", + "required": false, + "type": "number", + "format": "float" + }, + { + "name": "overlapThreshold", + "in": "query", + "description": "If applicable, the bounding box overlap threshold used to determine true predictions.", + "required": false, + "type": "number", + "format": "float" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IterationPerformance" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetIterationPerformance request": { + "$ref": "./examples/GetIterationPerformance.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/performance/images": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Get image with its prediction for a given project iteration.", + "description": "This API supports batching and range selection. By default it will only return first 50 images matching images.\r\nUse the {take} and {skip} parameters to control how many images to return in a given batch.\r\nThe filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned", + "operationId": "GetImagePerformances", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id. Defaults to workspace.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagIds", + "in": "query", + "description": "A list of tags ids to filter the images. Defaults to all tagged images when null. Limited to 20.", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 20, + "minItems": 0 + }, + { + "name": "orderBy", + "in": "query", + "description": "The ordering. Defaults to newest.", + "required": false, + "type": "string", + "enum": [ + "Newest", + "Oldest" + ] + }, + { + "name": "take", + "in": "query", + "description": "Maximum number of images to return. Defaults to 50, limited to 256.", + "required": false, + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 256, + "minimum": 0 + }, + { + "name": "skip", + "in": "query", + "description": "Number of images to skip before beginning the image batch. Defaults to 0.", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/ImagePerformance" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetImagePerformances request": { + "$ref": "./examples/GetImagePerformances.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/performance/images/count": { + "get": { + "tags": [ + "ProjectApi" + ], + "summary": "Gets the number of images tagged with the provided {tagIds} that have prediction results from\r\ntraining for the provided iteration {iterationId}.", + "description": "The filtering is on an and/or relationship. For example, if the provided tag ids are for the \"Dog\" and\r\n\"Cat\" tags, then only images tagged with Dog and/or Cat will be returned", + "operationId": "GetImagePerformanceCount", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id. Defaults to workspace.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagIds", + "in": "query", + "description": "A list of tags ids to filter the images to count. Defaults to all tags when null.", + "required": false, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "format": "int32", + "type": "integer" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetImagePerformanceCount request": { + "$ref": "./examples/GetImagePerformanceCount.json" + } + } + } + }, + "/projects/{projectId}/iterations/{iterationId}/publish": { + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Publish a specific iteration.", + "operationId": "PublishIteration", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "publishName", + "in": "query", + "description": "The name to give the published iteration.", + "required": true, + "type": "string" + }, + { + "name": "predictionId", + "in": "query", + "description": "The id of the prediction resource to publish to.", + "required": true, + "type": "string" + }, + { + "name": "overwrite", + "in": "query", + "description": "Whether to overwrite the published model with the given name (default: false).", + "required": false, + "type": "boolean" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "boolean" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful PublishIteration request": { + "$ref": "./examples/PublishIteration.json" + } + } + }, + "delete": { + "tags": [ + "ProjectApi" + ], + "summary": "Unpublish a specific iteration.", + "operationId": "UnpublishIteration", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "path", + "description": "The iteration id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful UnpublishIteration request": { + "$ref": "./examples/UnpublishIteration.json" + } + } + } + }, + "/projects/{projectId}/predictions": { + "delete": { + "tags": [ + "PredictionsApi" + ], + "summary": "Delete a set of predicted images and their associated prediction results.", + "operationId": "DeletePrediction", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "ids", + "in": "query", + "description": "The prediction ids. Limited to 64.", + "required": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 64, + "minItems": 0 + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DeletePrediction request": { + "$ref": "./examples/DeletePrediction.json" + } + } + } + }, + "/projects/{projectId}/predictions/query": { + "post": { + "tags": [ + "PredictionsApi" + ], + "summary": "Get images that were sent to your prediction endpoint.", + "operationId": "QueryPredictions", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "query", + "in": "body", + "description": "Parameters used to query the predictions. Limited to combining 2 tags.", + "required": true, + "schema": { + "$ref": "#/definitions/PredictionQueryToken" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PredictionQueryResult" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful QueryPredictions request": { + "$ref": "./examples/QueryPredictions.json" + } + } + } + }, + "/projects/{projectId}/quicktest/image": { + "post": { + "tags": [ + "PredictionsApi" + ], + "summary": "Quick test an image.", + "operationId": "QuickTestImage", + "consumes": [ + "multipart/form-data", + "application/octet-stream" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "Optional. Specifies the id of a particular iteration to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "store", + "in": "query", + "description": "Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.", + "required": false, + "type": "boolean", + "default": true + }, + { + "name": "imageData", + "in": "formData", + "description": "Binary image data. Supported formats are JPEG, GIF, PNG, and BMP. Supports images up to 6MB.", + "required": true, + "type": "file" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful QuickTestImage request": { + "$ref": "./examples/QuickTestImage.json" + } + } + } + }, + "/projects/{projectId}/quicktest/url": { + "post": { + "tags": [ + "PredictionsApi" + ], + "summary": "Quick test an image url.", + "operationId": "QuickTestImageUrl", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project to evaluate against.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageUrl", + "in": "body", + "description": "An ImageUrl that contains the url of the image to be evaluated.", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUrl" + } + }, + { + "name": "iterationId", + "in": "query", + "description": "Optional. Specifies the id of a particular iteration to evaluate against.\r\n The default iteration for the project will be used when not specified.", + "required": false, + "type": "string", + "format": "uuid" + }, + { + "name": "store", + "in": "query", + "description": "Optional. Specifies whether or not to store the result of this prediction. The default is true, to store.", + "required": false, + "type": "boolean", + "default": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImagePrediction" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful QuickTestImageUrl request": { + "$ref": "./examples/QuickTestImageUrl.json" + } + } + } + }, + "/projects/{projectId}/tags": { + "get": { + "tags": [ + "TagsApi" + ], + "summary": "Get the tags for a given project and iteration.", + "operationId": "GetTags", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration id. Defaults to workspace.", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/Tag" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetTags request": { + "$ref": "./examples/GetTags.json" + } + } + }, + "post": { + "tags": [ + "TagsApi" + ], + "summary": "Create a tag for the project.", + "operationId": "CreateTag", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "name", + "in": "query", + "description": "The tag name.", + "required": true, + "type": "string" + }, + { + "name": "description", + "in": "query", + "description": "Optional description for the tag.", + "required": false, + "type": "string" + }, + { + "name": "type", + "in": "query", + "description": "Optional type for the tag.", + "required": false, + "type": "string", + "enum": [ + "Regular", + "Negative", + "GeneralProduct" + ] + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful CreateTag request": { + "$ref": "./examples/CreateTag.json" + } + } + } + }, + "/projects/{projectId}/tags/{tagId}": { + "get": { + "tags": [ + "TagsApi" + ], + "summary": "Get information about a specific tag.", + "operationId": "GetTag", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project this tag belongs to.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagId", + "in": "path", + "description": "The tag id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "The iteration to retrieve this tag from. Optional, defaults to current training set.", + "required": false, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful GetTag request": { + "$ref": "./examples/GetTag.json" + } + } + }, + "delete": { + "tags": [ + "TagsApi" + ], + "summary": "Delete a tag from the project.", + "operationId": "DeleteTag", + "consumes": [], + "produces": [], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagId", + "in": "path", + "description": "Id of the tag to be deleted.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful DeleteTag request": { + "$ref": "./examples/DeleteTag.json" + } + } + }, + "patch": { + "tags": [ + "TagsApi" + ], + "summary": "Update a tag.", + "operationId": "UpdateTag", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "tagId", + "in": "path", + "description": "The id of the target tag.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "updatedTag", + "in": "body", + "description": "The updated tag model.", + "required": true, + "schema": { + "$ref": "#/definitions/Tag" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Tag" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful UpdateTag request": { + "$ref": "./examples/UpdateTag.json" + } + } + } + }, + "/projects/{projectId}/tagsandregions/suggestions": { + "post": { + "tags": [ + "SuggestTagsAndRegionsApi" + ], + "summary": "Suggest tags and regions for an array/batch of untagged images. Returns empty array if no tags are found.", + "description": "This API will get suggested tags and regions for an array/batch of untagged images along with confidences for the tags. It returns an empty array if no tags are found.\r\nThere is a limit of 64 images in the batch.", + "operationId": "SuggestTagsAndRegions", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "iterationId", + "in": "query", + "description": "IterationId to use for tag and region suggestion.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "imageIds", + "in": "query", + "description": "Array of image ids tag suggestion are needed for. Use GetUntaggedImages API to get imageIds.", + "required": true, + "type": "array", + "items": { + "type": "string", + "format": "uuid", + "x-nullable": false + }, + "collectionFormat": "csv", + "maxItems": 64, + "minItems": 0 + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestedTagAndRegion" + } + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful SuggestTagsAndRegions request": { + "$ref": "./examples/SuggestTagsAndRegions.json" + } + } + } + }, + "/projects/{projectId}/train": { + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Queues project for training.", + "operationId": "TrainProject", + "consumes": [ + "application/json", + "application/xml", + "text/xml", + "application/x-www-form-urlencoded" + ], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "projectId", + "in": "path", + "description": "The project id.", + "required": true, + "type": "string", + "format": "uuid", + "x-nullable": false + }, + { + "name": "trainingType", + "in": "query", + "description": "The type of training to use to train the project (default: Regular).", + "required": false, + "type": "string", + "enum": [ + "Regular", + "Advanced" + ] + }, + { + "name": "reservedBudgetInHours", + "in": "query", + "description": "The number of hours reserved as budget for training (if applicable).", + "required": false, + "type": "integer", + "format": "int32", + "default": 0 + }, + { + "name": "forceTrain", + "in": "query", + "description": "Whether to force train even if dataset and configuration does not change (default: false).", + "required": false, + "type": "boolean", + "default": false + }, + { + "name": "notificationEmailAddress", + "in": "query", + "description": "The email address to send notification to when training finishes (default: null).", + "required": false, + "type": "string" + }, + { + "name": "trainingParameters", + "in": "body", + "description": "Additional training parameters passed in to control how the project is trained.", + "required": false, + "schema": { + "$ref": "#/definitions/TrainingParameters" + }, + "x-nullable": true + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Iteration" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful TrainProject request": { + "$ref": "./examples/TrainProject.json" + } + } + } + }, + "/projects/import": { + "post": { + "tags": [ + "ProjectApi" + ], + "summary": "Imports a project.", + "operationId": "ImportProject", + "consumes": [], + "produces": [ + "application/json", + "application/xml", + "text/xml" + ], + "parameters": [ + { + "name": "token", + "in": "query", + "description": "Token generated from the export project call.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "query", + "description": "Optional, name of the project to use instead of auto-generated name.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Project" + } + }, + "default": { + "description": "Error response", + "schema": { + "$ref": "#/definitions/CustomVisionError" + } + } + }, + "x-ms-examples": { + "Successful ImportProject request": { + "$ref": "./examples/ImportProject.json" + } + } + } + } + }, + "definitions": { + "BoundingBox": { + "description": "Bounding box that defines a region of an image.", + "required": [ + "left", + "top", + "width", + "height" + ], + "type": "object", + "properties": { + "left": { + "format": "float", + "description": "Coordinate of the left boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "top": { + "format": "float", + "description": "Coordinate of the top boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "width": { + "format": "float", + "description": "Width.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "height": { + "format": "float", + "description": "Height.", + "type": "number", + "readOnly": false, + "x-nullable": false + } + } + }, + "CustomVisionError": { + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "The error code.", + "enum": [ + "NoError", + "BadRequest", + "BadRequestExceededBatchSize", + "BadRequestNotSupported", + "BadRequestInvalidIds", + "BadRequestProjectName", + "BadRequestProjectNameNotUnique", + "BadRequestProjectDescription", + "BadRequestProjectUnknownDomain", + "BadRequestProjectUnknownClassification", + "BadRequestProjectUnsupportedDomainTypeChange", + "BadRequestProjectUnsupportedExportPlatform", + "BadRequestProjectImagePreprocessingSettings", + "BadRequestProjectDuplicated", + "BadRequestIterationName", + "BadRequestIterationNameNotUnique", + "BadRequestIterationDescription", + "BadRequestIterationIsNotTrained", + "BadRequestIterationValidationFailed", + "BadRequestWorkspaceCannotBeModified", + "BadRequestWorkspaceNotDeletable", + "BadRequestTagName", + "BadRequestTagNameNotUnique", + "BadRequestTagDescription", + "BadRequestTagType", + "BadRequestMultipleNegativeTag", + "BadRequestMultipleGeneralProductTag", + "BadRequestImageTags", + "BadRequestImageRegions", + "BadRequestNegativeAndRegularTagOnSameImage", + "BadRequestUnsupportedDomain", + "BadRequestRequiredParamIsNull", + "BadRequestIterationIsPublished", + "BadRequestInvalidPublishName", + "BadRequestInvalidPublishTarget", + "BadRequestUnpublishFailed", + "BadRequestIterationNotPublished", + "BadRequestSubscriptionApi", + "BadRequestExceedProjectLimit", + "BadRequestExceedIterationPerProjectLimit", + "BadRequestExceedTagPerProjectLimit", + "BadRequestExceedTagPerImageLimit", + "BadRequestExceededQuota", + "BadRequestCannotMigrateProjectWithName", + "BadRequestNotLimitedTrial", + "BadRequestImageBatch", + "BadRequestImageStream", + "BadRequestImageUrl", + "BadRequestImageFormat", + "BadRequestImageSizeBytes", + "BadRequestImageDimensions", + "BadRequestImageExceededCount", + "BadRequestTrainingNotNeeded", + "BadRequestTrainingNotNeededButTrainingPipelineUpdated", + "BadRequestTrainingValidationFailed", + "BadRequestClassificationTrainingValidationFailed", + "BadRequestMultiClassClassificationTrainingValidationFailed", + "BadRequestMultiLabelClassificationTrainingValidationFailed", + "BadRequestDetectionTrainingValidationFailed", + "BadRequestTrainingAlreadyInProgress", + "BadRequestDetectionTrainingNotAllowNegativeTag", + "BadRequestInvalidEmailAddress", + "BadRequestDomainNotSupportedForAdvancedTraining", + "BadRequestExportPlatformNotSupportedForAdvancedTraining", + "BadRequestReservedBudgetInHoursNotEnoughForAdvancedTraining", + "BadRequestExportValidationFailed", + "BadRequestExportAlreadyInProgress", + "BadRequestPredictionIdsMissing", + "BadRequestPredictionIdsExceededCount", + "BadRequestPredictionTagsExceededCount", + "BadRequestPredictionResultsExceededCount", + "BadRequestPredictionInvalidApplicationName", + "BadRequestPredictionInvalidQueryParameters", + "BadRequestInvalidImportToken", + "BadRequestExportWhileTraining", + "BadRequestImageMetadataKey", + "BadRequestImageMetadataValue", + "BadRequestOperationNotSupported", + "BadRequestInvalidArtifactUri", + "BadRequestCustomerManagedKeyRevoked", + "BadRequestInvalid", + "UnsupportedMediaType", + "Forbidden", + "ForbiddenUser", + "ForbiddenUserResource", + "ForbiddenUserSignupDisabled", + "ForbiddenUserSignupAllowanceExceeded", + "ForbiddenUserDoesNotExist", + "ForbiddenUserDisabled", + "ForbiddenUserInsufficientCapability", + "ForbiddenDRModeEnabled", + "ForbiddenInvalid", + "NotFound", + "NotFoundProject", + "NotFoundProjectDefaultIteration", + "NotFoundIteration", + "NotFoundIterationPerformance", + "NotFoundTag", + "NotFoundImage", + "NotFoundDomain", + "NotFoundApimSubscription", + "NotFoundInvalid", + "Conflict", + "ConflictInvalid", + "ErrorUnknown", + "ErrorIterationCopyFailed", + "ErrorPreparePerformanceMigrationFailed", + "ErrorProjectInvalidWorkspace", + "ErrorProjectInvalidPipelineConfiguration", + "ErrorProjectInvalidDomain", + "ErrorProjectTrainingRequestFailed", + "ErrorProjectImportRequestFailed", + "ErrorProjectExportRequestFailed", + "ErrorFeaturizationServiceUnavailable", + "ErrorFeaturizationQueueTimeout", + "ErrorFeaturizationInvalidFeaturizer", + "ErrorFeaturizationAugmentationUnavailable", + "ErrorFeaturizationUnrecognizedJob", + "ErrorFeaturizationAugmentationError", + "ErrorExporterInvalidPlatform", + "ErrorExporterInvalidFeaturizer", + "ErrorExporterInvalidClassifier", + "ErrorPredictionServiceUnavailable", + "ErrorPredictionModelNotFound", + "ErrorPredictionModelNotCached", + "ErrorPrediction", + "ErrorPredictionStorage", + "ErrorRegionProposal", + "ErrorUnknownBaseModel", + "ErrorInvalid" + ], + "type": "string", + "x-ms-enum": { + "name": "CustomVisionErrorCodes", + "modelAsString": true + } + }, + "message": { + "description": "A message explaining the error reported by the service.", + "type": "string" + } + } + }, + "Domain": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "example": "00000000-0000-0000-0000-000000000000", + "x-nullable": false + }, + "name": { + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "type": { + "enum": [ + "Classification", + "ObjectDetection" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "DomainType", + "modelAsString": true + } + }, + "exportable": { + "type": "boolean", + "readOnly": true, + "x-nullable": false + }, + "enabled": { + "type": "boolean", + "readOnly": true, + "x-nullable": false + } + } + }, + "Export": { + "type": "object", + "properties": { + "platform": { + "description": "Platform of the export.", + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX", + "VAIDK" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportPlatform", + "modelAsString": true + } + }, + "status": { + "description": "Status of the export.", + "enum": [ + "Exporting", + "Failed", + "Done" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ExportStatus", + "modelAsString": true + } + }, + "downloadUri": { + "description": "URI used to download the model. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "flavor": { + "description": "Flavor of the export. These are specializations of the export platform.\r\nDocker platform has valid flavors: Linux, Windows, ARM.\r\nTensorflow platform has valid flavors: TensorFlowNormal, TensorFlowLite.\r\nONNX platform has valid flavors: ONNX10, ONNX12.", + "enum": [ + "Linux", + "Windows", + "ONNX10", + "ONNX12", + "ARM", + "TensorFlowNormal", + "TensorFlowLite" + ], + "type": "string", + "readOnly": true, + "x-nullable": true, + "x-ms-enum": { + "name": "ExportFlavor", + "modelAsString": true + } + }, + "newerVersionAvailable": { + "description": "Indicates an updated version of the export package is available and should be re-exported for the latest changes.", + "type": "boolean", + "readOnly": true, + "x-nullable": false + } + } + }, + "Image": { + "description": "Image model to be sent as JSON.", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Id of the image.", + "type": "string", + "readOnly": true, + "example": "00000000-0000-0000-0000-000000000000", + "x-nullable": false + }, + "created": { + "format": "date-time", + "description": "Date the image was created.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "width": { + "format": "int32", + "description": "Width of the image.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "height": { + "format": "int32", + "description": "Height of the image.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "resizedImageUri": { + "description": "The URI to the (resized) image used for training. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "thumbnailUri": { + "description": "The URI to the thumbnail of the original image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "originalImageUri": { + "description": "The URI to the original uploaded image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Tags associated with this image.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageTag" + }, + "readOnly": true, + "x-nullable": true + }, + "regions": { + "description": "Regions associated with this image.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegion" + }, + "readOnly": true, + "x-nullable": true + }, + "metadata": { + "description": "Metadata associated with this image.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true, + "x-nullable": true + } + } + }, + "ImageCreateResult": { + "type": "object", + "properties": { + "sourceUrl": { + "description": "Source URL of the image.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "status": { + "description": "Status of the image creation.", + "enum": [ + "OK", + "OKDuplicate", + "ErrorSource", + "ErrorImageFormat", + "ErrorImageSize", + "ErrorStorage", + "ErrorLimitExceed", + "ErrorTagLimitExceed", + "ErrorRegionLimitExceed", + "ErrorUnknown", + "ErrorNegativeAndRegularTagOnSameImage" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "ImageCreateStatus", + "modelAsString": true + } + }, + "image": { + "$ref": "#/definitions/Image", + "description": "The image.", + "readOnly": true + } + } + }, + "ImageCreateSummary": { + "type": "object", + "properties": { + "isBatchSuccessful": { + "description": "True if all of the images in the batch were created successfully, otherwise false.", + "type": "boolean", + "readOnly": true, + "x-nullable": false + }, + "images": { + "description": "List of the image creation results.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageCreateResult", + "x-nullable": false + }, + "readOnly": true + } + } + }, + "ImageFileCreateBatch": { + "type": "object", + "properties": { + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageFileCreateEntry", + "x-nullable": false + }, + "readOnly": false + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000", + "x-nullable": false + }, + "readOnly": false + }, + "metadata": { + "description": "The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": false, + "x-nullable": true + } + } + }, + "ImageFileCreateEntry": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "contents": { + "format": "byte", + "type": "string", + "readOnly": false + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "example": "00000000-0000-0000-0000-000000000000", + "x-nullable": false + }, + "readOnly": false + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region", + "x-nullable": false + }, + "readOnly": false + } + } + }, + "ImageIdCreateBatch": { + "type": "object", + "properties": { + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageIdCreateEntry", + "x-nullable": false + }, + "readOnly": false + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "readOnly": false + }, + "metadata": { + "description": "The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": false, + "x-nullable": true + } + } + }, + "ImageIdCreateEntry": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Id of the image.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "readOnly": false + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region", + "x-nullable": false + }, + "readOnly": false + } + } + }, + "ImageMetadataUpdateEntry": { + "description": "Entry associating a metadata to an image.", + "type": "object", + "properties": { + "imageId": { + "format": "uuid", + "description": "Id of the image.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "status": { + "description": "Status of the metadata update.", + "enum": [ + "OK", + "ErrorImageNotFound", + "ErrorLimitExceed", + "ErrorUnknown" + ], + "type": "string", + "readOnly": false, + "x-nullable": false, + "x-ms-enum": { + "name": "ImageMetadataUpdateStatus", + "modelAsString": true + } + }, + "metadata": { + "description": "Metadata of the image.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": false, + "x-nullable": true + } + } + }, + "ImageMetadataUpdateSummary": { + "type": "object", + "properties": { + "isBatchSuccessful": { + "type": "boolean", + "readOnly": true, + "x-nullable": false + }, + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageMetadataUpdateEntry", + "x-nullable": false + }, + "readOnly": true + } + } + }, + "ImagePerformance": { + "description": "Image performance model.", + "type": "object", + "properties": { + "predictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Prediction" + }, + "readOnly": true, + "x-nullable": true + }, + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "width": { + "format": "int32", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "height": { + "format": "int32", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "imageUri": { + "type": "string", + "readOnly": true + }, + "thumbnailUri": { + "type": "string", + "readOnly": true + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTag" + }, + "readOnly": true, + "x-nullable": true + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegion" + }, + "readOnly": true, + "x-nullable": true + } + } + }, + "ImagePrediction": { + "description": "Result of an image prediction request.", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Prediction Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "project": { + "format": "uuid", + "description": "Project Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "iteration": { + "format": "uuid", + "description": "Iteration Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "description": "Date this prediction was created.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "predictions": { + "description": "List of predictions.", + "type": "array", + "items": { + "$ref": "#/definitions/Prediction", + "x-nullable": false + }, + "readOnly": true + } + } + }, + "ImageProcessingSettings": { + "description": "Represents image preprocessing settings used by image augmentation.", + "type": "object", + "properties": { + "augmentationMethods": { + "description": "Gets or sets enabled image transforms. The key corresponds to the transform name. If value is set to true, then correspondent transform is enabled. Otherwise this transform will not be used.\r\nAugmentation will be uniformly distributed among enabled transforms.", + "type": "object", + "additionalProperties": { + "type": "boolean" + }, + "readOnly": false, + "x-nullable": true + } + } + }, + "ImageRegion": { + "required": [ + "tagId", + "left", + "top", + "width", + "height" + ], + "type": "object", + "properties": { + "regionId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "description": "Id of the tag associated with this region.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "left": { + "format": "float", + "description": "Coordinate of the left boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "top": { + "format": "float", + "description": "Coordinate of the top boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "width": { + "format": "float", + "description": "Width.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "height": { + "format": "float", + "description": "Height.", + "type": "number", + "readOnly": false, + "x-nullable": false + } + } + }, + "ImageRegionCreateBatch": { + "description": "Batch of image region information to create.", + "type": "object", + "properties": { + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateEntry", + "x-nullable": false + }, + "readOnly": false + } + } + }, + "ImageRegionCreateEntry": { + "description": "Entry associating a region to an image.", + "required": [ + "imageId", + "tagId", + "left", + "top", + "width", + "height" + ], + "type": "object", + "properties": { + "imageId": { + "format": "uuid", + "description": "Id of the image.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "description": "Id of the tag associated with this region.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "left": { + "format": "float", + "description": "Coordinate of the left boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "top": { + "format": "float", + "description": "Coordinate of the top boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "width": { + "format": "float", + "description": "Width.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "height": { + "format": "float", + "description": "Height.", + "type": "number", + "readOnly": false, + "x-nullable": false + } + } + }, + "ImageRegionCreateResult": { + "required": [ + "tagId", + "left", + "top", + "width", + "height" + ], + "type": "object", + "properties": { + "imageId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "regionId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "description": "Id of the tag associated with this region.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "left": { + "format": "float", + "description": "Coordinate of the left boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "top": { + "format": "float", + "description": "Coordinate of the top boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "width": { + "format": "float", + "description": "Width.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "height": { + "format": "float", + "description": "Height.", + "type": "number", + "readOnly": false, + "x-nullable": false + } + } + }, + "ImageRegionCreateSummary": { + "type": "object", + "properties": { + "created": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateResult" + }, + "readOnly": false, + "x-nullable": true + }, + "duplicated": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateEntry" + }, + "readOnly": false, + "x-nullable": true + }, + "exceeded": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageRegionCreateEntry" + }, + "readOnly": false, + "x-nullable": true + } + } + }, + "ImageRegionProposal": { + "type": "object", + "properties": { + "projectId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "imageId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "proposals": { + "type": "array", + "items": { + "$ref": "#/definitions/RegionProposal", + "x-nullable": false + }, + "readOnly": true + } + } + }, + "ImageTag": { + "type": "object", + "properties": { + "tagId": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "type": "string", + "readOnly": true, + "x-nullable": false + } + } + }, + "ImageTagCreateBatch": { + "description": "Batch of image tags.", + "type": "object", + "properties": { + "tags": { + "description": "Image Tag entries to include in this batch.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry", + "x-nullable": false + }, + "readOnly": false + } + } + }, + "ImageTagCreateEntry": { + "description": "Entry associating a tag to an image.", + "type": "object", + "properties": { + "imageId": { + "format": "uuid", + "description": "Id of the image.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "description": "Id of the tag.", + "type": "string", + "readOnly": false, + "x-nullable": false + } + } + }, + "ImageTagCreateSummary": { + "type": "object", + "properties": { + "created": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "readOnly": false, + "x-nullable": true + }, + "duplicated": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "readOnly": false, + "x-nullable": true + }, + "exceeded": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageTagCreateEntry" + }, + "readOnly": false, + "x-nullable": true + } + } + }, + "ImageUrl": { + "description": "Image url.", + "required": [ + "url" + ], + "type": "object", + "properties": { + "url": { + "description": "Url of the image.", + "type": "string", + "readOnly": false, + "x-nullable": false + } + } + }, + "ImageUrlCreateBatch": { + "type": "object", + "properties": { + "images": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageUrlCreateEntry", + "x-nullable": false + }, + "readOnly": false + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "readOnly": false + }, + "metadata": { + "description": "The metadata of image. Limited to 50 key-value pairs per image. The length of key is limited to 256. The length of value is limited to 512.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": false, + "x-nullable": true + } + } + }, + "ImageUrlCreateEntry": { + "required": [ + "url" + ], + "type": "object", + "properties": { + "url": { + "description": "Url of the image.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "tagIds": { + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "readOnly": false + }, + "regions": { + "type": "array", + "items": { + "$ref": "#/definitions/Region", + "x-nullable": false + }, + "readOnly": false + } + } + }, + "Iteration": { + "description": "Iteration model to be sent over JSON.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Gets the id of the iteration.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "name": { + "description": "Gets or sets the name of the iteration.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "status": { + "description": "Gets the current iteration status.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "description": "Gets the time this iteration was completed.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "lastModified": { + "format": "date-time", + "description": "Gets the time this iteration was last modified.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "trainedAt": { + "format": "date-time", + "description": "Gets the time this iteration was last modified.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "projectId": { + "format": "uuid", + "description": "Gets the project id of the iteration.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "exportable": { + "description": "Whether the iteration can be exported to another format for download.", + "type": "boolean", + "readOnly": true, + "x-nullable": false + }, + "exportableTo": { + "description": "A set of platforms this iteration can export to.", + "type": "array", + "items": { + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX", + "VAIDK" + ], + "type": "string", + "x-nullable": false + }, + "readOnly": true + }, + "domainId": { + "format": "uuid", + "description": "Get or sets a guid of the domain the iteration has been trained on.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "classificationType": { + "description": "Gets the classification type of the project.", + "enum": [ + "Multiclass", + "Multilabel" + ], + "type": "string", + "readOnly": true, + "x-nullable": true, + "x-ms-enum": { + "name": "Classifier", + "modelAsString": true + } + }, + "trainingType": { + "description": "Gets the training type of the iteration.", + "enum": [ + "Regular", + "Advanced" + ], + "type": "string", + "readOnly": true, + "x-nullable": false, + "x-ms-enum": { + "name": "TrainingType", + "modelAsString": true + } + }, + "reservedBudgetInHours": { + "format": "int32", + "description": "Gets the reserved advanced training budget for the iteration.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "trainingTimeInMinutes": { + "format": "int32", + "description": "Gets the training time for the iteration.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "publishName": { + "description": "Name of the published model.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "originalPublishResourceId": { + "description": "Resource Provider Id this iteration was originally published to.", + "type": "string", + "readOnly": true, + "x-nullable": false + } + } + }, + "IterationPerformance": { + "description": "Represents the detailed performance data for a trained iteration.", + "type": "object", + "properties": { + "perTagPerformance": { + "description": "Gets the per-tag performance details for this iteration.", + "type": "array", + "items": { + "$ref": "#/definitions/TagPerformance", + "x-nullable": false + }, + "readOnly": true + }, + "precision": { + "format": "float", + "description": "Gets the precision.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "precisionStdDeviation": { + "format": "float", + "description": "Gets the standard deviation for the precision.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "recall": { + "format": "float", + "description": "Gets the recall.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "recallStdDeviation": { + "format": "float", + "description": "Gets the standard deviation for the recall.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "averagePrecision": { + "format": "float", + "description": "Gets the average precision when applicable.", + "type": "number", + "readOnly": true, + "x-nullable": true + } + } + }, + "Prediction": { + "description": "Prediction result.", + "type": "object", + "properties": { + "probability": { + "format": "float", + "description": "Probability of the tag.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "tagId": { + "format": "uuid", + "description": "Id of the predicted tag.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "tagName": { + "description": "Name of the predicted tag.", + "type": "string", + "readOnly": true, + "x-nullable": true + }, + "boundingBox": { + "$ref": "#/definitions/BoundingBox", + "description": "Bounding box of the prediction.", + "readOnly": true, + "x-nullable": true + }, + "tagType": { + "description": "Type of the predicted tag.", + "enum": [ + "Regular", + "Negative", + "GeneralProduct" + ], + "type": "string", + "readOnly": true, + "x-nullable": true, + "x-ms-enum": { + "name": "TagType", + "modelAsString": true + } + } + } + }, + "PredictionQueryResult": { + "description": "Query result of the prediction images that were sent to your prediction endpoint.", + "type": "object", + "properties": { + "token": { + "$ref": "#/definitions/PredictionQueryToken", + "description": "Prediction Query Token.", + "readOnly": false + }, + "results": { + "description": "Result of an image prediction request.", + "type": "array", + "items": { + "$ref": "#/definitions/StoredImagePrediction", + "x-nullable": false + }, + "readOnly": true + } + } + }, + "PredictionQueryTag": { + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "minThreshold": { + "format": "float", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "maxThreshold": { + "format": "float", + "type": "number", + "readOnly": false, + "x-nullable": false + } + } + }, + "PredictionQueryToken": { + "type": "object", + "properties": { + "session": { + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "continuation": { + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "maxCount": { + "format": "int32", + "type": "integer", + "readOnly": false, + "x-nullable": false + }, + "orderBy": { + "enum": [ + "Newest", + "Oldest", + "Suggested" + ], + "type": "string", + "readOnly": false, + "x-nullable": false, + "x-ms-enum": { + "name": "OrderBy", + "modelAsString": true + } + }, + "tags": { + "type": "array", + "items": { + "$ref": "#/definitions/PredictionQueryTag", + "x-nullable": false + }, + "readOnly": false + }, + "iterationId": { + "format": "uuid", + "type": "string", + "readOnly": false, + "x-nullable": true + }, + "startTime": { + "format": "date-time", + "type": "string", + "readOnly": false, + "x-nullable": true + }, + "endTime": { + "format": "date-time", + "type": "string", + "readOnly": false, + "x-nullable": true + }, + "application": { + "type": "string", + "readOnly": false, + "x-nullable": false + } + } + }, + "Project": { + "description": "Represents a project.", + "required": [ + "name", + "description", + "settings" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Gets the project id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "name": { + "description": "Gets or sets the name of the project.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "description": { + "description": "Gets or sets the description of the project.", + "type": "string", + "readOnly": false, + "x-nullable": true + }, + "settings": { + "$ref": "#/definitions/ProjectSettings", + "description": "Gets or sets the project settings.", + "readOnly": false + }, + "created": { + "format": "date-time", + "description": "Gets the date this project was created.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "lastModified": { + "format": "date-time", + "description": "Gets the date this project was last modified.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "thumbnailUri": { + "description": "Gets the thumbnail url representing the image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "drModeEnabled": { + "description": "Gets if the Disaster Recovery (DR) mode is on, indicating the project is temporarily read-only.", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "status": { + "description": "Gets the status of the project.", + "enum": [ + "Succeeded", + "Importing", + "Failed" + ], + "type": "string", + "readOnly": false, + "x-nullable": false, + "x-ms-enum": { + "name": "ProjectStatus", + "modelAsString": true + } + } + } + }, + "ProjectExport": { + "description": "Represents information about a project export.", + "type": "object", + "properties": { + "iterationCount": { + "format": "int32", + "description": "Count of iterations that will be exported.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "imageCount": { + "format": "int32", + "description": "Count of images that will be exported.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "tagCount": { + "format": "int32", + "description": "Count of tags that will be exported.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "regionCount": { + "format": "int32", + "description": "Count of regions that will be exported.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "estimatedImportTimeInMS": { + "format": "int32", + "description": "Estimated time this project will take to import, can change based on network connectivity and load between\r\nsource and destination regions.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "token": { + "description": "Opaque token that should be passed to ImportProject to perform the import. This token grants access to import this\r\nproject to all that have the token.", + "type": "string", + "readOnly": true, + "x-nullable": false + } + } + }, + "ProjectSettings": { + "description": "Represents settings associated with a project.", + "type": "object", + "properties": { + "domainId": { + "format": "uuid", + "description": "Gets or sets the id of the Domain to use with this project.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "classificationType": { + "description": "Gets or sets the classification type of the project.", + "enum": [ + "Multiclass", + "Multilabel" + ], + "type": "string", + "readOnly": false, + "x-nullable": true, + "x-ms-enum": { + "name": "Classifier", + "modelAsString": true + } + }, + "targetExportPlatforms": { + "description": "A list of ExportPlatform that the trained model should be able to support.", + "type": "array", + "items": { + "enum": [ + "CoreML", + "TensorFlow", + "DockerFile", + "ONNX", + "VAIDK" + ], + "type": "string", + "x-nullable": false + }, + "readOnly": false + }, + "useNegativeSet": { + "description": "Indicates if negative set is being used.", + "type": "boolean", + "readOnly": true, + "x-nullable": true + }, + "detectionParameters": { + "description": "Detection parameters in use, if any.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "imageProcessingSettings": { + "$ref": "#/definitions/ImageProcessingSettings", + "description": "Gets or sets image preprocessing settings.", + "readOnly": false + } + } + }, + "Region": { + "required": [ + "tagId", + "left", + "top", + "width", + "height" + ], + "type": "object", + "properties": { + "tagId": { + "format": "uuid", + "description": "Id of the tag associated with this region.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "left": { + "format": "float", + "description": "Coordinate of the left boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "top": { + "format": "float", + "description": "Coordinate of the top boundary.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "width": { + "format": "float", + "description": "Width.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "height": { + "format": "float", + "description": "Height.", + "type": "number", + "readOnly": false, + "x-nullable": false + } + } + }, + "RegionProposal": { + "type": "object", + "properties": { + "confidence": { + "format": "float", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "boundingBox": { + "$ref": "#/definitions/BoundingBox", + "readOnly": true + } + } + }, + "StoredImagePrediction": { + "description": "Result of an image prediction request.", + "type": "object", + "properties": { + "resizedImageUri": { + "description": "The URI to the (resized) prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "thumbnailUri": { + "description": "The URI to the thumbnail of the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "originalImageUri": { + "description": "The URI to the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "domain": { + "format": "uuid", + "description": "Domain used for the prediction.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "id": { + "format": "uuid", + "description": "Prediction Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "project": { + "format": "uuid", + "description": "Project Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "iteration": { + "format": "uuid", + "description": "Iteration Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "description": "Date this prediction was created.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "predictions": { + "description": "List of predictions.", + "type": "array", + "items": { + "$ref": "#/definitions/Prediction", + "x-nullable": false + }, + "readOnly": true + } + } + }, + "StoredSuggestedTagAndRegion": { + "description": "Result of a suggested tags and regions request of the untagged image.", + "type": "object", + "properties": { + "width": { + "format": "int32", + "description": "Width of the resized image.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "height": { + "format": "int32", + "description": "Height of the resized image.", + "type": "integer", + "readOnly": true, + "x-nullable": false + }, + "resizedImageUri": { + "description": "The URI to the (resized) prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "thumbnailUri": { + "description": "The URI to the thumbnail of the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "originalImageUri": { + "description": "The URI to the original prediction image. If VNET feature is enabled this will be a relative path to be used with GetArtifact, otherwise this will be an absolute URI to the resource.", + "type": "string", + "readOnly": true + }, + "domain": { + "format": "uuid", + "description": "Domain used for the prediction.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "id": { + "format": "uuid", + "description": "Prediction Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "project": { + "format": "uuid", + "description": "Project Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "iteration": { + "format": "uuid", + "description": "Iteration Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "description": "Date this prediction was created.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "predictions": { + "description": "List of predictions.", + "type": "array", + "items": { + "$ref": "#/definitions/Prediction", + "x-nullable": false + }, + "readOnly": true + }, + "predictionUncertainty": { + "format": "double", + "description": "Uncertainty (entropy) of suggested tags or regions per image.", + "type": "number", + "readOnly": true, + "x-nullable": false + } + } + }, + "SuggestedTagAndRegion": { + "description": "Result of a suggested tags and regions request.", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Prediction Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "project": { + "format": "uuid", + "description": "Project Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "iteration": { + "format": "uuid", + "description": "Iteration Id.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "created": { + "format": "date-time", + "description": "Date this prediction was created.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "predictions": { + "description": "List of predictions.", + "type": "array", + "items": { + "$ref": "#/definitions/Prediction", + "x-nullable": false + }, + "readOnly": true + }, + "predictionUncertainty": { + "format": "double", + "description": "Uncertainty (entropy) of suggested tags or regions per image.", + "type": "number", + "readOnly": true, + "x-nullable": false + } + } + }, + "SuggestedTagAndRegionQuery": { + "description": "The array of result images and token containing session and continuation Ids for the next query.", + "type": "object", + "properties": { + "token": { + "$ref": "#/definitions/SuggestedTagAndRegionQueryToken", + "description": "Contains properties we need to fetch suggested tags for.", + "readOnly": false + }, + "results": { + "description": "Result of a suggested tags and regions request of the untagged image.", + "type": "array", + "items": { + "$ref": "#/definitions/StoredSuggestedTagAndRegion", + "x-nullable": false + }, + "readOnly": true + } + } + }, + "SuggestedTagAndRegionQueryToken": { + "description": "Contains properties we need to fetch suggested tags for. For the first call, Session and continuation set to null.\r\nThen on subsequent calls, uses the session/continuation from the previous SuggestedTagAndRegionQuery result to fetch additional results.", + "type": "object", + "properties": { + "tagIds": { + "description": "Existing TagIds in project to filter suggested tags on.", + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "readOnly": false + }, + "threshold": { + "format": "double", + "description": "Confidence threshold to filter suggested tags on.", + "type": "number", + "readOnly": false, + "x-nullable": false + }, + "session": { + "description": "SessionId for database query. Initially set to null but later used to paginate.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "continuation": { + "description": "Continuation Id for database pagination. Initially null but later used to paginate.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "maxCount": { + "format": "int32", + "description": "Maximum number of results you want to be returned in the response.", + "type": "integer", + "readOnly": false, + "x-nullable": false + }, + "sortBy": { + "description": "OrderBy. Ordering mechanism for your results.", + "enum": [ + "UncertaintyAscending", + "UncertaintyDescending" + ], + "type": "string", + "readOnly": false, + "x-nullable": false, + "x-ms-enum": { + "name": "SortBy", + "modelAsString": true + } + } + } + }, + "Tag": { + "description": "Represents a Tag.", + "required": [ + "name", + "description", + "type" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Gets the Tag ID.", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "name": { + "description": "Gets or sets the name of the tag.", + "type": "string", + "readOnly": false, + "x-nullable": false + }, + "description": { + "description": "Gets or sets the description of the tag.", + "type": "string", + "readOnly": false, + "x-nullable": true + }, + "type": { + "description": "Gets or sets the type of the tag.", + "enum": [ + "Regular", + "Negative", + "GeneralProduct" + ], + "type": "string", + "readOnly": false, + "x-nullable": false, + "x-ms-enum": { + "name": "TagType", + "modelAsString": true + } + }, + "imageCount": { + "format": "int32", + "description": "Gets the number of images with this tag.", + "type": "integer", + "readOnly": true, + "x-nullable": false + } + } + }, + "TagFilter": { + "description": "Model that query for counting of images whose suggested tags match given tags and their probability are greater than or equal to the given threshold.", + "type": "object", + "properties": { + "tagIds": { + "description": "Existing TagIds in project to get suggested tags count for.", + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "readOnly": false + }, + "threshold": { + "format": "double", + "description": "Confidence threshold to filter suggested tags on.", + "type": "number", + "readOnly": false, + "x-nullable": false + } + } + }, + "TagPerformance": { + "description": "Represents performance data for a particular tag in a trained iteration.", + "type": "object", + "properties": { + "id": { + "format": "uuid", + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "name": { + "type": "string", + "readOnly": true, + "x-nullable": false + }, + "precision": { + "format": "float", + "description": "Gets the precision.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "precisionStdDeviation": { + "format": "float", + "description": "Gets the standard deviation for the precision.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "recall": { + "format": "float", + "description": "Gets the recall.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "recallStdDeviation": { + "format": "float", + "description": "Gets the standard deviation for the recall.", + "type": "number", + "readOnly": true, + "x-nullable": false + }, + "averagePrecision": { + "format": "float", + "description": "Gets the average precision when applicable.", + "type": "number", + "readOnly": true, + "x-nullable": true + } + } + }, + "TrainingParameters": { + "description": "Parameters used for training.", + "type": "object", + "properties": { + "selectedTags": { + "description": "List of tags selected for this training session, other tags in the project will be ignored.", + "type": "array", + "items": { + "format": "uuid", + "type": "string", + "x-nullable": false + }, + "readOnly": false + } + } + } + }, + "parameters": { + "Endpoint": { + "name": "Endpoint", + "in": "path", + "description": "Supported Cognitive Services endpoints.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + }, + "securityDefinitions": { + "apim_key": { + "type": "apiKey", + "name": "Training-Key", + "in": "header" + } + }, + "security": [ + { + "apim_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{Endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/Endpoint" + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageRegions.json new file mode 100644 index 000000000000..9f554c49071c --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageRegions.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "batch": { + "regions": [ + { + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "left": 0.25, + "top": 0.25, + "width": 0.25, + "height": 0.25 + }, + { + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "left": 0.35, + "top": 0.35, + "width": 0.25, + "height": 0.25 + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "created": [ + { + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "left": 0.25, + "top": 0.25, + "width": 0.25, + "height": 0.25 + }, + { + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "left": 0.35, + "top": 0.35, + "width": 0.25, + "height": 0.25 + } + ], + "duplicated": [], + "exceeded": [] + } + }, + "207": { + "headers": {}, + "body": { + "created": [ + { + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "left": 0.25, + "top": 0.25, + "width": 0.25, + "height": 0.25 + } + ], + "duplicated": [], + "exceeded": [ + { + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "left": 0.35, + "top": 0.35, + "width": 0.25, + "height": 0.25 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageTags.json new file mode 100644 index 000000000000..5b7395424693 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImageTags.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "batch": { + "tags": [ + { + "imageId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a" + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "created": [ + { + "imageId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a" + } + ], + "duplicated": null, + "exceeded": null + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromData.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromData.json new file mode 100644 index 000000000000..05b0b07590b5 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromData.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "tagIds": [ + "b607964f-7bd6-4a3b-a869-6791fb6aab87" + ], + "imageData": "multipart data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "isBatchSuccessful": true, + "images": [ + { + "sourceUrl": "\"hemlock_10.jpg\"", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag 1" + } + ] + } + }, + { + "sourceUrl": "\"hemlock_6.jpg\"", + "status": "OK", + "image": { + "id": "f1855a92-b873-47e7-b513-f07a667ceda1", + "created": "2017-12-19T15:56:10Z", + "width": 900, + "height": 1531, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag 1" + } + ] + } + } + ] + } + }, + "207": { + "headers": {}, + "body": { + "isBatchSuccessful": false, + "images": [ + { + "sourceUrl": "\"hemlock_10.jpg\"", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag 1" + } + ] + } + }, + { + "sourceUrl": "\"hemlock_6.jpg\"", + "status": "ErrorLimitExceed" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromFiles.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromFiles.json new file mode 100644 index 000000000000..6853f6ab1401 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromFiles.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "tagIds": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "batch": { + "images": [ + { + "name": "hemlock_10.jpg", + "contents": "{image contents}" + } + ], + "tagIds": [ + "b607964f-7bd6-4a3b-a869-6791fb6aab87" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "isBatchSuccessful": true, + "images": [ + { + "sourceUrl": "\"hemlock_10.jpg\"", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag 1" + } + ] + } + } + ] + } + }, + "207": { + "headers": {}, + "body": { + "isBatchSuccessful": false, + "images": [ + { + "sourceUrl": "\"hemlock_10.jpg\"", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag 1" + } + ] + } + }, + { + "sourceUrl": "{url}", + "status": "ErrorLimitExceed" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromPredictions.json new file mode 100644 index 000000000000..1970c61d0d39 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromPredictions.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "tagIds": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "batch": { + "images": [ + { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9" + } + ], + "tagIds": [ + "b607964f-7bd6-4a3b-a869-6791fb6aab87" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "isBatchSuccessful": true, + "images": [ + { + "sourceUrl": "\"hemlock_10.jpg\"", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag 1" + } + ] + } + } + ] + } + }, + "207": { + "headers": {}, + "body": { + "isBatchSuccessful": false, + "images": [ + { + "sourceUrl": "\"hemlock_10.jpg\"", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag 1" + } + ] + } + }, + { + "sourceUrl": "{url}", + "status": "ErrorLimitExceed" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromUrls.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromUrls.json new file mode 100644 index 000000000000..a3ecd489a1f7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateImagesFromUrls.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "tagIds": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "batch": { + "images": [ + { + "url": "{url to image}" + } + ], + "tagIds": [ + "b607964f-7bd6-4a3b-a869-6791fb6aab87" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "isBatchSuccessful": true, + "images": [ + { + "sourceUrl": "{url to image}", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag name" + } + ] + } + } + ] + } + }, + "207": { + "headers": {}, + "body": { + "isBatchSuccessful": false, + "images": [ + { + "sourceUrl": "{url to image}", + "status": "OK", + "image": { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag name" + } + ] + } + }, + { + "sourceUrl": "{url to image}", + "status": "ErrorSource", + "image": null + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateProject.json new file mode 100644 index 000000000000..88f852ced738 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateProject.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "name": "My New Project", + "description": "A test project", + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "My New Project", + "description": "A test project", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "created": "2017-12-18T05:43:18Z", + "lastModified": "2017-12-18T05:43:18Z", + "thumbnailUri": "" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateTag.json new file mode 100644 index 000000000000..ed19817462ae --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/CreateTag.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "Tag1", + "description": "Description of Tag1", + "body": "" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "name": "Tag1", + "description": "Description of Tag1", + "type": "Regular", + "imageCount": 0 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageRegions.json new file mode 100644 index 000000000000..8931d4e2629e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageRegions.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "regionIds": [ + "" + ] + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageTags.json new file mode 100644 index 000000000000..d6a188454e9b --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImageTags.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "imageIds": [ + "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + ], + "tagIds": [ + "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + ] + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImages.json new file mode 100644 index 000000000000..ccc479209fd2 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteImages.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "imageIds": [ + "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + ] + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteIteration.json new file mode 100644 index 000000000000..d1f9b7629958 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteIteration.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeletePrediction.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeletePrediction.json new file mode 100644 index 000000000000..c6b2d5c0bc58 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeletePrediction.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "ids": [ + "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + ] + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteProject.json new file mode 100644 index 000000000000..2b4cb5723a6a --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteProject.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteTag.json new file mode 100644 index 000000000000..e9f802505a09 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/DeleteTag.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportIteration.json new file mode 100644 index 000000000000..1bbfa05a5d86 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportIteration.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "platform": "TensorFlow" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "platform": "TensorFlow", + "status": "Exporting", + "downloadUri": "", + "newerVersionAvailable": false + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportProject.json new file mode 100644 index 000000000000..8d59acb577d1 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ExportProject.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "token": "" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetArtifact.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetArtifact.json new file mode 100644 index 000000000000..e48a4cf6fd86 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetArtifact.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "path": "i-40b66b39b86b4583be8c0fe223aa9ec5/t-5c882c62ca2b4458b39a2041b111dd73" + }, + "responses": { + "200": { + "body": "{file}" + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomain.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomain.json new file mode 100644 index 000000000000..c6702b3a8f29 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomain.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "domainId": "b30a91ae-e3c1-4f73-a81e-c270bff27c39" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "b30a91ae-e3c1-4f73-a81e-c270bff27c39", + "name": "Retail", + "type": "Classification", + "exportable": false, + "enabled": true + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomains.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomains.json new file mode 100644 index 000000000000..a10887726fcb --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetDomains.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "name": "General", + "type": "Classification", + "exportable": false, + "enabled": true + }, + { + "id": "c151d5b5-dd07-472a-acc8-15d29dea8518", + "name": "Food", + "type": "Classification", + "exportable": false, + "enabled": true + }, + { + "id": "ca455789-012d-4b50-9fec-5bb63841c793", + "name": "Landmarks", + "type": "Classification", + "exportable": false, + "enabled": true + }, + { + "id": "b30a91ae-e3c1-4f73-a81e-c270bff27c39", + "name": "Retail", + "type": "Classification", + "exportable": false, + "enabled": true + }, + { + "id": "45badf75-3591-4f26-a705-45678d3e9f5f", + "name": "Adult", + "type": "Classification", + "exportable": false, + "enabled": true + }, + { + "id": "0732100f-1a38-4e49-a514-c9b44c697ab5", + "name": "General (compact)", + "type": "Classification", + "exportable": false, + "enabled": true + }, + { + "id": "b5cfd229-2ac7-4b2b-8d0a-2b0661344894", + "name": "Landmarks (compact)", + "type": "Classification", + "exportable": false, + "enabled": true + }, + { + "id": "6b4faeda-8396-481b-9f8b-177b9fa3097f", + "name": "Retail (compact)", + "type": "Classification", + "exportable": false, + "enabled": true + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetExports.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetExports.json new file mode 100644 index 000000000000..1267168dbb4c --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetExports.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "platform": "TensorFlow", + "status": "Done", + "newerVersionAvailable": false, + "downloadUri": "{Download URI}" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageCount.json new file mode 100644 index 000000000000..ee6e4980eefa --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageCount.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "200": { + "headers": {}, + "body": 12 + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformanceCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformanceCount.json new file mode 100644 index 000000000000..c57ffd50669b --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformanceCount.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12", + "tagIds": [ + "b5f7e6a2-a481-49a6-afec-a7cef1af3544" + ] + }, + "responses": { + "200": { + "headers": {}, + "body": "1" + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformances.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformances.json new file mode 100644 index 000000000000..dfe6eb5a7208 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagePerformances.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66", + "tagIds": [ + "" + ], + "orderBy": "Newest" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042", + "created": "2018-01-31T20:18:26Z", + "predictions": [ + { + "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "tagName": "Tag 1", + "probability": 1.0, + "boundingBox": { + "left": 0.25, + "top": 0.25, + "width": 0.25, + "height": 0.25 + } + } + ], + "width": 600, + "height": 1600, + "imageUri": "", + "thumbnailUri": "", + "tags": [], + "regions": [] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageRegionProposals.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageRegionProposals.json new file mode 100644 index 000000000000..7638215aae62 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImageRegionProposals.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "proposals": [ + { + "confidence": 0.25, + "boundingBox": { + "left": 0.25, + "top": 0.25, + "width": 0.25, + "height": 0.25 + } + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImages.json new file mode 100644 index 000000000000..d02bd9b585ef --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImages.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "created": "2017-12-19T15:56:10Z", + "width": 1095, + "height": 900, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag 1" + } + ] + }, + { + "id": "f1855a92-b873-47e7-b513-f07a667ceda1", + "created": "2017-12-19T15:56:10Z", + "width": 900, + "height": 1531, + "resizedImageUri": "{Resized Image Uri}", + "originalImageUri": "{Image Uri}", + "thumbnailUri": "{Thumbnail Uri}", + "tags": [ + { + "tagId": "b607964f-7bd6-4a3b-a869-6791fb6aab87", + "created": "2017-12-19T15:56:09Z", + "tagName": "tag 1" + } + ] + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagesByIds.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagesByIds.json new file mode 100644 index 000000000000..037118bc9d41 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetImagesByIds.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIteration.json new file mode 100644 index 000000000000..2383a6c6f910 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIteration.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Iteration 2", + "status": "Completed", + "created": "2017-12-18T22:40:36Z", + "lastModified": "2017-12-19T15:47:02Z", + "trainedAt": "2017-12-19T15:47:02Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "exportableTo": [ + "ONNX", + "DockerFile", + "TensorFlow", + "CoreML" + ], + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterationPerformance.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterationPerformance.json new file mode 100644 index 000000000000..323173c03a51 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterationPerformance.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "threshold": 0.9 + }, + "responses": { + "200": { + "headers": {}, + "body": { + "perTagPerformance": [ + { + "id": "e31ff107-5505-4753-be42-b369b21b026c", + "name": "Hemlock", + "precision": 1.0, + "precisionStdDeviation": 0.0, + "recall": 1.0, + "recallStdDeviation": 0.0 + }, + { + "id": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "name": "Japanese Cherry", + "precision": 1.0, + "precisionStdDeviation": 0.0, + "recall": 1.0, + "recallStdDeviation": 0.0 + } + ], + "precision": 1.0, + "precisionStdDeviation": 0.0, + "recall": 1.0, + "recallStdDeviation": 0.0 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterations.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterations.json new file mode 100644 index 000000000000..ac0c78134a80 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetIterations.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "name": "Iteration 1", + "status": "Completed", + "created": "2017-12-18T22:40:29Z", + "lastModified": "2017-12-18T22:40:41Z", + "trainedAt": "2017-12-18T22:40:41Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "exportableTo": [ + "ONNX", + "DockerFile", + "TensorFlow", + "CoreML" + ], + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" + }, + { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Iteration 2", + "status": "Completed", + "created": "2017-12-18T22:40:36Z", + "lastModified": "2017-12-19T15:47:02Z", + "trainedAt": "2017-12-19T15:47:02Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "exportableTo": [ + "ONNX", + "DockerFile", + "TensorFlow", + "CoreML" + ], + "trainingType": "Regular", + "reservedBudgetInHours": 5, + "publishName": "model1" + }, + { + "id": "3adaf7b2-18fc-4376-9da4-b5ea160a7cf5", + "name": "Iteration 3", + "status": "New", + "created": "2017-12-19T15:46:59Z", + "lastModified": "2017-12-19T15:46:59Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": null, + "exportableTo": [ + "ONNX", + "DockerFile", + "TensorFlow", + "CoreML" + ], + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProject.json new file mode 100644 index 000000000000..4b68bf1ea390 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProject.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "My New Project", + "description": "A test project", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "created": "2017-12-18T05:43:18Z", + "lastModified": "2017-12-18T05:43:18Z", + "thumbnailUri": "" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProjects.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProjects.json new file mode 100644 index 000000000000..b5166555936f --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetProjects.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "My New Project", + "description": "", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "created": "2017-12-18T05:43:18Z", + "lastModified": "2017-12-18T05:43:18Z", + "thumbnailUri": "" + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTag.json new file mode 100644 index 000000000000..4ad3135822ae --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTag.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "name": "Tag1", + "description": "Description of Tag1", + "type": "Regular", + "imageCount": 0 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImageCount.json new file mode 100644 index 000000000000..c0ed09aa6ae9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImageCount.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": "10" + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImages.json new file mode 100644 index 000000000000..037118bc9d41 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTaggedImages.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTags.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTags.json new file mode 100644 index 000000000000..6ad8ea76c689 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetTags.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "name": "Tag1", + "description": "Description of Tag1", + "type": "Regular", + "imageCount": 0 + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImageCount.json new file mode 100644 index 000000000000..c0ed09aa6ae9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImageCount.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": "10" + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImages.json new file mode 100644 index 000000000000..037118bc9d41 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/GetUntaggedImages.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "cf0f83fb-ebaa-4b25-8e34-613a6a0b8a12" + }, + "responses": { + "200": { + "headers": {}, + "body": [] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ImportProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ImportProject.json new file mode 100644 index 000000000000..87702da27426 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/ImportProject.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "token": "token" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "Import Project", + "description": "", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "created": "2019-10-06T05:43:18Z", + "lastModified": "2019-10-06T05:43:18Z", + "thumbnailUri": "", + "status": "Importing" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/PublishIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/PublishIteration.json new file mode 100644 index 000000000000..67d6ad03e29f --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/PublishIteration.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "publishName": "Model1", + "predictionId": "/subscriptions/{subscription}/resourceGroups/{resource group name}/providers/Microsoft.CognitiveServices/accounts/{resource name}" + }, + "responses": { + "200": { + "headers": {}, + "body": true + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QueryPredictions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QueryPredictions.json new file mode 100644 index 000000000000..0bd19d6b7980 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QueryPredictions.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "query": { + "orderBy": "Newest", + "tags": [ + { + "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "maxThreshold": 1, + "minThreshold": 0.9 + } + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "results": [ + { + "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042", + "project": "8988643a-ae70-447d-9a22-15c4255e5ecb", + "iteration": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66", + "created": "2018-01-31T20:18:26Z", + "predictions": [ + { + "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "tagName": "Tag 1", + "probability": 1.0 + }, + { + "tagId": "45619cda-d1c9-4bc8-a3e1-87c5d81adbc3", + "tagName": "Tag 2", + "probability": 3.60627153E-12 + } + ], + "originalImageUri": "", + "thumbnailUri": "", + "resizedImageUri": "", + "domain": "b30a91ae-e3c1-4f73-a81e-c270bff27c39" + } + ], + "token": { + "session": "1:286613", + "continuation": "", + "maxCount": 0, + "orderBy": "Newest", + "tags": [ + { + "id": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "minThreshold": 0.9, + "maxThreshold": 1.0 + } + ], + "iterationId": null, + "startTime": null, + "endTime": null, + "application": "" + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImageCount.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImageCount.json new file mode 100644 index 000000000000..bfe12dad0540 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImageCount.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66", + "query": { + "tagIds": [ + "b5f7e6a2-a481-49a6-afec-a7cef1af3544" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "b5f7e6a2-a481-49a6-afec-a7cef1af3544": 1 + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImages.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImages.json new file mode 100644 index 000000000000..c42db2bc784f --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuerySuggestedImages.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66", + "query": { + "tagIds": [ + "b5f7e6a2-a481-49a6-afec-a7cef1af3544" + ] + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "results": [ + { + "id": "dfd2d346-3ed5-4e1e-857d-af4e32cec042", + "project": "8988643a-ae70-447d-9a22-15c4255e5ecb", + "iteration": "b7b9d99c-a2c6-4658-9900-a98d2ff5bc66", + "created": "2018-01-31T20:18:26Z", + "predictions": [ + { + "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "tagName": "Tag 1", + "probability": 1.0 + }, + { + "tagId": "45619cda-d1c9-4bc8-a3e1-87c5d81adbc3", + "tagName": "Tag 2", + "probability": 3.60627153E-12 + } + ], + "originalImageUri": "", + "thumbnailUri": "", + "resizedImageUri": "", + "domain": "b30a91ae-e3c1-4f73-a81e-c270bff27c39" + } + ], + "token": { + "session": "1:286613", + "continuation": "", + "maxCount": 0, + "sortBy": "Newest", + "tagIds": [ + "b5f7e6a2-a481-49a6-afec-a7cef1af3544" + ] + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImage.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImage.json new file mode 100644 index 000000000000..489852dc79df --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImage.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "imageData": "multipart-form-data" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.00 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImageUrl.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImageUrl.json new file mode 100644 index 000000000000..dc904ef6f116 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/QuickTestImageUrl.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "imageUrl": { + "url": "{Image URL}" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "951098b2-9b69-427b-bddb-d5cb618874e3", + "project": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iteration": "fe1e83c4-6f50-4899-9544-6bb08cf0e15a", + "created": "2017-12-19T14:21:41Z", + "predictions": [ + { + "tagId": "e31ff107-5505-4753-be42-b369b21b026c", + "tagName": "Hemlock", + "probability": 0.05149666 + }, + { + "tagId": "349d72ac-0948-4d51-b1e4-c14a1f9b848a", + "tagName": "Japanese Cherry", + "probability": 0.00 + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/SuggestTagsAndRegions.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/SuggestTagsAndRegions.json new file mode 100644 index 000000000000..175a0a2a01e0 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/SuggestTagsAndRegions.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iterationId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "imageIds": [ + "e7f08c23-9e54-49f7-b609-69a0240ba306", + "ce632666-4b66-4adb-aa0a-ad8b7c32df06" + ] + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "id": "8497e814-23cc-47d7-b24b-691cef0bcec9", + "project": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "iteration": "ce271ee4-cc13-460f-b66f-993f8005522d", + "created": "2019-07-08T13:43:18Z", + "predictions": [ + { + "tagId": "b5f7e6a2-a481-49a6-afec-a7cef1af3544", + "tagName": "Tag 1", + "probability": 1.0 + }, + { + "tagId": "45619cda-d1c9-4bc8-a3e1-87c5d81adbc3", + "tagName": "Tag 2", + "probability": 3.60627153E-12 + } + ], + "predictionUncertainty": 0.32 + } + ] + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/TrainProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/TrainProject.json new file mode 100644 index 000000000000..dd3deca15afb --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/TrainProject.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "trainingParameters": {} + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Iteration 2", + "status": "Training", + "created": "2017-12-18T22:40:36Z", + "lastModified": "2017-12-19T15:46:58Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "domainId": null, + "exportableTo": [ + "ONNX", + "DockerFile", + "TensorFlow", + "CoreML" + ], + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UnpublishIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UnpublishIteration.json new file mode 100644 index 000000000000..d1f9b7629958 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UnpublishIteration.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758" + }, + "responses": { + "204": {} + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateImageMetadata.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateImageMetadata.json new file mode 100644 index 000000000000..54ac8a7a0725 --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateImageMetadata.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "imageIds": [ + "4d6eb844-42ee-42bc-bd6f-c32455ef07c9" + ], + "metadata": { + "tag": "value" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "isBatchSuccessful": true, + "images": [ + { + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "status": "OK", + "metadata": { + "tag": "value" + } + } + ] + } + }, + "207": { + "headers": {}, + "body": { + "isBatchSuccessful": false, + "images": [ + { + "imageId": "4d6eb844-42ee-42bc-bd6f-c32455ef07c9", + "status": "ErrorLimitExceed" + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateIteration.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateIteration.json new file mode 100644 index 000000000000..a965deb8aa0f --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateIteration.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "iterationId": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "updatedIteration": { + "name": "Best Iteration" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "e31a14ab-5d78-4f7b-a267-3a1e4fd8a758", + "name": "Best Iteration", + "status": "Completed", + "created": "2017-12-18T22:40:36Z", + "lastModified": "2017-12-19T15:53:07Z", + "trainedAt": "2017-12-19T15:47:02Z", + "projectId": "64b822c5-8082-4b36-a426-27225f4aa18c", + "exportable": false, + "exportableTo": [ + "ONNX", + "DockerFile", + "TensorFlow", + "CoreML" + ], + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31", + "trainingType": "Regular", + "reservedBudgetInHours": 0, + "publishName": "" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateProject.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateProject.json new file mode 100644 index 000000000000..e19735364b5e --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateProject.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "updatedProject": { + "name": "New Project Name", + "description": "A new Description", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "name": "New Project Name", + "description": "A new Description", + "settings": { + "domainId": "ee85a74c-405e-4adc-bb47-ffa8ca0c9f31" + }, + "created": "2017-12-18T05:43:18Z", + "lastModified": "2017-12-18T05:43:19Z", + "thumbnailUri": "" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateTag.json b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateTag.json new file mode 100644 index 000000000000..51e0ee680aab --- /dev/null +++ b/specification/cognitiveservices/data-plane/CustomVision/Training/stable/v3.3/examples/UpdateTag.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "Endpoint": "https://westus.api.cognitive.microsoft.com", + "Content-Type": "application/json", + "Training-Key": "{API Key}", + "projectId": "bc3f7dad-5544-468c-8573-3ef04d55463e", + "tagId": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "updatedTag": { + "name": "Better Tag Name", + "type": "Regular", + "description": "Better description" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "9e27bc1b-7ae7-4e3b-a4e5-36153479dc01", + "name": "Better Tag Name", + "description": "Better description", + "type": "Regular", + "imageCount": 0 + } + } + } +} From bf612e0ab6da899b86bf42e6e88b1c27ed0414aa Mon Sep 17 00:00:00 2001 From: Joohee Suh <58048046+josuhazure@users.noreply.github.com> Date: Fri, 5 Jun 2020 14:13:49 -0700 Subject: [PATCH 097/318] =?UTF-8?q?Changing=20aspects/opinions=20to=20opti?= =?UTF-8?q?onal=20properties=20from=20required=20proper=E2=80=A6=20(#9702)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Changing aspects/opinions to optional properties from required properties * removing (Optional) description Co-authored-by: josuh --- .../TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json index 675210bab169..0ff15eff3ba9 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.1-preview.1/TextAnalytics.json @@ -734,9 +734,7 @@ "sentiment", "confidenceScores", "offset", - "length", - "aspects", - "opinions" + "length" ], "properties": { "text": { From 48d89bb98a9fbd4e7bb1d78eae963f99a841557b Mon Sep 17 00:00:00 2001 From: Anirban Sarkar <33848291+asarkar84@users.noreply.github.com> Date: Fri, 5 Jun 2020 19:37:58 -0700 Subject: [PATCH 098/318] Adding the missing api-version parameter for move and validate move APIs. It is already part of the examples. (#9732) * Correcting the swagger to accept downloadToken similar to other download operations Correcting the swagger to accept downloadToken similar to other download operations * Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. Co-authored-by: Anirban Sarkar --- .../Microsoft.Billing/stable/2020-05-01/billing.json | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json index a8db81727888..873581679036 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json @@ -1725,6 +1725,9 @@ { "$ref": "#/parameters/subscriptionIdParameter" }, + { + "$ref": "#/parameters/apiVersionParameter" + }, { "name": "parameters", "in": "body", @@ -1786,6 +1789,9 @@ { "$ref": "#/parameters/subscriptionIdParameter" }, + { + "$ref": "#/parameters/apiVersionParameter" + }, { "name": "parameters", "in": "body", @@ -2142,6 +2148,9 @@ { "$ref": "#/parameters/productNameParameter" }, + { + "$ref": "#/parameters/apiVersionParameter" + }, { "name": "parameters", "in": "body", From 4dfbf09aec092eb3309c113869b54ac43ee6be01 Mon Sep 17 00:00:00 2001 From: Liang Wang Date: Sat, 6 Jun 2020 16:39:39 +0800 Subject: [PATCH 099/318] Add Missing Json in Readme for Monitor (#9730) --- specification/monitor/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index 044ae1e3b1ec..b59bddef23e9 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -446,6 +446,7 @@ input-file: - Microsoft.Insights/preview/2017-05-01-preview/diagnosticsSettings_API.json - Microsoft.Insights/preview/2017-05-01-preview/metricDefinitions_API.json - Microsoft.Insights/preview/2017-05-01-preview/metrics_API.json +- Microsoft.Insights/preview/2017-05-01-preview/subscriptionDiagnosticsSettings_API.json ``` From 783ed6e4298b198acbce4c4a1f1ae2a5b5bd39c6 Mon Sep 17 00:00:00 2001 From: Theodore Chang Date: Sat, 6 Jun 2020 10:18:58 -0400 Subject: [PATCH 100/318] Delete labeler (#9738) * Delete computeReviewLabeler.yml * Delete computeReviewLabeler.yml * Update CODEOWNERS --- .github/computeReviewLabeler.yml | 3 --- .github/workflows/computeReviewLabeler.yml | 12 ------------ CODEOWNERS | 2 -- 3 files changed, 17 deletions(-) delete mode 100644 .github/computeReviewLabeler.yml delete mode 100644 .github/workflows/computeReviewLabeler.yml diff --git a/.github/computeReviewLabeler.yml b/.github/computeReviewLabeler.yml deleted file mode 100644 index 131556674c2c..000000000000 --- a/.github/computeReviewLabeler.yml +++ /dev/null @@ -1,3 +0,0 @@ -computeReview: -- 'specification/compute/*' -- 'specification/compute/**/*' diff --git a/.github/workflows/computeReviewLabeler.yml b/.github/workflows/computeReviewLabeler.yml deleted file mode 100644 index 67c75fdaf6de..000000000000 --- a/.github/workflows/computeReviewLabeler.yml +++ /dev/null @@ -1,12 +0,0 @@ -name: Compute Labeler -on: -- pull_request - -jobs: - label: - runs-on: ubuntu-latest - steps: - - uses: actions/labeler@v2 - with: - repo-token: "${{ secrets.GITHUB_TOKEN }}" - configuration-path: .github/computeReviewLabeler.yml diff --git a/CODEOWNERS b/CODEOWNERS index bf60aa798a9f..c5db75e8217f 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -76,5 +76,3 @@ /specification/trafficmanager/ @allencal @hrkulkarmsft /specification/web/ @lukaszstem @naveedaz @nking92 /profile/ @shahabhijeet -/.github/computeReviewLabeler.yml @grizzlytheodore -/.github/workflows/computeReviewLabeler.yml @grizzlytheodore From dd4ec423a1114f9f4b89ee0dee35cbf18fcc65a3 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Mon, 8 Jun 2020 03:51:09 +0200 Subject: [PATCH 101/318] enable t2 generation (#9749) --- specification/monitor/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index b59bddef23e9..aa10b3d13604 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -533,6 +533,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python after_scripts: - python ./scripts/multiapi_init_gen.py azure-mgmt-monitor + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js From de0195946dacdccdd19ed29c7f90675837eeef20 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Mon, 8 Jun 2020 04:03:38 +0200 Subject: [PATCH 102/318] enable t2 generation (#9756) --- specification/appconfiguration/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/appconfiguration/resource-manager/readme.md b/specification/appconfiguration/resource-manager/readme.md index de29d229eefa..feac2e4b88ce 100644 --- a/specification/appconfiguration/resource-manager/readme.md +++ b/specification/appconfiguration/resource-manager/readme.md @@ -68,6 +68,7 @@ This is not used by Autorest itself. ``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-python + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-net - repo: azure-sdk-for-js From 535109d5f9dae0e789affb02cb13bce8727feb44 Mon Sep 17 00:00:00 2001 From: srcharug <62158390+srcharug@users.noreply.github.com> Date: Sun, 7 Jun 2020 19:27:38 -0700 Subject: [PATCH 103/318] =?UTF-8?q?Added=20the=20allowed=20values=20to=20$?= =?UTF-8?q?select,=20$expand=20and=20$filter=20queries=20unde=E2=80=A6=20(?= =?UTF-8?q?#9585)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Added the allowed values to $select, $expand and $filter queries under VMSS and to $select query for Avset * Adding allowed values in the corresponding descriptions field * changing the examples --- .../Microsoft.Compute/stable/2015-06-15/compute.json | 6 +++--- .../Microsoft.Compute/stable/2016-03-30/compute.json | 8 ++++---- .../Microsoft.Compute/stable/2017-03-30/compute.json | 8 ++++---- .../examples/ListAvailabilitySetsInASubscription.json | 2 +- .../Microsoft.Compute/stable/2017-12-01/compute.json | 8 ++++---- .../examples/ListAvailabilitySetsInASubscription.json | 2 +- .../Microsoft.Compute/stable/2018-04-01/compute.json | 8 ++++---- .../examples/ListAvailabilitySetsInASubscription.json | 2 +- .../Microsoft.Compute/stable/2018-06-01/compute.json | 8 ++++---- .../examples/ListAvailabilitySetsInASubscription.json | 2 +- .../Microsoft.Compute/stable/2018-10-01/compute.json | 8 ++++---- .../examples/ListAvailabilitySetsInASubscription.json | 2 +- .../Microsoft.Compute/stable/2019-03-01/compute.json | 8 ++++---- .../examples/ListAvailabilitySetsInASubscription.json | 2 +- .../Microsoft.Compute/stable/2019-07-01/compute.json | 8 ++++---- .../examples/ListAvailabilitySetsInASubscription.json | 2 +- .../Microsoft.Compute/stable/2019-12-01/compute.json | 8 ++++---- .../examples/ListAvailabilitySetsInASubscription.json | 2 +- 18 files changed, 47 insertions(+), 47 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json index 66735a54b30d..27547d5699c5 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2015-06-15/compute.json @@ -2460,21 +2460,21 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply to the operation." + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", - "description": "The list parameters." + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json index 939d08a0e931..83dd89c98d6b 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2016-03-30/compute.json @@ -179,7 +179,7 @@ "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." } ], "responses": { @@ -2541,21 +2541,21 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply to the operation." + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", - "description": "The list parameters." + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json index 9cb759885ebe..9fbeb9bcab70 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/compute.json @@ -183,7 +183,7 @@ "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." } ], "responses": { @@ -3562,21 +3562,21 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply to the operation." + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", - "description": "The list parameters." + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/ListAvailabilitySetsInASubscription.json index 996c3b390765..8184ebca23ed 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-03-30/examples/ListAvailabilitySetsInASubscription.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "{subscriptionId}", "api-version": "2017-03-30", - "$expand": "virtualMachines\\$ref" + "$expand": "instanceView" }, "responses": { "200": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json index 0cb61c92bf74..02566cf61a71 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/compute.json @@ -254,7 +254,7 @@ "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." } ], "responses": { @@ -3968,21 +3968,21 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply to the operation." + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", - "description": "The list parameters." + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListAvailabilitySetsInASubscription.json index d5bb9e943b6d..1d999ce5a8fa 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2017-12-01/examples/ListAvailabilitySetsInASubscription.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "{subscriptionId}", "api-version": "2017-12-01", - "$expand": "virtualMachines\\$ref" + "$expand": "instanceView" }, "responses": { "200": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json index e0f8125e5df8..9f7169f58aaa 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/compute.json @@ -251,7 +251,7 @@ "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." } ], "responses": { @@ -4079,21 +4079,21 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply to the operation." + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", - "description": "The list parameters." + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json index 29bb119ff690..c97c80fff2f5 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-04-01/examples/ListAvailabilitySetsInASubscription.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "{subscriptionId}", "api-version": "2018-04-01", - "$expand": "virtualMachines\\$ref" + "$expand": "instanceView" }, "responses": { "200": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json index 6ec3b585ce05..acdb3a9dc59d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/compute.json @@ -251,7 +251,7 @@ "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." } ], "responses": { @@ -4198,21 +4198,21 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply to the operation." + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", - "description": "The list parameters." + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json index 217c0f707840..fc595d9a5ab8 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-06-01/examples/ListAvailabilitySetsInASubscription.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "{subscriptionId}", "api-version": "2018-06-01", - "$expand": "virtualMachines\\$ref" + "$expand": "instanceView" }, "responses": { "200": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json index 11aeaedc3244..429401d44d5f 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/compute.json @@ -251,7 +251,7 @@ "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." } ], "responses": { @@ -4201,21 +4201,21 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply to the operation." + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", - "description": "The list parameters." + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json index bd9cb9e4e140..cb52806da595 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2018-10-01/examples/ListAvailabilitySetsInASubscription.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "{subscriptionId}", "api-version": "2018-10-01", - "$expand": "virtualMachines\\$ref" + "$expand": "instanceView" }, "responses": { "200": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json index c1ed4a79de77..d7d39de3f591 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/compute.json @@ -251,7 +251,7 @@ "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." } ], "responses": { @@ -4810,21 +4810,21 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply to the operation." + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", - "description": "The list parameters." + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json index d7c2558571ef..f7b93ed9e9b9 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-03-01/examples/ListAvailabilitySetsInASubscription.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "{subscriptionId}", "api-version": "2019-03-01", - "$expand": "virtualMachines\\$ref" + "$expand": "instanceView" }, "responses": { "200": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json index 83d0e5419fe2..f0df5077fd9c 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/compute.json @@ -251,7 +251,7 @@ "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." } ], "responses": { @@ -5316,21 +5316,21 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply to the operation." + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", - "description": "The list parameters." + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json index 719e9496ee1e..a76d7a10ce71 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/examples/ListAvailabilitySetsInASubscription.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "{subscriptionId}", "api-version": "2019-07-01", - "$expand": "virtualMachines\\$ref" + "$expand": "instanceView" }, "responses": { "200": { diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json index f1433d61b827..8cc4586990f8 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json @@ -251,7 +251,7 @@ "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." } ], "responses": { @@ -5707,21 +5707,21 @@ "in": "query", "required": false, "type": "string", - "description": "The filter to apply to the operation." + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." }, { "name": "$select", "in": "query", "required": false, "type": "string", - "description": "The list parameters." + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." }, { "name": "$expand", "in": "query", "required": false, "type": "string", - "description": "The expand expression to apply to the operation." + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/examples/ListAvailabilitySetsInASubscription.json index 8a8af8f9e5d2..cd51b4aa7948 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/examples/ListAvailabilitySetsInASubscription.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/examples/ListAvailabilitySetsInASubscription.json @@ -2,7 +2,7 @@ "parameters": { "subscriptionId": "{subscriptionId}", "api-version": "2019-12-01", - "$expand": "virtualMachines\\$ref" + "$expand": "instanceView" }, "responses": { "200": { From 394c32d26c9d16a75e5bd1380a7d7452b3486525 Mon Sep 17 00:00:00 2001 From: chetmaddula <57730350+chetmaddula@users.noreply.github.com> Date: Sun, 7 Jun 2020 19:29:45 -0700 Subject: [PATCH 104/318] DiskRP Swagger changes for 2020-05-01 (#9552) * baseline commit for disk.json * changes related to disk access, changes in disk encryption set for new api version, new examples related to disk access * adding few more examples, more changes to disk.json * prettier commit * few fixes * added more examples and fixed readme.md, fixed typos in disk.json * fixing readme * prettier fixes * fix ref to example * adding network access policy and diskAccessId to snapshots * fix readme.md * fixing enum descriptions * fixing enum description * fixing descriptions * fixing validations * fix swagger api version * reverting des change to make sourceVault optional * fix field name actionsRequired * fixing descryptions for encryption at rest * consolidating enums and fixing type --- .../stable/2020-05-01/disk.json | 2641 +++++++++++++++++ .../examples/CreateADiskAccess.json | 32 + .../examples/CreateADiskEncryptionSet.json | 60 + .../CreateAManagedDiskByCopyingASnapshot.json | 45 + ...managedBlobFromADifferentSubscription.json | 48 + ...nUnmanagedBlobFromTheSameSubscription.json | 45 + .../CreateAManagedDiskFromAPlatformImage.json | 54 + ...AManagedDiskFromAnExistingManagedDisk.json | 45 + .../CreateAManagedDiskWithDiskAccess.json | 49 + ...eateAManagedDiskWithDiskEncryptionSet.json | 51 + .../examples/CreateAManagedUploadDisk.json | 45 + ...managedBlobFromADifferentSubscription.json | 48 + ...nUnmanagedBlobFromTheSameSubscription.json | 45 + ...CreateASnapshotFromAnExistingSnapshot.json | 45 + .../examples/CreateAnEmptyManagedDisk.json | 45 + .../examples/DeleteADiskAccess.json | 13 + .../examples/DeleteADiskEncryptionSet.json | 13 + .../GetDiskAccessPrivateLinkResources.json | 30 + .../GetInformationAboutADiskAccess.json | 26 + ...nAboutADiskAccessWithPrivateEndpoints.json | 44 + ...GetInformationAboutADiskEncryptionSet.json | 35 + .../GetInformationAboutAManagedDisk.json | 57 + .../GetInformationAboutASnapshot.json | 53 + .../ListDiskAccessesInAResourceGroup.json | 62 + .../ListDiskAccessesInASubscription.json | 61 + ...istDiskEncryptionSetsInAResourceGroup.json | 62 + ...ListDiskEncryptionSetsInASubscription.json | 61 + .../ListManagedDisksInAResourceGroup.json | 120 + .../ListManagedDisksInASubscription.json | 119 + .../ListSnapshotsInAResourceGroup.json | 57 + .../ListSnapshotsInASubscription.json | 99 + .../examples/UpdateADiskAccess.json | 40 + .../examples/UpdateADiskEncryptionSet.json | 68 + .../UpdateAManagedDiskToRemoveDiskAccess.json | 43 + .../compute/resource-manager/readme.md | 26 +- 35 files changed, 4386 insertions(+), 1 deletion(-) create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/disk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateADiskAccess.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateADiskEncryptionSet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByCopyingASnapshot.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromADifferentSubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromTheSameSubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskFromAPlatformImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskFromAnExistingManagedDisk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskWithDiskAccess.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskWithDiskEncryptionSet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedUploadDisk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromADifferentSubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromTheSameSubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotFromAnExistingSnapshot.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAnEmptyManagedDisk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/DeleteADiskAccess.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/DeleteADiskEncryptionSet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetDiskAccessPrivateLinkResources.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskAccess.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskAccessWithPrivateEndpoints.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskEncryptionSet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutAManagedDisk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutASnapshot.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskAccessesInAResourceGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskAccessesInASubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskEncryptionSetsInAResourceGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskEncryptionSetsInASubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListManagedDisksInAResourceGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListManagedDisksInASubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListSnapshotsInAResourceGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListSnapshotsInASubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateADiskAccess.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateADiskEncryptionSet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateAManagedDiskToRemoveDiskAccess.json diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/disk.json new file mode 100644 index 000000000000..8871f4d6f77e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/disk.json @@ -0,0 +1,2641 @@ +{ + "swagger": "2.0", + "info": { + "title": "DiskResourceProviderClient", + "description": "The Disk Resource Provider Client.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}": { + "put": { + "tags": [ + "Disks" + ], + "operationId": "Disks_CreateOrUpdate", + "description": "Creates or updates a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "disk", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Disk" + }, + "description": "Disk object supplied in the body of the Put disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-examples": { + "Create an empty managed disk.": { + "$ref": "./examples/CreateAnEmptyManagedDisk.json" + }, + "Create a managed disk from a platform image.": { + "$ref": "./examples/CreateAManagedDiskFromAPlatformImage.json" + }, + "Create a managed disk from an existing managed disk in the same or different subscription.": { + "$ref": "./examples/CreateAManagedDiskFromAnExistingManagedDisk.json" + }, + "Create a managed disk by importing an unmanaged blob from the same subscription.": { + "$ref": "./examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromTheSameSubscription.json" + }, + "Create a managed disk by importing an unmanaged blob from a different subscription.": { + "$ref": "./examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromADifferentSubscription.json" + }, + "Create a managed disk by copying a snapshot.": { + "$ref": "./examples/CreateAManagedDiskByCopyingASnapshot.json" + }, + "Create a managed upload disk.": { + "$ref": "./examples/CreateAManagedUploadDisk.json" + }, + "Create a managed disk and associate with disk access resource.": { + "$ref": "./examples/CreateAManagedDiskWithDiskAccess.json" + }, + "Create a managed disk and associate with disk encryption set.": { + "$ref": "./examples/CreateAManagedDiskWithDiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Update", + "description": "Updates (patches) a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "disk", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskUpdate" + }, + "description": "Disk object supplied in the body of the Patch disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update managed disk to remove disk access resource association.": { + "$ref": "./examples/UpdateAManagedDiskToRemoveDiskAccess.json" + } + } + }, + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Get", + "description": "Gets information about a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Disk" + } + } + }, + "x-ms-examples": { + "Get information about a managed disk.": { + "$ref": "./examples/GetInformationAboutAManagedDisk.json" + } + } + }, + "delete": { + "tags": [ + "Disks" + ], + "operationId": "Disks_Delete", + "description": "Deletes a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk is deleted, this is an expected error code." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks": { + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_ListByResourceGroup", + "description": "Lists all the disks under a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskList" + } + } + }, + "x-ms-examples": { + "List all managed disks in a resource group.": { + "$ref": "./examples/ListManagedDisksInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks": { + "get": { + "tags": [ + "Disks" + ], + "operationId": "Disks_List", + "description": "Lists all the disks under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskList" + } + } + }, + "x-ms-examples": { + "List all managed disks in a subscription.": { + "$ref": "./examples/ListManagedDisksInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/beginGetAccess": { + "post": { + "tags": [ + "Disks" + ], + "operationId": "Disks_GrantAccess", + "description": "Grants access to a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/disks/{diskName}/endGetAccess": { + "post": { + "tags": [ + "Disks" + ], + "operationId": "Disks_RevokeAccess", + "description": "Revokes access to a disk.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}": { + "put": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_CreateOrUpdate", + "description": "Creates or updates a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "snapshot", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Snapshot" + }, + "description": "Snapshot object supplied in the body of the Put disk operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-examples": { + "Create a snapshot from an existing snapshot in the same or a different subscription.": { + "$ref": "./examples/CreateASnapshotFromAnExistingSnapshot.json" + }, + "Create a snapshot by importing an unmanaged blob from the same subscription.": { + "$ref": "./examples/CreateASnapshotByImportingAnUnmanagedBlobFromTheSameSubscription.json" + }, + "Create a snapshot by importing an unmanaged blob from a different subscription.": { + "$ref": "./examples/CreateASnapshotByImportingAnUnmanagedBlobFromADifferentSubscription.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Update", + "description": "Updates (patches) a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "snapshot", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SnapshotUpdate" + }, + "description": "Snapshot object supplied in the body of the Patch snapshot operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Get", + "description": "Gets information about a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Snapshot" + } + } + }, + "x-ms-examples": { + "Get information about a snapshot.": { + "$ref": "./examples/GetInformationAboutASnapshot.json" + } + } + }, + "delete": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_Delete", + "description": "Deletes a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the snapshot is deleted, this is an expected error code." + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_ListByResourceGroup", + "description": "Lists snapshots under a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotList" + } + } + }, + "x-ms-examples": { + "List all snapshots in a resource group.": { + "$ref": "./examples/ListSnapshotsInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/snapshots": { + "get": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_List", + "description": "Lists snapshots under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SnapshotList" + } + } + }, + "x-ms-examples": { + "List all snapshots in a subscription.": { + "$ref": "./examples/ListSnapshotsInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/beginGetAccess": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_GrantAccess", + "description": "Grants access to a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "grantAccessData", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GrantAccessData" + }, + "description": "Access data object supplied in the body of the get snapshot access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccessUri" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/snapshots/{snapshotName}/endGetAccess": { + "post": { + "tags": [ + "Snapshots" + ], + "operationId": "Snapshots_RevokeAccess", + "description": "Revokes access to a snapshot.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SnapshotNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets/{diskEncryptionSetName}": { + "put": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_CreateOrUpdate", + "description": "Creates or updates a disk encryption set", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "diskEncryptionSet", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + }, + "description": "disk encryption set object supplied in the body of the Put disk encryption set operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a disk encryption set.": { + "$ref": "./examples/CreateADiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Update", + "description": "Updates (patches) a disk encryption set.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "diskEncryptionSet", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskEncryptionSetUpdate" + }, + "description": "disk encryption set object supplied in the body of the Patch disk encryption set operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a disk encryption set.": { + "$ref": "./examples/UpdateADiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Get", + "description": "Gets information about a disk encryption set.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a disk encryption set.": { + "$ref": "./examples/GetInformationAboutADiskEncryptionSet.json" + } + } + }, + "delete": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_Delete", + "description": "Deletes a disk encryption set.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskEncryptionSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk encryption set is already deleted, this is an expected error code." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a disk encryption set.": { + "$ref": "./examples/DeleteADiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskEncryptionSets": { + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_ListByResourceGroup", + "description": "Lists all the disk encryption sets under a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk encryption sets in a resource group.": { + "$ref": "./examples/ListDiskEncryptionSetsInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets": { + "get": { + "tags": [ + "DiskEncryptionSets" + ], + "operationId": "DiskEncryptionSets_List", + "description": "Lists all the disk encryption sets under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskEncryptionSetList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk encryption sets in a subscription.": { + "$ref": "./examples/ListDiskEncryptionSetsInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}": { + "put": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_CreateOrUpdate", + "description": "Creates or updates a disk access resource", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "diskAccess", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskAccess" + }, + "description": "disk access object supplied in the body of the Put disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a disk access resource.": { + "$ref": "./examples/CreateADiskAccess.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_Update", + "description": "Updates (patches) a disk access resource.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "diskAccess", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DiskAccessUpdate" + }, + "description": "disk access object supplied in the body of the Patch disk access operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update a disk access resource.": { + "$ref": "./examples/UpdateADiskAccess.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_Get", + "description": "Gets information about a disk access resource.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccess" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get information about a disk access resource.": { + "$ref": "./examples/GetInformationAboutADiskAccess.json" + }, + "Get information about a disk access resource with private endpoints.": { + "$ref": "./examples/GetInformationAboutADiskAccessWithPrivateEndpoints.json" + } + } + }, + "delete": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_Delete", + "description": "Deletes a disk access resource.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "If the disk access resource is already deleted, this is an expected error code." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete a disk access resource.": { + "$ref": "./examples/DeleteADiskAccess.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_ListByResourceGroup", + "description": "Lists all the disk access resources under a resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccessList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk access resources in a resource group.": { + "$ref": "./examples/ListDiskAccessesInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_List", + "description": "Lists all the disk access resources under a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DiskAccessList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all disk access resources in a subscription.": { + "$ref": "./examples/ListDiskAccessesInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/diskAccesses/{diskAccessName}/privateLinkResources": { + "get": { + "tags": [ + "DiskAccesses" + ], + "operationId": "DiskAccesses_GetPrivateLinkResources", + "description": "Gets the private link resources possible under disk access resource", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/DiskAccessNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + } + }, + "x-ms-examples": { + "List all possible private link resources under disk access resource.": { + "$ref": "./examples/GetDiskAccessPrivateLinkResources.json" + } + } + } + } + }, + "definitions": { + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "Disk": { + "properties": { + "managedBy": { + "readOnly": true, + "type": "string", + "description": "A relative URI containing the ID of the VM that has the disk attached." + }, + "managedByExtended": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of relative URIs containing the IDs of the VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs." + }, + "sku": { + "$ref": "#/definitions/DiskSku" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The Logical zone list for Disk." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Disk resource." + }, + "DiskUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "sku": { + "$ref": "#/definitions/DiskSku" + } + }, + "description": "Disk update resource." + }, + "DiskList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Disk" + }, + "description": "A list of disks." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disks. Call ListNext() with this to fetch the next page of disks." + } + }, + "required": [ + "value" + ], + "description": "The List Disks operation response." + }, + "DiskSku": { + "properties": { + "name": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ], + "x-ms-enum": { + "name": "DiskStorageAccountTypes", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage. Best for backup, non-critical, and infrequent access." + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage. Best for production and performance sensitive workloads." + }, + { + "value": "StandardSSD_LRS", + "description": "Standard SSD locally redundant storage. Best for web servers, lightly used enterprise applications and dev/test." + }, + { + "value": "UltraSSD_LRS", + "description": "Ultra SSD locally redundant storage. Best for IO-intensive workloads such as SAP HANA, top tier databases (for example, SQL, Oracle), and other transaction-heavy workloads." + } + ] + }, + "description": "The sku name." + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "The sku tier." + } + }, + "description": "The disks sku name. Can be Standard_LRS, Premium_LRS, StandardSSD_LRS, or UltraSSD_LRS." + }, + "SnapshotSku": { + "properties": { + "name": { + "type": "string", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "Standard_ZRS" + ], + "x-ms-enum": { + "name": "SnapshotStorageAccountTypes", + "modelAsString": true, + "values": [ + { + "value": "Standard_LRS", + "description": "Standard HDD locally redundant storage" + }, + { + "value": "Premium_LRS", + "description": "Premium SSD locally redundant storage" + }, + { + "value": "Standard_ZRS", + "description": "Standard zone redundant storage" + } + ] + }, + "description": "The sku name." + }, + "tier": { + "type": "string", + "readOnly": true, + "description": "The sku tier." + } + }, + "description": "The snapshots sku name. Can be Standard_LRS, Premium_LRS, or Standard_ZRS." + }, + "DiskProperties": { + "properties": { + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the disk was created." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "diskSizeBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The size of the disk in bytes. This field is read only." + }, + "uniqueId": { + "type": "string", + "readOnly": true, + "description": "Unique Guid identifying the resource." + }, + "encryptionSettingsCollection": { + "$ref": "#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used for Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk provisioning state." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskIOPSReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskState": { + "type": "string", + "description": "The state of the disk.", + "readOnly": true, + "enum": [ + "Unattached", + "Attached", + "Reserved", + "ActiveSAS", + "ReadyToUpload", + "ActiveUpload" + ], + "x-ms-enum": { + "name": "DiskState", + "modelAsString": true, + "values": [ + { + "value": "Unattached", + "description": "The disk is not being used and can be attached to a VM." + }, + { + "value": "Attached", + "description": "The disk is currently mounted to a running VM." + }, + { + "value": "Reserved", + "description": "The disk is mounted to a stopped-deallocated VM" + }, + { + "value": "ActiveSAS", + "description": "The disk currently has an Active SAS Uri associated with it." + }, + { + "value": "ReadyToUpload", + "description": "A disk is ready to be created by upload by requesting a write token." + }, + { + "value": "ActiveUpload", + "description": "A disk is created for upload and a write token has been issued for uploading to it." + } + ] + } + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "maxShares": { + "type": "integer", + "format": "int32", + "description": "The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time." + }, + "shareInfo": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ShareInfoElement" + }, + "description": "Details of the list of all VMs that have the disk attached. maxShares should be set to a value greater than one for disks to allow attaching them to multiple VMs." + }, + "networkAccessPolicy": { + "$ref": "#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + } + }, + "required": [ + "creationData" + ], + "description": "Disk resource properties." + }, + "SnapshotProperties": { + "properties": { + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the snapshot was created." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "hyperVGeneration": { + "type": "string", + "description": "The hypervisor generation of the Virtual Machine. Applicable to OS disks only.", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGeneration", + "modelAsString": true + } + }, + "creationData": { + "$ref": "#/definitions/CreationData", + "description": "Disk source information. CreationData information cannot be changed after the disk has been created." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "diskSizeBytes": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The size of the disk in bytes. This field is read only." + }, + "uniqueId": { + "type": "string", + "readOnly": true, + "description": "Unique Guid identifying the resource." + }, + "encryptionSettingsCollection": { + "$ref": "#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk provisioning state." + }, + "incremental": { + "type": "boolean", + "description": "Whether a snapshot is incremental. Incremental snapshots on the same disk occupy less space than full snapshots and can be diffed." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "networkAccessPolicy": { + "$ref": "#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + } + }, + "required": [ + "creationData" + ], + "description": "Snapshot resource properties." + }, + "ShareInfoElement": { + "properties": { + "vmUri": { + "readOnly": true, + "type": "string", + "description": "A relative URI containing the ID of the VM that has the disk attached." + } + } + }, + "EncryptionSetProperties": { + "properties": { + "encryptionType": { + "$ref": "#/definitions/EncryptionType" + }, + "activeKey": { + "$ref": "#/definitions/KeyVaultAndKeyReference", + "description": "The key vault key which is currently used by this disk encryption set." + }, + "previousKeys": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/KeyVaultAndKeyReference" + }, + "description": "A readonly collection of key vault keys previously used by this disk encryption set while a key rotation is in progress. It will be empty if there is no ongoing key rotation." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk encryption set provisioning state." + } + } + }, + "EncryptionSettingsCollection": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Set this flag to true and provide DiskEncryptionKey and optional KeyEncryptionKey to enable encryption. Set this flag to false and remove DiskEncryptionKey and KeyEncryptionKey to disable encryption. If EncryptionSettings is null in the request object, the existing settings remain unchanged." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/EncryptionSettingsElement" + }, + "description": "A collection of encryption settings, one for each disk volume." + }, + "encryptionSettingsVersion": { + "type": "string", + "description": "Describes what type of encryption is used for the disks. Once this field is set, it cannot be overwritten. '1.0' corresponds to Azure Disk Encryption with AAD app.'1.1' corresponds to Azure Disk Encryption." + } + }, + "required": [ + "enabled" + ], + "description": "Encryption settings for disk or snapshot" + }, + "EncryptionSettingsElement": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultAndSecretReference", + "description": "Key Vault Secret Url and vault id of the disk encryption key" + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultAndKeyReference", + "description": "Key Vault Key Url and vault id of the key encryption key. KeyEncryptionKey is optional and when provided is used to unwrap the disk encryption key." + } + }, + "description": "Encryption settings for one disk volume." + }, + "KeyVaultAndSecretReference": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SourceVault", + "description": "Resource id of the KeyVault containing the key or secret" + }, + "secretUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Key Vault Secret Url and vault id of the encryption key " + }, + "KeyVaultAndKeyReference": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SourceVault", + "description": "Resource id of the KeyVault containing the key or secret" + }, + "keyUrl": { + "type": "string", + "description": "Url pointing to a key or secret in KeyVault" + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Key Vault Key Url and vault id of KeK, KeK is optional and when provided is used to unwrap the encryptionKey" + }, + "SourceVault": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "description": "The vault id is an Azure Resource Manager Resource id in the form /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.KeyVault/vaults/{vaultName}" + }, + "EncryptionType": { + "type": "string", + "description": "The type of key used to encrypt the data of the disk.", + "enum": [ + "EncryptionAtRestWithPlatformKey", + "EncryptionAtRestWithCustomerKey", + "EncryptionAtRestWithPlatformAndCustomerKeys" + ], + "x-ms-enum": { + "name": "EncryptionType", + "modelAsString": true, + "values": [ + { + "value": "EncryptionAtRestWithPlatformKey", + "description": "Disk is encrypted at rest with Platform managed key. It is the default encryption type." + }, + { + "value": "EncryptionAtRestWithCustomerKey", + "description": "Disk is encrypted at rest with Customer managed key that can be changed and revoked by a customer." + }, + { + "value": "EncryptionAtRestWithPlatformAndCustomerKeys", + "description": "Disk is encrypted at rest with 2 layers of encryption. One of the keys is Customer managed and the other key is Platform managed." + } + ] + } + }, + "Encryption": { + "properties": { + "diskEncryptionSetId": { + "type": "string", + "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." + }, + "type": { + "$ref": "#/definitions/EncryptionType" + } + }, + "description": "Encryption at rest settings for disk or snapshot" + }, + "NetworkAccessPolicy": { + "type": "string", + "description": "Policy for accessing the disk via network.", + "enum": [ + "AllowAll", + "AllowPrivate", + "DenyAll" + ], + "x-ms-enum": { + "name": "NetworkAccessPolicy", + "modelAsString": true, + "values": [ + { + "value": "AllowAll", + "description": "The disk can be exported or uploaded to from any network." + }, + { + "value": "AllowPrivate", + "description": "The disk can be exported or uploaded to using a DiskAccess resource's private endpoints." + }, + { + "value": "DenyAll", + "description": "The disk cannot be exported." + } + ] + } + }, + "DiskUpdateProperties": { + "properties": { + "osType": { + "type": "string", + "description": "the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "$ref": "#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "The number of IOPS allowed for this disk; only settable for UltraSSD disks. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "The bandwidth allowed for this disk; only settable for UltraSSD disks. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "diskIOPSReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total number of IOPS that will be allowed across all VMs mounting the shared disk as ReadOnly. One operation can transfer between 4k and 256k bytes." + }, + "diskMBpsReadOnly": { + "type": "integer", + "format": "int64", + "description": "The total throughput (MBps) that will be allowed across all VMs mounting the shared disk as ReadOnly. MBps means millions of bytes per second - MB here uses the ISO notation, of powers of 10." + }, + "maxShares": { + "type": "integer", + "format": "int32", + "description": "The maximum number of VMs that can attach to the disk at the same time. Value greater than one indicates a disk that can be mounted on multiple VMs at the same time." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "networkAccessPolicy": { + "$ref": "#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + } + }, + "description": "Disk resource update properties." + }, + "SnapshotUpdateProperties": { + "properties": { + "osType": { + "type": "string", + "description": "the Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "If creationData.createOption is Empty, this field is mandatory and it indicates the size of the disk to create. If this field is present for updates or creation with other options, it indicates a resize. Resizes are only allowed if the disk is not attached to a running VM, and can only increase the disk's size." + }, + "encryptionSettingsCollection": { + "$ref": "#/definitions/EncryptionSettingsCollection", + "description": "Encryption settings collection used be Azure Disk Encryption, can contain multiple encryption settings per disk or snapshot." + }, + "encryption": { + "$ref": "#/definitions/Encryption", + "description": "Encryption property can be used to encrypt data at rest with customer managed keys or platform managed keys." + }, + "networkAccessPolicy": { + "$ref": "#/definitions/NetworkAccessPolicy" + }, + "diskAccessId": { + "type": "string", + "description": "ARM id of the DiskAccess resource for using private endpoints on disks." + } + }, + "description": "Snapshot resource update properties." + }, + "DiskEncryptionSetUpdateProperties": { + "properties": { + "activeKey": { + "$ref": "#/definitions/KeyVaultAndKeyReference" + } + }, + "description": "disk encryption set resource update properties." + }, + "CreationData": { + "properties": { + "createOption": { + "type": "string", + "enum": [ + "Empty", + "Attach", + "FromImage", + "Import", + "Copy", + "Restore", + "Upload" + ], + "x-ms-enum": { + "name": "DiskCreateOption", + "modelAsString": true, + "values": [ + { + "value": "Empty", + "description": "Create an empty data disk of a size given by diskSizeGB." + }, + { + "value": "Attach", + "description": "Disk will be attached to a VM." + }, + { + "value": "FromImage", + "description": "Create a new disk from a platform image specified by the given imageReference or galleryImageReference." + }, + { + "value": "Import", + "description": "Create a disk by importing from a blob specified by a sourceUri in a storage account specified by storageAccountId." + }, + { + "value": "Copy", + "description": "Create a new disk or snapshot by copying from a disk or snapshot specified by the given sourceResourceId." + }, + { + "value": "Restore", + "description": "Create a new disk by copying from a backup recovery point." + }, + { + "value": "Upload", + "description": "Create a new disk by obtaining a write token and using it to directly upload the contents of the disk." + } + ] + }, + "description": "This enumerates the possible sources of a disk's creation." + }, + "storageAccountId": { + "type": "string", + "description": "Required if createOption is Import. The Azure Resource Manager identifier of the storage account containing the blob to import as a disk." + }, + "imageReference": { + "$ref": "#/definitions/ImageDiskReference", + "description": "Disk source information." + }, + "galleryImageReference": { + "$ref": "#/definitions/ImageDiskReference", + "description": "Required if creating from a Gallery Image. The id of the ImageDiskReference will be the ARM id of the shared galley image version from which to create a disk." + }, + "sourceUri": { + "type": "string", + "description": "If createOption is Import, this is the URI of a blob to be imported into a managed disk." + }, + "sourceResourceId": { + "type": "string", + "description": "If createOption is Copy, this is the ARM id of the source snapshot or disk." + }, + "sourceUniqueId": { + "readOnly": true, + "type": "string", + "description": "If this field is set, this is the unique id identifying the source of this resource." + }, + "uploadSizeBytes": { + "type": "integer", + "format": "int64", + "description": "If createOption is Upload, this is the size of the contents of the upload including the VHD footer. This value should be between 20972032 (20 MiB + 512 bytes for the VHD footer) and 35183298347520 bytes (32 TiB + 512 bytes for the VHD footer)." + } + }, + "required": [ + "createOption" + ], + "description": "Data used when creating a disk." + }, + "ImageDiskReference": { + "properties": { + "id": { + "type": "string", + "description": "A relative uri containing either a Platform Image Repository or user image reference." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "If the disk is created from an image's data disk, this is an index that indicates which of the data disks in the image to use. For OS disks, this field is null." + } + }, + "required": [ + "id" + ], + "description": "The source image used for creating the disk." + }, + "GrantAccessData": { + "properties": { + "access": { + "type": "string", + "enum": [ + "None", + "Read", + "Write" + ], + "x-ms-enum": { + "name": "AccessLevel", + "modelAsString": true + } + }, + "durationInSeconds": { + "type": "integer", + "format": "int32", + "description": "Time duration in seconds until the SAS access expires." + } + }, + "required": [ + "access", + "durationInSeconds" + ], + "description": "Data used for requesting a SAS." + }, + "AccessUri": { + "properties": { + "accessSAS": { + "readOnly": true, + "type": "string", + "description": "A SAS uri for accessing a disk." + } + }, + "description": "A disk access SAS uri." + }, + "Snapshot": { + "properties": { + "managedBy": { + "readOnly": true, + "type": "string", + "description": "Unused. Always Null." + }, + "sku": { + "$ref": "#/definitions/SnapshotSku" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnapshotProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Snapshot resource." + }, + "SnapshotUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SnapshotUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + }, + "sku": { + "$ref": "#/definitions/SnapshotSku" + } + }, + "description": "Snapshot update resource." + }, + "SnapshotList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Snapshot" + }, + "description": "A list of snapshots." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of snapshots. Call ListNext() with this to fetch the next page of snapshots." + } + }, + "required": [ + "value" + ], + "description": "The List Snapshots operation response." + }, + "EncryptionSetIdentity": { + "properties": { + "type": { + "type": "string", + "enum": [ + "SystemAssigned" + ], + "x-ms-enum": { + "name": "DiskEncryptionSetIdentityType", + "modelAsString": true + }, + "description": "The type of Managed Identity used by the DiskEncryptionSet. Only SystemAssigned is supported." + }, + "principalId": { + "readOnly": true, + "type": "string", + "description": "The object id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-identity-principal-id header in the PUT request if the resource has a systemAssigned(implicit) identity" + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the Managed Identity Resource. This will be sent to the RP from ARM via the x-ms-client-tenant-id header in the PUT request if the resource has a systemAssigned(implicit) identity" + } + }, + "description": "The managed identity for the disk encryption set. It should be given permission on the key vault before it can be used to encrypt disks." + }, + "DiskEncryptionSet": { + "properties": { + "identity": { + "$ref": "#/definitions/EncryptionSetIdentity" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EncryptionSetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "disk encryption set resource." + }, + "DiskEncryptionSetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskEncryptionSetUpdateProperties" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "disk encryption set update resource." + }, + "DiskEncryptionSetList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSet" + }, + "description": "A list of disk encryption sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disk encryption sets. Call ListNext() with this to fetch the next page of disk encryption sets." + } + }, + "required": [ + "value" + ], + "description": "The List disk encryption set operation response." + }, + "PrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between DiskAccess and Virtual Network." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "private endpoint connection Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "private endpoint connection name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "private endpoint connection type" + } + }, + "description": "The Private Endpoint Connection resource." + }, + "DiskAccessProperties": { + "properties": { + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "A readonly collection of private endpoint connections created on the disk. Currently only one endpoint connection is supported." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The disk access resource provisioning state." + }, + "timeCreated": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time when the disk access was created." + } + } + }, + "DiskAccess": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DiskAccessProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "disk access resource." + }, + "DiskAccessList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskAccess" + }, + "description": "A list of disk access resources." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of disk access resources. Call ListNext() with this to fetch the next page of disk access resources." + } + }, + "required": [ + "value" + ], + "description": "The List disk access operation response." + }, + "DiskAccessUpdate": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "description": "Used for updating a disk access resource." + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "id": { + "readOnly": true, + "type": "string", + "description": "private link resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "private link resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "private link resource type" + } + }, + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/ApiError" + } + }, + "description": "An error response from the Compute service." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "DiskNameParameter": { + "name": "diskName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the managed disk that is being created. The name can't be changed after the disk is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + }, + "SnapshotNameParameter": { + "name": "snapshotName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the snapshot that is being created. The name can't be changed after the snapshot is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The max name length is 80 characters.", + "x-ms-parameter-location": "method" + }, + "DiskEncryptionSetNameParameter": { + "name": "diskEncryptionSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the disk encryption set that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + }, + "DiskAccessNameParameter": { + "name": "diskAccessName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the disk access resource that is being created. The name can't be changed after the disk encryption set is created. Supported characters for the name are a-z, A-Z, 0-9 and _. The maximum name length is 80 characters.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateADiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateADiskAccess.json new file mode 100644 index 000000000000..8258083a4243 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateADiskAccess.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskAccessName": "myDiskAccess", + "diskAccess": { + "location": "West US" + } + }, + "responses": { + "202": { + "body": { + "name": "myDiskAccess", + "location": "West US", + "type": "Microsoft.Compute/diskAccesses" + } + }, + "200": { + "body": { + "name": "myDiskAccess", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "type": "Microsoft.Compute/diskAccesses", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateADiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateADiskEncryptionSet.json new file mode 100644 index 000000000000..00889e9835be --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateADiskEncryptionSet.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [] + } + } + }, + "200": { + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [] + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByCopyingASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByCopyingASnapshot.json new file mode 100644 index 000000000000..a803786c3a74 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByCopyingASnapshot.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromADifferentSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromADifferentSubscription.json new file mode 100644 index 000000000000..04099033b89b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromADifferentSubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromTheSameSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromTheSameSubscription.json new file mode 100644 index 000000000000..c27fa7a173f7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskByImportingAnUnmanagedBlobFromTheSameSubscription.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskFromAPlatformImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskFromAPlatformImage.json new file mode 100644 index 000000000000..a08c744382c5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskFromAPlatformImage.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + }, + "200": { + "body": { + "name": "myDisk", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskFromAnExistingManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskFromAnExistingManagedDisk.json new file mode 100644 index 000000000000..77e9a0f63a2f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskFromAnExistingManagedDisk.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myDisk2", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + } + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk2" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDisk1" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk2" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskWithDiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskWithDiskAccess.json new file mode 100644 index 000000000000..e84d4ad3d972 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskWithDiskAccess.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "networkAccessPolicy": "AllowPrivate", + "diskAccessId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/{existing-diskAccess-name}" + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "networkAccessPolicy": "AllowPrivate", + "diskAccessId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/{existing-diskAccess-name}" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskWithDiskEncryptionSet.json new file mode 100644 index 000000000000..1d5673635ef0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedDiskWithDiskEncryptionSet.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "encryption": { + "diskEncryptionSetId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "encryption": { + "diskEncryptionSetId": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedUploadDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedUploadDisk.json new file mode 100644 index 000000000000..6e4e296a8203 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAManagedUploadDisk.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + } + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Upload", + "uploadSizeBytes": 10737418752 + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromADifferentSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromADifferentSubscription.json new file mode 100644 index 000000000000..2b3f867bf38f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromADifferentSubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "snapshotName": "mySnapshot1", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromTheSameSubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromTheSameSubscription.json new file mode 100644 index 000000000000..01d02842d7ef --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotByImportingAnUnmanagedBlobFromTheSameSubscription.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "snapshotName": "mySnapshot1", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + } + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Import", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "mySnapshot1" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotFromAnExistingSnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotFromAnExistingSnapshot.json new file mode 100644 index 000000000000..da2e8f151dce --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateASnapshotFromAnExistingSnapshot.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "snapshotName": "mySnapshot2", + "snapshot": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + }, + "200": { + "body": { + "name": "mySnapshot2", + "location": "West US", + "properties": { + "provisioningState": "Updating", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAnEmptyManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAnEmptyManagedDisk.json new file mode 100644 index 000000000000..ce8be10e624c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/CreateAnEmptyManagedDisk.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myDisk", + "disk": { + "location": "West US", + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200 + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/DeleteADiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/DeleteADiskAccess.json new file mode 100644 index 000000000000..cd138298f526 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/DeleteADiskAccess.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskAccessName": "myDiskAccess", + "api-version": "2020-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/DeleteADiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/DeleteADiskEncryptionSet.json new file mode 100644 index 000000000000..5b3569467275 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/DeleteADiskEncryptionSet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "diskEncryptionSetName": "myDiskEncryptionSet", + "api-version": "2020-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetDiskAccessPrivateLinkResources.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetDiskAccessPrivateLinkResources.json new file mode 100644 index 000000000000..03ffff09b0ff --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetDiskAccessPrivateLinkResources.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateLinkResources/disks", + "name": "disks", + "type": "Microsoft.Compute/diskAccesses/privateLinkResources", + "properties": { + "groupId": "disks", + "requiredMembers": [ + "diskAccess_1" + ], + "requiredZoneNames": [ + "privatelink.blob.core.windows.net" + ] + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskAccess.json new file mode 100644 index 000000000000..085ca9beb839 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskAccess.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskAccessWithPrivateEndpoints.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskAccessWithPrivateEndpoints.json new file mode 100644 index 000000000000..64b76c11afb0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskAccessWithPrivateEndpoints.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskAccessName": "myDiskAccess" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00", + "privateEndpointConnections": [ + { + "name": "myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess/privateEndpoinConnections/myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskEncryptionSet.json new file mode 100644 index 000000000000..79dd5a069b1e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutADiskEncryptionSet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskEncryptionSetName": "myDiskEncryptionSet" + }, + "responses": { + "200": { + "body": { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutAManagedDisk.json new file mode 100644 index 000000000000..c0d091d9d798 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutAManagedDisk.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myManagedDisk" + }, + "responses": { + "200": { + "body": { + "managedBy": "/subscriptions/123caaa-123v-v211-a49f-f88ccac5bf88/resourceGroups/ResourceGroupName/providers/Microsoft.Compute/virtualMachines/TestVM414689371c88843d65ec", + "sku": { + "name": "Standard_LRS" + }, + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutASnapshot.json new file mode 100644 index 000000000000..c3ec32fa4a7e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/GetInformationAboutASnapshot.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "snapshotName": "mySnapshot" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 100, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.079872+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskAccessesInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskAccessesInAResourceGroup.json new file mode 100644 index 000000000000..d6b8dada0e9a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskAccessesInAResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + }, + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00", + "privateEndpointConnections": [ + { + "name": "myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2/privateEndpoinConnections/myDiskAccess2.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint2" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2", + "name": "myDiskAccess2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskAccessesInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskAccessesInASubscription.json new file mode 100644 index 000000000000..85db06c39cb5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskAccessesInASubscription.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00" + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "name": "myDiskAccess" + }, + { + "properties": { + "provisioningState": "Succeeded", + "timeCreated": "2020-05-01T04:41:35.079872+00:00", + "privateEndpointConnections": [ + { + "name": "myDiskAccess.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "type": "Microsoft.Compute/diskAccesses/PrivateEndpointConnections", + "id": "/subscriptions/{subscription-id}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2/privateEndpoinConnections/myDiskAccess2.d4914cfa-6bc2-4049-a57c-3d1f622d8eef", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/{subscription-id}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint2" + }, + "privateLinkServiceConnectionState": { + "actionsRequired": "None", + "description": "Auto-Approved", + "status": "Approved" + } + } + } + ] + }, + "type": "Microsoft.Compute/diskAccesses", + "location": "westus", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess2", + "name": "myDiskAccess2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskAccesses?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskEncryptionSetsInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskEncryptionSetsInAResourceGroup.json new file mode 100644 index 000000000000..fc267bdcfc29 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskEncryptionSetsInAResourceGroup.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + }, + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2", + "name": "myDiskEncryptionSet2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskEncryptionSetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskEncryptionSetsInASubscription.json new file mode 100644 index 000000000000..4680795b13c8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListDiskEncryptionSetsInASubscription.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet", + "name": "myDiskEncryptionSet" + }, + { + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/mySecondResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault2" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/diskEncryptionSets", + "location": "westus", + "tags": { + "department": "Development", + "project": "Encryption" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/mySecondResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/myDiskEncryptionSet2", + "name": "myDiskEncryptionSet2" + } + ], + "nextLink": "https://management.azure.com/subscriptions/{subscriptionId}/providers/Microsoft.Compute/diskEncryptionSets?$skiptoken={token}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListManagedDisksInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListManagedDisksInAResourceGroup.json new file mode 100644 index 000000000000..99577d2019b5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListManagedDisksInAResourceGroup.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.872242+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk2" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.3973934+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk", + "name": "myManagedDisk3" + } + ], + "nextLink": "http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListManagedDisksInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListManagedDisksInASubscription.json new file mode 100644 index 000000000000..7a11120324f5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListManagedDisksInASubscription.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1", + "name": "myManagedDisk1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 10, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.872242+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2", + "name": "myManagedDisk2" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "FromImage", + "imageReference": { + "id": "/Subscriptions/{subscriptionId}/Providers/Microsoft.Compute/Locations/uswest/Publishers/Microsoft/ArtifactTypes/VMImage/Offers/{offer}" + } + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:36.3973934+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/disks", + "location": "westus", + "tags": { + "department": "Development", + "project": "ManagedDisks" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk3", + "name": "myManagedDisk3" + } + ], + "nextLink": "http://disksvchost:99/subscriptions/{subscriptionId}/providers/Microsoft.Compute/disks?$skiptoken={token}/Subscriptions/{subscriptionId}/ResourceGroups/myResourceGroup/Disks/myManagedDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListSnapshotsInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListSnapshotsInAResourceGroup.json new file mode 100644 index 000000000000..2731bf774cf2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListSnapshotsInAResourceGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:41:35.9278721+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot", + "name": "mySnapshot" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListSnapshotsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListSnapshotsInASubscription.json new file mode 100644 index 000000000000..1a4bd0559f34 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/ListSnapshotsInASubscription.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Copy", + "sourceResourceId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:47:30.6630569+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1", + "name": "mySnapshot1" + }, + { + "properties": { + "osType": "Windows", + "creationData": { + "createOption": "Import", + "storageAccountId": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Storage/storageAccounts/myStorageAccount", + "sourceUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd" + }, + "diskSizeGB": 200, + "encryptionSettingsCollection": { + "enabled": true, + "encryptionSettings": [ + { + "diskEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "secretUrl": "https://myvmvault.vault-int.azure-int.net/secrets/{secret}" + }, + "keyEncryptionKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + } + ] + }, + "encryption": { + "type": "EncryptionAtRestWithPlatformKey" + }, + "timeCreated": "2016-12-28T04:47:30.3247198+00:00", + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/snapshots", + "location": "westus", + "tags": { + "department": "Development", + "project": "Snapshots" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2", + "name": "mySnapshot2" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateADiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateADiskAccess.json new file mode 100644 index 000000000000..fa0d26f53b12 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateADiskAccess.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskAccessName": "myDiskAccess", + "diskAccess": { + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDiskAccess", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "type": "Microsoft.Compute/diskAccesses", + "location": "West US", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + } + } + }, + "200": { + "body": { + "name": "myDiskAccess", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourcegroup/providers/Microsoft.Compute/diskAccesses/myDiskAccess", + "type": "Microsoft.Compute/diskAccesses", + "location": "West US", + "tags": { + "department": "Development", + "project": "PrivateEndpoints" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateADiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateADiskEncryptionSet.json new file mode 100644 index 000000000000..31573f1e0edf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateADiskEncryptionSet.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskEncryptionSetName": "myDiskEncryptionSet", + "diskEncryptionSet": { + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + } + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + }, + "responses": { + "202": { + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [] + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + }, + "200": { + "body": { + "name": "myDiskEncryptionSet", + "location": "West US", + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "activeKey": { + "sourceVault": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.KeyVault/vaults/myVMVault" + }, + "keyUrl": "https://myvmvault.vault-int.azure-int.net/keys/{key}" + }, + "previousKeys": [] + }, + "tags": { + "department": "Development", + "project": "Encryption" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateAManagedDiskToRemoveDiskAccess.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateAManagedDiskToRemoveDiskAccess.json new file mode 100644 index 000000000000..a9cbcf115a87 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/examples/UpdateAManagedDiskToRemoveDiskAccess.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "diskName": "myDisk", + "disk": { + "properties": { + "networkAccessPolicy": "AllowAll" + } + } + }, + "responses": { + "202": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Updating", + "networkAccessPolicy": "AllowAll" + }, + "location": "West US", + "name": "myDisk" + } + }, + "200": { + "body": { + "properties": { + "creationData": { + "createOption": "Empty" + }, + "diskSizeGB": 200, + "provisioningState": "Succeeded", + "networkAccessPolicy": "AllowAll" + }, + "location": "West US", + "name": "myDisk" + } + } + } +} diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index fd00318c0fe8..46f7bb57354b 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -34,7 +34,7 @@ These are the global settings for the Compute API. title: ComputeManagementClient description: Compute Client openapi-type: arm -tag: package-2019-12-01 +tag: package-2020-05-01 directive: - where: @@ -215,6 +215,29 @@ directive: ``` +### Tag: package-2020-05-01 + +These settings apply only when `--tag=package-2020-05-01` is specified on the command line. + +``` yaml $(tag) == 'package-2020-05-01' +input-file: +- Microsoft.Compute/stable/2019-12-01/compute.json +- Microsoft.Compute/stable/2019-12-01/runCommands.json +- Microsoft.Compute/stable/2019-04-01/skus.json +- Microsoft.Compute/stable/2020-05-01/disk.json +- Microsoft.Compute/stable/2019-12-01/gallery.json +- Microsoft.ContainerService/stable/2017-01-31/containerService.json +``` + +### Tag: package-2020-05-01-only + +These settings apply only when `--tag=package-2020-05-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2020-05-01-only' +input-file: +- Microsoft.Compute/stable/2020-05-01/disk.json +``` + ### Tag: package-2019-12-01 These settings apply only when `--tag=package-2019-12-01` is specified on the command line. @@ -774,6 +797,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.Compute/stable/2020-05-01/disk.json - $(this-folder)/Microsoft.Compute/stable/2019-12-01/compute.json - $(this-folder)/Microsoft.Compute/stable/2019-12-01/runCommands.json - $(this-folder)/Microsoft.Compute/stable/2019-04-01/skus.json From c164a415d14b81fca68c45071a44b58888cdcb32 Mon Sep 17 00:00:00 2001 From: Filiz Topatan Date: Sun, 7 Jun 2020 22:22:32 -0700 Subject: [PATCH 105/318] [Resources] Add new API version (#9487) * Initial commit with the old version * Add error proprty to DeploymentOperationProperties * Add enum values for provisioningState * Update provisioningState description * Update statusMessage property * Update api-version and parameters in examples * Update readme.md to refer to the new resources swagger * Prettier fix; we can Python sdk too * Added id and relativePath parameters to TemplateLink * update csharp and java read me files for the new API * Address Pr feedback * Examples for TemplateSpecs deployment * Unblock Java SDK generation * Fix examples for templatespecs * prettier fixes Co-authored-by: Filiz Topatan Co-authored-by: Gokul Premraj --- .../examples/CalculateTemplateHash.json | 46 + .../examples/CreateResourceGroup.json | 32 + .../examples/ExportResourceGroup.json | 68 + .../ExportResourceGroupWithFiltering.json | 46 + .../2020-06-01/examples/GetTagsResource.json | 18 + .../examples/GetTagsSubscription.json | 18 + .../PostDeploymentWhatIfOnResourceGroup.json | 73 + .../PostDeploymentWhatIfOnSubscription.json | 84 + .../PutDeploymentAtManagementGroup.json | 139 + .../examples/PutDeploymentAtScope.json | 151 + .../examples/PutDeploymentAtTenant.json | 150 + ...ymentResourceGroupTemplateSpecsWithId.json | 92 + ...oymentSubscriptionTemplateSpecsWithId.json | 66 + ...ntWithOnErrorDeploymentLastSuccessful.json | 168 + ...thOnErrorDeploymentSpecificDeployment.json | 169 + .../2020-06-01/examples/PutTagsResource.json | 26 + .../examples/PutTagsSubscription.json | 26 + .../stable/2020-06-01/resources.json | 5913 +++++++++++++++++ .../resource-manager/readme.csharp.md | 79 + .../resources/resource-manager/readme.java.md | 14 + .../resources/resource-manager/readme.md | 11 +- .../resource-manager/readme.python.md | 15 + 22 files changed, 7403 insertions(+), 1 deletion(-) create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/CalculateTemplateHash.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/CreateResourceGroup.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/ExportResourceGroup.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/ExportResourceGroupWithFiltering.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetTagsResource.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetTagsSubscription.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnResourceGroup.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnSubscription.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtManagementGroup.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtScope.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtTenant.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutTagsResource.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutTagsSubscription.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/CalculateTemplateHash.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/CalculateTemplateHash.json new file mode 100644 index 000000000000..719bd2aff5e6 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/CalculateTemplateHash.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "template": { + "$schema": "http://schemas.management.azure.com/deploymentTemplate?api-version=2014-04-01-preview", + "contentVersion": "1.0.0.0", + "parameters": { + "string": { + "type": "string" + } + }, + "variables": { + "string": "string", + "int": 42, + "bool": true, + "array": [ + 1, + 2, + 3, + 4 + ], + "object": { + "object": { + "vmSize": "Large", + "location": "West US" + } + } + }, + "resources": [], + "outputs": { + "string": { + "type": "string", + "value": "myvalue" + } + } + } + }, + "responses": { + "200": { + "body": { + "minifiedTemplate": "{\"$SCHEMA\":\"HTTP://SCHEMAS.MANAGEMENT.AZURE.COM/DEPLOYMENTTEMPLATE?API-VERSION=2014-04-01-PREVIEW\",\"CONTENTVERSION\":\"1.0.0.0\",\"PARAMETERS\":{\"STRING\":{\"TYPE\":\"STRING\"}},\"VARIABLES\":{\"STRING\":\"STRING\",\"INT\":42,\"BOOL\":TRUE,\"ARRAY\":[1,2,3,4],\"OBJECT\":{\"OBJECT\":{\"VMSIZE\":\"LARGE\",\"LOCATION\":\"WEST US\"}}},\"RESOURCES\":[],\"OUTPUTS\":{\"STRING\":{\"TYPE\":\"STRING\",\"VALUE\":\"MYVALUE\"}}}", + "templateHash": "695440707931307747" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/CreateResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/CreateResourceGroup.json new file mode 100644 index 000000000000..096db5c70dc5 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/CreateResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "my-resource-group", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group", + "name": "my-resource-group", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group", + "name": "my-resource-group", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/ExportResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/ExportResourceGroup.json new file mode 100644 index 000000000000..d611dfcf411c --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/ExportResourceGroup.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "my-resource-group", + "api-version": "2020-06-01", + "parameters": { + "resources": [ + "*" + ], + "options": "IncludeParameterDefaultValue,IncludeComments" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01" + } + }, + "200": { + "body": { + "template": { + "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": { + "myResourceType_myFirstResource_name": { + "defaultValue": "myFirstResource", + "type": "String" + }, + "myResourceType_mySecondResource_name": { + "defaultValue": "mySecondResource", + "type": "String" + }, + "myResourceType_myFirstResource_secret": { + "defaultValue": null, + "type": "SecureString" + } + }, + "variables": {}, + "resources": [ + { + "type": "My.RP/myResourceType", + "apiVersion": "2019-01-01", + "name": "[parameters('myResourceType_myFirstResource_name')]", + "location": "West US", + "properties": { + "secret": "[parameters('myResourceType_myFirstResource_secret')]" + } + }, + { + "type": "My.RP/myResourceType", + "apiVersion": "2019-01-01", + "name": "[parameters('myResourceType_mySecondResource_name')]", + "location": "West US", + "properties": { + "customProperty": "hello!" + } + } + ] + }, + "error": { + "code": "ExportTemplateCompletedWithErrors", + "message": "Export template operation completed with errors. Some resources were not exported. Please see details for more information.", + "details": [] + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/ExportResourceGroupWithFiltering.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/ExportResourceGroupWithFiltering.json new file mode 100644 index 000000000000..b0b251b7414f --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/ExportResourceGroupWithFiltering.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "my-resource-group", + "api-version": "2020-06-01", + "parameters": { + "resources": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/my-resource-group/providers/My.RP/myResourceType/myFirstResource" + ], + "options": "SkipResourceNameParameterization" + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/operationresults/c9bbccf4-e16a-4eb7-befb-2e2e5195c347?api-version=2018-08-01" + } + }, + "200": { + "body": { + "template": { + "$schema": "https://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": { + "myResourceType_myFirstResource_secret": { + "defaultValue": null, + "type": "SecureString" + } + }, + "variables": {}, + "resources": [ + { + "type": "My.RP/myResourceType", + "apiVersion": "2019-01-01", + "name": "myFirstResource", + "location": "West US", + "properties": { + "secret": "[parameters('myResourceType_myFirstResource_secret')]" + } + } + ] + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetTagsResource.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetTagsResource.json new file mode 100644 index 000000000000..56144dde4570 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetTagsResource.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetTagsSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetTagsSubscription.json new file mode 100644 index 000000000000..f9687306265e --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/GetTagsSubscription.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnResourceGroup.json new file mode 100644 index 000000000000..0fd56fa4f3cd --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnResourceGroup.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000001", + "resourceGroupName": "my-resource-group", + "deploymentName": "my-deployment", + "api-version": "2020-06-01", + "parameters": { + "properties": { + "templateLink": "https://example.com/exampleTemplate.json", + "parameters": {}, + "mode": "Incremental" + } + } + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "properties": { + "changes": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity", + "changeType": "Modify", + "before": { + "apiVersion": "2018-11-30", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity", + "type": "Microsoft.ManagedIdentity/userAssignedIdentities", + "name": "myExistingIdentity", + "location": "westus2" + }, + "after": { + "apiVersion": "2018-11-30", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity", + "type": "Microsoft.ManagedIdentity/userAssignedIdentities", + "name": "myExistingIdentity", + "location": "westus2", + "tags": { + "myNewTag": "my tag value" + } + }, + "delta": [ + { + "path": "tags.myNewTag", + "propertyChangeType": "Create", + "after": "my tag value" + } + ] + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity", + "changeType": "Create", + "after": { + "apiVersion": "2018-11-30", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity", + "type": "Microsoft.ManagedIdentity/userAssignedIdentities", + "name": "myNewIdentity", + "location": "eastus", + "tags": { + "myOtherNewTag": "another new tag value" + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "/subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnSubscription.json new file mode 100644 index 000000000000..07e9ab646da7 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnSubscription.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000001", + "deploymentName": "my-deployment", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "templateLink": "https://example.com/exampleTemplate.json", + "parameters": {}, + "mode": "Incremental" + } + } + }, + "responses": { + "200": { + "body": { + "status": "succeeded", + "properties": { + "changes": [ + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity", + "changeType": "Modify", + "before": { + "apiVersion": "2018-11-30", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity", + "type": "Microsoft.ManagedIdentity/userAssignedIdentities", + "name": "myExistingIdentity", + "location": "westus2" + }, + "after": { + "apiVersion": "2018-11-30", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myExistingIdentity", + "type": "Microsoft.ManagedIdentity/userAssignedIdentities", + "name": "myExistingIdentity", + "location": "westus2", + "tags": { + "myNewTag": "my tag value" + } + }, + "delta": [ + { + "path": "tags.myNewTag", + "propertyChangeType": "Create", + "after": "my tag value" + } + ] + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity", + "changeType": "Create", + "after": { + "apiVersion": "2018-11-30", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.ManagedIdentity/userAssignedIdentities/myNewIdentity", + "type": "Microsoft.ManagedIdentity/userAssignedIdentities", + "name": "myNewIdentity", + "location": "eastus", + "tags": { + "myOtherNewTag": "another new tag value" + } + } + }, + { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2", + "changeType": "Create", + "after": { + "apiVersion": "2019-03-01", + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group2", + "type": "Microsoft.Resources/resourceGroups", + "name": "my-resource-group2", + "location": "{location3}" + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "/subscriptions/00000000-0000-0000-0000-000000000000/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtManagementGroup.json new file mode 100644 index 000000000000..e6fe90cae1e0 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtManagementGroup.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "groupId": "my-management-group-id", + "deploymentName": "my-deployment", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "templateLink": { + "uri": "https://example.com/exampleTemplate.json" + }, + "parameters": {}, + "mode": "Incremental" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "location": "eastus", + "properties": { + "parameters": {}, + "mode": "Incremental", + "provisioningState": "Accepted", + "timestamp": "2019-04-24T22:52:38.7895563Z", + "duration": "PT1.2970875S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Authorization", + "resourceTypes": [ + { + "resourceType": "policyDefinitions", + "locations": [ + null + ] + }, + { + "resourceType": "policyAssignments", + "locations": [ + null + ] + } + ] + }, + { + "namespace": "Microsoft.Resources", + "resourceTypes": [ + { + "resourceType": "deployments", + "locations": [ + "eastus" + ] + } + ] + } + ], + "dependencies": [ + { + "dependsOn": [ + { + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name", + "resourceType": "Microsoft.Authorization/policyDefinitions", + "resourceName": "policy-definition-name" + } + ], + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock", + "resourceType": "Microsoft.Authorization/policyAssignments", + "resourceName": "location-lock" + } + ] + } + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "location": "eastus", + "properties": { + "parameters": {}, + "mode": "Incremental", + "provisioningState": "Accepted", + "timestamp": "2019-04-24T22:52:38.7895563Z", + "duration": "PT1.2970875S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Authorization", + "resourceTypes": [ + { + "resourceType": "policyDefinitions", + "locations": [ + null + ] + }, + { + "resourceType": "policyAssignments", + "locations": [ + null + ] + } + ] + }, + { + "namespace": "Microsoft.Resources", + "resourceTypes": [ + { + "resourceType": "deployments", + "locations": [ + "eastus" + ] + } + ] + } + ], + "dependencies": [ + { + "dependsOn": [ + { + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name", + "resourceType": "Microsoft.Authorization/policyDefinitions", + "resourceName": "policy-definition-name" + } + ], + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock", + "resourceType": "Microsoft.Authorization/policyAssignments", + "resourceName": "location-lock" + } + ] + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtScope.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtScope.json new file mode 100644 index 000000000000..b3964c7fa7bf --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtScope.json @@ -0,0 +1,151 @@ +{ + "parameters": { + "scope": "providers/Microsoft.Management/managementGroups/my-management-group-id", + "deploymentName": "my-deployment", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "templateLink": { + "uri": "https://example.com/exampleTemplate.json" + }, + "parameters": {}, + "mode": "Incremental" + }, + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "location": "eastus", + "properties": { + "parameters": {}, + "mode": "Incremental", + "provisioningState": "Accepted", + "timestamp": "2019-04-24T22:52:38.7895563Z", + "duration": "PT1.2970875S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Authorization", + "resourceTypes": [ + { + "resourceType": "policyDefinitions", + "locations": [ + null + ] + }, + { + "resourceType": "policyAssignments", + "locations": [ + null + ] + } + ] + }, + { + "namespace": "Microsoft.Resources", + "resourceTypes": [ + { + "resourceType": "deployments", + "locations": [ + "eastus" + ] + } + ] + } + ], + "dependencies": [ + { + "dependsOn": [ + { + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name", + "resourceType": "Microsoft.Authorization/policyDefinitions", + "resourceName": "policy-definition-name" + } + ], + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock", + "resourceType": "Microsoft.Authorization/policyAssignments", + "resourceName": "location-lock" + } + ] + }, + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "location": "eastus", + "properties": { + "parameters": {}, + "mode": "Incremental", + "provisioningState": "Accepted", + "timestamp": "2019-04-24T22:52:38.7895563Z", + "duration": "PT1.2970875S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Authorization", + "resourceTypes": [ + { + "resourceType": "policyDefinitions", + "locations": [ + null + ] + }, + { + "resourceType": "policyAssignments", + "locations": [ + null + ] + } + ] + }, + { + "namespace": "Microsoft.Resources", + "resourceTypes": [ + { + "resourceType": "deployments", + "locations": [ + "eastus" + ] + } + ] + } + ], + "dependencies": [ + { + "dependsOn": [ + { + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name", + "resourceType": "Microsoft.Authorization/policyDefinitions", + "resourceName": "policy-definition-name" + } + ], + "id": "/providers/Microsoft.Management/managementGroups/my-management-group-id/providers/Microsoft.Authorization/policyAssignments/location-lock", + "resourceType": "Microsoft.Authorization/policyAssignments", + "resourceName": "location-lock" + } + ] + }, + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtTenant.json new file mode 100644 index 000000000000..9b8a3f96e2d5 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentAtTenant.json @@ -0,0 +1,150 @@ +{ + "parameters": { + "deploymentName": "tenant-dep01", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "templateLink": { + "uri": "https://example.com/exampleTemplate.json" + }, + "parameters": {}, + "mode": "Incremental" + }, + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Resources/deployments/tenant-dep01", + "name": "tenant-dep01", + "type": "Microsoft.Resources/deployments", + "location": "eastus", + "properties": { + "parameters": {}, + "mode": "Incremental", + "provisioningState": "Accepted", + "timestamp": "2019-04-24T22:52:38.7895563Z", + "duration": "PT1.2970875S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Authorization", + "resourceTypes": [ + { + "resourceType": "policyDefinitions", + "locations": [ + null + ] + }, + { + "resourceType": "policyAssignments", + "locations": [ + null + ] + } + ] + }, + { + "namespace": "Microsoft.Resources", + "resourceTypes": [ + { + "resourceType": "deployments", + "locations": [ + "eastus" + ] + } + ] + } + ], + "dependencies": [ + { + "dependsOn": [ + { + "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name", + "resourceType": "Microsoft.Authorization/policyDefinitions", + "resourceName": "policy-definition-name" + } + ], + "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock", + "resourceType": "Microsoft.Authorization/policyAssignments", + "resourceName": "location-lock" + } + ] + }, + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + }, + "201": { + "body": { + "id": "/providers/Microsoft.Resources/deployments/tenant-dep01", + "name": "tenant-dep01", + "type": "Microsoft.Resources/deployments", + "location": "eastus", + "properties": { + "parameters": {}, + "mode": "Incremental", + "provisioningState": "Accepted", + "timestamp": "2019-04-24T22:52:38.7895563Z", + "duration": "PT1.2970875S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Authorization", + "resourceTypes": [ + { + "resourceType": "policyDefinitions", + "locations": [ + null + ] + }, + { + "resourceType": "policyAssignments", + "locations": [ + null + ] + } + ] + }, + { + "namespace": "Microsoft.Resources", + "resourceTypes": [ + { + "resourceType": "deployments", + "locations": [ + "eastus" + ] + } + ] + } + ], + "dependencies": [ + { + "dependsOn": [ + { + "id": "/providers/Microsoft.Authorization/policyDefinitions/policy-definition-name", + "resourceType": "Microsoft.Authorization/policyDefinitions", + "resourceName": "policy-definition-name" + } + ], + "id": "/providers/Microsoft.Authorization/policyAssignments/location-lock", + "resourceType": "Microsoft.Authorization/policyAssignments", + "resourceName": "location-lock" + } + ] + }, + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json new file mode 100644 index 000000000000..621dc58ff4a8 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentResourceGroupTemplateSpecsWithId.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000001", + "resourceGroupName": "my-resource-group", + "deploymentName": "my-deployment", + "api-version": "2020-06-01", + "parameters": { + "properties": { + "templateLink": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1" + }, + "parameters": {}, + "mode": "Incremental" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "properties": { + "templateLink": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1", + "contentVersion": "1.0.0.0" + }, + "templateHash": "0000000000000000000", + "parameters": {}, + "mode": "Incremental", + "provisioningState": "Succeeded", + "timestamp": "2020-06-05T01:20:01.723776Z", + "duration": "PT22.8356799S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Storage", + "resourceTypes": [ + { + "resourceType": "storageAccounts", + "locations": [ + "eastus" + ] + } + ] + } + ], + "dependencies": [], + "outputResources": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Storage/storageAccounts/my-storage-account" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "properties": { + "templateLink": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1", + "contentVersion": "1.0.0.0" + }, + "templateHash": "0000000000000000000", + "parameters": {}, + "mode": "Incremental", + "provisioningState": "Accepted", + "timestamp": "2020-06-05T01:20:01.723776Z", + "duration": "PT22.8356799S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Storage", + "resourceTypes": [ + { + "resourceType": "storageAccounts", + "locations": [ + "eastus" + ] + } + ] + } + ], + "dependencies": [] + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json new file mode 100644 index 000000000000..0535e39dc58b --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentSubscriptionTemplateSpecsWithId.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000001", + "deploymentName": "my-deployment", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "templateLink": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1" + }, + "parameters": {}, + "mode": "Incremental" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "location": "eastus", + "properties": { + "templateLink": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1", + "contentVersion": "1.0.0.0" + }, + "templateHash": "0000000000000000000", + "parameters": {}, + "mode": "Incremental", + "provisioningState": "Succeeded", + "timestamp": "2020-06-05T01:51:58.6288067Z", + "duration": "PT1.2637681S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [], + "dependencies": [], + "outputResources": [] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "location": "eastus", + "properties": { + "templateLink": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000001/resourceGroups/my-resource-group/providers/Microsoft.Resources/TemplateSpecs/TemplateSpec-Name/versions/v1", + "contentVersion": "1.0.0.0" + }, + "templateHash": "0000000000000000000", + "parameters": {}, + "mode": "Incremental", + "provisioningState": "Accepted", + "timestamp": "2020-06-05T01:51:58.6288067Z", + "duration": "PT1.2637681S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [], + "dependencies": [] + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json new file mode 100644 index 000000000000..dd3f441c1c5c --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "my-resource-group", + "deploymentName": "my-deployment", + "api-version": "2020-06-01", + "parameters": { + "properties": { + "templateLink": { + "uri": "https://example.com/exampleTemplate.json" + }, + "parameters": {}, + "mode": "Complete", + "onErrorDeployment": { + "type": "LastSuccessful" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "properties": { + "templateLink": { + "uri": "https://example.com/exampleTemplate.json", + "contentVersion": "1.0.0.0" + }, + "parameters": {}, + "mode": "Complete", + "provisioningState": "Accepted", + "timestamp": "2019-03-01T00:00:00.0000000Z", + "duration": "PT0.8204881S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Network", + "resourceTypes": [ + { + "resourceType": "virtualNetworks", + "locations": [ + "centralus" + ] + }, + { + "resourceType": "virtualNetworks/subnets", + "locations": [ + "centralus" + ] + } + ] + } + ], + "dependencies": [ + { + "dependsOn": [ + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks", + "resourceName": "VNet1" + } + ], + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet1" + }, + { + "dependsOn": [ + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks", + "resourceName": "VNet1" + }, + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet1" + } + ], + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet2" + } + ], + "onErrorDeployment": { + "type": "LastSuccessful", + "deploymentName": "{nameOfLastSuccesfulDeployment}" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "properties": { + "templateLink": { + "uri": "https://example.com/exampleTemplate.json", + "contentVersion": "1.0.0.0" + }, + "parameters": {}, + "mode": "Complete", + "provisioningState": "Accepted", + "timestamp": "2019-03-01T00:00:00.0000000Z", + "duration": "PT0.8204881S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Network", + "resourceTypes": [ + { + "resourceType": "virtualNetworks", + "locations": [ + "centralus" + ] + }, + { + "resourceType": "virtualNetworks/subnets", + "locations": [ + "centralus" + ] + } + ] + } + ], + "dependencies": [ + { + "dependsOn": [ + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks", + "resourceName": "VNet1" + } + ], + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet1" + }, + { + "dependsOn": [ + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks", + "resourceName": "VNet1" + }, + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet1" + } + ], + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet2" + } + ], + "onErrorDeployment": { + "type": "LastSuccessful", + "deploymentName": "{nameOfLastSuccesfulDeployment}" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json new file mode 100644 index 000000000000..795092a412d5 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "my-resource-group", + "deploymentName": "my-deployment", + "api-version": "2020-06-01", + "parameters": { + "properties": { + "templateLink": { + "uri": "https://example.com/exampleTemplate.json" + }, + "parameters": {}, + "mode": "Complete", + "onErrorDeployment": { + "type": "SpecificDeployment", + "deploymentName": "name-of-deployment-to-use" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "properties": { + "templateLink": { + "uri": "https://example.com/exampleTemplate.json", + "contentVersion": "1.0.0.0" + }, + "parameters": {}, + "mode": "Complete", + "provisioningState": "Accepted", + "timestamp": "2019-03-01T00:00:00.0000000Z", + "duration": "PT0.8204881S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Network", + "resourceTypes": [ + { + "resourceType": "virtualNetworks", + "locations": [ + "centralus" + ] + }, + { + "resourceType": "virtualNetworks/subnets", + "locations": [ + "centralus" + ] + } + ] + } + ], + "dependencies": [ + { + "dependsOn": [ + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks", + "resourceName": "VNet1" + } + ], + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet1" + }, + { + "dependsOn": [ + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks", + "resourceName": "VNet1" + }, + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet1" + } + ], + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet2" + } + ], + "onErrorDeployment": { + "type": "SpecificDeployment", + "deploymentName": "name-of-deployment-to-use" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/Microsoft.Resources/deployments/my-deployment", + "name": "my-deployment", + "type": "Microsoft.Resources/deployments", + "properties": { + "templateLink": { + "uri": "https://example.com/exampleTemplate.json", + "contentVersion": "1.0.0.0" + }, + "parameters": {}, + "mode": "Complete", + "provisioningState": "Accepted", + "timestamp": "2019-03-01T00:00:00.0000000Z", + "duration": "PT0.8204881S", + "correlationId": "00000000-0000-0000-0000-000000000000", + "providers": [ + { + "namespace": "Microsoft.Network", + "resourceTypes": [ + { + "resourceType": "virtualNetworks", + "locations": [ + "centralus" + ] + }, + { + "resourceType": "virtualNetworks/subnets", + "locations": [ + "centralus" + ] + } + ] + } + ], + "dependencies": [ + { + "dependsOn": [ + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks", + "resourceName": "VNet1" + } + ], + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet1" + }, + { + "dependsOn": [ + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks", + "resourceName": "VNet1" + }, + { + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet1" + } + ], + "id": "{resourceid}", + "resourceType": "Microsoft.Network/virtualNetworks/subnets", + "resourceName": "VNet1/Subnet2" + } + ], + "onErrorDeployment": { + "type": "SpecificDeployment", + "deploymentName": "name-of-deployment-to-use" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutTagsResource.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutTagsResource.json new file mode 100644 index 000000000000..613d9770af33 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutTagsResource.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/my-resource-group/providers/myPRNameSpace/VM/myVm", + "api-version": "2020-06-01", + "parameters": { + "properties": { + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutTagsSubscription.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutTagsSubscription.json new file mode 100644 index 000000000000..8a603526dbce --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PutTagsSubscription.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "api-version": "2020-06-01", + "parameters": { + "properties": { + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "tags": { + "tagKey1": "tag-value-1", + "tagKey2": "tag-value-2" + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json new file mode 100644 index 000000000000..ff07635dde6f --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json @@ -0,0 +1,5913 @@ +{ + "swagger": "2.0", + "info": { + "title": "ResourceManagementClient", + "version": "2020-06-01", + "description": "Provides operations for working with resources and resource groups." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Resources/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Microsoft.Resources REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_DeleteAtScope", + "summary": "Deletes a deployment from the deployment history.", + "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "head": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CheckExistenceAtScope", + "description": "Checks whether the deployment exists.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdateAtScope", + "summary": "Deploys resources at a given scope.", + "description": "You can provide the template and parameters directly in the request or link to JSON files.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Additional parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "201": { + "description": "Created - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create deployment at a given scope.": { + "$ref": "./examples/PutDeploymentAtScope.json" + } + } + }, + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_GetAtScope", + "description": "Gets a deployment.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CancelAtScope", + "summary": "Cancels a currently running template deployment.", + "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ValidateAtScope", + "x-ms-long-running-operation": true, + "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "202": { + "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously." + }, + "400": { + "description": "Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ExportTemplateAtScope", + "description": "Exports the template used for specified deployment.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the template.", + "schema": { + "$ref": "#/definitions/DeploymentExportResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Resources/deployments/": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ListAtScope", + "description": "Get all the deployments at the given scope.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to get. If null is passed, returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of deployments.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DeploymentExtendedFilter" + } + }, + "/providers/Microsoft.Resources/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_DeleteAtTenantScope", + "summary": "Deletes a deployment from the deployment history.", + "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "head": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CheckExistenceAtTenantScope", + "description": "Checks whether the deployment exists.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdateAtTenantScope", + "summary": "Deploys resources at tenant scope.", + "description": "You can provide the template and parameters directly in the request or link to JSON files.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopedDeployment" + }, + "description": "Additional parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "201": { + "description": "Created - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create deployment at tenant scope.": { + "$ref": "./examples/PutDeploymentAtTenant.json" + } + } + }, + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_GetAtTenantScope", + "description": "Gets a deployment.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CancelAtTenantScope", + "summary": "Cancels a currently running template deployment.", + "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ValidateAtTenantScope", + "x-ms-long-running-operation": true, + "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopedDeployment" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "202": { + "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously." + }, + "400": { + "description": "Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ExportTemplateAtTenantScope", + "description": "Exports the template used for specified deployment.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the template.", + "schema": { + "$ref": "#/definitions/DeploymentExportResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Resources/deployments/": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ListAtTenantScope", + "description": "Get all the deployments at the tenant scope.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to get. If null is passed, returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of deployments.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DeploymentExtendedFilter" + } + }, + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_DeleteAtManagementGroupScope", + "summary": "Deletes a deployment from the deployment history.", + "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "head": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CheckExistenceAtManagementGroupScope", + "description": "Checks whether the deployment exists.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdateAtManagementGroupScope", + "summary": "Deploys resources at management group scope.", + "description": "You can provide the template and parameters directly in the request or link to JSON files.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopedDeployment" + }, + "description": "Additional parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "201": { + "description": "Created - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create deployment at management group scope.": { + "$ref": "./examples/PutDeploymentAtManagementGroup.json" + } + } + }, + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_GetAtManagementGroupScope", + "description": "Gets a deployment.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CancelAtManagementGroupScope", + "summary": "Cancels a currently running template deployment.", + "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ValidateAtManagementGroupScope", + "x-ms-long-running-operation": true, + "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopedDeployment" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "202": { + "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously." + }, + "400": { + "description": "Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ExportTemplateAtManagementGroupScope", + "description": "Exports the template used for specified deployment.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the template.", + "schema": { + "$ref": "#/definitions/DeploymentExportResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ListAtManagementGroupScope", + "description": "Get all the deployments for a management group.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to get. If null is passed, returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of deployments.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DeploymentExtendedFilter" + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_DeleteAtSubscriptionScope", + "summary": "Deletes a deployment from the deployment history.", + "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "head": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CheckExistenceAtSubscriptionScope", + "description": "Checks whether the deployment exists.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdateAtSubscriptionScope", + "summary": "Deploys resources at subscription scope.", + "description": "You can provide the template and parameters directly in the request or link to JSON files.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Additional parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "201": { + "description": "Created - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a deployment that will deploy a templateSpec with the given resourceId": { + "$ref": "./examples/PutDeploymentSubscriptionTemplateSpecsWithId.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_GetAtSubscriptionScope", + "description": "Gets a deployment.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CancelAtSubscriptionScope", + "summary": "Cancels a currently running template deployment.", + "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resources partially deployed.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ValidateAtSubscriptionScope", + "x-ms-long-running-operation": true, + "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "202": { + "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously." + }, + "400": { + "description": "Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_WhatIfAtSubscriptionScope", + "description": "Returns changes that will be made by the deployment if executed at the scope of the subscription.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentWhatIf" + }, + "description": "Parameters to What If." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns What-If operation status", + "schema": { + "$ref": "#/definitions/WhatIfOperationResult" + } + }, + "202": { + "description": "Accepted - Returns URL in Location header to query for long-running operation status.", + "headers": { + "Location": { + "type": "string", + "description": "URL to get status of this long-running operation." + }, + "Retry-After": { + "type": "string", + "description": "Number of seconds to wait before polling for status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Predict template changes at subscription scope": { + "$ref": "./examples/PostDeploymentWhatIfOnSubscription.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ExportTemplateAtSubscriptionScope", + "description": "Exports the template used for specified deployment.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the template.", + "schema": { + "$ref": "#/definitions/DeploymentExportResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ListAtSubscriptionScope", + "description": "Get all the deployments for a subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to get. If null is passed, returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of deployments.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DeploymentExtendedFilter" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}": { + "delete": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Delete", + "summary": "Deletes a deployment from the deployment history.", + "description": "A template deployment that is currently running cannot be deleted. Deleting a template deployment removes the associated deployment operations. Deleting a template deployment does not affect the state of the resource group. This is an asynchronous operation that returns a status of 202 until the template deployment is successfully deleted. The Location response header contains the URI that is used to obtain the status of the process. While the process is running, a call to the URI in the Location header returns a status of 202. When the process finishes, the URI in the Location header returns a status of 204 on success. If the asynchronous request failed, the URI in the Location header returns an error-level status code.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group with the deployment to delete. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted - Returns this status until the asynchronous operation has completed." + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "head": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CheckExistence", + "description": "Checks whether the deployment exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group with the deployment to check. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CreateOrUpdate", + "summary": "Deploys resources to a resource group.", + "description": "You can provide the template and parameters directly in the request or link to JSON files.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to deploy the resources to. The name is case insensitive. The resource group must already exist.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Additional parameters supplied to the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "201": { + "description": "Created - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create a deployment that will redeploy the last successful deployment on failure": { + "$ref": "./examples/PutDeploymentWithOnErrorDeploymentLastSuccessful.json" + }, + "Create a deployment that will redeploy another deployment on failure": { + "$ref": "./examples/PutDeploymentWithOnErrorDeploymentSpecificDeployment.json" + }, + "Create a deployment that will deploy a templateSpec with the given resourceId": { + "$ref": "./examples/PutDeploymentResourceGroupTemplateSpecsWithId.json" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Get", + "description": "Gets a deployment.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment, including provisioning status.", + "schema": { + "$ref": "#/definitions/DeploymentExtended" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/cancel": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Cancel", + "summary": "Cancels a currently running template deployment.", + "description": "You can cancel a deployment only if the provisioningState is Accepted or Running. After the deployment is canceled, the provisioningState is set to Canceled. Canceling a template deployment stops the currently running template deployment and leaves the resource group partially deployed.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/validate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_Validate", + "x-ms-long-running-operation": true, + "description": "Validates whether the specified template is syntactically correct and will be accepted by Azure Resource Manager..", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group the template will be deployed to. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Deployment" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "202": { + "description": "Accepted - The request has been accepted for processing and the operation will complete asynchronously." + }, + "400": { + "description": "Returns the validation result.", + "schema": { + "$ref": "#/definitions/DeploymentValidateResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_WhatIf", + "description": "Returns changes that will be made by the deployment if executed at the scope of the resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group the template will be deployed to. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DeploymentWhatIf" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns What-If operation status", + "schema": { + "$ref": "#/definitions/WhatIfOperationResult" + } + }, + "202": { + "description": "Accepted - Returns URL in Location header to query for long-running operation status.", + "headers": { + "Location": { + "type": "string", + "description": "URL to get status of this long-running operation." + }, + "Retry-After": { + "type": "string", + "description": "Number of seconds to wait before polling for status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Predict template changes at resource group scope": { + "$ref": "./examples/PostDeploymentWhatIfOnResourceGroup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ExportTemplate", + "description": "Exports the template used for specified deployment.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the template.", + "schema": { + "$ref": "#/definitions/DeploymentExportResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/Microsoft.Resources/deployments/": { + "get": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_ListByResourceGroup", + "description": "Get all the deployments for a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group with the deployments to get. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. For example, you can use $filter=provisioningState eq '{state}'." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to get. If null is passed, returns all deployments." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of deployments.", + "schema": { + "$ref": "#/definitions/DeploymentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/DeploymentExtendedFilter" + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/unregister": { + "post": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Unregister", + "description": "Unregisters a subscription from a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider to unregister." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource provider.", + "schema": { + "$ref": "#/definitions/Provider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}/register": { + "post": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Register", + "description": "Registers a subscription with a resource provider.", + "parameters": [ + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider to register." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource provider.", + "schema": { + "$ref": "#/definitions/Provider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_List", + "description": "Gets all resource providers for a subscription.", + "parameters": [ + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return. If null is passed returns all deployments." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of resource providers.", + "schema": { + "$ref": "#/definitions/ProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_ListAtTenantScope", + "description": "Gets all resource providers for the tenant.", + "parameters": [ + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return. If null is passed returns all providers." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The properties to include in the results. For example, use &$expand=metadata in the query string to retrieve resource provider metadata. To include property aliases in response, use $expand=resourceTypes/aliases." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of resource providers.", + "schema": { + "$ref": "#/definitions/ProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/{resourceProviderNamespace}": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_Get", + "description": "Gets the specified resource provider.", + "parameters": [ + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases." + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource provider.", + "schema": { + "$ref": "#/definitions/Provider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/{resourceProviderNamespace}": { + "get": { + "tags": [ + "Providers" + ], + "operationId": "Providers_GetAtTenantScope", + "description": "Gets the specified resource provider at the tenant level.", + "parameters": [ + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The $expand query parameter. For example, to include property aliases in response, use $expand=resourceTypes/aliases." + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource provider.", + "schema": { + "$ref": "#/definitions/Provider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/resources": { + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "Resources_ListByResourceGroup", + "description": "Get all the resources for a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group with the resources to get.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.

The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.

For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.

For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)

You can link more than one substringof together by adding and/or operators.

You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.

You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return. If null is passed, returns all resources." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of resources", + "schema": { + "$ref": "#/definitions/ResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/GenericResourceFilter" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}": { + "head": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_CheckExistence", + "description": "Checks whether a resource group exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to check. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ResourceGroups" + ], + "x-ms-examples": { + "Create or update a resource group": { + "$ref": "./examples/CreateResourceGroup.json" + } + }, + "operationId": "ResourceGroups_CreateOrUpdate", + "description": "Creates or updates a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to create or update. Can include alphanumeric, underscore, parentheses, hyphen, period (except at end), and Unicode characters that match the allowed characters.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "Parameters supplied to the create or update a resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the new resource group.", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + }, + "201": { + "description": "Created - Returns information about the new resource group.", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Delete", + "summary": "Deletes a resource group.", + "description": "When you delete a resource group, all of its resources are also deleted. Deleting a resource group deletes all of its template deployments and currently stored operations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to delete. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Get", + "description": "Gets a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to get. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource group.", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_Update", + "summary": "Updates a resource group.", + "description": "Resource groups can be updated through a simple PATCH operation to a group address. The format of the request is the same as that for creating a resource group. If a field is unspecified, the current value is retained.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group to update. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourceGroupPatchable" + }, + "description": "Parameters supplied to update a resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource group.", + "schema": { + "$ref": "#/definitions/ResourceGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/exportTemplate": { + "post": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_ExportTemplate", + "description": "Captures the specified resource group as a template.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExportTemplateRequest" + }, + "description": "Parameters for exporting the template." + } + ], + "x-ms-examples": { + "Export a resource group": { + "$ref": "./examples/ExportResourceGroup.json" + }, + "Export a resource group with filtering": { + "$ref": "./examples/ExportResourceGroupWithFiltering.json" + } + }, + "responses": { + "200": { + "description": "OK - Returns the result of the export.", + "schema": { + "$ref": "#/definitions/ResourceGroupExportResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups": { + "get": { + "tags": [ + "ResourceGroups" + ], + "operationId": "ResourceGroups_List", + "description": "Gets all the resource groups for a subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.

You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return. If null is passed, returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of resource groups.", + "schema": { + "$ref": "#/definitions/ResourceGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/ResourceGroupFilter" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/moveResources": { + "post": { + "tags": [ + "Resources" + ], + "operationId": "Resources_MoveResources", + "summary": "Moves resources from one resource group to another resource group.", + "description": "The resources to move must be in the same source resource group. The target resource group may be in a different subscription. When moving resources, both the source group and the target group are locked for the duration of the operation. Write and delete operations are blocked on the groups until the move completes. ", + "parameters": [ + { + "name": "sourceResourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the resources to move.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourcesMoveInfo" + }, + "description": "Parameters for moving resources." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{sourceResourceGroupName}/validateMoveResources": { + "post": { + "tags": [ + "Resources" + ], + "operationId": "Resources_ValidateMoveResources", + "summary": "Validates whether resources can be moved from one resource group to another resource group.", + "description": "This operation checks whether the specified resources can be moved to the target. The resources to move must be in the same source resource group. The target resource group may be in a different subscription. If validation succeeds, it returns HTTP response code 204 (no content). If validation fails, it returns HTTP response code 409 (Conflict) with an error message. Retrieve the URL in the Location header value to check the result of the long-running operation.", + "parameters": [ + { + "name": "sourceResourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the resources to validate for move.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ResourcesMoveInfo" + }, + "description": "Parameters for moving resources." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SourceSubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resources": { + "get": { + "tags": [ + "Resources" + ], + "operationId": "Resources_List", + "description": "Get all the resources in a subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation.

The properties you can use for eq (equals) or ne (not equals) are: location, resourceType, name, resourceGroup, identity, identity/principalId, plan, plan/publisher, plan/product, plan/name, plan/version, and plan/promotionCode.

For example, to filter by a resource type, use: $filter=resourceType eq 'Microsoft.Network/virtualNetworks'

You can use substringof(value, property) in the filter. The properties you can use for substring are: name and resourceGroup.

For example, to get all resources with 'demo' anywhere in the name, use: $filter=substringof('demo', name)

You can link more than one substringof together by adding and/or operators.

You can filter by tag names and values. For example, to filter for a tag name and value, use $filter=tagName eq 'tag1' and tagValue eq 'Value1'. When you filter by a tag name and value, the tags for each resource are not returned in the results.

You can use some properties together when filtering. The combinations you can use are: substringof and/or resourceType, plan and plan/publisher and plan/name, identity and identity/principalId." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Comma-separated list of additional properties to be included in the response. Valid values include `createdTime`, `changedTime` and `provisioningState`. For example, `$expand=createdTime,changedTime`." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return. If null is passed, returns all resource groups." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of resources.", + "schema": { + "$ref": "#/definitions/ResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/GenericResourceFilter" + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}": { + "head": { + "tags": [ + "Resources" + ], + "operationId": "Resources_CheckExistence", + "description": "Checks whether a resource exists.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the resource to check. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The resource provider of the resource to check." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource to check whether it exists." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Resources" + ], + "operationId": "Resources_Delete", + "description": "Deletes a resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group that contains the resource to delete. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource to delete." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Resources" + ], + "operationId": "Resources_CreateOrUpdate", + "description": "Creates a resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group for the resource. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type of the resource to create.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource to create." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenericResource" + }, + "description": "Parameters for creating or updating the resource." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "201": { + "description": "Created - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Resources" + ], + "operationId": "Resources_Update", + "description": "Updates a resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group for the resource. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type of the resource to update.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource to update." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenericResource" + }, + "description": "Parameters for updating the resource." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Resources" + ], + "operationId": "Resources_Get", + "description": "Gets a resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing the resource to get. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider." + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type of the resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource to get." + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/{resourceId}": { + "head": { + "tags": [ + "Resources" + ], + "operationId": "Resources_CheckExistenceById", + "description": "Checks by ID whether a resource exists.", + "parameters": [ + { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}", + "x-ms-skip-url-encoding": true + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + } + ], + "responses": { + "204": { + "description": "No Content" + }, + "404": { + "description": "Not Found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Resources" + ], + "operationId": "Resources_DeleteById", + "description": "Deletes a resource by ID.", + "parameters": [ + { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}", + "x-ms-skip-url-encoding": true + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "put": { + "tags": [ + "Resources" + ], + "operationId": "Resources_CreateOrUpdateById", + "description": "Create a resource by ID.", + "parameters": [ + { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}", + "x-ms-skip-url-encoding": true + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenericResource" + }, + "description": "Create or update resource parameters." + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "201": { + "description": "Created - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Resources" + ], + "operationId": "Resources_UpdateById", + "description": "Updates a resource by ID.", + "parameters": [ + { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}", + "x-ms-skip-url-encoding": true + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GenericResource" + }, + "description": "Update resource parameters." + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Resources" + ], + "operationId": "Resources_GetById", + "description": "Gets a resource by ID.", + "parameters": [ + { + "name": "resourceId", + "in": "path", + "required": true, + "type": "string", + "description": "The fully qualified ID of the resource, including the resource name and resource type. Use the format, /subscriptions/{guid}/resourceGroups/{resource-group-name}/{resource-provider-namespace}/{resource-type}/{resource-name}", + "x-ms-skip-url-encoding": true + }, + { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for the operation." + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the resource.", + "schema": { + "$ref": "#/definitions/GenericResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames/{tagName}/tagValues/{tagValue}": { + "delete": { + "tags": [ + "Tags" + ], + "operationId": "TagsOperation_DeleteValue", + "summary": "Deletes a predefined tag value for a predefined tag name.", + "description": "This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "name": "tagValue", + "in": "path", + "required": true, + "type": "string", + "description": "The value of the tag to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Predefined tag value successfully deleted." + }, + "204": { + "description": "Predefined tag value did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Tags" + ], + "operationId": "TagsOperation_CreateOrUpdateValue", + "summary": "Creates a predefined value for a predefined tag name.", + "description": "This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "name": "tagValue", + "in": "path", + "required": true, + "type": "string", + "description": "The value of the tag to create." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Predefined tag value already exists. Returns information about the predefined tag value.", + "schema": { + "$ref": "#/definitions/TagValue" + } + }, + "201": { + "description": "Predefined tag value successfully created. Returns information about the predefined tag value.", + "schema": { + "$ref": "#/definitions/TagValue" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames/{tagName}": { + "put": { + "tags": [ + "Tags" + ], + "operationId": "TagsOperation_CreateOrUpdate", + "summary": "Creates a predefined tag name.", + "description": "This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag to create." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Predefined tag name already exists. Returns information about the predefined tag name.", + "schema": { + "$ref": "#/definitions/TagDetails" + } + }, + "201": { + "description": "Predefined tag name successfully created. Returns information about the predefined tag name.", + "schema": { + "$ref": "#/definitions/TagDetails" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Tags" + ], + "operationId": "TagsOperation_Delete", + "summary": "Deletes a predefined tag name.", + "description": "This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.", + "parameters": [ + { + "name": "tagName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tag." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Predefined tag name successfully deleted." + }, + "204": { + "description": "Predefined tag name did not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/tagNames": { + "get": { + "tags": [ + "Tags" + ], + "operationId": "TagsOperation_List", + "summary": "Gets a summary of tag usage under the subscription.", + "description": "This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of tag names and values.", + "schema": { + "$ref": "#/definitions/TagsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_GetAtScope", + "description": "Gets a deployments operation.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the operation to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment operation.", + "schema": { + "$ref": "#/definitions/DeploymentOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_ListAtScope", + "description": "Gets all deployments operations for a deployment.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Return an array of deployment operations.", + "schema": { + "$ref": "#/definitions/DeploymentOperationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_GetAtTenantScope", + "description": "Gets a deployments operation.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the operation to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment operation.", + "schema": { + "$ref": "#/definitions/DeploymentOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Resources/deployments/{deploymentName}/operations": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_ListAtTenantScope", + "description": "Gets all deployments operations for a deployment.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Return an array of deployment operations.", + "schema": { + "$ref": "#/definitions/DeploymentOperationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_GetAtManagementGroupScope", + "description": "Gets a deployments operation.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the operation to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment operation.", + "schema": { + "$ref": "#/definitions/DeploymentOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_ListAtManagementGroupScope", + "description": "Gets all deployments operations for a deployment.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Return an array of deployment operations.", + "schema": { + "$ref": "#/definitions/DeploymentOperationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations/{operationId}": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_GetAtSubscriptionScope", + "description": "Gets a deployments operation.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the operation to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment operation.", + "schema": { + "$ref": "#/definitions/DeploymentOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/deployments/{deploymentName}/operations": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_ListAtSubscriptionScope", + "description": "Gets all deployments operations for a deployment.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Return an array of deployment operations.", + "schema": { + "$ref": "#/definitions/DeploymentOperationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations/{operationId}": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_Get", + "description": "Gets a deployments operation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the operation to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the deployment operation.", + "schema": { + "$ref": "#/definitions/DeploymentOperation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/deployments/{deploymentName}/operations": { + "get": { + "tags": [ + "DeploymentOperations" + ], + "operationId": "DeploymentOperations_List", + "description": "Gets all deployments operations for a deployment.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90 + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "The number of results to return." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Return an array of deployment operations.", + "schema": { + "$ref": "#/definitions/DeploymentOperationsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Resources/calculateTemplateHash": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_CalculateTemplateHash", + "description": "Calculate the hash of the given template.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "template", + "in": "body", + "required": true, + "schema": { + "type": "object" + }, + "description": "The template provided to calculate hash." + } + ], + "x-ms-examples": { + "Calculate template hash": { + "$ref": "./examples/CalculateTemplateHash.json" + } + }, + "responses": { + "200": { + "description": "OK - Returns the hash.", + "schema": { + "$ref": "#/definitions/TemplateHashResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/{scope}/providers/Microsoft.Resources/tags/default": { + "put": { + "tags": [ + "Tags" + ], + "operationId": "TagsOperation_CreateOrUpdateAtScope", + "summary": "Creates or updates the entire set of tags on a resource or subscription.", + "description": "This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsResource" + } + } + ], + "responses": { + "200": { + "description": "Tags updated successfully. Returns tags from the specified object.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update tags on a resource": { + "$ref": "./examples/PutTagsResource.json" + }, + "Update tags on a subscription": { + "$ref": "./examples/PutTagsSubscription.json" + } + } + }, + "patch": { + "tags": [ + "Tags" + ], + "operationId": "TagsOperation_UpdateAtScope", + "summary": "Selectively updates the set of tags on a resource or subscription.", + "description": "This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsPatchResource" + } + } + ], + "responses": { + "200": { + "description": "Tags updated successfully. Returns tags from the specified object.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "Tags" + ], + "operationId": "TagsOperation_GetAtScope", + "summary": "Gets the entire set of tags on a resource or subscription.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Returns tags from the specified object.", + "schema": { + "$ref": "#/definitions/TagsResource" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get tags on a resource": { + "$ref": "./examples/GetTagsResource.json" + }, + "Get tags on a subscription": { + "$ref": "./examples/GetTagsSubscription.json" + } + } + }, + "delete": { + "tags": [ + "Tags" + ], + "operationId": "TagsOperation_DeleteAtScope", + "summary": "Deletes the entire set of tags on a resource or subscription.", + "parameters": [ + { + "$ref": "#/parameters/ScopeParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Tags successfully deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "DeploymentExtendedFilter": { + "properties": { + "provisioningState": { + "type": "string", + "description": "The provisioning state." + } + }, + "description": "Deployment filter." + }, + "GenericResourceFilter": { + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type." + }, + "tagname": { + "type": "string", + "description": "The tag name." + }, + "tagvalue": { + "type": "string", + "description": "The tag value." + } + }, + "description": "Resource filter." + }, + "ResourceGroupFilter": { + "properties": { + "tagName": { + "type": "string", + "description": "The tag name." + }, + "tagValue": { + "type": "string", + "description": "The tag value." + } + }, + "description": "Resource group filter." + }, + "TemplateLink": { + "properties": { + "uri": { + "type": "string", + "description": "The URI of the template to deploy. Use either the uri or id property, but not both." + }, + "id": { + "type": "string", + "description": "The resource id of a Template Spec. Use either the id or uri property, but not both." + }, + "relativePath": { + "type": "string", + "description": "Applicable only if this template link references a Template Spec. This relativePath property can optionally be used to reference a Template Spec artifact by path." + }, + "contentVersion": { + "type": "string", + "description": "If included, must match the ContentVersion in the template." + } + }, + "description": "Entity representing the reference to the template." + }, + "ParametersLink": { + "properties": { + "uri": { + "type": "string", + "description": "The URI of the parameters file." + }, + "contentVersion": { + "type": "string", + "description": "If included, must match the ContentVersion in the template." + } + }, + "required": [ + "uri" + ], + "description": "Entity representing the reference to the deployment parameters." + }, + "DeploymentProperties": { + "properties": { + "template": { + "type": "object", + "description": "The template content. You use this element when you want to pass the template syntax directly in the request rather than link to an existing template. It can be a JObject or well-formed JSON string. Use either the templateLink property or the template property, but not both." + }, + "templateLink": { + "$ref": "#/definitions/TemplateLink", + "description": "The URI of the template. Use either the templateLink property or the template property, but not both." + }, + "parameters": { + "type": "object", + "description": "Name and value pairs that define the deployment parameters for the template. You use this element when you want to provide the parameter values directly in the request rather than link to an existing parameter file. Use either the parametersLink property or the parameters property, but not both. It can be a JObject or a well formed JSON string." + }, + "parametersLink": { + "$ref": "#/definitions/ParametersLink", + "description": "The URI of parameters file. You use this element to link to an existing parameters file. Use either the parametersLink property or the parameters property, but not both." + }, + "mode": { + "type": "string", + "description": "The mode that is used to deploy resources. This value can be either Incremental or Complete. In Incremental mode, resources are deployed without deleting existing resources that are not included in the template. In Complete mode, resources are deployed and existing resources in the resource group that are not included in the template are deleted. Be careful when using Complete mode as you may unintentionally delete resources.", + "enum": [ + "Incremental", + "Complete" + ], + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": false + } + }, + "debugSetting": { + "$ref": "#/definitions/DebugSetting", + "description": "The debug setting of the deployment." + }, + "onErrorDeployment": { + "$ref": "#/definitions/OnErrorDeployment", + "description": "The deployment on error behavior." + } + }, + "required": [ + "mode" + ], + "description": "Deployment properties." + }, + "DebugSetting": { + "properties": { + "detailLevel": { + "type": "string", + "description": "Specifies the type of information to log for debugging. The permitted values are none, requestContent, responseContent, or both requestContent and responseContent separated by a comma. The default is none. When setting this value, carefully consider the type of information you are passing in during deployment. By logging information about the request or response, you could potentially expose sensitive data that is retrieved through the deployment operations." + } + }, + "description": "The debug setting." + }, + "Deployment": { + "properties": { + "location": { + "type": "string", + "description": "The location to store the deployment data." + }, + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "The deployment properties." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Deployment tags" + } + }, + "required": [ + "properties" + ], + "description": "Deployment operation parameters." + }, + "ScopedDeployment": { + "properties": { + "location": { + "type": "string", + "description": "The location to store the deployment data." + }, + "properties": { + "$ref": "#/definitions/DeploymentProperties", + "description": "The deployment properties." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Deployment tags" + } + }, + "required": [ + "location", + "properties" + ], + "description": "Deployment operation parameters." + }, + "DeploymentExportResult": { + "properties": { + "template": { + "type": "object", + "description": "The template content." + } + }, + "description": "The deployment export result. " + }, + "DeploymentWhatIf": { + "properties": { + "location": { + "type": "string", + "description": "The location to store the deployment data." + }, + "properties": { + "$ref": "#/definitions/DeploymentWhatIfProperties", + "description": "The deployment properties." + } + }, + "required": [ + "properties" + ], + "description": "Deployment What-if operation parameters." + }, + "DeploymentWhatIfProperties": { + "properties": { + "whatIfSettings": { + "$ref": "#/definitions/DeploymentWhatIfSettings", + "description": "Optional What-If operation settings." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DeploymentProperties" + } + ], + "description": "Deployment What-if properties." + }, + "DeploymentWhatIfSettings": { + "properties": { + "resultFormat": { + "type": "string", + "description": "The format of the What-If results", + "enum": [ + "ResourceIdOnly", + "FullResourcePayloads" + ], + "x-ms-enum": { + "name": "WhatIfResultFormat", + "modelAsString": false + } + } + }, + "description": "Deployment What-If operation settings." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "An error response for a resource management request." + }, + "AliasPath": { + "properties": { + "path": { + "type": "string", + "description": "The path of an alias." + }, + "apiVersions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The API versions." + }, + "pattern": { + "$ref": "#/definitions/AliasPattern", + "description": "The pattern for an alias path." + } + }, + "description": "The type of the paths for alias." + }, + "AliasPattern": { + "properties": { + "phrase": { + "type": "string", + "description": "The alias pattern phrase." + }, + "variable": { + "type": "string", + "description": "The alias pattern variable." + }, + "type": { + "type": "string", + "enum": [ + "NotSpecified", + "Extract" + ], + "x-ms-enum": { + "name": "AliasPatternType", + "modelAsString": false, + "values": [ + { + "value": "NotSpecified", + "description": "NotSpecified is not allowed." + }, + { + "value": "Extract", + "description": "Extract is the only allowed value." + } + ] + }, + "description": "The type of alias pattern" + } + }, + "description": "The type of the pattern for an alias path." + }, + "Alias": { + "properties": { + "name": { + "type": "string", + "description": "The alias name." + }, + "paths": { + "type": "array", + "items": { + "$ref": "#/definitions/AliasPath" + }, + "description": "The paths for an alias." + }, + "type": { + "type": "string", + "description": "The type of the alias.", + "enum": [ + "NotSpecified", + "PlainText", + "Mask" + ], + "x-ms-enum": { + "name": "AliasType", + "modelAsString": false, + "values": [ + { + "value": "NotSpecified", + "description": "Alias type is unknown (same as not providing alias type)." + }, + { + "value": "PlainText", + "description": "Alias value is not secret." + }, + { + "value": "Mask", + "description": "Alias value is secret." + } + ] + } + }, + "defaultPath": { + "type": "string", + "description": "The default path for an alias." + }, + "defaultPattern": { + "$ref": "#/definitions/AliasPattern", + "description": "The default pattern for an alias." + } + }, + "description": "The alias type. " + }, + "ProviderResourceType": { + "properties": { + "resourceType": { + "type": "string", + "description": "The resource type." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The collection of locations where this resource type can be created." + }, + "aliases": { + "type": "array", + "items": { + "$ref": "#/definitions/Alias" + }, + "description": "The aliases that are supported by this resource type." + }, + "apiVersions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The API version." + }, + "capabilities": { + "type": "string", + "description": "The additional capabilities offered by this resource type." + }, + "properties": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "The additional properties. " + }, + "description": "The properties." + } + }, + "description": "Resource type managed by the resource provider." + }, + "Provider": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The provider ID." + }, + "namespace": { + "type": "string", + "description": "The namespace of the resource provider." + }, + "registrationState": { + "readOnly": true, + "type": "string", + "description": "The registration state of the resource provider." + }, + "registrationPolicy": { + "readOnly": true, + "type": "string", + "description": "The registration policy of the resource provider." + }, + "resourceTypes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ProviderResourceType" + }, + "description": "The collection of provider resource types." + } + }, + "description": "Resource provider information." + }, + "BasicDependency": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the dependency." + }, + "resourceType": { + "type": "string", + "description": "The dependency resource type." + }, + "resourceName": { + "type": "string", + "description": "The dependency resource name." + } + }, + "description": "Deployment dependency information." + }, + "Dependency": { + "properties": { + "dependsOn": { + "type": "array", + "items": { + "$ref": "#/definitions/BasicDependency" + }, + "description": "The list of dependencies." + }, + "id": { + "type": "string", + "description": "The ID of the dependency." + }, + "resourceType": { + "type": "string", + "description": "The dependency resource type." + }, + "resourceName": { + "type": "string", + "description": "The dependency resource name." + } + }, + "description": "Deployment dependency information." + }, + "DeploymentPropertiesExtended": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "Denotes the state of provisioning.", + "enum": [ + "NotSpecified", + "Accepted", + "Running", + "Ready", + "Creating", + "Created", + "Deleting", + "Deleted", + "Canceled", + "Failed", + "Succeeded", + "Updating" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "correlationId": { + "readOnly": true, + "type": "string", + "description": "The correlation ID of the deployment." + }, + "timestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The timestamp of the template deployment." + }, + "duration": { + "readOnly": true, + "type": "string", + "description": "The duration of the template deployment." + }, + "outputs": { + "readOnly": true, + "type": "object", + "description": "Key/value pairs that represent deployment output." + }, + "providers": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Provider" + }, + "description": "The list of resource providers needed for the deployment." + }, + "dependencies": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Dependency" + }, + "description": "The list of deployment dependencies." + }, + "templateLink": { + "readOnly": true, + "$ref": "#/definitions/TemplateLink", + "description": "The URI referencing the template." + }, + "parameters": { + "readOnly": true, + "type": "object", + "description": "Deployment parameters. " + }, + "parametersLink": { + "readOnly": true, + "$ref": "#/definitions/ParametersLink", + "description": "The URI referencing the parameters. " + }, + "mode": { + "readOnly": true, + "type": "string", + "description": "The deployment mode. Possible values are Incremental and Complete.", + "enum": [ + "Incremental", + "Complete" + ], + "x-ms-enum": { + "name": "DeploymentMode", + "modelAsString": false + } + }, + "debugSetting": { + "readOnly": true, + "$ref": "#/definitions/DebugSetting", + "description": "The debug setting of the deployment." + }, + "onErrorDeployment": { + "readOnly": true, + "$ref": "#/definitions/OnErrorDeploymentExtended", + "description": "The deployment on error behavior." + }, + "templateHash": { + "readOnly": true, + "type": "string", + "description": "The hash produced for the template." + }, + "outputResources": { + "readOnly": true, + "type": "array", + "description": "Array of provisioned resources.", + "items": { + "$ref": "#/definitions/ResourceReference", + "description": "Details of provisioned resources." + } + }, + "validatedResources": { + "readOnly": true, + "type": "array", + "description": "Array of validated resources.", + "items": { + "$ref": "#/definitions/ResourceReference", + "description": "Details of validated resources." + } + }, + "error": { + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The deployment error." + } + }, + "description": "Deployment properties with additional details." + }, + "ResourceReference": { + "description": "The resource Id model.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The fully qualified resource Id." + } + } + }, + "OnErrorDeployment": { + "properties": { + "type": { + "type": "string", + "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.", + "enum": [ + "LastSuccessful", + "SpecificDeployment" + ], + "x-ms-enum": { + "name": "OnErrorDeploymentType", + "modelAsString": false + } + }, + "deploymentName": { + "type": "string", + "description": "The deployment to be used on error case." + } + }, + "description": "Deployment on error behavior." + }, + "OnErrorDeploymentExtended": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The state of the provisioning for the on error deployment." + }, + "type": { + "type": "string", + "description": "The deployment on error behavior type. Possible values are LastSuccessful and SpecificDeployment.", + "enum": [ + "LastSuccessful", + "SpecificDeployment" + ], + "x-ms-enum": { + "name": "OnErrorDeploymentType", + "modelAsString": false + } + }, + "deploymentName": { + "type": "string", + "description": "The deployment to be used on error case." + } + }, + "description": "Deployment on error behavior with additional details." + }, + "DeploymentValidateResult": { + "properties": { + "error": { + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The deployment validation error." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "The template deployment properties." + } + }, + "description": "Information from validate template deployment response." + }, + "DeploymentExtended": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the deployment." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the deployment." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the deployment." + }, + "location": { + "type": "string", + "description": "the location of the deployment." + }, + "properties": { + "$ref": "#/definitions/DeploymentPropertiesExtended", + "description": "Deployment properties." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Deployment tags" + } + }, + "x-ms-azure-resource": true, + "description": "Deployment information." + }, + "DeploymentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentExtended" + }, + "description": "An array of deployments." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of deployments." + }, + "ProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Provider" + }, + "description": "An array of resource providers." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of resource providers." + }, + "GenericResource": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "The plan of the resource." + }, + "properties": { + "type": "object", + "description": "The resource properties." + }, + "kind": { + "type": "string", + "description": "The kind of the resource.", + "pattern": "^[-\\w\\._,\\(\\)]+$" + }, + "managedBy": { + "type": "string", + "description": "ID of the resource that manages this resource." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the resource." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Resource information." + }, + "GenericResourceExpanded": { + "properties": { + "createdTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The created time of the resource. This is only present if requested via the $expand query parameter." + }, + "changedTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The changed time of the resource. This is only present if requested via the $expand query parameter." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the resource. This is only present if requested via the $expand query parameter." + } + }, + "allOf": [ + { + "$ref": "#/definitions/GenericResource" + } + ], + "description": "Resource information." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "The offer ID." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + }, + "version": { + "type": "string", + "description": "The plan's version." + } + }, + "description": "Plan for the resource." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The SKU name." + }, + "tier": { + "type": "string", + "description": "The SKU tier." + }, + "size": { + "type": "string", + "description": "The SKU size." + }, + "family": { + "type": "string", + "description": "The SKU family." + }, + "model": { + "type": "string", + "description": "The SKU model." + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "The SKU capacity." + } + }, + "description": "SKU for the resource." + }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "x-ms-client-name": "IdentityUserAssignedIdentitiesValue", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the resource." + }, + "ResourceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GenericResourceExpanded" + }, + "description": "An array of resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of resource groups." + }, + "ResourceGroup": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the resource group." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource group." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the resource group." + }, + "properties": { + "$ref": "#/definitions/ResourceGroupProperties", + "description": "The resource group properties." + }, + "location": { + "type": "string", + "description": "The location of the resource group. It cannot be changed after the resource group has been created. It must be one of the supported Azure locations." + }, + "managedBy": { + "type": "string", + "description": "The ID of the resource that manages this resource group." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "The additional properties. " + }, + "description": "The tags attached to the resource group." + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true, + "description": "Resource group information." + }, + "ResourceGroupPatchable": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource group." + }, + "properties": { + "$ref": "#/definitions/ResourceGroupProperties", + "description": "The resource group properties." + }, + "managedBy": { + "type": "string", + "description": "The ID of the resource that manages this resource group." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "The additional properties. " + }, + "description": "The tags attached to the resource group." + } + }, + "description": "Resource group information." + }, + "ResourceGroupProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state. " + } + }, + "description": "The resource group properties." + }, + "ResourceGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceGroup" + }, + "description": "An array of resource groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of resource groups." + }, + "ResourcesMoveInfo": { + "properties": { + "resources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the resources." + }, + "targetResourceGroup": { + "type": "string", + "description": "The target resource group." + } + }, + "description": "Parameters of move resources." + }, + "ExportTemplateRequest": { + "properties": { + "resources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IDs of the resources to filter the export by. To export all resources, supply an array with single entry '*'." + }, + "options": { + "type": "string", + "description": "The export template options. A CSV-formatted list containing zero or more of the following: 'IncludeParameterDefaultValue', 'IncludeComments', 'SkipResourceNameParameterization', 'SkipAllParameterization'" + } + }, + "description": "Export resource group template request parameters." + }, + "TagCount": { + "properties": { + "type": { + "type": "string", + "description": "Type of count." + }, + "value": { + "type": "integer", + "description": "Value of count." + } + }, + "description": "Tag count." + }, + "TagValue": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The tag value ID." + }, + "tagValue": { + "type": "string", + "description": "The tag value." + }, + "count": { + "$ref": "#/definitions/TagCount", + "description": "The tag value count." + } + }, + "x-ms-azure-resource": true, + "description": "Tag information." + }, + "TagDetails": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The tag name ID." + }, + "tagName": { + "type": "string", + "description": "The tag name." + }, + "count": { + "$ref": "#/definitions/TagCount", + "description": "The total number of resources that use the resource tag. When a tag is initially created and has no associated resources, the value is 0." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/TagValue" + }, + "description": "The list of tag values." + } + }, + "x-ms-azure-resource": true, + "description": "Tag details." + }, + "TagsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TagDetails" + }, + "description": "An array of tags." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of subscription tags." + }, + "TargetResource": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource." + }, + "resourceName": { + "type": "string", + "description": "The name of the resource." + }, + "resourceType": { + "type": "string", + "description": "The type of the resource." + } + }, + "description": "Target resource." + }, + "HttpMessage": { + "properties": { + "content": { + "type": "object", + "description": "HTTP message content." + } + }, + "description": "HTTP message." + }, + "DeploymentOperationProperties": { + "properties": { + "provisioningOperation": { + "readOnly": true, + "type": "string", + "description": "The name of the current provisioning operation.", + "enum": [ + "NotSpecified", + "Create", + "Delete", + "Waiting", + "AzureAsyncOperationWaiting", + "ResourceCacheWaiting", + "Action", + "Read", + "EvaluateDeploymentOutput", + "DeploymentCleanup" + ], + "x-ms-enum": { + "name": "ProvisioningOperation", + "modelAsString": false, + "values": [ + { + "value": "NotSpecified", + "description": "The provisioning operation is not specified." + }, + { + "value": "Create", + "description": "The provisioning operation is create." + }, + { + "value": "Delete", + "description": "The provisioning operation is delete." + }, + { + "value": "Waiting", + "description": "The provisioning operation is waiting." + }, + { + "value": "AzureAsyncOperationWaiting", + "description": "The provisioning operation is waiting Azure async operation." + }, + { + "value": "ResourceCacheWaiting", + "description": "The provisioning operation is waiting for resource cache." + }, + { + "value": "Action", + "description": "The provisioning operation is action." + }, + { + "value": "Read", + "description": "The provisioning operation is read." + }, + { + "value": "EvaluateDeploymentOutput", + "description": "The provisioning operation is evaluate output." + }, + { + "value": "DeploymentCleanup", + "description": "The provisioning operation is cleanup. This operation is part of the 'complete' mode deployment." + } + ] + } + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The state of the provisioning." + }, + "timestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date and time of the operation." + }, + "duration": { + "readOnly": true, + "type": "string", + "description": "The duration of the operation." + }, + "serviceRequestId": { + "readOnly": true, + "type": "string", + "description": "Deployment operation service request id." + }, + "statusCode": { + "readOnly": true, + "type": "string", + "description": "Operation status code." + }, + "statusMessage": { + "readOnly": true, + "description": "Operation status message.", + "$ref": "#/definitions/StatusMessage" + }, + "targetResource": { + "readOnly": true, + "$ref": "#/definitions/TargetResource", + "description": "The target resource." + }, + "request": { + "readOnly": true, + "$ref": "#/definitions/HttpMessage", + "description": "The HTTP request message." + }, + "response": { + "readOnly": true, + "$ref": "#/definitions/HttpMessage", + "description": "The HTTP response message." + } + }, + "description": "Deployment operation properties." + }, + "DeploymentOperation": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Full deployment operation ID." + }, + "operationId": { + "readOnly": true, + "type": "string", + "description": "Deployment operation ID." + }, + "properties": { + "$ref": "#/definitions/DeploymentOperationProperties", + "description": "Deployment properties." + } + }, + "description": "Deployment operation information." + }, + "DeploymentOperationsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DeploymentOperation" + }, + "description": "An array of deployment operations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "List of deployment operations." + }, + "ResourceProviderOperationDisplayProperties": { + "properties": { + "publisher": { + "type": "string", + "description": "Operation description." + }, + "provider": { + "type": "string", + "description": "Operation provider." + }, + "resource": { + "type": "string", + "description": "Operation resource." + }, + "operation": { + "type": "string", + "description": "Resource provider operation." + }, + "description": { + "type": "string", + "description": "Operation description." + } + }, + "description": "Resource provider operation's display properties." + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "x-ms-azure-resource": true, + "description": "Specified resource." + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID" + } + }, + "x-ms-azure-resource": true, + "description": "Sub-resource." + }, + "ResourceGroupExportResult": { + "properties": { + "template": { + "type": "object", + "description": "The template content." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The template export error." + } + }, + "description": "Resource group export result." + }, + "Operation": { + "description": "Microsoft.Resources operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Resources", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "type": "string" + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Microsoft.Resources operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Microsoft.Resources operations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "TemplateHashResult": { + "description": "Result of the request to calculate template hash. It contains a string of minified template and its hash.", + "properties": { + "minifiedTemplate": { + "type": "string", + "description": "The minified template string." + }, + "templateHash": { + "type": "string", + "description": "The template hash." + } + } + }, + "WhatIfPropertyChange": { + "required": [ + "path", + "propertyChangeType" + ], + "properties": { + "path": { + "type": "string", + "description": "The path of the property." + }, + "propertyChangeType": { + "type": "string", + "description": "The type of property change.", + "enum": [ + "Create", + "Delete", + "Modify", + "Array" + ], + "x-ms-enum": { + "name": "PropertyChangeType", + "modelAsString": false, + "values": [ + { + "value": "Create", + "description": "The property does not exist in the current state but is present in the desired state. The property will be created when the deployment is executed." + }, + { + "value": "Delete", + "description": "The property exists in the current state and is missing from the desired state. It will be deleted when the deployment is executed." + }, + { + "value": "Modify", + "description": "The property exists in both current and desired state and is different. The value of the property will change when the deployment is executed." + }, + { + "value": "Array", + "description": "The property is an array and contains nested changes." + } + ] + } + }, + "before": { + "type": "object", + "description": "The value of the property before the deployment is executed." + }, + "after": { + "type": "object", + "description": "The value of the property after the deployment is executed." + }, + "children": { + "type": "array", + "items": { + "$ref": "#/definitions/WhatIfPropertyChange" + }, + "description": "Nested property changes." + } + }, + "description": "The predicted change to the resource property." + }, + "WhatIfChange": { + "description": "Information about a single resource change predicted by What-If operation.", + "required": [ + "resourceId", + "changeType" + ], + "properties": { + "resourceId": { + "type": "string", + "description": "Resource ID" + }, + "changeType": { + "type": "string", + "description": "Type of change that will be made to the resource when the deployment is executed.", + "enum": [ + "Create", + "Delete", + "Ignore", + "Deploy", + "NoChange", + "Modify" + ], + "x-ms-enum": { + "name": "ChangeType", + "modelAsString": false, + "values": [ + { + "value": "Create", + "description": "The resource does not exist in the current state but is present in the desired state. The resource will be created when the deployment is executed." + }, + { + "value": "Delete", + "description": "The resource exists in the current state and is missing from the desired state. The resource will be deleted when the deployment is executed." + }, + { + "value": "Ignore", + "description": "The resource exists in the current state and is missing from the desired state. The resource will not be deployed or modified when the deployment is executed." + }, + { + "value": "Deploy", + "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource may or may not change." + }, + { + "value": "NoChange", + "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will not change." + }, + { + "value": "Modify", + "description": "The resource exists in the current state and the desired state and will be redeployed when the deployment is executed. The properties of the resource will change." + } + ] + } + }, + "before": { + "type": "object", + "description": "The snapshot of the resource before the deployment is executed." + }, + "after": { + "type": "object", + "description": "The predicted snapshot of the resource after the deployment is executed." + }, + "delta": { + "type": "array", + "items": { + "$ref": "#/definitions/WhatIfPropertyChange" + }, + "description": "The predicted changes to resource properties." + } + } + }, + "WhatIfOperationProperties": { + "description": "Deployment operation properties.", + "properties": { + "changes": { + "type": "array", + "items": { + "$ref": "#/definitions/WhatIfChange" + }, + "description": "List of resource changes predicted by What-If operation." + } + } + }, + "WhatIfOperationResult": { + "description": "Result of the What-If operation. Contains a list of predicted changes and a URL link to get to the next set of results.", + "properties": { + "status": { + "type": "string", + "description": "Status of the What-If operation." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WhatIfOperationProperties", + "description": "What-If operation properties." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "Error when What-If operation fails." + } + } + }, + "Tags": { + "description": "A dictionary of name and value pairs.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string", + "description": "The tag value." + } + } + } + }, + "TagsPatchResource": { + "type": "object", + "description": "Wrapper resource for tags patch API request only.", + "properties": { + "operation": { + "type": "string", + "description": "The operation type for the patch API.", + "enum": [ + "Replace", + "Merge", + "Delete" + ] + }, + "properties": { + "$ref": "#/definitions/Tags", + "description": "The set of tags." + } + } + }, + "TagsResource": { + "type": "object", + "description": "Wrapper resource for tags API requests and responses.", + "required": [ + "properties" + ], + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the tags wrapper resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the tags wrapper resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of the tags wrapper resource." + }, + "properties": { + "$ref": "#/definitions/Tags", + "description": "The set of tags." + } + }, + "x-ms-azure-resource": true + }, + "StatusMessage": { + "type": "object", + "description": "Operation status message object.", + "properties": { + "status": { + "type": "string", + "description": "Status of the deployment operation." + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The error reported by the operation." + } + } + } + }, + "parameters": { + "ScopeParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The resource scope.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "GroupIdParameter": { + "name": "groupId", + "in": "path", + "required": true, + "type": "string", + "description": "The management group ID.", + "x-ms-parameter-location": "method", + "minLength": 1, + "maxLength": 90 + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "SourceSubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the source subscription." + }, + "DeploymentNameParameter": { + "name": "deploymentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "x-ms-parameter-location": "method", + "minLength": 1, + "maxLength": 64, + "description": "The name of the deployment." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + } + } +} diff --git a/specification/resources/resource-manager/readme.csharp.md b/specification/resources/resource-manager/readme.csharp.md index 8035831712c8..c19e9afa7929 100644 --- a/specification/resources/resource-manager/readme.csharp.md +++ b/specification/resources/resource-manager/readme.csharp.md @@ -137,6 +137,19 @@ batch: ApiVersionName: Api2019_10_01 - policyD-2016-12-01: true ApiVersionName: Api2019_10_01 + + - resources-2020-06-01: true + ApiVersionName: Api2020_06_01 + - links-2016-09-01: true + ApiVersionName: Api2020_06_01 + - subscription-2016-06-01: true + ApiVersionName: Api2020_06_01 + - locks-2016-09-01: true + ApiVersionName: Api2020_06_01 + - policyA-2016-12-01: true + ApiVersionName: Api2020_06_01 + - policyD-2016-12-01: true + ApiVersionName: Api2020_06_01 ``` @@ -258,6 +271,72 @@ input-file: input-file: - Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json ``` +``` yaml $(Separator) +########################################################################### +########################################################################### +``` + +``` yaml $(resources-2020-06-01) +tag: pkg-2020-06-Az-res +``` + +``` yaml $(links-2016-09-01) +tag: pkg-2020-06-Az-lnk +``` + +``` yaml $(subscription-2016-06-01) +tag: pkg-2020-06-Az-sub +``` + +``` yaml $(locks-2016-09-01) +tag: pkg-2020-06-Az-loc +``` + +``` yaml $(policyA-2016-12-01) +tag: pkg-2020-06-Az-polA +``` + +``` yaml $(policyD-2016-12-01) +tag: pkg-2020-06-Az-polD +``` + + +## Tag: Packages for Azure Stack +### 1) pkg-2020-06-AzStk-res +``` yaml $(tag) == 'pkg-2020-06-Az-res' +input-file: +- Microsoft.Resources/stable/2019-05-01/resources.json +``` + +### 2) pkg-2020-06-AzStk-lnk +``` yaml $(tag) == 'pkg-2020-06-Az-lnk' +input-file: +- Microsoft.Resources/stable/2016-09-01/links.json +``` + +### 3) pkg-2020-06-AzStk-sub +``` yaml $(tag) == 'pkg-2020-06-Az-sub' +input-file: +- Microsoft.Resources/stable/2016-06-01/subscriptions.json +``` + +### 4) pkg-2020-06-AzStk-loc +``` yaml $(tag) == 'pkg-2020-06-Az-loc' +input-file: +- Microsoft.Authorization/stable/2016-09-01/locks.json +``` + +### 5) pkg-2020-06-AzStk-polA +``` yaml $(tag) == 'pkg-2020-06-Az-polA' +input-file: +- Microsoft.Authorization/stable/2016-12-01/policyAssignments.json +``` + +### 6) pkg-2020-06-AzStk-polD +``` yaml $(tag) == 'pkg-2020-06-Az-polD' +input-file: +- Microsoft.Authorization/stable/2016-12-01/policyDefinitions.json +``` ``` yaml $(Separator) ########################################################################### diff --git a/specification/resources/resource-manager/readme.java.md b/specification/resources/resource-manager/readme.java.md index c8705dc8d7f5..5e5e0d5c92b8 100644 --- a/specification/resources/resource-manager/readme.java.md +++ b/specification/resources/resource-manager/readme.java.md @@ -27,6 +27,7 @@ batch: - tag: package-policy-2018-05 - tag: package-policy-2018-03 - tag: package-policy-2016-12 + - tag: package-resources-2020-06 - tag: package-resources-2019-08 - tag: package-resources-2019-07 - tag: package-resources-2019-0510 @@ -189,6 +190,19 @@ directive: transform: $['x-ms-client-name'] = 'scopeProperty' ``` +### Tag: package-resources-2020-06 and java + +These settings apply only when `--tag=package-resources-2020-06 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-resources-2020-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.resources.v2020_06_01 + output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2020_06_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-resources-2019-08 and java These settings apply only when `--tag=package-resources-2019-08 --java` is specified on the command line. diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 32aea908a345..268e7e769ad4 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -41,7 +41,7 @@ tag: package-policy-2019-09 ``` ``` yaml $(package-resources) -tag: package-resources-2019-10 +tag: package-resources-2020-06 ``` ``` yaml $(package-subscriptions) @@ -60,6 +60,15 @@ tag: package-managedapplications-2018-06 tag: package-deploymentscripts-2019-10-preview ``` +### Tag: package-resources-2020-06 + +These settings apply only when `--tag=package-resources-2020-06` is specified on the command line. + +``` yaml $(tag) == 'package-resources-2020-06' +input-file: +- Microsoft.Resources/stable/2020-06-01/resources.json +``` + ### Tag: package-subscriptions-2020-01 These settings apply only when `--tag=package-subscriptions-2020-01` is specified on the command line. diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index 24a7fb0be6b6..709ec28a6bf9 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -41,6 +41,7 @@ batch: - tag: package-policy-2016-12 - tag: package-policy-2016-04 - tag: package-policy-2015-10 + - tag: package-resources-2020-06 - tag: package-resources-2019-10 - tag: package-resources-2019-08 - tag: package-resources-2019-07 @@ -80,6 +81,7 @@ batch: - tag: package-policy-2016-04 - tag: package-policy-2015-10 - multiapiscript-policy: true + - tag: package-resources-2020-06 - tag: package-resources-2019-10 - tag: package-resources-2019-08 - tag: package-resources-2019-07 @@ -332,6 +334,19 @@ python: output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/policy/v2015_10_01_preview ``` +### Tag: package-resources-2020-06 and python + +These settings apply only when `--tag=package-resources-2020-06 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-resources-2020-06' +namespace: azure.mgmt.resource.resources.v2020_06_01 +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/resources/v2020_06_01 +python: + namespace: azure.mgmt.resource.resources.v2020_06_01 + output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/resources/v2020_06_01 +``` + ### Tag: package-resources-2019-10 and python These settings apply only when `--tag=package-resources-2019-10 --python` is specified on the command line. From 8ba18e990a5c1a98d505018329d53272ce43f334 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Mon, 8 Jun 2020 13:27:34 +0800 Subject: [PATCH 106/318] Add multiapi support (#9759) --- specification/digitaltwins/resource-manager/readme.go.md | 7 +++++++ 1 file changed, 7 insertions(+) diff --git a/specification/digitaltwins/resource-manager/readme.go.md b/specification/digitaltwins/resource-manager/readme.go.md index 111d623ddb80..8da406275cdd 100644 --- a/specification/digitaltwins/resource-manager/readme.go.md +++ b/specification/digitaltwins/resource-manager/readme.go.md @@ -8,6 +8,13 @@ go: clear-output-folder: true ``` +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2020-03-01-preview +``` + ### Tag: package-2020-03-01-preview and go These settings apply only when `--tag=package-2020-03-01-preview --go` is specified on the command line. From 6f37cdbbe239571aaaf149a2a97fd583e0761800 Mon Sep 17 00:00:00 2001 From: sashahdo <64434373+sashahdo@users.noreply.github.com> Date: Mon, 8 Jun 2020 19:21:31 -0700 Subject: [PATCH 107/318] fixed examples and BudgetCategory as PM suggested (#9776) --- .../stable/2019-10-01/consumption.json | 3 +-- .../stable/2019-10-01/examples/Budget.json | 8 +++---- .../2019-10-01/examples/BudgetsList.json | 16 +++++++------- .../examples/CreateOrUpdateBudget.json | 22 +++++++++---------- 4 files changed, 24 insertions(+), 25 deletions(-) diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json index df51f5e489e7..cd3415b062d5 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json @@ -3548,8 +3548,7 @@ "description": "The category of the budget, whether the budget tracks cost or usage.", "type": "string", "enum": [ - "Cost", - "Usage" + "Cost" ], "x-ms-enum": { "name": "CategoryType", diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/Budget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/Budget.json index dc5d2048afb9..7772ab159833 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/Budget.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/Budget.json @@ -9,7 +9,7 @@ "responses": { "200": { "body": { - "id": "subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.Consumption/budgets", "eTag": "\"1d34d012214157f\"", @@ -28,8 +28,8 @@ "name": "ResourceId", "operator": "In", "values": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" ] } }, @@ -73,7 +73,7 @@ "Reader" ], "contactGroups": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" ], "thresholdType": "Actual" } diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/BudgetsList.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/BudgetsList.json index 79016fba4a92..3a2bef0fc12e 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/BudgetsList.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/BudgetsList.json @@ -10,7 +10,7 @@ "body": { "value": [ { - "id": "subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.Consumption/budgets", "eTag": "\"1d34d012214157f\"", @@ -29,8 +29,8 @@ "name": "ResourceId", "operator": "In", "values": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" ] } }, @@ -87,7 +87,7 @@ "Reader" ], "contactGroups": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" ] }, "thresholdType": "Actual" @@ -95,7 +95,7 @@ } }, { - "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/budgets/TestBudget", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.Consumption/budgets", "eTag": "\"1d34d012214157f\"", @@ -114,8 +114,8 @@ "name": "ResourceId", "operator": "In", "values": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" ] } }, @@ -172,7 +172,7 @@ "Reader" ], "contactGroups": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" ], "thresholdType": "Actual" } diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/CreateOrUpdateBudget.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/CreateOrUpdateBudget.json index 6e661c37f5d2..e7316c36d43e 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/CreateOrUpdateBudget.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/CreateOrUpdateBudget.json @@ -22,8 +22,8 @@ "name": "ResourceId", "operator": "In", "values": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" ] } }, @@ -63,7 +63,7 @@ "Reader" ], "contactGroups": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" ], "thresholdType": "Actual" } @@ -74,7 +74,7 @@ "responses": { "201": { "body": { - "id": "subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.Consumption/budgets", "eTag": "\"1d34d012214157f\"", @@ -93,8 +93,8 @@ "name": "ResourceId", "operator": "In", "values": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" ] } }, @@ -138,7 +138,7 @@ "Reader" ], "contactGroups": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" ], "thresholdType": "Actual" } @@ -148,7 +148,7 @@ }, "200": { "body": { - "id": "subscriptions/{subscription-id}/providers/Microsoft.Consumption/budgets/TestBudget", + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Consumption/budgets/TestBudget", "name": "TestBudget", "type": "Microsoft.Consumption/budgets", "eTag": "\"1d34d012214157f\"", @@ -167,8 +167,8 @@ "name": "ResourceId", "operator": "In", "values": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/MSVM2", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Compute/virtualMachines/platformcloudplatformGeneric1" ] } }, @@ -212,7 +212,7 @@ "Reader" ], "contactGroups": [ - "/subscriptions/{subscription-id}/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/microsoft.insights/actionGroups/SampleActionGroup" ], "thresholdType": "Actual" } From 8cbe73e65e3042dba7188724b860500cff6fedd1 Mon Sep 17 00:00:00 2001 From: aim-for-better Date: Tue, 9 Jun 2020 10:37:20 +0800 Subject: [PATCH 108/318] Fix Error Response Structure (#9733) Co-authored-by: Zhenyu Zhou --- .../examples/GetClusterVirtualMachines.json | 60 +++++++++---------- .../2018-06-01-preview/virtualMachines.json | 11 +--- 2 files changed, 32 insertions(+), 39 deletions(-) diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetClusterVirtualMachines.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetClusterVirtualMachines.json index ef9bdd0d2d1e..6e3d11ed1863 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetClusterVirtualMachines.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/GetClusterVirtualMachines.json @@ -7,37 +7,35 @@ }, "responses": { "200": { - "body": { - "value": [ - { - "name": "gateway1" - }, - { - "name": "gateway3" - }, - { - "name": "headnode0" - }, - { - "name": "headnode3" - }, - { - "name": "workernode0" - }, - { - "name": "workernode1" - }, - { - "name": "zookeepernode0" - }, - { - "name": "zookeepernode2" - }, - { - "name": "zookeepernode3" - } - ] - } + "body": [ + { + "name": "gateway1" + }, + { + "name": "gateway3" + }, + { + "name": "headnode0" + }, + { + "name": "headnode3" + }, + { + "name": "workernode0" + }, + { + "name": "workernode1" + }, + { + "name": "zookeepernode0" + }, + { + "name": "zookeepernode2" + }, + { + "name": "zookeepernode3" + } + ] } } } diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/virtualMachines.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/virtualMachines.json index 61878b4e0af6..4db9dc3a68d9 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/virtualMachines.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/virtualMachines.json @@ -142,14 +142,9 @@ }, "HostInfoListResult": { "description": "Result of the request to list cluster hosts", - "properties": { - "value": { - "type": "array", - "items": { - "$ref": "#/definitions/HostInfo" - }, - "description": "The list of cluster hosts." - } + "type": "array", + "items": { + "$ref": "#/definitions/HostInfo" }, "readOnly": true }, From c94d2623e95db48fcdff105c5c03fab75ebe9b56 Mon Sep 17 00:00:00 2001 From: Hyewon Lee Date: Mon, 8 Jun 2020 20:17:13 -0700 Subject: [PATCH 109/318] Adding new resource type azureADMetrics (#9636) * Adds base for updating Microsoft.Aadiam from version preview/2020-03-01-preview to version 2020-07-01-preview * Updates readme * Updates API version in new specs and examples * added azureADHealth * rough commit (without examples) for azureADHealth * changed Ad to AD * added examples for azureadhealth * removed private link files from 2020-07-01 preview * examples updated for azureadhealth * removed alltenants and tenants params from examples * Fix Linting errors * Update readme to make avocado fix * minor fix * custom word addition * Update examples to match spec * Make PrivateLinkPolicyName parameter have same values to solve LintDiff error * Make subscriptionIdParameter identical in all json files * error fixes for all model errors * fixed model validation error * additional suppressions for pascal case and operations * added azureadhealth in readme to fix avocado error * added privatelink api version along with azureadhealth * changed api version to the filepath version * modified for corrections on AzureADHealthGet * aded changes to match spec and example * reverted passing commit from before * renamed to azureadmetrics * Readme changes * azureadmetrics custom word change * azureadmetrics file updates * properties * quick prettier fix * minor change to run tests again * addressing comments * location and tag changes * delete doesnt take in param * removed duplicate tag def * syntax check * comment changes, except the provisioningState change * provisioningstate property addition * provisioningState example fixes * properties fix * semantic validation error fix Co-authored-by: Hyewon Lee Co-authored-by: Abbe Blank --- custom-words.txt | 1 + .../privateLinkForAzureAD.json | 2 +- .../privateLinkResources.json | 7 +- .../2020-07-01-preview/azureADMetrics.json | 432 ++++++++++++++++++ .../AzureADMetricsCreateOrUpdate.json | 38 ++ .../examples/AzureADMetricsDelete.json | 12 + .../examples/AzureADMetricsGet.json | 22 + .../examples/AzureADMetricsList.json | 24 + .../AzureADMetricsListBySubscription.json | 23 + .../examples/AzureADMetricsUpdate.json | 26 ++ .../resource-manager/readme.md | 55 ++- 11 files changed, 631 insertions(+), 11 deletions(-) create mode 100644 specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json create mode 100644 specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsCreateOrUpdate.json create mode 100644 specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsDelete.json create mode 100644 specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsGet.json create mode 100644 specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsList.json create mode 100644 specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsListBySubscription.json create mode 100644 specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsUpdate.json diff --git a/custom-words.txt b/custom-words.txt index 44054866df7b..626e14de791b 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1785,6 +1785,7 @@ userprincipalname sessionstate sessionhosts hostpool +azureADMetrics sparkr ambari dotnetspark diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json index beda20b39188..28cedade989e 100644 --- a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json +++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json @@ -474,7 +474,7 @@ "required": true, "type": "string", "x-ms-parameter-location": "method", - "description": "name of the private link policy." + "description": "The name of the private link policy in Azure AD." } } } diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json index a5cb5c0cab09..dcd0d05e2ce0 100644 --- a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json +++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json @@ -1,7 +1,7 @@ { "swagger": "2.0", "info": { - "version": "2017-04-01", + "version": "2020-03-01-preview", "title": "azureactivedirectory", "description": "Azure Active Directory Client." }, @@ -227,7 +227,8 @@ "in": "path", "description": "Azure subscription ID.", "required": true, - "type": "string" + "type": "string", + "x-ms-parameter-location": "client" }, "apiVersionParameter": { "name": "api-version", @@ -260,7 +261,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the private link policy name in Azure AD.", + "description": "The name of the private link policy in Azure AD.", "x-ms-parameter-location": "method" } } diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json new file mode 100644 index 000000000000..1111208831f3 --- /dev/null +++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json @@ -0,0 +1,432 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-07-01-preview", + "title": "azureactivedirectory", + "description": "Metrics and Alerts for Azure Active Directory." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/microsoft.aadiam/azureADMetrics/{azureADMetricsName}": { + "put": { + "tags": [ + "azureADMetrics" + ], + "operationId": "azureADMetrics_CreateOrUpdate", + "x-ms-long-running-operation": true, + "description": "Creates a azureADMetrics instance.", + "x-ms-examples": { + "azureADMetricsCreate": { + "$ref": "./examples/AzureADMetricsCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/azureADMetricsNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "azureADMetricsConfig", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/azureADMetricsConfig" + }, + "description": "AzureADMetrics definition supplied to the operation." + } + ], + "responses": { + "200": { + "description": "OK -- AzureADMetrics instance is updated.", + "schema": { + "$ref": "#/definitions/azureADMetricsConfig" + } + }, + "201": { + "description": "Created -- AzureADMetrics instance created.", + "schema": { + "$ref": "#/definitions/azureADMetricsConfig" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "azureADMetrics" + ], + "operationId": "azureADMetrics_Update", + "description": "Updates azureADMetrics tags with specified values.", + "x-ms-examples": { + "azureADMetricsUpdate": { + "$ref": "./examples/AzureADMetricsUpdate.json" + } + }, + "parameters": [ + { + "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/azureADMetricsNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "azureADMetricsConfig", + "in": "body", + "schema": { + "$ref": "#/definitions/azureADMetricsUpdateParameter" + }, + "description": "AzureADMetrics resource with the tags to be updated." + } + ], + "responses": { + "200": { + "description": "OK -- AzureADMetrics tags are updated.", + "schema": { + "$ref": "#/definitions/azureADMetricsConfig" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "get": { + "tags": [ + "azureADMetrics" + ], + "operationId": "azureADMetrics_Get", + "description": "Gets a azureADMetrics instance with a given name.", + "x-ms-examples": { + "azureADMetricsGet": { + "$ref": "./examples/AzureADMetricsGet.json" + } + }, + "parameters": [ + { + "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/azureADMetricsNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returns information about the azureADMetrics resource.", + "schema": { + "$ref": "#/definitions/azureADMetricsConfig" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "azureADMetrics" + ], + "operationId": "azureADMetrics_Delete", + "description": "Deletes a AzureADMetrics resource. When operation completes, status code 200 returned without content.", + "x-ms-examples": { + "azureADMetricsDelete": { + "$ref": "./examples/AzureADMetricsDelete.json" + } + }, + "parameters": [ + { + "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/azureADMetricsNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- azureADMetrics resource deleted." + }, + "204": { + "description": "azureADMetrics does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/microsoft.aadiam/azureADMetrics": { + "get": { + "tags": [ + "azureADMetrics" + ], + "operationId": "azureADMetrics_ListBySubscription", + "description": "Lists all AzureADMetrics resources in the given subscription.", + "x-ms-examples": { + "azureADMetricsListBySubscription": { + "$ref": "./examples/AzureADMetricsListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Returns a list azureADMetrics resources.", + "schema": { + "$ref": "#/definitions/azureADMetricsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.aadiam/azureADMetrics": { + "get": { + "tags": [ + "azureADMetrics" + ], + "operationId": "azureADMetrics_List", + "x-ms-examples": { + "azureADMetricsGetList": { + "$ref": "./examples/AzureADMetricsList.json" + } + }, + "description": "Operation to return the list of AzureADMetrics resources scoped to the resourceGroup.", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../2020-03-01-preview/privateLinkForAzureAD.json#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successful request to get list of AzureADMetrics resources For AzureAD.", + "schema": { + "$ref": "#/definitions/azureADMetricsListResult" + } + }, + "default": { + "description": "Error, failed to get list of AzureADMetrics resources.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "azureADMetricsListResult": { + "description": "A list of AzureADMetrics resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of AzureADMetrics resources.", + "items": { + "$ref": "#/definitions/azureADMetricsConfig" + }, + "readOnly": true + }, + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string", + "readOnly": true + } + } + }, + "azureADMetricsConfig": { + "description": "AzureADMetrics resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/AzureADMetricsPropertiesFormat" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ] + }, + "AzureADMetricsPropertiesFormat": { + "properties": { + "provisioningState": { + "type": "string", + "description": "The provisioning state of the resource.", + "enum": [ + "Succeeded", + "Created", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + } + } + }, + "azureADMetricsUpdateParameter": { + "type": "object", + "description": "AzureADMetrics parameters to be updated. ", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags to be updated.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error definition.", + "properties": { + "code": { + "description": "Service specific error code which serves as the substatus for the HTTP error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Description of the error.", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Internal error details.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDefinition" + }, + "readOnly": true + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Version of the API to be used with the client request." + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of an Azure resource group." + }, + "azureADMetricsNameParameter": { + "name": "azureADMetricsName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Name of the azureADMetrics instance." + } + } +} diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsCreateOrUpdate.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsCreateOrUpdate.json new file mode 100644 index 000000000000..5c9e06214b75 --- /dev/null +++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsCreateOrUpdate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "azureADMetricsName": "ddb1", + "api-version": "2020-07-01-preview", + "azureADMetricsConfig": { + "location": "West US", + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1", + "location": "West US", + "name": "ddb1", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "type": "Microsoft.Aadiam/azureADMetrics" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1", + "location": "West US", + "name": "ddb1", + "properties": { + "provisioningState": "Created" + }, + "tags": {}, + "type": "Microsoft.Aadiam/azureADMetrics" + } + } + } +} diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsDelete.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsDelete.json new file mode 100644 index 000000000000..87571e561014 --- /dev/null +++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "azureADMetricsName": "ddb1", + "api-version": "2020-07-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsGet.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsGet.json new file mode 100644 index 000000000000..8dbfdc69b9d7 --- /dev/null +++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "azureADMetricsName": "ddb1", + "api-version": "2020-07-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1", + "name": "ddb1", + "location": "West US", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "type": "Microsoft.Aadiam/azureADMetrics" + } + } + } +} diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsList.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsList.json new file mode 100644 index 000000000000..519c5cc740f1 --- /dev/null +++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "api-version": "2020-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1", + "name": "ddb1", + "location": "West US", + "properties": { + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Aadiam/azureADMetrics" + } + ] + } + } + } +} diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsListBySubscription.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsListBySubscription.json new file mode 100644 index 000000000000..f8bf57a8f2be --- /dev/null +++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsListBySubscription.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2020-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1", + "name": "ddb1", + "location": "West US", + "properties": { + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Aadiam/azureADMetrics" + } + ] + } + } + } +} diff --git a/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsUpdate.json b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsUpdate.json new file mode 100644 index 000000000000..bc7f75389954 --- /dev/null +++ b/specification/azureactivedirectory/resource-manager/Microsoft.Aadiam/preview/2020-07-01-preview/examples/AzureADMetricsUpdate.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg1", + "azureADMetricsName": "ddb1", + "api-version": "2020-07-01-preview", + "location": "West US", + "azureADMetricsConfig": { + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg1/providers/Microsoft.Aadiam/azureADMetrics/ddb1", + "location": "West US", + "name": "ddb1", + "properties": { + "provisioningState": "Succeeded" + }, + "tags": {}, + "type": "Microsoft.Aadiam/azureADMetrics" + } + } + } +} diff --git a/specification/azureactivedirectory/resource-manager/readme.md b/specification/azureactivedirectory/resource-manager/readme.md index b1d96fb51aa0..46fe420e432e 100644 --- a/specification/azureactivedirectory/resource-manager/readme.md +++ b/specification/azureactivedirectory/resource-manager/readme.md @@ -24,20 +24,58 @@ For other options on installation see [Installing AutoRest](https://aka.ms/autor These are the global settings for the azureactivedirectory. -```yaml +``` yaml openapi-type: arm -tag: package-2017-04-01 +tag: package-preview-2020-07 +``` + +### Tag: package-preview-2020-07 + +These settings apply only when `--tag=package-preview-2020-07` is specified on the command line. + +```yaml $(tag) == 'package-preview-2020-07' +input-file: + - Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json +``` + +### Tag: package-preview-2020-03 + +These settings apply only when `--tag=package-preview-2020-03` is specified on the command line. + +```yaml $(tag) == 'package-preview-2020-07' +input-file: + - Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json + - Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json ``` ### Tag: package-2017-04-01 These settings apply only when `--tag=package-2017-04-01` is specified on the command line. -```yaml $(tag) == 'package-2017-04-01' +``` yaml $(tag) == 'package-2017-04-01' input-file: - Microsoft.Aadiam/stable/2017-04-01/azureactivedirectory.json ``` +## Suppression +``` yaml +directive: + - suppress: BodyTopLevelProperties + from: azureADMetrics.json + where: $.definitions.azureADMetricsConfig.properties + - suppress: BodyTopLevelProperties + from: privateLinkForAzureAD.json + where: $.definitions.privateLinkPolicy.properties + - suppress: RequiredPropertiesMissingInResourceModel + from: azureADMetrics.json + where: $.definitions.azureADMetricsConfig + - suppress: RequiredPropertiesMissingInResourceModel + from: privateLinkForAzureAD.json + where: $.definitions.privateLinkPolicy + - suppress: R3020 + - suppress: R3023 +``` + --- # Code Generation @@ -47,7 +85,7 @@ input-file: This section describes what SDK should be generated by the automatic system. This is not used by Autorest itself. -```yaml $(swagger-to-sdk) +``` yaml $(swagger-to-sdk) swagger-to-sdk: - repo: azure-sdk-for-net - repo: azure-sdk-for-python @@ -79,7 +117,7 @@ See configuration in [readme.typescript.md](./readme.typescript.md) See configuration in [readme.csharp.md](./readme.csharp.md) -## Multi-API/Profile support for AutoRest v3 generators +## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -92,14 +130,17 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/Microsoft.Aadiam/stable/2017-04-01/azureactivedirectory.json + - $(this-folder)/Microsoft.Aadiam/preview/2020-07-01-preview/azureADMetrics.json + - $(this-folder)/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkForAzureAD.json + - $(this-folder)/Microsoft.Aadiam/preview/2020-03-01-preview/privateLinkResources.json + ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - From 607ab2eeadda0594535b145e4eb19455ae133f23 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Tue, 9 Jun 2020 06:47:01 +0200 Subject: [PATCH 110/318] enable t2 generation (#9755) --- specification/eventhub/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/eventhub/resource-manager/readme.md b/specification/eventhub/resource-manager/readme.md index f1cda0ee1161..a8da92c7327c 100644 --- a/specification/eventhub/resource-manager/readme.md +++ b/specification/eventhub/resource-manager/readme.md @@ -106,6 +106,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python after_scripts: - python ./scripts/multiapi_init_gen.py azure-mgmt-eventhub + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js From 2e3de6cd3b6406dd63e38713b01e457c876be1a2 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Tue, 9 Jun 2020 06:47:31 +0200 Subject: [PATCH 111/318] enable t2 generation (#9752) --- specification/resources/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 268e7e769ad4..e7212ceadb2f 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -583,6 +583,7 @@ swagger-to-sdk: - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#subscriptions - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#links - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#deploymentscripts + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node From 26c2e52baef4fea525e1412bc9fb0259ac1c8f97 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Tue, 9 Jun 2020 06:49:43 +0200 Subject: [PATCH 112/318] test support (#9741) --- .../support/resource-manager/readme.cli.md | 64 +++++++++++++++++++ 1 file changed, 64 insertions(+) create mode 100644 specification/support/resource-manager/readme.cli.md diff --git a/specification/support/resource-manager/readme.cli.md b/specification/support/resource-manager/readme.cli.md new file mode 100644 index 000000000000..220310005660 --- /dev/null +++ b/specification/support/resource-manager/readme.cli.md @@ -0,0 +1,64 @@ +## CLI + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +cli: + test-scenario: + - name: /SupportTickets/put/Create a ticket to request Quota increase for Low-priority cores for a Batch account + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for Servers for Azure Synapse Analytics + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for DTUs for Azure Synapse Analytics + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for Servers for SQL Database + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for DTUs for SQL Database + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for specific VM family cores for Machine Learning service + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for Active Jobs and Job Schedules for a Batch account + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for Pools for a Batch account + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for specific VM family cores for a Batch account + disabled: true + - name: /SupportTickets/put/Create a ticket for Billing related issues + disabled: true + - name: /SupportTickets/put/Create a ticket for Subscription Management related issues + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for Low-priority cores for Machine Learning service + disabled: true + - name: /SupportTickets/put/Create a ticket for Technical issue related to a specific resource + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for services that do not require additional details in the quotaTi + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for Compute VM Cores + disabled: true + - name: /SupportTickets/put/Create a ticket to request Quota increase for Batch accounts for a subscription + disabled: true + - name: /Communications/put/AddCommunicationToSubscriptionTicket + disabled: true + - name: /Communications/get/Get communication details for a subscription support ticket + disabled: true + - name: /Communications/get/List web communications for a subscription support ticket + disabled: true + - name: /Communications/get/List communications for a subscription support ticket + disabled: true + - name: /Communications/get/List web communication created on or after a specific date for a subscription support ticket + disabled: true + - name: /ProblemClassifications/get/Gets details of problemClassification for Azure service + - name: /SupportTickets/get/Get details of a subscription ticket + disabled: true + - name: /SupportTickets/get/List support tickets in open state for a subscription + - name: /ProblemClassifications/get/Gets list of problemClassifications for a service for which a support ticket can be created + - name: /SupportTickets/get/List support tickets created on or after a certain date and in open state for a subscription + - name: /Services/get/Gets list of services for which a support ticket can be created + - name: /Communications/post/Checks whether name is available for Communication resource + - name: /SupportTickets/patch/Update contact details of a support ticket + disabled: true + - name: /SupportTickets/patch/Update severity of a support ticket + disabled: true + - name: /SupportTickets/patch/Update status of a support ticket + disabled: true + - name: /SupportTickets/post/Checks whether name is available for SupportTicket resource From dd57b923c733118bc1eb05c1c32265e48aace077 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Tue, 9 Jun 2020 06:50:23 +0200 Subject: [PATCH 113/318] enable t2 generation (#9751) --- specification/storage/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/storage/resource-manager/readme.md b/specification/storage/resource-manager/readme.md index 27132c56a3d2..2e22b135e433 100644 --- a/specification/storage/resource-manager/readme.md +++ b/specification/storage/resource-manager/readme.md @@ -271,6 +271,7 @@ swagger-to-sdk: after_scripts: - python ./scripts/multiapi_init_gen.py azure-mgmt-storage - python ./scripts/trim_aio.py ./sdk/storage/azure-mgmt-storage + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node From 28fc6bb6c548550e876dc7a5a5ada512e6b9efcc Mon Sep 17 00:00:00 2001 From: stuartko <47676853+stuartko@users.noreply.github.com> Date: Mon, 8 Jun 2020 21:58:56 -0700 Subject: [PATCH 114/318] Adding swagger for Template Specs (#9778) * Adding swagger for Template Specs * Running prettier to fix whitespace/newline alignments --- .../examples/TemplateSpecVersionsCreate.json | 73 ++ .../examples/TemplateSpecVersionsDelete.json | 13 + .../examples/TemplateSpecVersionsGet.json | 36 + .../examples/TemplateSpecVersionsList.json | 50 + .../examples/TemplateSpecVersionsPatch.json | 44 + .../examples/TemplateSpecsCreate.json | 54 ++ .../examples/TemplateSpecsDelete.json | 12 + .../examples/TemplateSpecsGet.json | 29 + .../TemplateSpecsListByResourceGroup.json | 49 + .../TemplateSpecsListBySubscription.json | 48 + .../examples/TemplateSpecsPatch.json | 37 + .../2019-06-01-preview/templateSpecs.json | 863 ++++++++++++++++++ .../resource-manager/readme.csharp.md | 1 + .../resources/resource-manager/readme.md | 34 + 14 files changed, 1343 insertions(+) create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsCreate.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsDelete.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsGet.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsList.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsPatch.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsCreate.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsDelete.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsGet.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsListByResourceGroup.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsListBySubscription.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsPatch.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsCreate.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsCreate.json new file mode 100644 index 000000000000..7027130afd46 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsCreate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "templateSpecRG", + "templateSpecName": "simpleTemplateSpec", + "templateSpecVersion": "v1.0", + "templateSpecVersionModel": { + "location": "eastus", + "properties": { + "description": "This is version v1.0 of our template content", + "template": { + "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": {}, + "resources": [] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0", + "type": "Microsoft.Resources/templateSpecs/versions", + "name": "v1.0", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + }, + "properties": { + "description": "This is version v1.0 of our template content", + "template": { + "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": {}, + "resources": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0", + "type": "Microsoft.Resources/templateSpecs/versions", + "name": "v1.0", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "description": "This is version v1.0 of our template content", + "template": { + "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": {}, + "resources": [] + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsDelete.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsDelete.json new file mode 100644 index 000000000000..e7c2a152a793 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "templateSpecRG", + "templateSpecName": "simpleTemplateSpec", + "templateSpecVersion": "v1.0" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsGet.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsGet.json new file mode 100644 index 000000000000..c24ac4e90725 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "templateSpecRG", + "templateSpecName": "simpleTemplateSpec", + "templateSpecVersion": "v1.0" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0", + "type": "Microsoft.Resources/templateSpecs/versions", + "name": "v1.0", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + }, + "properties": { + "description": "This is version v1.0 of our template content", + "template": { + "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": {}, + "resources": [] + } + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsList.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsList.json new file mode 100644 index 000000000000..6c747f9c7623 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "templateSpecRG", + "templateSpecName": "simpleTemplateSpec" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0", + "type": "Microsoft.Resources/templateSpecs/versions", + "name": "v1.0", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + }, + "properties": { + "description": "This is version v1.0" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v2.0", + "type": "Microsoft.Resources/templateSpecs/versions", + "name": "v2.0", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-03T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-04T02:03:01.1974346Z" + }, + "properties": { + "description": "This is another version (v2.0)" + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsPatch.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsPatch.json new file mode 100644 index 000000000000..ae6ac0541e28 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecVersionsPatch.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "templateSpecRG", + "templateSpecName": "simpleTemplateSpec", + "templateSpecVersion": "v1.0", + "templateSpecVersionUpdateModel": { + "tags": { + "myTag": "My Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec/versions/v1.0", + "type": "Microsoft.Resources/templateSpecs/versions", + "name": "v1.0", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + }, + "properties": { + "description": "This is version v1.0 of our template content", + "template": { + "$schema": "http://schema.management.azure.com/schemas/2015-01-01/deploymentTemplate.json#", + "contentVersion": "1.0.0.0", + "parameters": {}, + "resources": [] + } + }, + "tags": { + "myTag": "My Value" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsCreate.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsCreate.json new file mode 100644 index 000000000000..68b29c856064 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsCreate.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "templateSpecRG", + "templateSpecName": "simpleTemplateSpec", + "templateSpec": { + "location": "eastus", + "properties": { + "description": "A very simple Template Spec" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec", + "type": "Microsoft.Resources/templateSpecs", + "name": "simpleTemplateSpec", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-01T01:01:01.1075056Z" + }, + "properties": { + "description": "A very simple Template Spec" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec", + "type": "Microsoft.Resources/templateSpecs", + "name": "simpleTemplateSpec", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + }, + "properties": { + "description": "A very simple Template Spec" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsDelete.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsDelete.json new file mode 100644 index 000000000000..9e62f14c3c13 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "templateSpecRG", + "templateSpecName": "simpleTemplateSpec" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsGet.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsGet.json new file mode 100644 index 000000000000..09213ca6a682 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "templateSpecRG", + "templateSpecName": "simpleTemplateSpec" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec", + "type": "Microsoft.Resources/templateSpecs", + "name": "simpleTemplateSpec", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + }, + "properties": { + "description": "A very simple Template Spec" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsListByResourceGroup.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsListByResourceGroup.json new file mode 100644 index 000000000000..601e93f3d384 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsListByResourceGroup.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "templateSpecRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec", + "type": "Microsoft.Resources/templateSpecs", + "name": "simpleTemplateSpec", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + }, + "properties": { + "description": "A very simple Template Spec" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/anotherSimpleTemplateSpec", + "type": "Microsoft.Resources/templateSpecs", + "name": "anotherSimpleTemplateSpec", + "location": "westus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-03T02:03:01.1974346Z" + }, + "properties": { + "description": "Another very simple Template Spec" + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsListBySubscription.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsListBySubscription.json new file mode 100644 index 000000000000..d06d40a793ba --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsListBySubscription.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec", + "type": "Microsoft.Resources/templateSpecs", + "name": "simpleTemplateSpec", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + }, + "properties": { + "description": "A very simple Template Spec" + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG2/providers/Microsoft.Resources/templateSpecs/anotherSimpleTemplateSpec", + "type": "Microsoft.Resources/templateSpecs", + "name": "anotherSimpleTemplateSpec", + "location": "westus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-02T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-03T02:03:01.1974346Z" + }, + "properties": { + "description": "Another very simple Template Spec" + } + } + ] + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsPatch.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsPatch.json new file mode 100644 index 000000000000..4170c4ad0219 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/examples/TemplateSpecsPatch.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2019-06-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "templateSpecRG", + "templateSpecName": "simpleTemplateSpec", + "templateSpec": { + "tags": { + "myTag": "My Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/templateSpecRG/providers/Microsoft.Resources/templateSpecs/simpleTemplateSpec", + "type": "Microsoft.Resources/templateSpecs", + "name": "simpleTemplateSpec", + "location": "eastus", + "systemData": { + "createdBy": "string", + "createdByType": "Application", + "createdAt": "2020-02-01T01:01:01.1075056Z", + "lastModifiedBy": "string", + "lastModifiedByType": "Application", + "lastModifiedAt": "2020-02-02T02:03:01.1974346Z" + }, + "properties": { + "description": "A very simple Template Spec" + }, + "tags": { + "myTag": "My Value" + } + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json new file mode 100644 index 000000000000..9cc8d212cd87 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json @@ -0,0 +1,863 @@ +{ + "swagger": "2.0", + "info": { + "title": "TemplateSpecsClient", + "description": "The APIs listed in this specification can be used to manage Template Spec resources through the Azure Resource Manager.", + "version": "2019-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}": { + "put": { + "tags": [ + "TemplateSpecs" + ], + "operationId": "TemplateSpecs_CreateOrUpdate", + "description": "Creates or updates a Template Spec.", + "x-ms-examples": { + "TemplateSpecsCreateUpdate": { + "$ref": "./examples/TemplateSpecsCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TemplateSpecNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "templateSpec", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TemplateSpecModel" + }, + "description": "Template Spec supplied to the operation." + } + ], + "responses": { + "200": { + "description": "OK - The Template Spec update request has succeeded.", + "schema": { + "$ref": "#/definitions/TemplateSpecModel" + } + }, + "201": { + "description": "Template Spec created.", + "schema": { + "$ref": "#/definitions/TemplateSpecModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + } + }, + "patch": { + "tags": [ + "TemplateSpecs" + ], + "operationId": "TemplateSpecs_Update", + "description": "Updates Template Spec tags with specified values.", + "x-ms-examples": { + "TemplateSpecsPatch": { + "$ref": "./examples/TemplateSpecsPatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TemplateSpecNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "templateSpec", + "in": "body", + "schema": { + "$ref": "#/definitions/TemplateSpecUpdateModel" + }, + "description": "Template Spec resource with the tags to be updated." + } + ], + "responses": { + "200": { + "description": "OK -- Template Spec tags are updated.", + "schema": { + "$ref": "#/definitions/TemplateSpecModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + } + }, + "get": { + "tags": [ + "TemplateSpecs" + ], + "operationId": "TemplateSpecs_Get", + "description": "Gets a Template Spec with a given name.", + "x-ms-examples": { + "TemplateSpecsGet": { + "$ref": "./examples/TemplateSpecsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TemplateSpecNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the Template Spec.", + "schema": { + "$ref": "#/definitions/TemplateSpecModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + } + }, + "delete": { + "tags": [ + "TemplateSpecs" + ], + "operationId": "TemplateSpecs_Delete", + "description": "Deletes a Template Spec by name. When operation completes, status code 200 returned without content.", + "x-ms-examples": { + "TemplateSpecsDelete": { + "$ref": "./examples/TemplateSpecsDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TemplateSpecNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Template Spec deleted." + }, + "204": { + "description": "Template Spec does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Resources/templateSpecs/": { + "get": { + "tags": [ + "TemplateSpecs" + ], + "operationId": "TemplateSpecs_ListBySubscription", + "description": "Lists all the Template Specs within the specified subscriptions.", + "x-ms-examples": { + "TemplatesSpecsListBySubscription": { + "$ref": "./examples/TemplateSpecsListBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of Template Specs.", + "schema": { + "$ref": "#/definitions/TemplateSpecsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/": { + "get": { + "tags": [ + "TemplateSpecs" + ], + "operationId": "TemplateSpecs_ListByResourceGroup", + "description": "Lists all the Template Specs within the specified resource group.", + "x-ms-examples": { + "TemplateSpecsListByResourceGroup": { + "$ref": "./examples/TemplateSpecsListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of Template Specs.", + "schema": { + "$ref": "#/definitions/TemplateSpecsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions/{templateSpecVersion}": { + "put": { + "tags": [ + "TemplateSpecVersions" + ], + "operationId": "TemplateSpecVersions_CreateOrUpdate", + "description": "Creates or updates a Template Spec version.", + "x-ms-examples": { + "TemplateSpecVersionsCreateUpdate": { + "$ref": "./examples/TemplateSpecVersionsCreate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TemplateSpecNameParameter" + }, + { + "$ref": "#/parameters/TemplateSpecVersionParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "templateSpecVersionModel", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TemplateSpecVersionModel" + }, + "description": "Template Spec Version supplied to the operation." + } + ], + "responses": { + "200": { + "description": "OK - The Template Spec Version has been successfully updated.", + "schema": { + "$ref": "#/definitions/TemplateSpecVersionModel" + } + }, + "201": { + "description": "Template Spec Version created.", + "schema": { + "$ref": "#/definitions/TemplateSpecVersionModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + } + }, + "patch": { + "tags": [ + "TemplateSpecVersions" + ], + "operationId": "TemplateSpecVersions_Update", + "description": "Updates Template Spec Version tags with specified values.", + "x-ms-examples": { + "TemplateSpecsPatch": { + "$ref": "./examples/TemplateSpecVersionsPatch.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TemplateSpecNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TemplateSpecVersionParameter" + }, + { + "name": "templateSpecVersionUpdateModel", + "in": "body", + "schema": { + "$ref": "#/definitions/TemplateSpecVersionUpdateModel" + }, + "description": "Template Spec Version resource with the tags to be updated." + } + ], + "responses": { + "200": { + "description": "OK -- Template Spec Version tags are updated.", + "schema": { + "$ref": "#/definitions/TemplateSpecVersionModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + } + }, + "get": { + "tags": [ + "TemplateSpecVersions" + ], + "operationId": "TemplateSpecVersions_Get", + "description": "Gets a Template Spec version from a specific Template Spec.", + "x-ms-examples": { + "TemplateSpecVersionsGet": { + "$ref": "./examples/TemplateSpecVersionsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TemplateSpecNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TemplateSpecVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the Template Spec version.", + "schema": { + "$ref": "#/definitions/TemplateSpecVersionModel" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + } + }, + "delete": { + "tags": [ + "TemplateSpecVersions" + ], + "operationId": "TemplateSpecVersions_Delete", + "description": "Deletes a specific version from a Template Spec. When operation completes, status code 200 returned without content.", + "x-ms-examples": { + "TemplateSpecVersionsDelete": { + "$ref": "./examples/TemplateSpecVersionsDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TemplateSpecNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/TemplateSpecVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Template Spec Version deleted." + }, + "204": { + "description": "Template Spec Version does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Resources/templateSpecs/{templateSpecName}/versions": { + "get": { + "tags": [ + "TemplateSpecVersions" + ], + "operationId": "TemplateSpecVersions_List", + "description": "Lists all the Template Spec versions in the specified Template Spec.", + "x-ms-examples": { + "TemplateSpecVersions_List": { + "$ref": "./examples/TemplateSpecVersionsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/TemplateSpecNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of Template Spec versions.", + "schema": { + "$ref": "#/definitions/TemplateSpecVersionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/TemplateSpecsError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "TemplateSpecModel": { + "required": [ + "location" + ], + "type": "object", + "description": "Template Spec object.", + "allOf": [ + { + "$ref": "#/definitions/AzureResourceBase" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The location of the Template Spec. It cannot be changed after Template Spec creation. It must be one of the supported Azure locations." + }, + "properties": { + "description": "Template Spec properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/TemplateSpecProperties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TemplateSpecProperties": { + "type": "object", + "description": "Template Spec properties.", + "properties": { + "description": { + "type": "string", + "maxLength": 4096, + "description": "Template Spec description." + }, + "displayName": { + "type": "string", + "maxLength": 64, + "description": "Template Spec display name." + } + } + }, + "TemplateSpecsListResult": { + "description": "List of Template Specs.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TemplateSpecModel" + }, + "description": "An array of Template Specs." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to use for getting the next set of results." + } + } + }, + "TemplateSpecUpdateModel": { + "type": "object", + "description": "Template Spec properties to be updated (only tags are currently supported).", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceBase" + } + ] + }, + "TemplateSpecVersionUpdateModel": { + "type": "object", + "description": "Template Spec Version properties to be updated (only tags are currently supported).", + "properties": { + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureResourceBase" + } + ] + }, + "AzureResourceBase": { + "x-ms-azure-resource": true, + "type": "object", + "description": "Common properties for all Azure resources.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "String Id used to locate any resource on Azure." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of this resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of this resource." + }, + "systemData": { + "readOnly": true, + "type": "object", + "description": "Azure Resource Manager metadata containing createdBy and modifiedBy information.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "TemplateSpecVersionModel": { + "required": [ + "properties", + "location" + ], + "type": "object", + "description": "Template Spec Version object.", + "allOf": [ + { + "$ref": "#/definitions/AzureResourceBase" + } + ], + "properties": { + "location": { + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ], + "description": "The location of the Template Spec Version. It must match the location of the parent Template Spec." + }, + "properties": { + "description": "Template Spec Version properties.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/TemplateSpecVersionProperties" + }, + "tags": { + "type": "object", + "description": "Resource tags.", + "additionalProperties": { + "type": "string" + } + } + } + }, + "TemplateSpecVersionProperties": { + "type": "object", + "description": "Template Spec Version properties.", + "properties": { + "artifacts": { + "type": "array", + "items": { + "$ref": "#/definitions/TemplateSpecArtifact" + }, + "description": "An array of Template Spec artifacts." + }, + "description": { + "type": "string", + "maxLength": 4096, + "description": "Template Spec version description." + }, + "template": { + "type": "object", + "description": "The Azure Resource Manager template content." + } + } + }, + "TemplateSpecVersionsListResult": { + "description": "List of Template Specs versions", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/TemplateSpecVersionModel" + }, + "description": "An array of Template Spec versions." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to use for getting the next set of results." + } + } + }, + "TemplateSpecArtifact": { + "type": "object", + "discriminator": "kind", + "description": "Represents a Template Spec artifact.", + "properties": { + "path": { + "type": "string", + "description": "A filesystem safe relative path of the artifact." + }, + "kind": { + "type": "string", + "description": "The kind of artifact.", + "enum": [ + "template" + ], + "x-ms-enum": { + "name": "TemplateSpecArtifactKind", + "modelAsString": true, + "values": [ + { + "value": "template", + "description": "The artifact represents an embedded Azure Resource Manager template." + } + ] + } + } + }, + "required": [ + "kind", + "path" + ] + }, + "TemplateSpecTemplateArtifact": { + "type": "object", + "x-ms-discriminator-value": "template", + "description": "Represents a Template Spec artifact containing an embedded Azure Resource Manager template.", + "properties": { + "template": { + "type": "object", + "description": "The Azure Resource Manager template." + } + }, + "required": [ + "template" + ], + "allOf": [ + { + "$ref": "#/definitions/TemplateSpecArtifact" + } + ] + }, + "TemplateSpecsError": { + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "Template Specs error response." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Subscription Id which forms part of the URI for every service call." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group. The name is case insensitive.", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "TemplateSpecNameParameter": { + "name": "templateSpecName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "description": "Name of the Template Spec.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "TemplateSpecVersionParameter": { + "name": "templateSpecVersion", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "description": "The version of the Template Spec.", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "description": "Client Api version." + } + } +} diff --git a/specification/resources/resource-manager/readme.csharp.md b/specification/resources/resource-manager/readme.csharp.md index c19e9afa7929..0364f5d7d6c2 100644 --- a/specification/resources/resource-manager/readme.csharp.md +++ b/specification/resources/resource-manager/readme.csharp.md @@ -24,6 +24,7 @@ batch: - package-subscriptions: true - package-links: true - package-deploymentscripts: true + - package-templatespecs: true # - package-managedapplications: true ``` diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index e7212ceadb2f..7ae41c1ac69c 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -60,6 +60,10 @@ tag: package-managedapplications-2018-06 tag: package-deploymentscripts-2019-10-preview ``` +``` yaml $(package-templatespecs) +tag: package-templatespecs-2019-06-preview +``` + ### Tag: package-resources-2020-06 These settings apply only when `--tag=package-resources-2020-06` is specified on the command line. @@ -218,6 +222,15 @@ override-info: title: PolicyClient ``` +### Tag: package-templatespecs-2019-06-preview + +These settings apply only when `--tag=package-templatespecs-2019-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-templatespecs-2019-06-preview' +input-file: +- Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json +``` + ### Tag: package-policy-2016-12 These settings apply only when `--tag=package-policy-2016-12` is specified on the command line. @@ -560,6 +573,26 @@ directive: - $.definitions.AzureCliScript.properties - $.definitions.AzurePowerShellScript.properties reason: Currently systemData is not allowed + - suppress: OperationsAPIImplementation + from: templateSpecs.json + where: $.paths + reason: OperationsAPI will come from Resources + - suppress: R3006 #BodyTopLevelProperties + from: templateSpecs.json + where: + - $.definitions.TemplateSpecModel.properties + - $.definitions.TemplateSpecVersionModel.properties + - $.definitions.TemplateSpecUpdateModel.properties + - $.definitions.TemplateSpecVersionUpdateModel.properties + reason: Currently systemData is not allowed + - suppress: TrackedResourceListByImmediateParent + from: templateSpecs.json + where: $.definitions + reason: Tooling issue + - suppress: TrackedResourceListByResourceGroup + from: templateSpecs.json + where: $.definitions.TemplateSpecVersionModel + reason: Tooling issue ``` --- @@ -612,6 +645,7 @@ batch: - package-links: true - package-managedapplications: true - package-deploymentscripts: true + - package-templatespecs: true ``` ### Tag: profile-hybrid-2019-03-01 From 8d70ce983b738bc38f84995c6b8bd30bcd9ab4b8 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Tue, 9 Jun 2020 07:17:53 +0200 Subject: [PATCH 115/318] enabling track2 generation (#9754) --- specification/network/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index d1b7dc95d0ab..45312080b20f 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -1515,6 +1515,7 @@ swagger-to-sdk: after_scripts: - python ./scripts/multiapi_init_gen.py azure-mgmt-network - python ./scripts/trim_aio.py ./sdk/network/azure-mgmt-network + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-js From 240f75f393846387d6419864d827804b573f6ad9 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Tue, 9 Jun 2020 09:19:33 +0200 Subject: [PATCH 116/318] added output folders (#9745) --- specification/attestation/resource-manager/readme.az.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/specification/attestation/resource-manager/readme.az.md b/specification/attestation/resource-manager/readme.az.md index 15a808946ef8..8f3cb7f07357 100644 --- a/specification/attestation/resource-manager/readme.az.md +++ b/specification/attestation/resource-manager/readme.az.md @@ -7,4 +7,6 @@ az: extensions: attestation package-name: azure-mgmt-attestation namespace: azure.mgmt.attestation +az-output-folder: $(azure-cli-extension-folder)/src/attestation +python-sdk-output-folder: "$(az-output-folder)/azext_attestation/vendored_sdks/attestation" ``` From 8e5820c94a1ea71f97cd98a1125b95d165cb26a1 Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Tue, 9 Jun 2020 16:58:57 +0800 Subject: [PATCH 117/318] add tags type (#9763) --- .../2019-12-10-preview/desktopvirtualization.json | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json index 621a229ef503..0948a6244957 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json @@ -2023,6 +2023,9 @@ "properties": { "tags": { "type": "object", + "additionalProperties": { + "type": "string" + }, "description": "tags to be updated" }, "properties": { @@ -2125,6 +2128,9 @@ "properties": { "tags": { "type": "object", + "additionalProperties": { + "type": "string" + }, "description": "tags to be updated" }, "properties": { @@ -2293,6 +2299,9 @@ "properties": { "tags": { "type": "object", + "additionalProperties": { + "type": "string" + }, "description": "tags to be updated" }, "properties": { @@ -2558,6 +2567,9 @@ "properties": { "tags": { "type": "object", + "additionalProperties": { + "type": "string" + }, "description": "tags to be updated" }, "properties": { @@ -2680,6 +2692,9 @@ "properties": { "tags": { "type": "object", + "additionalProperties": { + "type": "string" + }, "description": "tags to be updated" }, "properties": { From 3c09c5f5e3a7c6a543ae1a9eea7f06a3cfda83a8 Mon Sep 17 00:00:00 2001 From: Anton Evseev Date: Tue, 9 Jun 2020 17:24:11 +0300 Subject: [PATCH 118/318] Network May release (#9786) * Adds base for updating Microsoft.Network from version stable/2020-04-01 to version 2020-05-01 * Updates readme * Updates API version in new specs and examples * Add VirtualHubBgpConnections, VirtualHubIpConfigurations, NetworkVirtualApplianceSites child resources (#9357) * Adds base for updating Microsoft.Network from version stable/2020-03-01 to version 2020-05-01 * Updates readme * Updates API version in new specs and examples * Final changes * Fix formatting issues * Fix merge and formatting issues * Fix formatiing * Ipconfig properties * Fix build errors * Lint check * Fix semantics errors * Address review comments * Fix prettier and nextLink checks * Fix dots * Address errors * Fix Ipconfig version Co-authored-by: dexiang-ms <64503627+dexiang-ms@users.noreply.github.com> * Change NRP repo for validation scripts (#9394) * Move terminateTLS flag to ApplicationRuleCondition (#9539) * DNS Proxy support for Firewall Policy (#9461) * Adding DnsProxySettings Support in Firewall Policy dnsServers, dnsEnableProxy, dnsRequireProxyForNetworkRules are added as subproperties. * spell check * Removing DNS as prefix on sub properties. * Syntax error. * DnsProxySettings to DNSSettings * Fixing proxy settings name. Co-authored-by: Ishani Gupta * fix network (#9369) (#9547) * fix network * duplicated publicipprefix * fixed example in 2018-01-01 * final updates * missing examples (cherry picked from commit 42d96397744ec1e6e837a06879d6e43a13f8bc33) * Added new properties to ConnectivityHop (#9386) * Added new properties to ConnectivityHop * Fixed spelling * added x-ms-client-flatten to HopLink.properties.properties * Rename Firewall Policy child resource RuleGroup to RuleCollectionGroup (#9356) * Rename Firewall Policy child resource RuleGroup to RuleCollectionGroup * rebase with ti whitelist * rebase with ti whitelist * rebase with ti whitelist * prettier run * making nat rule into a collection * prettier run * Multiple Public IPs support for Azure Firewall in Virtual Hub (#9560) * multi pip for firewall in hub swagger change * resolving issues * VirtualWan: Hubvnet Connection related changes (#9536) 1. Exposed direct PUT/DELETE APIs for hubvnet connections. This is the API expected to be used in the future by all consumers (direct rest api calls, powershell, portal, azure cli). This avoids needing a put on the virtual hub every time a hubvnet connection is to be added/changed. 2. Deprecate specifying hubvnet connection in virtualHub PUT. This is to avoid having multiple APIs to do the same thing. Also having this API introduces other complexities and breaks some scenarios. 3. Deprecate allowHubToRemoteVnetTransit and allowRemoteVnetToUseHubVnetGateways flags in hubvnet connection. These flags are maintained internally in the implementation and shouldn't be exposed to the user. For now, just mark it as such. Will be removed in later release. Co-authored-by: Shyam Dharmarajan * Destination FQDNs in FirewallPolicy for network rules. (#9609) * v1 * making boolean as nullable Co-authored-by: Ishani Gupta * VirtualHub : Add Routing State and expose Effective Routes Api (#9385) * Add Routing State and expose Effective Routes Api * updated opId name and added examples * prettier fix done * rename variable to prevent conflict * Updating VpnGateway examples for bgpSettings (#9656) * Updating VpnGateway examples * prettier Co-authored-by: Khushboo Baheti * Application Gateway Private Link Support (#9490) * Application Gateway Private Link Support * Fix comments * Fix comments for including example * Add nvaSku property for NetworkVirtualAppliance (#9682) * code fixes for hubIPAddresses (#9775) * Fix lint errors (#9787) Co-authored-by: naveenchekuri Co-authored-by: dexiang-ms <64503627+dexiang-ms@users.noreply.github.com> Co-authored-by: odedlaz Co-authored-by: Ishani Gupta Co-authored-by: Ishani Gupta Co-authored-by: Zim Kalinowski Co-authored-by: irrogozh Co-authored-by: Sai Sujith Reddy Mankala Co-authored-by: Anchal Kapoor Co-authored-by: shyamshd <64368451+shyamshd@users.noreply.github.com> Co-authored-by: Shyam Dharmarajan Co-authored-by: Ritvika Reddy Nagula Co-authored-by: Khushboo Baheti <37917868+Khushboo-Baheti@users.noreply.github.com> Co-authored-by: Khushboo Baheti Co-authored-by: jaishals --- .azure-pipelines/NetworkValidation.yml | 2 +- .../stable/2020-05-01/applicationGateway.json | 3402 +++++++++ .../2020-05-01/applicationSecurityGroup.json | 406 + .../2020-05-01/availableDelegations.json | 178 + .../2020-05-01/availableServiceAliases.json | 171 + .../stable/2020-05-01/azureFirewall.json | 1085 +++ .../2020-05-01/azureFirewallFqdnTag.json | 130 + .../stable/2020-05-01/bastionHost.json | 869 +++ .../2020-05-01/checkDnsAvailability.json | 96 + .../stable/2020-05-01/ddosCustomPolicy.json | 364 + .../stable/2020-05-01/ddosProtectionPlan.json | 436 ++ .../stable/2020-05-01/endpointService.json | 119 + ...tionGatewayAvailableRequestHeadersGet.json | 13 + ...ionGatewayAvailableResponseHeadersGet.json | 13 + ...ionGatewayAvailableServerVariablesGet.json | 13 + ...licationGatewayAvailableSslOptionsGet.json | 64 + ...ilableSslOptionsPredefinedPoliciesGet.json | 101 + ...vailableSslOptionsPredefinedPolicyGet.json | 48 + ...icationGatewayAvailableWafRuleSetsGet.json | 36 + .../ApplicationGatewayBackendHealthGet.json | 57 + .../ApplicationGatewayBackendHealthTest.json | 45 + .../examples/ApplicationGatewayCreate.json | 771 ++ .../examples/ApplicationGatewayDelete.json | 13 + .../examples/ApplicationGatewayGet.json | 294 + .../examples/ApplicationGatewayList.json | 125 + .../examples/ApplicationGatewayListAll.json | 124 + ...atewayPrivateEndpointConnectionDelete.json | 14 + ...onGatewayPrivateEndpointConnectionGet.json | 29 + ...nGatewayPrivateEndpointConnectionList.json | 32 + ...atewayPrivateEndpointConnectionUpdate.json | 39 + ...icationGatewayPrivateLinkResourceList.json | 28 + .../examples/ApplicationGatewayStart.json | 12 + .../examples/ApplicationGatewayStop.json | 12 + .../ApplicationGatewayUpdateTags.json | 148 + .../ApplicationSecurityGroupCreate.json | 38 + .../ApplicationSecurityGroupDelete.json | 13 + .../examples/ApplicationSecurityGroupGet.json | 22 + .../ApplicationSecurityGroupList.json | 35 + .../ApplicationSecurityGroupListAll.json | 34 + .../ApplicationSecurityGroupUpdateTags.json | 33 + .../AutoApprovedPrivateLinkServicesGet.json | 24 + ...edPrivateLinkServicesResourceGroupGet.json | 25 + .../AvailableDelegationsResourceGroupGet.json | 25 + .../AvailableDelegationsSubscriptionGet.json | 24 + .../AvailablePrivateEndpointTypesGet.json | 20 + ...ePrivateEndpointTypesResourceGroupGet.json | 21 + .../examples/AvailableServiceAliasesList.json | 27 + ...ableServiceAliasesListByResourceGroup.json | 28 + .../examples/AzureFirewallDelete.json | 13 + ...ureFirewallFqdnTagsListBySubscription.json | 28 + .../2020-05-01/examples/AzureFirewallGet.json | 177 + ...reFirewallGetWithAdditionalProperties.json | 179 + .../AzureFirewallGetWithIpGroups.json | 189 + .../AzureFirewallGetWithMgmtSubnet.json | 190 + .../examples/AzureFirewallGetWithZones.json | 181 + .../AzureFirewallListByResourceGroup.json | 193 + .../AzureFirewallListBySubscription.json | 192 + .../2020-05-01/examples/AzureFirewallPut.json | 497 ++ .../examples/AzureFirewallPutInHub.json | 115 + ...reFirewallPutWithAdditionalProperties.json | 507 ++ .../AzureFirewallPutWithIpGroups.json | 505 ++ .../AzureFirewallPutWithMgmtSubnet.json | 507 ++ .../examples/AzureFirewallPutWithZones.json | 509 ++ .../examples/AzureFirewallUpdateTags.json | 33 + .../examples/BastionHostDelete.json | 13 + .../2020-05-01/examples/BastionHostGet.json | 44 + .../BastionHostListByResourceGroup.json | 44 + .../BastionHostListBySubscription.json | 43 + .../2020-05-01/examples/BastionHostPut.json | 89 + .../examples/BastionSessionDelete.json | 36 + .../examples/BastionSessionsList.json | 30 + .../examples/BastionShareableLinkCreate.json | 45 + .../examples/BastionShareableLinkDelete.json | 26 + .../examples/BastionShareableLinkGet.json | 44 + .../examples/CheckDnsNameAvailability.json | 15 + .../CheckPrivateLinkServiceVisibility.json | 17 + ...eLinkServiceVisibilityByResourceGroup.json | 18 + .../examples/DdosCustomPolicyCreate.json | 58 + .../examples/DdosCustomPolicyDelete.json | 16 + .../examples/DdosCustomPolicyGet.json | 27 + .../examples/DdosCustomPolicyUpdateTags.json | 39 + .../examples/DdosProtectionPlanCreate.json | 40 + .../examples/DdosProtectionPlanDelete.json | 13 + .../examples/DdosProtectionPlanGet.json | 27 + .../examples/DdosProtectionPlanList.json | 45 + .../examples/DdosProtectionPlanListAll.json | 47 + .../DdosProtectionPlanUpdateTags.json | 33 + .../examples/DefaultSecurityRuleGet.json | 33 + .../examples/DefaultSecurityRuleList.json | 136 + .../EffectiveRoutesListForConnection.json | 20 + .../EffectiveRoutesListForRouteTable.json | 20 + .../EffectiveRoutesListForVirtualHub.json | 17 + .../examples/EndpointServicesList.json | 30 + .../ExpressRouteCircuitARPTableList.json | 25 + ...xpressRouteCircuitAuthorizationCreate.json | 36 + ...xpressRouteCircuitAuthorizationDelete.json | 14 + .../ExpressRouteCircuitAuthorizationGet.json | 24 + .../ExpressRouteCircuitAuthorizationList.json | 26 + .../ExpressRouteCircuitConnectionCreate.json | 74 + .../ExpressRouteCircuitConnectionDelete.json | 15 + .../ExpressRouteCircuitConnectionGet.json | 36 + .../ExpressRouteCircuitConnectionList.json | 54 + .../examples/ExpressRouteCircuitCreate.json | 84 + ...sRouteCircuitCreateOnExpressRoutePort.json | 79 + .../examples/ExpressRouteCircuitDelete.json | 13 + .../examples/ExpressRouteCircuitGet.json | 38 + ...xpressRouteCircuitListByResourceGroup.json | 91 + ...ExpressRouteCircuitListBySubscription.json | 90 + .../ExpressRouteCircuitPeeringCreate.json | 75 + .../ExpressRouteCircuitPeeringDelete.json | 14 + .../ExpressRouteCircuitPeeringGet.json | 61 + .../ExpressRouteCircuitPeeringList.json | 88 + .../ExpressRouteCircuitPeeringStats.json | 19 + .../ExpressRouteCircuitRouteTableList.json | 26 + ...ressRouteCircuitRouteTableSummaryList.json | 26 + .../examples/ExpressRouteCircuitStats.json | 18 + .../ExpressRouteCircuitUpdateTags.json | 48 + .../ExpressRouteConnectionCreate.json | 102 + .../ExpressRouteConnectionDelete.json | 14 + .../examples/ExpressRouteConnectionGet.json | 51 + .../examples/ExpressRouteConnectionList.json | 54 + ...sRouteCrossConnectionBgpPeeringCreate.json | 75 + ...sRouteCrossConnectionBgpPeeringDelete.json | 14 + ...ressRouteCrossConnectionBgpPeeringGet.json | 37 + ...essRouteCrossConnectionBgpPeeringList.json | 40 + .../ExpressRouteCrossConnectionGet.json | 32 + .../ExpressRouteCrossConnectionList.json | 33 + ...uteCrossConnectionListByResourceGroup.json | 34 + .../ExpressRouteCrossConnectionUpdate.json | 36 + ...ExpressRouteCrossConnectionUpdateTags.json | 41 + .../ExpressRouteCrossConnectionsArpTable.json | 25 + ...xpressRouteCrossConnectionsRouteTable.json | 33 + ...outeCrossConnectionsRouteTableSummary.json | 31 + .../examples/ExpressRouteGatewayCreate.json | 63 + .../examples/ExpressRouteGatewayDelete.json | 13 + .../examples/ExpressRouteGatewayGet.json | 25 + ...xpressRouteGatewayListByResourceGroup.json | 73 + ...ExpressRouteGatewayListBySubscription.json | 72 + .../examples/ExpressRouteLinkGet.json | 26 + .../examples/ExpressRouteLinkList.json | 42 + .../examples/ExpressRoutePortCreate.json | 112 + .../examples/ExpressRoutePortDelete.json | 13 + .../examples/ExpressRoutePortGet.json | 57 + .../examples/ExpressRoutePortList.json | 59 + .../ExpressRoutePortListByResourceGroup.json | 60 + .../examples/ExpressRoutePortUpdateLink.json | 120 + .../examples/ExpressRoutePortUpdateTags.json | 63 + .../ExpressRoutePortsLocationGet.json | 28 + .../ExpressRoutePortsLocationList.json | 26 + .../examples/ExpressRouteProviderList.json | 60 + .../examples/FirewallPolicyDelete.json | 13 + .../examples/FirewallPolicyGet.json | 47 + .../FirewallPolicyListByResourceGroup.json | 42 + .../FirewallPolicyListBySubscription.json | 41 + .../examples/FirewallPolicyPut.json | 114 + ...rewallPolicyRuleCollectionGroupDelete.json | 14 + .../FirewallPolicyRuleCollectionGroupGet.json | 50 + ...FirewallPolicyRuleCollectionGroupList.json | 54 + .../FirewallPolicyRuleCollectionGroupPut.json | 119 + ...icyRuleCollectionGroupWithIpGroupsGet.json | 50 + ...cyRuleCollectionGroupWithIpGroupsList.json | 54 + ...icyRuleCollectionGroupWithIpGroupsPut.json | 119 + ...alWanVpnServerConfigurationVpnProfile.json | 18 + .../GetVirtualWanVpnServerConfigurations.json | 20 + .../examples/HubRouteTableDelete.json | 14 + .../2020-05-01/examples/HubRouteTableGet.json | 47 + .../examples/HubRouteTableList.json | 81 + .../2020-05-01/examples/HubRouteTablePut.json | 104 + .../HubVirtualNetworkConnectionDelete.json | 14 + .../HubVirtualNetworkConnectionGet.json | 67 + .../HubVirtualNetworkConnectionList.json | 123 + .../HubVirtualNetworkConnectionPut.json | 155 + .../examples/InboundNatRuleCreate.json | 66 + .../examples/InboundNatRuleDelete.json | 14 + .../examples/InboundNatRuleGet.json | 32 + .../examples/InboundNatRuleList.json | 54 + .../examples/IpAllocationCreate.json | 52 + .../examples/IpAllocationDelete.json | 13 + .../2020-05-01/examples/IpAllocationGet.json | 26 + .../2020-05-01/examples/IpAllocationList.json | 42 + .../IpAllocationListByResourceGroup.json | 43 + .../examples/IpAllocationUpdateTags.json | 37 + .../2020-05-01/examples/IpGroupsCreate.json | 67 + .../2020-05-01/examples/IpGroupsDelete.json | 13 + .../2020-05-01/examples/IpGroupsGet.json | 32 + .../examples/IpGroupsListByResourceGroup.json | 55 + .../examples/IpGroupsListBySubscription.json | 54 + .../examples/IpGroupsUpdateTags.json | 42 + ...sPoolListWithBackendAddressesPoolType.json | 50 + ...endAddressPoolWithBackendAddressesGet.json | 47 + ...endAddressPoolWithBackendAddressesPut.json | 107 + ...endAddressesPutWithNICIPConfiguration.json | 91 + .../LoadBalancerBackendAddressPoolDelete.json | 14 + .../LoadBalancerBackendAddressPoolGet.json | 32 + .../LoadBalancerBackendAddressPoolList.json | 35 + .../examples/LoadBalancerCreate.json | 339 + .../LoadBalancerCreateStandardSku.json | 339 + .../LoadBalancerCreateWithInboundNatPool.json | 180 + .../LoadBalancerCreateWithOutboundRules.json | 423 ++ .../examples/LoadBalancerCreateWithZones.json | 348 + .../examples/LoadBalancerDelete.json | 13 + ...oadBalancerFrontendIPConfigurationGet.json | 38 + ...adBalancerFrontendIPConfigurationList.json | 41 + .../2020-05-01/examples/LoadBalancerGet.json | 139 + .../2020-05-01/examples/LoadBalancerList.json | 161 + .../examples/LoadBalancerListAll.json | 160 + .../LoadBalancerLoadBalancingRuleGet.json | 38 + .../LoadBalancerLoadBalancingRuleList.json | 41 + ...oadBalancerNetworkInterfaceListSimple.json | 59 + .../LoadBalancerNetworkInterfaceListVmss.json | 112 + .../examples/LoadBalancerOutboundRuleGet.json | 34 + .../LoadBalancerOutboundRuleList.json | 37 + .../examples/LoadBalancerProbeGet.json | 32 + .../examples/LoadBalancerProbeList.json | 35 + .../examples/LoadBalancerUpdateTags.json | 132 + .../examples/LocalNetworkGatewayCreate.json | 60 + .../examples/LocalNetworkGatewayDelete.json | 13 + .../examples/LocalNetworkGatewayGet.json | 29 + .../examples/LocalNetworkGatewayList.json | 49 + .../LocalNetworkGatewayUpdateTags.json | 38 + .../examples/NatGatewayCreateOrUpdate.json | 118 + .../2020-05-01/examples/NatGatewayDelete.json | 13 + .../2020-05-01/examples/NatGatewayGet.json | 40 + .../2020-05-01/examples/NatGatewayList.json | 71 + .../examples/NatGatewayListAll.json | 70 + .../examples/NatGatewayUpdateTags.json | 50 + .../examples/NetworkInterfaceCreate.json | 101 + .../examples/NetworkInterfaceDelete.json | 13 + .../NetworkInterfaceEffectiveNSGList.json | 71 + ...tworkInterfaceEffectiveRouteTableList.json | 71 + .../examples/NetworkInterfaceGet.json | 55 + .../NetworkInterfaceIPConfigurationGet.json | 45 + .../NetworkInterfaceIPConfigurationList.json | 31 + .../examples/NetworkInterfaceList.json | 92 + .../examples/NetworkInterfaceListAll.json | 91 + .../NetworkInterfaceLoadBalancerList.json | 139 + ...etworkInterfaceTapConfigurationCreate.json | 46 + ...etworkInterfaceTapConfigurationDelete.json | 14 + .../NetworkInterfaceTapConfigurationGet.json | 25 + .../NetworkInterfaceTapConfigurationList.json | 28 + .../examples/NetworkInterfaceUpdateTags.json | 56 + .../NetworkProfileCreateConfigOnly.json | 110 + .../examples/NetworkProfileDelete.json | 13 + .../examples/NetworkProfileGetConfigOnly.json | 84 + .../NetworkProfileGetWithContainerNic.json | 203 + .../examples/NetworkProfileList.json | 97 + .../examples/NetworkProfileListAll.json | 84 + .../examples/NetworkProfileUpdateTags.json | 58 + .../examples/NetworkSecurityGroupCreate.json | 233 + .../NetworkSecurityGroupCreateWithRule.json | 282 + .../examples/NetworkSecurityGroupDelete.json | 13 + .../examples/NetworkSecurityGroupGet.json | 136 + .../examples/NetworkSecurityGroupList.json | 231 + .../examples/NetworkSecurityGroupListAll.json | 230 + .../NetworkSecurityGroupRuleCreate.json | 57 + .../NetworkSecurityGroupRuleDelete.json | 14 + .../examples/NetworkSecurityGroupRuleGet.json | 28 + .../NetworkSecurityGroupRuleList.json | 31 + .../NetworkSecurityGroupUpdateTags.json | 130 + .../NetworkVirtualApplianceDelete.json | 13 + .../examples/NetworkVirtualApplianceGet.json | 62 + ...rkVirtualApplianceListByResourceGroup.json | 65 + ...orkVirtualApplianceListBySubscription.json | 64 + .../examples/NetworkVirtualAppliancePut.json | 143 + .../NetworkVirtualApplianceSiteDelete.json | 14 + .../NetworkVirtualApplianceSiteGet.json | 29 + .../NetworkVirtualApplianceSiteList.json | 33 + .../NetworkVirtualApplianceSitePut.json | 59 + .../NetworkVirtualApplianceSkuGet.json | 34 + .../NetworkVirtualApplianceSkuList.json | 36 + .../NetworkVirtualApplianceUpdateTags.json | 69 + ...tworkWatcherAvailableProvidersListGet.json | 68 + ...workWatcherAzureReachabilityReportGet.json | 82 + ...NetworkWatcherConnectionMonitorCreate.json | 70 + ...NetworkWatcherConnectionMonitorDelete.json | 13 + .../NetworkWatcherConnectionMonitorGet.json | 35 + .../NetworkWatcherConnectionMonitorList.json | 60 + .../NetworkWatcherConnectionMonitorQuery.json | 77 + .../NetworkWatcherConnectionMonitorStart.json | 13 + .../NetworkWatcherConnectionMonitorStop.json | 13 + ...orkWatcherConnectionMonitorUpdateTags.json | 45 + ...tworkWatcherConnectionMonitorV2Create.json | 206 + .../NetworkWatcherConnectivityCheck.json | 80 + .../examples/NetworkWatcherCreate.json | 40 + .../examples/NetworkWatcherDelete.json | 12 + .../NetworkWatcherFlowLogConfigure.json | 35 + .../examples/NetworkWatcherFlowLogCreate.json | 73 + .../examples/NetworkWatcherFlowLogDelete.json | 13 + .../examples/NetworkWatcherFlowLogGet.json | 43 + .../examples/NetworkWatcherFlowLogList.json | 69 + .../NetworkWatcherFlowLogStatusQuery.json | 31 + .../examples/NetworkWatcherGet.json | 23 + .../examples/NetworkWatcherIpFlowVerify.json | 31 + .../examples/NetworkWatcherList.json | 37 + .../examples/NetworkWatcherListAll.json | 36 + ...WatcherNetworkConfigurationDiagnostic.json | 198 + .../examples/NetworkWatcherNextHopGet.json | 30 + .../NetworkWatcherPacketCaptureCreate.json | 56 + .../NetworkWatcherPacketCaptureDelete.json | 13 + .../NetworkWatcherPacketCaptureGet.json | 37 + ...etworkWatcherPacketCaptureQueryStatus.json | 31 + .../NetworkWatcherPacketCaptureStop.json | 13 + .../NetworkWatcherPacketCapturesList.json | 58 + .../NetworkWatcherSecurityGroupViewGet.json | 141 + .../examples/NetworkWatcherTopologyGet.json | 39 + .../NetworkWatcherTroubleshootGet.json | 71 + ...NetworkWatcherTroubleshootResultQuery.json | 67 + .../examples/NetworkWatcherUpdateTags.json | 32 + .../2020-05-01/examples/OperationList.json | 137 + .../examples/P2SVpnGatewayDelete.json | 13 + .../P2SVpnGatewayGenerateVpnProfile.json | 17 + .../2020-05-01/examples/P2SVpnGatewayGet.json | 56 + .../P2SVpnGatewayGetConnectionHealth.json | 57 + ...VpnGatewayGetConnectionHealthDetailed.json | 21 + .../examples/P2SVpnGatewayList.json | 103 + .../P2SVpnGatewayListByResourceGroup.json | 99 + .../2020-05-01/examples/P2SVpnGatewayPut.json | 130 + .../examples/P2SVpnGatewayUpdateTags.json | 64 + ...pnGatewaysDisconnectP2sVpnConnections.json | 18 + .../PeerExpressRouteCircuitConnectionGet.json | 32 + ...PeerExpressRouteCircuitConnectionList.json | 53 + .../examples/PrivateEndpointCreate.json | 126 + ...rivateEndpointCreateForManualApproval.json | 126 + .../examples/PrivateEndpointDelete.json | 13 + .../PrivateEndpointDnsZoneGroupCreate.json | 90 + .../PrivateEndpointDnsZoneGroupDelete.json | 14 + .../PrivateEndpointDnsZoneGroupGet.json | 68 + .../PrivateEndpointDnsZoneGroupList.json | 80 + .../examples/PrivateEndpointGet.json | 60 + .../PrivateEndpointGetForManualApproval.json | 60 + .../examples/PrivateEndpointList.json | 111 + .../examples/PrivateEndpointListAll.json | 156 + .../examples/PrivateLinkServiceCreate.json | 155 + .../examples/PrivateLinkServiceDelete.json | 13 + ...erviceDeletePrivateEndpointConnection.json | 14 + .../examples/PrivateLinkServiceGet.json | 77 + ...nkServiceGetPrivateEndpointConnection.json | 25 + .../examples/PrivateLinkServiceList.json | 141 + .../examples/PrivateLinkServiceListAll.json | 142 + ...kServiceListPrivateEndpointConnection.json | 40 + ...erviceUpdatePrivateEndpointConnection.json | 37 + ...PublicIpAddressCreateCustomizedValues.json | 70 + .../PublicIpAddressCreateDefaults.json | 53 + .../examples/PublicIpAddressCreateDns.json | 60 + .../examples/PublicIpAddressDelete.json | 13 + .../examples/PublicIpAddressGet.json | 37 + .../examples/PublicIpAddressList.json | 60 + .../examples/PublicIpAddressListAll.json | 49 + .../examples/PublicIpAddressUpdateTags.json | 37 + .../PublicIpPrefixCreateCustomizedValues.json | 69 + .../PublicIpPrefixCreateDefaults.json | 59 + .../examples/PublicIpPrefixDelete.json | 13 + .../examples/PublicIpPrefixGet.json | 35 + .../examples/PublicIpPrefixList.json | 56 + .../examples/PublicIpPrefixListAll.json | 76 + .../examples/PublicIpPrefixUpdateTags.json | 40 + .../examples/RouteFilterCreate.json | 95 + .../examples/RouteFilterDelete.json | 13 + .../2020-05-01/examples/RouteFilterGet.json | 42 + .../2020-05-01/examples/RouteFilterList.json | 44 + .../RouteFilterListByResourceGroup.json | 45 + .../examples/RouteFilterRuleCreate.json | 53 + .../examples/RouteFilterRuleDelete.json | 14 + .../examples/RouteFilterRuleGet.json | 27 + .../RouteFilterRuleListByRouteFilter.json | 30 + .../examples/RouteFilterUpdateTags.json | 46 + .../2020-05-01/examples/RouteTableCreate.json | 39 + .../examples/RouteTableCreateWithRoute.json | 70 + .../2020-05-01/examples/RouteTableDelete.json | 13 + .../2020-05-01/examples/RouteTableGet.json | 33 + .../2020-05-01/examples/RouteTableList.json | 47 + .../examples/RouteTableListAll.json | 44 + .../examples/RouteTableRouteCreate.json | 39 + .../examples/RouteTableRouteDelete.json | 14 + .../examples/RouteTableRouteGet.json | 22 + .../examples/RouteTableRouteList.json | 34 + .../examples/RouteTableUpdateTags.json | 32 + .../SecurityPartnerProviderDelete.json | 13 + .../examples/SecurityPartnerProviderGet.json | 30 + ...ityPartnerProviderListByResourceGroup.json | 33 + ...rityPartnerProviderListBySubscription.json | 32 + .../examples/SecurityPartnerProviderPut.json | 60 + .../SecurityPartnerProviderUpdateTags.json | 32 + .../examples/ServiceCommunityList.json | 56 + .../examples/ServiceEndpointPolicyCreate.json | 41 + ...iceEndpointPolicyCreateWithDefinition.json | 83 + ...ServiceEndpointPolicyDefinitionCreate.json | 52 + ...ServiceEndpointPolicyDefinitionDelete.json | 14 + .../ServiceEndpointPolicyDefinitionGet.json | 26 + .../ServiceEndpointPolicyDefinitionList.json | 29 + .../examples/ServiceEndpointPolicyDelete.json | 13 + .../examples/ServiceEndpointPolicyGet.json | 37 + .../examples/ServiceEndpointPolicyList.json | 63 + .../ServiceEndpointPolicyListAll.json | 64 + .../ServiceEndpointPolicyUpdateTags.json | 47 + .../2020-05-01/examples/ServiceTagsList.json | 88 + .../2020-05-01/examples/SubnetCreate.json | 36 + .../examples/SubnetCreateServiceEndpoint.json | 61 + .../examples/SubnetCreateWithDelegation.json | 60 + .../2020-05-01/examples/SubnetDelete.json | 14 + .../stable/2020-05-01/examples/SubnetGet.json | 21 + .../examples/SubnetGetWithDelegation.json | 33 + .../2020-05-01/examples/SubnetList.json | 32 + .../SubnetPrepareNetworkPolicies.json | 16 + .../SubnetUnprepareNetworkPolicies.json | 16 + .../stable/2020-05-01/examples/UsageList.json | 265 + .../examples/UsageListSpacedLocation.json | 335 + .../VirtualHubBgpConnectionDelete.json | 14 + .../examples/VirtualHubBgpConnectionGet.json | 24 + .../examples/VirtualHubBgpConnectionList.json | 27 + .../examples/VirtualHubBgpConnectionPut.json | 43 + .../2020-05-01/examples/VirtualHubDelete.json | 13 + .../2020-05-01/examples/VirtualHubGet.json | 34 + .../VirtualHubIpConfigurationDelete.json | 14 + .../VirtualHubIpConfigurationGet.json | 25 + .../VirtualHubIpConfigurationList.json | 28 + .../VirtualHubIpConfigurationPut.json | 46 + .../2020-05-01/examples/VirtualHubList.json | 128 + .../VirtualHubListByResourceGroup.json | 129 + .../2020-05-01/examples/VirtualHubPut.json | 71 + .../VirtualHubRouteTableV2Delete.json | 14 + .../examples/VirtualHubRouteTableV2Get.json | 47 + .../examples/VirtualHubRouteTableV2List.json | 72 + .../examples/VirtualHubRouteTableV2Put.json | 113 + .../examples/VirtualHubUpdateTags.json | 43 + ...tualNetworkCheckIPAddressAvailability.json | 23 + .../examples/VirtualNetworkCreate.json | 56 + ...ualNetworkCreateServiceEndpointPolicy.json | 126 + .../VirtualNetworkCreateServiceEndpoints.json | 111 + .../examples/VirtualNetworkCreateSubnet.json | 82 + ...etworkCreateSubnetWithAddressPrefixes.json | 91 + ...tualNetworkCreateSubnetWithDelegation.json | 114 + ...irtualNetworkCreateWithBgpCommunities.json | 93 + .../examples/VirtualNetworkDelete.json | 13 + ...VirtualNetworkGatewayConnectionCreate.json | 136 + ...VirtualNetworkGatewayConnectionDelete.json | 13 + .../VirtualNetworkGatewayConnectionGet.json | 44 + ...lNetworkGatewayConnectionGetSharedKey.json | 15 + ...etworkGatewayConnectionResetSharedKey.json | 19 + ...lNetworkGatewayConnectionSetSharedKey.json | 23 + ...rkGatewayConnectionStartPacketCapture.json | 14 + ...onnectionStartPacketCaptureFilterData.json | 17 + ...orkGatewayConnectionStopPacketCapture.json | 17 + ...ualNetworkGatewayConnectionUpdateTags.json | 51 + .../VirtualNetworkGatewayConnectionsList.json | 75 + .../examples/VirtualNetworkGatewayDelete.json | 13 + ...etworkGatewayGenerateVpnClientPackage.json | 15 + ...rtualNetworkGatewayGenerateVpnProfile.json | 15 + .../examples/VirtualNetworkGatewayGet.json | 88 + ...tualNetworkGatewayGetAdvertisedRoutes.json | 15 + ...VirtualNetworkGatewayGetBGPPeerStatus.json | 14 + ...orkGatewayGetVpnClientIpsecParameters.json | 22 + ...NetworkGatewayGetVpnProfilePackageUrl.json | 14 + ...rkGatewayGetVpnclientConnectionHealth.json | 45 + .../VirtualNetworkGatewayLearnedRoutes.json | 14 + .../examples/VirtualNetworkGatewayList.json | 132 + .../examples/VirtualNetworkGatewayReset.json | 74 + ...NetworkGatewayResetVpnClientSharedKey.json | 12 + ...orkGatewaySetVpnClientIpsecParameters.json | 24 + ...rtualNetworkGatewayStartPacketCapture.json | 14 + ...rkGatewayStartPacketCaptureFilterData.json | 17 + ...irtualNetworkGatewayStopPacketCapture.json | 17 + ...rtualNetworkGatewaySupportedVpnDevice.json | 13 + .../examples/VirtualNetworkGatewayUpdate.json | 220 + .../VirtualNetworkGatewayUpdateTags.json | 83 + ...rkGatewayVpnDeviceConfigurationScript.json | 18 + ...rkGatewaysDisconnectP2sVpnConnections.json | 18 + ...VirtualNetworkGatewaysListConnections.json | 41 + .../examples/VirtualNetworkGet.json | 42 + ...tualNetworkGetResourceNavigationLinks.json | 28 + ...tualNetworkGetServiceAssociationLinks.json | 31 + ...lNetworkGetWithServiceAssociationLink.json | 69 + ...VirtualNetworkGetWithSubnetDelegation.json | 54 + .../examples/VirtualNetworkList.json | 64 + .../examples/VirtualNetworkListAll.json | 63 + .../examples/VirtualNetworkListUsage.json | 36 + .../examples/VirtualNetworkPeeringCreate.json | 66 + .../examples/VirtualNetworkPeeringDelete.json | 14 + .../examples/VirtualNetworkPeeringGet.json | 33 + .../examples/VirtualNetworkPeeringList.json | 56 + .../examples/VirtualNetworkTapCreate.json | 62 + .../examples/VirtualNetworkTapDelete.json | 13 + .../examples/VirtualNetworkTapGet.json | 32 + .../examples/VirtualNetworkTapList.json | 55 + .../examples/VirtualNetworkTapListAll.json | 54 + .../examples/VirtualNetworkTapUpdateTags.json | 40 + .../examples/VirtualNetworkUpdateTags.json | 39 + .../examples/VirtualRouterDelete.json | 13 + .../2020-05-01/examples/VirtualRouterGet.json | 38 + .../VirtualRouterListByResourceGroup.json | 41 + .../VirtualRouterListBySubscription.json | 40 + .../examples/VirtualRouterPeeringDelete.json | 14 + .../examples/VirtualRouterPeeringGet.json | 23 + .../examples/VirtualRouterPeeringList.json | 26 + .../examples/VirtualRouterPeeringPut.json | 41 + .../2020-05-01/examples/VirtualRouterPut.json | 77 + .../2020-05-01/examples/VirtualWANDelete.json | 13 + .../2020-05-01/examples/VirtualWANGet.json | 35 + .../2020-05-01/examples/VirtualWANList.json | 60 + .../VirtualWANListByResourceGroup.json | 61 + .../2020-05-01/examples/VirtualWANPut.json | 70 + .../examples/VirtualWANUpdateTags.json | 42 + .../VirtualWanSupportedSecurityProviders.json | 22 + .../examples/VmssNetworkInterfaceGet.json | 65 + .../VmssNetworkInterfaceIpConfigGet.json | 39 + .../VmssNetworkInterfaceIpConfigList.json | 42 + .../examples/VmssNetworkInterfaceList.json | 118 + .../2020-05-01/examples/VmssPublicIpGet.json | 34 + .../examples/VmssPublicIpListAll.json | 52 + .../examples/VmssVmNetworkInterfaceList.json | 68 + .../examples/VmssVmPublicIpList.json | 37 + .../examples/VpnConnectionDelete.json | 14 + .../2020-05-01/examples/VpnConnectionGet.json | 100 + .../examples/VpnConnectionList.json | 101 + .../2020-05-01/examples/VpnConnectionPut.json | 162 + .../2020-05-01/examples/VpnGatewayDelete.json | 13 + .../2020-05-01/examples/VpnGatewayGet.json | 145 + .../2020-05-01/examples/VpnGatewayList.json | 239 + .../VpnGatewayListByResourceGroup.json | 239 + .../2020-05-01/examples/VpnGatewayPut.json | 286 + .../2020-05-01/examples/VpnGatewayReset.json | 104 + .../examples/VpnGatewayUpdateTags.json | 111 + .../VpnServerConfigurationDelete.json | 13 + .../examples/VpnServerConfigurationGet.json | 73 + .../examples/VpnServerConfigurationList.json | 132 + ...erverConfigurationListByResourceGroup.json | 129 + .../examples/VpnServerConfigurationPut.json | 190 + .../VpnServerConfigurationUpdateTags.json | 73 + .../2020-05-01/examples/VpnSiteDelete.json | 13 + .../2020-05-01/examples/VpnSiteGet.json | 57 + .../examples/VpnSiteLinkConnectionGet.json | 37 + .../examples/VpnSiteLinkConnectionList.json | 38 + .../2020-05-01/examples/VpnSiteLinkGet.json | 30 + .../examples/VpnSiteLinkListByVpnSite.json | 50 + .../2020-05-01/examples/VpnSiteList.json | 88 + .../examples/VpnSiteListByResourceGroup.json | 88 + .../2020-05-01/examples/VpnSitePut.json | 137 + .../examples/VpnSiteUpdateTags.json | 48 + .../VpnSitesConfigurationDownload.json | 22 + .../examples/WafListAllPolicies.json | 102 + .../2020-05-01/examples/WafListPolicies.json | 103 + .../examples/WafPolicyCreateOrUpdate.json | 258 + .../2020-05-01/examples/WafPolicyDelete.json | 13 + .../2020-05-01/examples/WafPolicyGet.json | 140 + .../2020-05-01/expressRouteCircuit.json | 2507 +++++++ .../expressRouteCrossConnection.json | 1006 +++ .../stable/2020-05-01/expressRoutePort.json | 869 +++ .../stable/2020-05-01/firewallPolicy.json | 1224 +++ .../stable/2020-05-01/ipAllocation.json | 454 ++ .../stable/2020-05-01/ipGroups.json | 422 ++ .../stable/2020-05-01/loadBalancer.json | 2242 ++++++ .../stable/2020-05-01/natGateway.json | 472 ++ .../stable/2020-05-01/network.json | 335 + .../stable/2020-05-01/networkInterface.json | 1522 ++++ .../stable/2020-05-01/networkProfile.json | 622 ++ .../2020-05-01/networkSecurityGroup.json | 982 +++ .../2020-05-01/networkVirtualAppliance.json | 1009 +++ .../stable/2020-05-01/networkWatcher.json | 4534 +++++++++++ .../stable/2020-05-01/operation.json | 271 + .../stable/2020-05-01/privateEndpoint.json | 963 +++ .../stable/2020-05-01/privateLinkService.json | 1068 +++ .../stable/2020-05-01/publicIpAddress.json | 545 ++ .../stable/2020-05-01/publicIpPrefix.json | 485 ++ .../stable/2020-05-01/routeFilter.json | 822 ++ .../stable/2020-05-01/routeTable.json | 755 ++ .../2020-05-01/securityPartnerProvider.json | 441 ++ .../stable/2020-05-01/serviceCommunity.json | 158 + .../2020-05-01/serviceEndpointPolicy.json | 742 ++ .../stable/2020-05-01/serviceTags.json | 166 + .../stable/2020-05-01/usage.json | 160 + .../stable/2020-05-01/virtualNetwork.json | 1965 +++++ .../2020-05-01/virtualNetworkGateway.json | 3717 +++++++++ .../stable/2020-05-01/virtualNetworkTap.json | 426 ++ .../stable/2020-05-01/virtualRouter.json | 698 ++ .../stable/2020-05-01/virtualWan.json | 6647 +++++++++++++++++ .../2020-05-01/vmssNetworkInterface.json | 374 + .../2020-05-01/vmssPublicIpAddress.json | 241 + .../2020-05-01/webapplicationfirewall.json | 743 ++ .../network/resource-manager/readme.md | 57 +- 579 files changed, 81970 insertions(+), 3 deletions(-) create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/applicationGateway.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/applicationSecurityGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/availableDelegations.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/availableServiceAliases.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/azureFirewall.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/azureFirewallFqdnTag.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/bastionHost.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/checkDnsAvailability.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ddosCustomPolicy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ddosProtectionPlan.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/endpointService.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableServerVariablesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayBackendHealthGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayBackendHealthTest.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateLinkResourceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayStart.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayStop.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AutoApprovedPrivateLinkServicesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableDelegationsResourceGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableDelegationsSubscriptionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailablePrivateEndpointTypesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableServiceAliasesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableServiceAliasesListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallFqdnTagsListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithAdditionalProperties.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithIpGroups.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithMgmtSubnet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithZones.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutInHub.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithAdditionalProperties.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithIpGroups.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithMgmtSubnet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithZones.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionSessionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionSessionsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckDnsNameAvailability.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibility.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DefaultSecurityRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DefaultSecurityRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForRouteTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForVirtualHub.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EndpointServicesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitARPTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringStats.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitRouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitRouteTableSummaryList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitStats.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsArpTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsRouteTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteLinkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteLinkList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortUpdateLink.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortsLocationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortsLocationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteProviderList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/GetVirtualWanVpnServerConfigurations.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTablePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateStandardSku.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithInboundNatPool.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithOutboundRules.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithZones.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerFrontendIPConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerFrontendIPConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerLoadBalancingRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerLoadBalancingRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerNetworkInterfaceListSimple.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerNetworkInterfaceListVmss.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerOutboundRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerOutboundRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerProbeGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerProbeList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayCreateOrUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceEffectiveNSGList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceEffectiveRouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceIPConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceIPConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceLoadBalancerList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileCreateConfigOnly.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileGetConfigOnly.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileGetWithContainerNic.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupCreateWithRule.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualAppliancePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSitePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSkuGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSkuList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherAvailableProvidersListGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherAzureReachabilityReportGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorQuery.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorStart.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorStop.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorV2Create.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectivityCheck.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogConfigure.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogStatusQuery.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherIpFlowVerify.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherNextHopGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureQueryStatus.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureStop.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCapturesList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherSecurityGroupViewGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTopologyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTroubleshootGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTroubleshootResultQuery.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/OperationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGenerateVpnProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGetConnectionHealth.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PeerExpressRouteCircuitConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PeerExpressRouteCircuitConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointCreateForManualApproval.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointGetForManualApproval.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateCustomizedValues.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateDefaults.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateDns.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixCreateCustomizedValues.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixCreateDefaults.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleListByRouteFilter.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableCreateWithRoute.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceCommunityList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyCreateWithDefinition.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceTagsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreateServiceEndpoint.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreateWithDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetGetWithDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetPrepareNetworkPolicies.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetUnprepareNetworkPolicies.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/UsageList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/UsageListSpacedLocation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Delete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Get.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2List.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Put.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCheckIPAddressAvailability.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateServiceEndpoints.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnetWithDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateWithBgpCommunities.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionsList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayLearnedRoutes.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayReset.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStartPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStopPacketCapture.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaysListConnections.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetResourceNavigationLinks.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetServiceAssociationLinks.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetWithServiceAssociationLink.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetWithSubnetDelegation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkListUsage.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapCreate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterListBySubscription.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWanSupportedSecurityProviders.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceIpConfigGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceIpConfigList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssPublicIpGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssPublicIpListAll.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssVmNetworkInterfaceList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssVmPublicIpList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayReset.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationPut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkConnectionGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkConnectionList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkListByVpnSite.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteList.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteListByResourceGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSitePut.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteUpdateTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSitesConfigurationDownload.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRouteCircuit.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRouteCrossConnection.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRoutePort.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/firewallPolicy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ipAllocation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ipGroups.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/natGateway.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/network.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkInterface.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkProfile.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkSecurityGroup.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkVirtualAppliance.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkWatcher.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/operation.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateEndpoint.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateLinkService.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpAddress.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpPrefix.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/routeFilter.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/routeTable.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/securityPartnerProvider.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceCommunity.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceEndpointPolicy.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceTags.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/usage.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetwork.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetworkGateway.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetworkTap.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualRouter.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualWan.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/vmssPublicIpAddress.json create mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json diff --git a/.azure-pipelines/NetworkValidation.yml b/.azure-pipelines/NetworkValidation.yml index 17784464b8c9..8b3ed7dd40c0 100644 --- a/.azure-pipelines/NetworkValidation.yml +++ b/.azure-pipelines/NetworkValidation.yml @@ -18,7 +18,7 @@ jobs: displayName: Install Node.js - script: npm install autorest -g displayName: Install autorest - - script: git clone --depth 1 -- https://dev.azure.com/v-anevse/BuildScripts/_git/BuildScripts ..\BuildScripts + - script: git clone --depth 1 -- https://dev.azure.com/nrp-swagger/swagger-stack/_git/automation-scripts ..\BuildScripts displayName: Clone build tools - powershell: | $swgrPath = (Get-Item ".\").FullName diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/applicationGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/applicationGateway.json new file mode 100644 index 000000000000..0294f1d0ead6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/applicationGateway.json @@ -0,0 +1,3402 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}": { + "delete": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Delete", + "x-ms-examples": { + "Delete ApplicationGateway": { + "$ref": "./examples/ApplicationGatewayDelete.json" + } + }, + "description": "Deletes the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Get", + "x-ms-examples": { + "Get ApplicationGateway": { + "$ref": "./examples/ApplicationGatewayGet.json" + } + }, + "description": "Gets the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_CreateOrUpdate", + "description": "Creates or updates the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGateway" + }, + "description": "Parameters supplied to the create or update application gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Application Gateway": { + "$ref": "./examples/ApplicationGatewayCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_UpdateTags", + "x-ms-examples": { + "Update Application Gateway tags": { + "$ref": "./examples/ApplicationGatewayUpdateTags.json" + } + }, + "description": "Updates the specified application gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update application gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ApplicationGateway resource.", + "schema": { + "$ref": "#/definitions/ApplicationGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_List", + "x-ms-examples": { + "Lists all application gateways in a resource group": { + "$ref": "./examples/ApplicationGatewayList.json" + } + }, + "description": "Lists all application gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of ApplicationGateway resources.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGateways": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAll", + "x-ms-examples": { + "Lists all application gateways in a subscription": { + "$ref": "./examples/ApplicationGatewayListAll.json" + } + }, + "description": "Gets all the application gateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of ApplicationGateway resources.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/start": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Start", + "x-ms-examples": { + "Start Application Gateway": { + "$ref": "./examples/ApplicationGatewayStart.json" + } + }, + "description": "Starts the specified application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation starts the ApplicationGateway resource." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/stop": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_Stop", + "x-ms-examples": { + "Stop Application Gateway": { + "$ref": "./examples/ApplicationGatewayStop.json" + } + }, + "description": "Stops the specified application gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the ApplicationGateway resource." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/backendhealth": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_BackendHealth", + "description": "Gets the backend health of the specified application gateway in a resource group.", + "x-ms-examples": { + "Get Backend Health": { + "$ref": "./examples/ApplicationGatewayBackendHealthGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health." + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayBackendHealth" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/getBackendHealthOnDemand": { + "post": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_BackendHealthOnDemand", + "description": "Gets the backend health for given combination of backend pool and http setting of the specified application gateway in a resource group.", + "x-ms-examples": { + "Test Backend Health": { + "$ref": "./examples/ApplicationGatewayBackendHealthTest.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands BackendAddressPool and BackendHttpSettings referenced in backend health." + }, + { + "name": "probeRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGatewayOnDemandProbe" + }, + "description": "Request body for on-demand test probe operation." + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthOnDemand" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateLinkResources": { + "get": { + "tags": [ + "ApplicationGatewayPrivateLinkResources" + ], + "operationId": "ApplicationGatewayPrivateLinkResources_List", + "x-ms-examples": { + "Lists all private link resources on application gateway": { + "$ref": "./examples/ApplicationGatewayPrivateLinkResourceList.json" + } + }, + "description": "Lists all private link resources on an application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of private link resources on application gateway.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections/{connectionName}": { + "delete": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_Delete", + "x-ms-examples": { + "Delete Application Gateway Private Endpoint Connection": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionDelete.json" + } + }, + "description": "Deletes the specified private endpoint connection on application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway private endpoint connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "put": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_Update", + "description": "Updates the specified private endpoint connection on application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + }, + "description": "Parameters supplied to update application gateway private endpoint connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting private endpoint connection on application gateway.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Application Gateway Private Endpoint Connection": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection on application gateway.", + "x-ms-examples": { + "Get Application Gateway Private Endpoint Connection": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway private endpoint connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an application gateway private endpoint connection.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationGateways/{applicationGatewayName}/privateEndpointConnections": { + "get": { + "tags": [ + "ApplicationGatewayPrivateEndpointConnections" + ], + "operationId": "ApplicationGatewayPrivateEndpointConnections_List", + "x-ms-examples": { + "Lists all private endpoint connections on application gateway": { + "$ref": "./examples/ApplicationGatewayPrivateEndpointConnectionList.json" + } + }, + "description": "Lists all private endpoint connections on an application gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of private endpoint connections on application gateway.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableServerVariables": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableServerVariables", + "x-ms-examples": { + "Get Available Server Variables": { + "$ref": "./examples/ApplicationGatewayAvailableServerVariablesGet.json" + } + }, + "description": "Lists all available server variables.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available server variables.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableServerVariablesResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableRequestHeaders": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableRequestHeaders", + "x-ms-examples": { + "Get Available Request Headers": { + "$ref": "./examples/ApplicationGatewayAvailableRequestHeadersGet.json" + } + }, + "description": "Lists all available request headers.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available request headers.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableRequestHeadersResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableResponseHeaders": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableResponseHeaders", + "x-ms-examples": { + "Get Available Response Headers": { + "$ref": "./examples/ApplicationGatewayAvailableResponseHeadersGet.json" + } + }, + "description": "Lists all available response headers.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available response headers.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableResponseHeadersResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableWafRuleSets", + "x-ms-examples": { + "Get Available Waf Rule Sets": { + "$ref": "./examples/ApplicationGatewayAvailableWafRuleSetsGet.json" + } + }, + "description": "Lists all available web application firewall rule sets.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of all available web application firewall rule sets.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableWafRuleSetsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableSslOptions", + "x-ms-examples": { + "Get Available Ssl Options": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsGet.json" + } + }, + "description": "Lists available Ssl options for configuring Ssl policy.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns all available Ssl options for configuring Ssl policy.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptions" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_ListAvailableSslPredefinedPolicies", + "x-ms-examples": { + "Get Available Ssl Predefined Policies": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "description": "Lists all SSL predefined policies for configuring Ssl policy.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a lists of all Ssl predefined policies for configuring Ssl policy.", + "schema": { + "$ref": "#/definitions/ApplicationGatewayAvailableSslPredefinedPolicies" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationGatewayAvailableSslOptions/default/predefinedPolicies/{predefinedPolicyName}": { + "get": { + "tags": [ + "ApplicationGateways" + ], + "operationId": "ApplicationGateways_GetSslPredefinedPolicy", + "x-ms-examples": { + "Get Available Ssl Predefined Policy by name": { + "$ref": "./examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json" + } + }, + "description": "Gets Ssl predefined policy with the specified policy name.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "predefinedPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of Ssl predefined policy." + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a Ssl predefined policy with the specified policy name.", + "schema": { + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ApplicationGatewayOnDemandProbe": { + "properties": { + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used for the probe." + }, + "host": { + "type": "string", + "description": "Host name to send the probe to." + }, + "path": { + "type": "string", + "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds." + }, + "pickHostNameFromBackendHttpSettings": { + "type": "boolean", + "description": "Whether the host header should be picked from the backend http settings. Default value is false." + }, + "match": { + "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", + "description": "Criterion for classifying a healthy probe response." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to backend pool of application gateway to which probe request will be sent." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to backend http setting of application gateway to be used for test probe." + } + }, + "description": "Details of on demand test probe request." + }, + "ApplicationGatewayBackendHealthOnDemand": { + "properties": { + "backendAddressPool": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", + "description": "Reference to an ApplicationGatewayBackendAddressPool resource." + }, + "backendHealthHttpSettings": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings", + "description": "Application gateway BackendHealthHttp settings." + } + }, + "description": "Result of on demand test probe." + }, + "ApplicationGatewayBackendHealth": { + "properties": { + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthPool" + }, + "description": "A list of ApplicationGatewayBackendHealthPool resources." + } + }, + "description": "Response for ApplicationGatewayBackendHealth API service call." + }, + "ApplicationGatewayBackendHealthPool": { + "properties": { + "backendAddressPool": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool", + "description": "Reference to an ApplicationGatewayBackendAddressPool resource." + }, + "backendHttpSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthHttpSettings" + }, + "description": "List of ApplicationGatewayBackendHealthHttpSettings resources." + } + }, + "description": "Application gateway BackendHealth pool." + }, + "ApplicationGatewayBackendHealthHttpSettings": { + "properties": { + "backendHttpSettings": { + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings", + "description": "Reference to an ApplicationGatewayBackendHttpSettings resource." + }, + "servers": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHealthServer" + }, + "description": "List of ApplicationGatewayBackendHealthServer resources." + } + }, + "description": "Application gateway BackendHealthHttp settings." + }, + "ApplicationGatewayBackendHealthServer": { + "properties": { + "address": { + "type": "string", + "description": "IP address or FQDN of backend server." + }, + "ipConfiguration": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "Reference to IP configuration of backend server." + }, + "health": { + "type": "string", + "description": "Health of backend server.", + "enum": [ + "Unknown", + "Up", + "Down", + "Partial", + "Draining" + ], + "x-ms-enum": { + "name": "ApplicationGatewayBackendHealthServerHealth", + "modelAsString": true + } + }, + "healthProbeLog": { + "type": "string", + "description": "Health Probe Log." + } + }, + "description": "Application gateway backendhealth http settings." + }, + "ApplicationGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Name of an application gateway SKU.", + "enum": [ + "Standard_Small", + "Standard_Medium", + "Standard_Large", + "WAF_Medium", + "WAF_Large", + "Standard_v2", + "WAF_v2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of an application gateway.", + "enum": [ + "Standard", + "WAF", + "Standard_v2", + "WAF_v2" + ], + "x-ms-enum": { + "name": "ApplicationGatewayTier", + "modelAsString": true + } + }, + "capacity": { + "type": "integer", + "format": "int32", + "description": "Capacity (instance count) of an application gateway." + } + }, + "description": "SKU of an application gateway." + }, + "ApplicationGatewaySslPolicy": { + "properties": { + "disabledSslProtocols": { + "type": "array", + "description": "Ssl protocols to be disabled on application gateway.", + "items": { + "type": "string", + "$ref": "#/definitions/ProtocolsEnum" + } + }, + "policyType": { + "type": "string", + "description": "Type of Ssl Policy.", + "enum": [ + "Predefined", + "Custom" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslPolicyType", + "modelAsString": true + } + }, + "policyName": { + "$ref": "#/definitions/PolicyNameEnum", + "description": "Name of Ssl predefined policy." + }, + "cipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "Ssl cipher suites to be enabled in the specified order to application gateway." + }, + "minProtocolVersion": { + "$ref": "#/definitions/ProtocolsEnum", + "description": "Minimum version of Ssl protocol to be supported on application gateway." + } + }, + "description": "Application Gateway Ssl policy." + }, + "ApplicationGatewayIPConfigurationPropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource. A subnet from where application gateway gets its private address." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway IP configuration resource." + } + }, + "description": "Properties of IP configuration of an application gateway." + }, + "ApplicationGatewayIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayIPConfigurationPropertiesFormat", + "description": "Properties of the application gateway IP configuration." + }, + "name": { + "type": "string", + "description": "Name of the IP configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an application gateway. Currently 1 public and 1 private IP configuration is allowed." + }, + "ApplicationGatewayAuthenticationCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the authentication certificate resource." + } + }, + "description": "Authentication certificates properties of an application gateway." + }, + "ApplicationGatewayAuthenticationCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificatePropertiesFormat", + "description": "Properties of the application gateway authentication certificate." + }, + "name": { + "type": "string", + "description": "Name of the authentication certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Authentication certificates of an application gateway." + }, + "ApplicationGatewayTrustedRootCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Certificate public data." + }, + "keyVaultSecretId": { + "type": "string", + "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the trusted root certificate resource." + } + }, + "description": "Trusted Root certificates properties of an application gateway." + }, + "ApplicationGatewayTrustedRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificatePropertiesFormat", + "description": "Properties of the application gateway trusted root certificate." + }, + "name": { + "type": "string", + "description": "Name of the trusted root certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Trusted Root certificates of an application gateway." + }, + "ApplicationGatewaySslCertificatePropertiesFormat": { + "properties": { + "data": { + "type": "string", + "description": "Base-64 encoded pfx certificate. Only applicable in PUT Request." + }, + "password": { + "type": "string", + "description": "Password for the pfx file specified in data. Only applicable in PUT request." + }, + "publicCertData": { + "readOnly": true, + "type": "string", + "description": "Base-64 encoded Public cert data corresponding to pfx specified in data. Only applicable in GET request." + }, + "keyVaultSecretId": { + "type": "string", + "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the SSL certificate resource." + } + }, + "description": "Properties of SSL certificates of an application gateway." + }, + "ApplicationGatewaySslCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslCertificatePropertiesFormat", + "description": "Properties of the application gateway SSL certificate." + }, + "name": { + "type": "string", + "description": "Name of the SSL certificate that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "SSL certificates of an application gateway." + }, + "ApplicationGatewayFrontendIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "PrivateIPAddress of the network interface IP Configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the PublicIP resource." + }, + "privateLinkConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the application gateway private link configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the frontend IP configuration resource." + } + }, + "description": "Properties of Frontend IP configuration of an application gateway." + }, + "ApplicationGatewayFrontendIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfigurationPropertiesFormat", + "description": "Properties of the application gateway frontend IP configuration." + }, + "name": { + "type": "string", + "description": "Name of the frontend IP configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend IP configuration of an application gateway." + }, + "ApplicationGatewayFrontendPortPropertiesFormat": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "Frontend port." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the frontend port resource." + } + }, + "description": "Properties of Frontend port of an application gateway." + }, + "ApplicationGatewayFrontendPort": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFrontendPortPropertiesFormat", + "description": "Properties of the application gateway frontend port." + }, + "name": { + "type": "string", + "description": "Name of the frontend port that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend port of an application gateway." + }, + "ApplicationGatewayBackendAddress": { + "properties": { + "fqdn": { + "type": "string", + "description": "Fully qualified domain name (FQDN)." + }, + "ipAddress": { + "type": "string", + "description": "IP address." + } + }, + "description": "Backend address of an application gateway." + }, + "ApplicationGatewayBackendAddressPoolPropertiesFormat": { + "properties": { + "backendIPConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "Collection of references to IPs defined in network interfaces." + }, + "backendAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendAddress" + }, + "description": "Backend addresses." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the backend address pool resource." + } + }, + "description": "Properties of Backend Address Pool of an application gateway." + }, + "ApplicationGatewayBackendAddressPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendAddressPoolPropertiesFormat", + "description": "Properties of the application gateway backend address pool." + }, + "name": { + "type": "string", + "description": "Name of the backend address pool that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend Address Pool of an application gateway." + }, + "ApplicationGatewayBackendHttpSettingsPropertiesFormat": { + "properties": { + "port": { + "type": "integer", + "format": "int32", + "description": "The destination port on the backend." + }, + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used to communicate with the backend." + }, + "cookieBasedAffinity": { + "type": "string", + "description": "Cookie based affinity.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ApplicationGatewayCookieBasedAffinity", + "modelAsString": true + } + }, + "requestTimeout": { + "type": "integer", + "format": "int32", + "description": "Request timeout in seconds. Application Gateway will fail the request if response is not received within RequestTimeout. Acceptable values are from 1 second to 86400 seconds." + }, + "probe": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Probe resource of an application gateway." + }, + "authenticationCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway authentication certificates." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of references to application gateway trusted root certificates." + }, + "connectionDraining": { + "$ref": "#/definitions/ApplicationGatewayConnectionDraining", + "description": "Connection draining of the backend http settings resource." + }, + "hostName": { + "type": "string", + "description": "Host header to be sent to the backend servers." + }, + "pickHostNameFromBackendAddress": { + "type": "boolean", + "description": "Whether to pick host header should be picked from the host name of the backend server. Default value is false." + }, + "affinityCookieName": { + "type": "string", + "description": "Cookie name to use for the affinity cookie." + }, + "probeEnabled": { + "type": "boolean", + "description": "Whether the probe is enabled. Default value is false." + }, + "path": { + "type": "string", + "description": "Path which should be used as a prefix for all HTTP requests. Null means no path will be prefixed. Default value is null." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the backend HTTP settings resource." + } + }, + "description": "Properties of Backend address pool settings of an application gateway." + }, + "ApplicationGatewayBackendHttpSettings": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettingsPropertiesFormat", + "description": "Properties of the application gateway backend HTTP settings." + }, + "name": { + "type": "string", + "description": "Name of the backend http settings that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Backend address pool settings of an application gateway." + }, + "ApplicationGatewayHttpListenerPropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend IP configuration resource of an application gateway." + }, + "frontendPort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Frontend port resource of an application gateway." + }, + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "Protocol of the HTTP listener." + }, + "hostName": { + "type": "string", + "description": "Host name of HTTP listener." + }, + "sslCertificate": { + "$ref": "./network.json#/definitions/SubResource", + "description": "SSL certificate resource of an application gateway." + }, + "requireServerNameIndication": { + "type": "boolean", + "description": "Applicable only if protocol is https. Enables SNI for multi-hosting." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the HTTP listener resource." + }, + "customErrorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayCustomError" + }, + "description": "Custom error configurations of the HTTP listener." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the FirewallPolicy resource." + }, + "hostNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Host names for HTTP Listener that allows special wildcard characters as well." + } + }, + "description": "Properties of HTTP listener of an application gateway." + }, + "ApplicationGatewayHttpListener": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayHttpListenerPropertiesFormat", + "description": "Properties of the application gateway HTTP listener." + }, + "name": { + "type": "string", + "description": "Name of the HTTP listener that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Http listener of an application gateway." + }, + "ApplicationGatewayPathRulePropertiesFormat": { + "properties": { + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Path rules of URL path map." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of URL path map path rule." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend http settings resource of URL path map path rule." + }, + "redirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Redirect configuration resource of URL path map path rule." + }, + "rewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Rewrite rule set resource of URL path map path rule." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the path rule resource." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the FirewallPolicy resource." + } + }, + "description": "Properties of path rule of an application gateway." + }, + "ApplicationGatewayPathRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPathRulePropertiesFormat", + "description": "Properties of the application gateway path rule." + }, + "name": { + "type": "string", + "description": "Name of the path rule that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Path rule of URL path map of an application gateway." + }, + "ApplicationGatewayProbePropertiesFormat": { + "properties": { + "protocol": { + "$ref": "#/definitions/ApplicationGatewayProtocol", + "description": "The protocol used for the probe." + }, + "host": { + "type": "string", + "description": "Host name to send the probe to." + }, + "path": { + "type": "string", + "description": "Relative path of probe. Valid path starts from '/'. Probe is sent to ://:." + }, + "interval": { + "type": "integer", + "format": "int32", + "description": "The probing interval in seconds. This is the time interval between two consecutive probes. Acceptable values are from 1 second to 86400 seconds." + }, + "timeout": { + "type": "integer", + "format": "int32", + "description": "The probe timeout in seconds. Probe marked as failed if valid response is not received with this timeout period. Acceptable values are from 1 second to 86400 seconds." + }, + "unhealthyThreshold": { + "type": "integer", + "format": "int32", + "description": "The probe retry count. Backend server is marked down after consecutive probe failure count reaches UnhealthyThreshold. Acceptable values are from 1 second to 20." + }, + "pickHostNameFromBackendHttpSettings": { + "type": "boolean", + "description": "Whether the host header should be picked from the backend http settings. Default value is false." + }, + "minServers": { + "type": "integer", + "format": "int32", + "description": "Minimum number of servers that are always marked healthy. Default value is 0." + }, + "match": { + "$ref": "#/definitions/ApplicationGatewayProbeHealthResponseMatch", + "description": "Criterion for classifying a healthy probe response." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the probe resource." + }, + "port": { + "type": "integer", + "format": "int32", + "description": "Custom port which will be used for probing the backend servers. The valid value ranges from 1 to 65535. In case not set, port from http settings will be used. This property is valid for Standard_v2 and WAF_v2 only.", + "minimum": 1, + "maximum": 65535 + } + }, + "description": "Properties of probe of an application gateway." + }, + "ApplicationGatewayProbeHealthResponseMatch": { + "properties": { + "body": { + "type": "string", + "description": "Body that must be contained in the health response. Default value is empty." + }, + "statusCodes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Allowed ranges of healthy status codes. Default range of healthy status codes is 200-399." + } + }, + "description": "Application gateway probe health response match." + }, + "ApplicationGatewayProbe": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayProbePropertiesFormat", + "description": "Properties of the application gateway probe." + }, + "name": { + "type": "string", + "description": "Name of the probe that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Probe of the application gateway." + }, + "ApplicationGatewayRequestRoutingRulePropertiesFormat": { + "properties": { + "ruleType": { + "type": "string", + "description": "Rule type.", + "enum": [ + "Basic", + "PathBasedRouting" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRequestRoutingRuleType", + "modelAsString": true + } + }, + "priority": { + "type": "integer", + "format": "int32", + "minimum": 1, + "exclusiveMinimum": false, + "maximum": 20000, + "exclusiveMaximum": false, + "description": "Priority of the request routing rule." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend address pool resource of the application gateway." + }, + "backendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Backend http settings resource of the application gateway." + }, + "httpListener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Http listener resource of the application gateway." + }, + "urlPathMap": { + "$ref": "./network.json#/definitions/SubResource", + "description": "URL path map resource of the application gateway." + }, + "rewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Rewrite Rule Set resource in Basic rule of the application gateway." + }, + "redirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Redirect configuration resource of the application gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the request routing rule resource." + } + }, + "description": "Properties of request routing rule of the application gateway." + }, + "ApplicationGatewayRequestRoutingRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRulePropertiesFormat", + "description": "Properties of the application gateway request routing rule." + }, + "name": { + "type": "string", + "description": "Name of the request routing rule that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Request routing rule of an application gateway." + }, + "ApplicationGatewayRewriteRuleSet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRewriteRuleSetPropertiesFormat", + "description": "Properties of the application gateway rewrite rule set." + }, + "name": { + "type": "string", + "description": "Name of the rewrite rule set that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Rewrite rule set of an application gateway." + }, + "ApplicationGatewayRewriteRuleSetPropertiesFormat": { + "properties": { + "rewriteRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRule" + }, + "description": "Rewrite rules in the rewrite rule set." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the rewrite rule set resource." + } + }, + "description": "Properties of rewrite rule set of the application gateway." + }, + "ApplicationGatewayRewriteRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the rewrite rule that is unique within an Application Gateway." + }, + "ruleSequence": { + "type": "integer", + "description": "Rule Sequence of the rewrite rule that determines the order of execution of a particular rule in a RewriteRuleSet." + }, + "conditions": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRuleCondition" + }, + "description": "Conditions based on which the action set execution will be evaluated." + }, + "actionSet": { + "type": "object", + "$ref": "#/definitions/ApplicationGatewayRewriteRuleActionSet", + "description": "Set of actions to be done as part of the rewrite Rule." + } + }, + "description": "Rewrite rule of an application gateway." + }, + "ApplicationGatewayRewriteRuleCondition": { + "properties": { + "variable": { + "type": "string", + "description": "The condition parameter of the RewriteRuleCondition." + }, + "pattern": { + "type": "string", + "description": "The pattern, either fixed string or regular expression, that evaluates the truthfulness of the condition." + }, + "ignoreCase": { + "type": "boolean", + "description": "Setting this paramter to truth value with force the pattern to do a case in-sensitive comparison." + }, + "negate": { + "type": "boolean", + "description": "Setting this value as truth will force to check the negation of the condition given by the user." + } + }, + "description": "Set of conditions in the Rewrite Rule in Application Gateway." + }, + "ApplicationGatewayRewriteRuleActionSet": { + "properties": { + "requestHeaderConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" + }, + "description": "Request Header Actions in the Action Set." + }, + "responseHeaderConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHeaderConfiguration" + }, + "description": "Response Header Actions in the Action Set." + }, + "urlConfiguration": { + "$ref": "#/definitions/ApplicationGatewayUrlConfiguration", + "description": "Url Configuration Action in the Action Set." + } + }, + "description": "Set of actions in the Rewrite Rule in Application Gateway." + }, + "ApplicationGatewayHeaderConfiguration": { + "properties": { + "headerName": { + "type": "string", + "description": "Header name of the header configuration." + }, + "headerValue": { + "type": "string", + "description": "Header value of the header configuration." + } + }, + "description": "Header configuration of the Actions set in Application Gateway." + }, + "ApplicationGatewayUrlConfiguration": { + "properties": { + "modifiedPath": { + "type": "string", + "description": "Url path which user has provided for url rewrite. Null means no path will be updated. Default value is null." + }, + "modifiedQueryString": { + "type": "string", + "description": "Query string which user has provided for url rewrite. Null means no query string will be updated. Default value is null." + }, + "reroute": { + "type": "boolean", + "description": "If set as true, it will re-evaluate the url path map provided in path based request routing rules using modified path. Default value is false." + } + }, + "description": "Url configuration of the Actions set in Application Gateway." + }, + "ApplicationGatewayRedirectConfigurationPropertiesFormat": { + "properties": { + "redirectType": { + "type": "string", + "$ref": "#/definitions/RedirectTypeEnum", + "description": "HTTP redirection type." + }, + "targetListener": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to a listener to redirect the request to." + }, + "targetUrl": { + "type": "string", + "description": "Url to redirect the request to." + }, + "includePath": { + "type": "boolean", + "description": "Include path in the redirected url." + }, + "includeQueryString": { + "type": "boolean", + "description": "Include query string in the redirected url." + }, + "requestRoutingRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Request routing specifying redirect configuration." + }, + "urlPathMaps": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Url path maps specifying default redirect configuration." + }, + "pathRules": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Path rules specifying redirect configuration." + } + }, + "description": "Properties of redirect configuration of the application gateway." + }, + "ApplicationGatewayRedirectConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayRedirectConfigurationPropertiesFormat", + "description": "Properties of the application gateway redirect configuration." + }, + "name": { + "type": "string", + "description": "Name of the redirect configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Redirect configuration of an application gateway." + }, + "ApplicationGatewayPrivateLinkConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateLinkConfigurationProperties", + "description": "Properties of the application gateway private link configuration." + }, + "name": { + "type": "string", + "description": "Name of the private link configuration that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Private Link Configuration on an application gateway." + }, + "ApplicationGatewayPrivateLinkConfigurationProperties": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkIpConfiguration" + }, + "description": "An array of application gateway private link ip configurations." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway private link configuration." + } + }, + "description": "Properties of private link configuration on an application gateway." + }, + "ApplicationGatewayPrivateLinkIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateLinkIpConfigurationProperties", + "description": "Properties of an application gateway private link ip configuration." + }, + "name": { + "type": "string", + "description": "The name of application gateway private link ip configuration." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "The application gateway private link ip configuration." + }, + "ApplicationGatewayPrivateLinkIpConfigurationProperties": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource." + }, + "primary": { + "type": "boolean", + "description": "Whether the ip configuration is primary or not." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway private link IP configuration." + } + }, + "description": "Properties of an application gateway private link IP configuration." + }, + "ApplicationGatewayPrivateLinkResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateLinkResourceProperties", + "description": "Properties of the application gateway private link resource." + }, + "name": { + "type": "string", + "description": "Name of the private link resource that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "PrivateLink Resource of an application gateway." + }, + "ApplicationGatewayPrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "Group identifier of private link resource.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "Required member names of private link resource.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Required DNS zone names of the the private link resource." + } + }, + "description": "Properties of a private link resource." + }, + "ApplicationGatewayPrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkResource" + }, + "description": "List of private link resources of an application gateway." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGatewayPrivateLinkResources API service call. Gets all private link resources for an application gateway." + }, + "ApplicationGatewayPrivateEndpointConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnectionProperties", + "description": "Properties of the application gateway private endpoint connection." + }, + "name": { + "type": "string", + "description": "Name of the private endpoint connection on an application gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Private Endpoint connection on an application gateway." + }, + "ApplicationGatewayPrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "readOnly": true, + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "./privateLinkService.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway private endpoint connection resource." + }, + "linkIdentifier": { + "readOnly": true, + "type": "string", + "description": "The consumer link id." + } + }, + "description": "Properties of Private Link Resource of an application gateway." + }, + "ApplicationGatewayPrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + }, + "description": "List of private endpoint connections on an application gateway." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGatewayPrivateEndpointConnection API service call. Gets all private endpoint connections for an application gateway." + }, + "ApplicationGatewayPropertiesFormat": { + "properties": { + "sku": { + "$ref": "#/definitions/ApplicationGatewaySku", + "description": "SKU of the application gateway resource." + }, + "sslPolicy": { + "$ref": "#/definitions/ApplicationGatewaySslPolicy", + "description": "SSL policy of the application gateway resource." + }, + "operationalState": { + "readOnly": true, + "type": "string", + "description": "Operational state of the application gateway resource.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping" + ], + "x-ms-enum": { + "name": "ApplicationGatewayOperationalState", + "modelAsString": true + } + }, + "gatewayIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayIPConfiguration" + }, + "description": "Subnets of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "authenticationCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayAuthenticationCertificate" + }, + "description": "Authentication certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayTrustedRootCertificate" + }, + "description": "Trusted Root certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "sslCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslCertificate" + }, + "description": "SSL certificates of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFrontendIPConfiguration" + }, + "description": "Frontend IP addresses of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "frontendPorts": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFrontendPort" + }, + "description": "Frontend ports of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "probes": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayProbe" + }, + "description": "Probes of the application gateway resource." + }, + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendAddressPool" + }, + "description": "Backend address pool of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "backendHttpSettingsCollection": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayBackendHttpSettings" + }, + "description": "Backend http settings of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "httpListeners": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayHttpListener" + }, + "description": "Http listeners of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "urlPathMaps": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayUrlPathMap" + }, + "description": "URL path map of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "requestRoutingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRequestRoutingRule" + }, + "description": "Request routing rules of the application gateway resource." + }, + "rewriteRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRewriteRuleSet" + }, + "description": "Rewrite rules for the application gateway resource." + }, + "redirectConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayRedirectConfiguration" + }, + "description": "Redirect configurations of the application gateway resource. For default limits, see [Application Gateway limits](https://docs.microsoft.com/azure/azure-subscription-service-limits#application-gateway-limits)." + }, + "webApplicationFirewallConfiguration": { + "$ref": "#/definitions/ApplicationGatewayWebApplicationFirewallConfiguration", + "description": "Web application firewall configuration." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the FirewallPolicy resource." + }, + "enableHttp2": { + "type": "boolean", + "description": "Whether HTTP2 is enabled on the application gateway resource." + }, + "enableFips": { + "type": "boolean", + "description": "Whether FIPS is enabled on the application gateway resource." + }, + "autoscaleConfiguration": { + "$ref": "#/definitions/ApplicationGatewayAutoscaleConfiguration", + "description": "Autoscale Configuration." + }, + "privateLinkConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateLinkConfiguration" + }, + "description": "PrivateLink configurations on application gateway." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPrivateEndpointConnection" + }, + "description": "Private Endpoint connections on application gateway." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the application gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application gateway resource." + }, + "customErrorConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayCustomError" + }, + "description": "Custom error configurations of the application gateway resource." + }, + "forceFirewallPolicyAssociation": { + "type": "boolean", + "description": "If true, associates a firewall policy with an application gateway regardless whether the policy differs from the WAF Config." + } + }, + "description": "Properties of the application gateway." + }, + "ApplicationGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayPropertiesFormat", + "description": "Properties of the application gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the application gateway, if configured." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Application gateway resource." + }, + "ApplicationGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGateway" + }, + "description": "List of an application gateways in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListApplicationGateways API service call." + }, + "ApplicationGatewayUrlPathMapPropertiesFormat": { + "properties": { + "defaultBackendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default backend address pool resource of URL path map." + }, + "defaultBackendHttpSettings": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default backend http settings resource of URL path map." + }, + "defaultRewriteRuleSet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default Rewrite rule set resource of URL path map." + }, + "defaultRedirectConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Default redirect configuration resource of URL path map." + }, + "pathRules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayPathRule" + }, + "description": "Path rule of URL path map resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the URL path map resource." + } + }, + "description": "Properties of UrlPathMap of the application gateway." + }, + "ApplicationGatewayUrlPathMap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayUrlPathMapPropertiesFormat", + "description": "Properties of the application gateway URL path map." + }, + "name": { + "type": "string", + "description": "Name of the URL path map that is unique within an Application Gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "UrlPathMaps give a url path to the backend mapping information for PathBasedRouting." + }, + "ApplicationGatewayWebApplicationFirewallConfiguration": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the web application firewall is enabled or not." + }, + "firewallMode": { + "type": "string", + "description": "Web application firewall mode.", + "enum": [ + "Detection", + "Prevention" + ], + "x-ms-enum": { + "name": "ApplicationGatewayFirewallMode", + "modelAsString": true + } + }, + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set. Possible values are: 'OWASP'." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the rule set type." + }, + "disabledRuleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallDisabledRuleGroup" + }, + "description": "The disabled rule groups." + }, + "requestBodyCheck": { + "type": "boolean", + "description": "Whether allow WAF to check request Body." + }, + "maxRequestBodySize": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maximum request body size for WAF." + }, + "maxRequestBodySizeInKb": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maximum request body size in Kb for WAF." + }, + "fileUploadLimitInMb": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false, + "description": "Maximum file upload size in Mb for WAF." + }, + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallExclusion" + }, + "description": "The exclusion list." + } + }, + "required": [ + "enabled", + "firewallMode", + "ruleSetType", + "ruleSetVersion" + ], + "description": "Application gateway web application firewall configuration." + }, + "ApplicationGatewayAutoscaleConfiguration": { + "properties": { + "minCapacity": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false, + "description": "Lower bound on number of Application Gateway capacity." + }, + "maxCapacity": { + "type": "integer", + "format": "int32", + "minimum": 2, + "exclusiveMinimum": false, + "description": "Upper bound on number of Application Gateway capacity." + } + }, + "required": [ + "minCapacity" + ], + "description": "Application Gateway autoscale configuration." + }, + "ApplicationGatewayConnectionDraining": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether connection draining is enabled or not." + }, + "drainTimeoutInSec": { + "type": "integer", + "format": "int32", + "maximum": 3600, + "exclusiveMaximum": false, + "minimum": 1, + "exclusiveMinimum": false, + "description": "The number of seconds connection draining is active. Acceptable values are from 1 second to 3600 seconds." + } + }, + "required": [ + "enabled", + "drainTimeoutInSec" + ], + "description": "Connection draining allows open connections to a backend server to be active for a specified time after the backend server got removed from the configuration." + }, + "ApplicationGatewayFirewallDisabledRuleGroup": { + "properties": { + "ruleGroupName": { + "type": "string", + "description": "The name of the rule group that will be disabled." + }, + "rules": { + "type": "array", + "items": { + "type": "integer", + "format": "int32", + "x-nullable": false + }, + "description": "The list of rules that will be disabled. If null, all rules of the rule group will be disabled." + } + }, + "required": [ + "ruleGroupName" + ], + "description": "Allows to disable rules within a rule group or an entire rule group." + }, + "ApplicationGatewayAvailableServerVariablesResult": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Response for ApplicationGatewayAvailableServerVariables API service call." + }, + "ApplicationGatewayAvailableRequestHeadersResult": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Response for ApplicationGatewayAvailableRequestHeaders API service call." + }, + "ApplicationGatewayAvailableResponseHeadersResult": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Response for ApplicationGatewayAvailableResponseHeaders API service call." + }, + "ApplicationGatewayFirewallExclusion": { + "properties": { + "matchVariable": { + "type": "string", + "description": "The variable to be excluded." + }, + "selectorMatchOperator": { + "type": "string", + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to." + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." + } + }, + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Allow to exclude some variable satisfy the condition for the WAF check." + }, + "ApplicationGatewayAvailableWafRuleSetsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSet" + }, + "description": "The list of application gateway rule sets." + } + }, + "description": "Response for ApplicationGatewayAvailableWafRuleSets API service call." + }, + "ApplicationGatewayFirewallRuleSet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayFirewallRuleSetPropertiesFormat", + "description": "Properties of the application gateway firewall rule set." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A web application firewall rule set." + }, + "ApplicationGatewayFirewallRuleSetPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the web application firewall rule set." + }, + "ruleSetType": { + "type": "string", + "description": "The type of the web application firewall rule set." + }, + "ruleSetVersion": { + "type": "string", + "description": "The version of the web application firewall rule set type." + }, + "ruleGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRuleGroup" + }, + "description": "The rule groups of the web application firewall rule set." + } + }, + "required": [ + "ruleSetType", + "ruleSetVersion", + "ruleGroups" + ], + "description": "Properties of the web application firewall rule set." + }, + "ApplicationGatewayFirewallRuleGroup": { + "properties": { + "ruleGroupName": { + "type": "string", + "description": "The name of the web application firewall rule group." + }, + "description": { + "type": "string", + "description": "The description of the web application firewall rule group." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewayFirewallRule" + }, + "description": "The rules of the web application firewall rule group." + } + }, + "required": [ + "ruleGroupName", + "rules" + ], + "description": "A web application firewall rule group." + }, + "ApplicationGatewayFirewallRule": { + "properties": { + "ruleId": { + "type": "integer", + "format": "int32", + "description": "The identifier of the web application firewall rule." + }, + "description": { + "type": "string", + "description": "The description of the web application firewall rule." + } + }, + "required": [ + "ruleId" + ], + "description": "A web application firewall rule." + }, + "ApplicationGatewayAvailableSslOptions": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewayAvailableSslOptionsPropertiesFormat", + "description": "Properties of the application gateway available SSL options." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Response for ApplicationGatewayAvailableSslOptions API service call." + }, + "ApplicationGatewayAvailableSslOptionsPropertiesFormat": { + "properties": { + "predefinedPolicies": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of available Ssl predefined policy." + }, + "defaultPolicy": { + "$ref": "#/definitions/PolicyNameEnum", + "description": "Name of the Ssl predefined policy applied by default to application gateway." + }, + "availableCipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "List of available Ssl cipher suites." + }, + "availableProtocols": { + "type": "array", + "items": { + "$ref": "#/definitions/ProtocolsEnum" + }, + "description": "List of available Ssl protocols." + } + }, + "description": "Properties of ApplicationGatewayAvailableSslOptions." + }, + "ApplicationGatewayAvailableSslPredefinedPolicies": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicy" + }, + "description": "List of available Ssl predefined policy." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ApplicationGatewayAvailableSslOptions API service call." + }, + "ApplicationGatewaySslPredefinedPolicy": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Ssl predefined policy." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationGatewaySslPredefinedPolicyPropertiesFormat", + "description": "Properties of the application gateway SSL predefined policy." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "An Ssl predefined policy." + }, + "ApplicationGatewaySslPredefinedPolicyPropertiesFormat": { + "properties": { + "cipherSuites": { + "type": "array", + "items": { + "$ref": "#/definitions/CipherSuitesEnum" + }, + "description": "Ssl cipher suites to be enabled in the specified order for application gateway." + }, + "minProtocolVersion": { + "$ref": "#/definitions/ProtocolsEnum", + "description": "Minimum version of Ssl protocol to be supported on application gateway." + } + }, + "description": "Properties of ApplicationGatewaySslPredefinedPolicy." + }, + "ApplicationGatewayCustomError": { + "properties": { + "statusCode": { + "type": "string", + "description": "Status code of the application gateway customer error.", + "enum": [ + "HttpStatus403", + "HttpStatus502" + ], + "x-ms-enum": { + "name": "ApplicationGatewayCustomErrorStatusCode", + "modelAsString": true + } + }, + "customErrorPageUrl": { + "type": "string", + "description": "Error page URL of the application gateway customer error." + } + }, + "description": "Customer error of an application gateway." + }, + "PolicyNameEnum": { + "type": "string", + "description": "Ssl predefined policy name enums.", + "enum": [ + "AppGwSslPolicy20150501", + "AppGwSslPolicy20170401", + "AppGwSslPolicy20170401S" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslPolicyName", + "modelAsString": true + } + }, + "ProtocolsEnum": { + "type": "string", + "description": "Ssl protocol enums.", + "enum": [ + "TLSv1_0", + "TLSv1_1", + "TLSv1_2" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslProtocol", + "modelAsString": true + } + }, + "CipherSuitesEnum": { + "type": "string", + "description": "Ssl cipher suites enums.", + "enum": [ + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384" + ], + "x-ms-enum": { + "name": "ApplicationGatewaySslCipherSuite", + "modelAsString": true + } + }, + "RedirectTypeEnum": { + "type": "string", + "description": "Redirect type enum.", + "enum": [ + "Permanent", + "Found", + "SeeOther", + "Temporary" + ], + "x-ms-enum": { + "name": "ApplicationGatewayRedirectType", + "modelAsString": true + } + }, + "ApplicationGatewayProtocol": { + "type": "string", + "description": "Application Gateway protocol.", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ApplicationGatewayProtocol", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/applicationSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/applicationSecurityGroup.json new file mode 100644 index 000000000000..87dc42b4e92a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/applicationSecurityGroup.json @@ -0,0 +1,406 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups/{applicationSecurityGroupName}": { + "delete": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_Delete", + "description": "Deletes the specified application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete application security group": { + "$ref": "./examples/ApplicationSecurityGroupDelete.json" + } + } + }, + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_Get", + "description": "Gets information about the specified application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get application security group": { + "$ref": "./examples/ApplicationSecurityGroupGet.json" + } + } + }, + "put": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_CreateOrUpdate", + "description": "Creates or updates an application security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + }, + "description": "Parameters supplied to the create or update ApplicationSecurityGroup operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting application security group resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create application security group": { + "$ref": "./examples/ApplicationSecurityGroupCreate.json" + } + } + }, + "patch": { + "tags": [ + "applicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_UpdateTags", + "description": "Updates an application security group's tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "applicationSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the application security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update application security group tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ApplicationSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update application security group tags": { + "$ref": "./examples/ApplicationSecurityGroupUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/applicationSecurityGroups": { + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_ListAll", + "description": "Gets all application security groups in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of application security group resources.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all application security groups": { + "$ref": "./examples/ApplicationSecurityGroupListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/applicationSecurityGroups": { + "get": { + "tags": [ + "ApplicationSecurityGroups" + ], + "operationId": "ApplicationSecurityGroups_List", + "description": "Gets all the application security groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of application security group resources.", + "schema": { + "$ref": "#/definitions/ApplicationSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List load balancers in resource group": { + "$ref": "./examples/ApplicationSecurityGroupList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ApplicationSecurityGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ApplicationSecurityGroupPropertiesFormat", + "description": "Properties of the application security group." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "An application security group in a resource group." + }, + "ApplicationSecurityGroupPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the application security group resource. It uniquely identifies a resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application security group resource." + } + }, + "description": "Application security group properties." + }, + "ApplicationSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ApplicationSecurityGroup" + }, + "description": "A list of application security groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of application security groups." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/availableDelegations.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/availableDelegations.json new file mode 100644 index 000000000000..85b58a28536e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/availableDelegations.json @@ -0,0 +1,178 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableDelegations_List", + "description": "Gets all of the available subnet delegations for this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available delegations": { + "$ref": "./examples/AvailableDelegationsSubscriptionGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableDelegations": { + "get": { + "operationId": "AvailableResourceGroupDelegations_List", + "description": "Gets all of the available subnet delegations for this resource group in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the possible delegations for a subnet in this subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableDelegationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available delegations in the resource group": { + "$ref": "./examples/AvailableDelegationsResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AvailableDelegationsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableDelegation" + }, + "description": "An array of available delegations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available delegations." + }, + "AvailableDelegation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the AvailableDelegation resource." + }, + "id": { + "type": "string", + "description": "A unique identifier of the AvailableDelegation resource." + }, + "type": { + "type": "string", + "description": "Resource type." + }, + "serviceName": { + "type": "string", + "description": "The name of the service and resource." + }, + "actions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The actions permitted to the service upon delegation." + } + }, + "description": "The serviceName of an AvailableDelegation indicates a possible delegation for a subnet." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/availableServiceAliases.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/availableServiceAliases.json new file mode 100644 index 000000000000..3e61635a9541 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/availableServiceAliases.json @@ -0,0 +1,171 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availableServiceAliases": { + "get": { + "operationId": "AvailableServiceAliases_List", + "description": "Gets all available service aliases for this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all available service aliases for the subscription in the region.", + "schema": { + "$ref": "#/definitions/AvailableServiceAliasesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available service aliases": { + "$ref": "./examples/AvailableServiceAliasesList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availableServiceAliases": { + "get": { + "operationId": "AvailableServiceAliases_ListByResourceGroup", + "description": "Gets all available service aliases for this resource group in this region.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all available service aliases for the resource group in the region.", + "schema": { + "$ref": "#/definitions/AvailableServiceAliasesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available service aliases in the resource group": { + "$ref": "./examples/AvailableServiceAliasesListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AvailableServiceAlias": { + "properties": { + "name": { + "type": "string", + "description": "The name of the service alias." + }, + "id": { + "type": "string", + "description": "The ID of the service alias." + }, + "type": { + "type": "string", + "description": "The type of the resource." + }, + "resourceName": { + "type": "string", + "description": "The resource name of the service alias." + } + }, + "description": "The available service alias." + }, + "AvailableServiceAliasesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableServiceAlias" + }, + "description": "An array of available service aliases." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available service aliases." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/azureFirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/azureFirewall.json new file mode 100644 index 000000000000..c9ca5b08e37c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/azureFirewall.json @@ -0,0 +1,1085 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls/{azureFirewallName}": { + "delete": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_Delete", + "description": "Deletes the specified Azure Firewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Azure Firewall": { + "$ref": "./examples/AzureFirewallDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_Get", + "description": "Gets the specified Azure Firewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Firewall." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Azure Firewall": { + "$ref": "./examples/AzureFirewallGet.json" + }, + "Get Azure Firewall With Zones": { + "$ref": "./examples/AzureFirewallGetWithZones.json" + }, + "Get Azure Firewall With management subnet": { + "$ref": "./examples/AzureFirewallGetWithMgmtSubnet.json" + }, + "Get Azure Firewall With Additional Properties": { + "$ref": "./examples/AzureFirewallGetWithAdditionalProperties.json" + }, + "Get Azure Firewall With IpGroups": { + "$ref": "./examples/AzureFirewallGetWithIpGroups.json" + } + } + }, + "put": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_CreateOrUpdate", + "description": "Creates or updates the specified Azure Firewall.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 56, + "description": "The name of the Azure Firewall." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureFirewall" + }, + "description": "Parameters supplied to the create or update Azure Firewall operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Azure Firewall": { + "$ref": "./examples/AzureFirewallPut.json" + }, + "Create Azure Firewall With Zones": { + "$ref": "./examples/AzureFirewallPutWithZones.json" + }, + "Create Azure Firewall With management subnet": { + "$ref": "./examples/AzureFirewallPutWithMgmtSubnet.json" + }, + "Create Azure Firewall in virtual Hub": { + "$ref": "./examples/AzureFirewallPutInHub.json" + }, + "Create Azure Firewall With Additional Properties": { + "$ref": "./examples/AzureFirewallPutWithAdditionalProperties.json" + }, + "Create Azure Firewall With IpGroups": { + "$ref": "./examples/AzureFirewallPutWithIpGroups.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_UpdateTags", + "description": "Updates tags of an Azure Firewall resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "azureFirewallName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Azure Firewall." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update azure firewall tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Update successful. The operation returns the resulting AzureFirewall resource.", + "schema": { + "$ref": "#/definitions/AzureFirewall" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Azure Firewall Tags": { + "$ref": "./examples/AzureFirewallUpdateTags.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/azureFirewalls": { + "get": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_List", + "description": "Lists all Azure Firewalls in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of AzureFirewall resources.", + "schema": { + "$ref": "#/definitions/AzureFirewallListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Firewalls for a given resource group": { + "$ref": "./examples/AzureFirewallListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewalls": { + "get": { + "tags": [ + "AzureFirewalls" + ], + "operationId": "AzureFirewalls_ListAll", + "description": "Gets all the Azure Firewalls in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of AzureFirewall resources.", + "schema": { + "$ref": "#/definitions/AzureFirewallListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Firewalls for a given subscription": { + "$ref": "./examples/AzureFirewallListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AzureFirewallIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "readOnly": true, + "description": "The Firewall Internal Load Balancer IP to be used as the next hop in User Defined Routes." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the subnet resource. This resource must be named 'AzureFirewallSubnet' or 'AzureFirewallManagementSubnet'." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the PublicIP resource. This field is a mandatory input if subnet is not null." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Azure firewall IP configuration resource." + } + }, + "description": "Properties of IP configuration of an Azure Firewall." + }, + "AzureFirewallIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallIPConfigurationPropertiesFormat", + "description": "Properties of the azure firewall IP configuration." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an Azure Firewall." + }, + "AzureFirewallPublicIPAddress": { + "properties": { + "address": { + "type": "string", + "description": "Public IP Address value." + } + }, + "description": "Public IP Address associated with azure firewall." + }, + "AzureFirewallIpGroups": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource ID." + }, + "changeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number." + } + }, + "description": "IpGroups associated with azure firewall." + }, + "HubPublicIPAddresses": { + "properties": { + "addresses": { + "type": "array", + "description": "The number of Public IP addresses associated with azure firewall.", + "items": { + "$ref": "#/definitions/AzureFirewallPublicIPAddress" + } + }, + "count": { + "type": "integer", + "format": "int32", + "description": "Private IP Address associated with azure firewall." + } + }, + "description": "Public IP addresses associated with azure firewall." + }, + "HubIPAddresses": { + "properties": { + "publicIPs": { + "description": "Public IP addresses associated with azure firewall.", + "$ref": "#/definitions/HubPublicIPAddresses" + }, + "privateIPAddress": { + "type": "string", + "description": "Private IP Address associated with azure firewall." + } + }, + "description": "IP addresses associated with azure firewall." + }, + "IpGroups": { + "type": "array", + "description": "List of IpGroups associated with azure firewall.", + "items": { + "$ref": "#/definitions/AzureFirewallIpGroups" + } + }, + "AzureFirewallPropertiesFormat": { + "properties": { + "applicationRuleCollections": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallApplicationRuleCollection" + }, + "description": "Collection of application rule collections used by Azure Firewall." + }, + "natRuleCollections": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNatRuleCollection" + }, + "description": "Collection of NAT rule collections used by Azure Firewall." + }, + "networkRuleCollections": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRuleCollection" + }, + "description": "Collection of network rule collections used by Azure Firewall." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallIPConfiguration" + }, + "description": "IP configuration of the Azure Firewall resource." + }, + "managementIpConfiguration": { + "$ref": "#/definitions/AzureFirewallIPConfiguration", + "description": "IP configuration of the Azure Firewall used for management traffic." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Azure firewall resource." + }, + "threatIntelMode": { + "description": "The operation mode for Threat Intelligence.", + "$ref": "#/definitions/AzureFirewallThreatIntelMode" + }, + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The virtualHub to which the firewall belongs." + }, + "firewallPolicy": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The firewallPolicy associated with this azure firewall." + }, + "hubIPAddresses": { + "description": "IP addresses associated with AzureFirewall.", + "$ref": "#/definitions/HubIPAddresses" + }, + "ipGroups": { + "readOnly": true, + "description": "IpGroups associated with AzureFirewall.", + "$ref": "#/definitions/IpGroups" + }, + "sku": { + "description": "The Azure Firewall Resource SKU.", + "$ref": "#/definitions/AzureFirewallSku" + }, + "additionalProperties": { + "$ref": "#/definitions/AzureFirewallAdditionalProperties", + "description": "The additional properties used to further config this azure firewall." + } + }, + "description": "Properties of the Azure Firewall." + }, + "AzureFirewall": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallPropertiesFormat", + "description": "Properties of the azure firewall." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting where the resource needs to come from." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Azure Firewall resource." + }, + "AzureFirewallListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewall" + }, + "description": "List of Azure Firewalls in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListAzureFirewalls API service call." + }, + "AzureFirewallThreatIntelMode": { + "type": "string", + "description": "The operation mode for Threat Intel.", + "enum": [ + "Alert", + "Deny", + "Off" + ], + "x-ms-enum": { + "name": "AzureFirewallThreatIntelMode", + "modelAsString": true + } + }, + "AzureFirewallAdditionalProperties": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The additional properties of azure firewall." + }, + "AzureFirewallApplicationRuleCollectionPropertiesFormat": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the application rule collection resource." + }, + "action": { + "$ref": "#/definitions/AzureFirewallRCAction", + "description": "The action type of a rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallApplicationRule" + }, + "description": "Collection of rules used by a application rule collection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the application rule collection resource." + } + }, + "description": "Properties of the application rule collection." + }, + "AzureFirewallApplicationRuleCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallApplicationRuleCollectionPropertiesFormat", + "description": "Properties of the azure firewall application rule collection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the Azure firewall. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Application rule collection resource." + }, + "AzureFirewallApplicationRuleProtocol": { + "properties": { + "protocolType": { + "description": "Protocol type.", + "$ref": "#/definitions/AzureFirewallApplicationRuleProtocolType" + }, + "port": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false, + "description": "Port number for the protocol, cannot be greater than 64000. This field is optional." + } + }, + "description": "Properties of the application rule protocol." + }, + "AzureFirewallApplicationRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the application rule." + }, + "description": { + "type": "string", + "description": "Description of the rule." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallApplicationRuleProtocol" + }, + "description": "Array of ApplicationRuleProtocols." + }, + "targetFqdns": { + "type": "array", + "description": "List of FQDNs for this rule.", + "items": { + "type": "string" + } + }, + "fqdnTags": { + "type": "array", + "description": "List of FQDN Tags for this rule.", + "items": { + "type": "string" + } + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + } + }, + "description": "Properties of an application rule." + }, + "AzureFirewallNatRuleCollectionProperties": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the NAT rule collection resource." + }, + "action": { + "$ref": "#/definitions/AzureFirewallNatRCAction", + "description": "The action type of a NAT rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNatRule" + }, + "description": "Collection of rules used by a NAT rule collection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the NAT rule collection resource." + } + }, + "description": "Properties of the NAT rule collection." + }, + "AzureFirewallNatRuleCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallNatRuleCollectionProperties", + "description": "Properties of the azure firewall NAT rule collection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the Azure firewall. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "NAT rule collection resource." + }, + "AzureFirewallNatRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the NAT rule." + }, + "description": { + "type": "string", + "description": "Description of the rule." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "destinationAddresses": { + "type": "array", + "description": "List of destination IP addresses for this rule. Supports IP ranges, prefixes, and service tags.", + "items": { + "type": "string" + } + }, + "destinationPorts": { + "type": "array", + "description": "List of destination ports.", + "items": { + "type": "string" + } + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRuleProtocol" + }, + "description": "Array of AzureFirewallNetworkRuleProtocols applicable to this NAT rule." + }, + "translatedAddress": { + "type": "string", + "description": "The translated address for this NAT rule." + }, + "translatedPort": { + "type": "string", + "description": "The translated port for this NAT rule." + }, + "translatedFqdn": { + "type": "string", + "description": "The translated FQDN for this NAT rule." + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + } + }, + "description": "Properties of a NAT rule." + }, + "AzureFirewallNatRCAction": { + "properties": { + "type": { + "description": "The type of action.", + "$ref": "#/definitions/AzureFirewallNatRCActionType" + } + }, + "description": "AzureFirewall NAT Rule Collection Action." + }, + "AzureFirewallNatRCActionType": { + "type": "string", + "description": "The action type of a NAT rule collection.", + "enum": [ + "Snat", + "Dnat" + ], + "x-ms-enum": { + "name": "AzureFirewallNatRCActionType", + "modelAsString": true + } + }, + "AzureFirewallNetworkRuleCollectionPropertiesFormat": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the network rule collection resource." + }, + "action": { + "$ref": "#/definitions/AzureFirewallRCAction", + "description": "The action type of a rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRule" + }, + "description": "Collection of rules used by a network rule collection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network rule collection resource." + } + }, + "description": "Properties of the network rule collection." + }, + "AzureFirewallNetworkRuleCollection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallNetworkRuleCollectionPropertiesFormat", + "description": "Properties of the azure firewall network rule collection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the Azure firewall. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Network rule collection resource." + }, + "AzureFirewallNetworkRule": { + "properties": { + "name": { + "type": "string", + "description": "Name of the network rule." + }, + "description": { + "type": "string", + "description": "Description of the rule." + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallNetworkRuleProtocol" + }, + "description": "Array of AzureFirewallNetworkRuleProtocols." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "destinationAddresses": { + "type": "array", + "description": "List of destination IP addresses.", + "items": { + "type": "string" + } + }, + "destinationPorts": { + "type": "array", + "description": "List of destination ports.", + "items": { + "type": "string" + } + }, + "destinationFqdns": { + "type": "array", + "description": "List of destination FQDNs.", + "items": { + "type": "string" + } + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + }, + "destinationIpGroups": { + "type": "array", + "description": "List of destination IpGroups for this rule.", + "items": { + "type": "string" + } + } + }, + "description": "Properties of the network rule." + }, + "AzureFirewallRCAction": { + "properties": { + "type": { + "description": "The type of action.", + "$ref": "#/definitions/AzureFirewallRCActionType" + } + }, + "description": "Properties of the AzureFirewallRCAction." + }, + "AzureFirewallRCActionType": { + "type": "string", + "description": "The action type of a rule collection.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "AzureFirewallRCActionType", + "modelAsString": true + } + }, + "AzureFirewallNetworkRuleProtocol": { + "type": "string", + "description": "The protocol of a Network Rule resource.", + "enum": [ + "TCP", + "UDP", + "Any", + "ICMP" + ], + "x-ms-enum": { + "name": "AzureFirewallNetworkRuleProtocol", + "modelAsString": true + } + }, + "AzureFirewallApplicationRuleProtocolType": { + "type": "string", + "description": "The protocol type of a Application Rule resource.", + "enum": [ + "Http", + "Https", + "Mssql" + ], + "x-ms-enum": { + "name": "AzureFirewallApplicationRuleProtocolType", + "modelAsString": true + } + }, + "AzureFirewallSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of an Azure Firewall SKU.", + "enum": [ + "AZFW_VNet", + "AZFW_Hub" + ], + "x-ms-enum": { + "name": "AzureFirewallSkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of an Azure Firewall.", + "enum": [ + "Standard", + "Premium" + ], + "x-ms-enum": { + "name": "AzureFirewallSkuTier", + "modelAsString": true + } + } + }, + "description": "SKU of an Azure Firewall." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/azureFirewallFqdnTag.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/azureFirewallFqdnTag.json new file mode 100644 index 000000000000..9c0c0d2db671 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/azureFirewallFqdnTag.json @@ -0,0 +1,130 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/azureFirewallFqdnTags": { + "get": { + "tags": [ + "AzureFirewallFqdnTags" + ], + "operationId": "AzureFirewallFqdnTags_ListAll", + "description": "Gets all the Azure Firewall FQDN Tags in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Azure Firewall FQDN Tag resources.", + "schema": { + "$ref": "#/definitions/AzureFirewallFqdnTagListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Azure Firewall FQDN Tags for a given subscription": { + "$ref": "./examples/AzureFirewallFqdnTagsListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "AzureFirewallFqdnTagPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Azure firewall FQDN tag resource." + }, + "fqdnTagName": { + "type": "string", + "readOnly": true, + "description": "The name of this FQDN Tag." + } + }, + "description": "Azure Firewall FQDN Tag Properties." + }, + "AzureFirewallFqdnTag": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AzureFirewallFqdnTagPropertiesFormat", + "description": "Properties of the azure firewall FQDN tag." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Azure Firewall FQDN Tag Resource." + }, + "AzureFirewallFqdnTagListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureFirewallFqdnTag" + }, + "description": "List of Azure Firewall FQDN Tags in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListAzureFirewallFqdnTags API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/bastionHost.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/bastionHost.json new file mode 100644 index 000000000000..87fc9f0ecc65 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/bastionHost.json @@ -0,0 +1,869 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}": { + "delete": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_Delete", + "description": "Deletes the specified Bastion Host.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Bastion Host": { + "$ref": "./examples/BastionHostDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_Get", + "description": "Gets the specified Bastion Host.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns an BastionHost resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Bastion Host": { + "$ref": "./examples/BastionHostGet.json" + } + } + }, + "put": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_CreateOrUpdate", + "description": "Creates or updates the specified Bastion Host.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BastionHost" + }, + "description": "Parameters supplied to the create or update Bastion Host operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting Bastion Host resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting Bastion Host resource.", + "schema": { + "$ref": "#/definitions/BastionHost" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Bastion Host": { + "$ref": "./examples/BastionHostPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/bastionHosts": { + "get": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_List", + "description": "Lists all Bastion Hosts in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Bastion Host resources.", + "schema": { + "$ref": "#/definitions/BastionHostListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Bastion Hosts for a given subscription": { + "$ref": "./examples/BastionHostListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts": { + "get": { + "tags": [ + "BastionHosts" + ], + "operationId": "BastionHosts_ListByResourceGroup", + "description": "Lists all Bastion Hosts in a resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of BastionHost resources.", + "schema": { + "$ref": "#/definitions/BastionHostListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Bastion Hosts for a given resource group": { + "$ref": "./examples/BastionHostListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/createShareableLinks": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "PutBastionShareableLink", + "description": "Creates a Bastion Shareable Links for all the VMs specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkRequest" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of shareable links for the specified VMs, giving appropriate error messages as needed.", + "schema": { + "$ref": "#/definitions/BastionShareableLinkListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/deleteShareableLinks": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "DeleteBastionShareableLink", + "description": "Deletes the Bastion Shareable Links for all the VMs specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkRequest" + } + ], + "responses": { + "200": { + "description": "Success. The operation deleted the BastionShareableLinks associated with the VMs, if they existed. No return body." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/getShareableLinks": { + "post": { + "tags": [ + "BastionHosts", + "BastionShareableLink" + ], + "operationId": "GetBastionShareableLink", + "description": "Return the Bastion Shareable Links for all the VMs specified in the request.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/BastionShareableLinkRequest" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of shareable links for the specified VMs, giving appropriate error messages as needed.", + "schema": { + "$ref": "#/definitions/BastionShareableLinkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Returns the Bastion Shareable Links for the request VMs": { + "$ref": "./examples/BastionShareableLinkGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/getActiveSessions": { + "post": { + "tags": [ + "BastionHosts" + ], + "operationId": "GetActiveSessions", + "description": "Returns the list of currently active sessions on the Bastion.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of active sessions on the Bastion.", + "schema": { + "$ref": "#/definitions/BastionActiveSessionListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Returns a list of currently active sessions on the Bastion": { + "$ref": "./examples/BastionSessionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/bastionHosts/{bastionHostName}/disconnectActiveSessions": { + "post": { + "tags": [ + "BastionHosts" + ], + "operationId": "DisconnectActiveSessions", + "description": "Returns the list of currently active sessions on the Bastion.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/BastionHostName" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/SessionIdsParameters" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of sessions with the state of deleted/failed/not found.", + "schema": { + "$ref": "#/definitions/BastionSessionDeleteResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Deletes the specified active session": { + "$ref": "./examples/BastionSessionDelete.json" + } + } + } + } + }, + "definitions": { + "BastionHostIPConfigurationPropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference of the PublicIP resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the bastion host IP configuration resource." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "Private IP allocation method." + } + }, + "required": [ + "subnet", + "publicIPAddress" + ], + "description": "Properties of IP configuration of an Bastion Host." + }, + "BastionHostIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BastionHostIPConfigurationPropertiesFormat", + "description": "Represents the ip configuration associated with the resource." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Ip configuration type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration of an Bastion Host." + }, + "BastionHostPropertiesFormat": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionHostIPConfiguration" + }, + "description": "IP configuration of the Bastion Host resource." + }, + "dnsName": { + "type": "string", + "description": "FQDN for the endpoint on which bastion host is accessible." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the bastion host resource." + } + }, + "description": "Properties of the Bastion Host." + }, + "BastionHost": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BastionHostPropertiesFormat", + "description": "Represents the bastion host resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Bastion Host resource." + }, + "BastionHostListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionHost" + }, + "description": "List of Bastion Hosts in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListBastionHosts API service call." + }, + "BastionShareableLink": { + "properties": { + "vm": { + "$ref": "#/definitions/VM", + "description": "Reference of the virtual machine resource." + }, + "bsl": { + "type": "string", + "readOnly": true, + "description": "The unique Bastion Shareable Link to the virtual machine." + }, + "createdAt": { + "type": "string", + "readOnly": true, + "description": "The time when the link was created." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Optional field indicating the warning or error message related to the vm in case of partial failure." + } + }, + "required": [ + "vm" + ], + "description": "Bastion Shareable Link." + }, + "BastionShareableLinkListRequest": { + "properties": { + "vms": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionShareableLink" + }, + "description": "List of VM references." + } + }, + "description": "Post request for all the Bastion Shareable Link endpoints." + }, + "BastionShareableLinkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionShareableLink" + }, + "description": "List of Bastion Shareable Links for the request." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for all the Bastion Shareable Link endpoints." + }, + "BastionActiveSession": { + "properties": { + "sessionId": { + "type": "string", + "readOnly": true, + "description": "A unique id for the session." + }, + "startTime": { + "type": "object", + "readOnly": true, + "description": "The time when the session started." + }, + "targetSubscriptionId": { + "type": "string", + "readOnly": true, + "description": "The subscription id for the target virtual machine." + }, + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The type of the resource." + }, + "targetHostName": { + "type": "string", + "readOnly": true, + "description": "The host name of the target." + }, + "targetResourceGroup": { + "type": "string", + "readOnly": true, + "description": "The resource group of the target." + }, + "userName": { + "type": "string", + "readOnly": true, + "description": "The user name who is active on this session." + }, + "targetIpAddress": { + "type": "string", + "readOnly": true, + "description": "The IP Address of the target." + }, + "protocol": { + "type": "string", + "readOnly": true, + "description": "The protocol used to connect to the target.", + "enum": [ + "SSH", + "RDP" + ], + "x-ms-enum": { + "name": "BastionConnectProtocol", + "modelAsString": true + } + }, + "targetResourceId": { + "type": "string", + "readOnly": true, + "description": "The resource id of the target." + }, + "sessionDurationInMins": { + "type": "number", + "readOnly": true, + "description": "Duration in mins the session has been active." + } + }, + "description": "The session detail for a target." + }, + "BastionActiveSessionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionActiveSession" + }, + "description": "List of active sessions on the bastion." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for GetActiveSessions." + }, + "BastionSessionState": { + "properties": { + "sessionId": { + "type": "string", + "readOnly": true, + "description": "A unique id for the session." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "Used for extra information." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the session. Disconnected/Failed/NotFound." + } + }, + "description": "The session state detail for a target." + }, + "BastionSessionDeleteResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BastionSessionState" + }, + "description": "List of sessions with their corresponding state." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for DisconnectActiveSessions." + }, + "VM": { + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "SessionIds": { + "properties": { + "sessionIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of session IDs." + } + }, + "description": "List of session IDs." + } + }, + "parameters": { + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "BastionShareableLinkRequest": { + "name": "bslRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BastionShareableLinkListRequest" + }, + "description": "Post request for all the Bastion Shareable Link endpoints.", + "x-ms-parameter-location": "method" + }, + "BastionHostName": { + "name": "bastionHostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Bastion Host.", + "x-ms-parameter-location": "method" + }, + "SessionIdsParameters": { + "name": "sessionIds", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SessionIds" + }, + "description": "The list of sessionids to disconnect.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/checkDnsAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/checkDnsAvailability.json new file mode 100644 index 000000000000..0c0b4a7113cc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/checkDnsAvailability.json @@ -0,0 +1,96 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/CheckDnsNameAvailability": { + "get": { + "operationId": "CheckDnsNameAvailability", + "description": "Checks whether a domain name in the cloudapp.azure.com zone is available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "domainNameLabel", + "in": "query", + "required": true, + "type": "string", + "description": "The domain name to be verified. It must conform to the following regular expression: ^[a-z][a-z0-9-]{1,61}[a-z0-9]$." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the DNS name is available.", + "schema": { + "$ref": "#/definitions/DnsNameAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check Dns Name Availability": { + "$ref": "./examples/CheckDnsNameAvailability.json" + } + } + } + } + }, + "definitions": { + "DnsNameAvailabilityResult": { + "properties": { + "available": { + "type": "boolean", + "description": "Domain availability (True/False)." + } + }, + "description": "Response for the CheckDnsNameAvailability API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ddosCustomPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ddosCustomPolicy.json new file mode 100644 index 000000000000..29514b35370c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ddosCustomPolicy.json @@ -0,0 +1,364 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosCustomPolicies/{ddosCustomPolicyName}": { + "delete": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_Delete", + "description": "Deletes the specified DDoS custom policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete DDoS custom policy": { + "$ref": "./examples/DdosCustomPolicyDelete.json" + } + } + }, + "get": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_Get", + "description": "Gets information about the specified DDoS custom policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DDoS custom policy": { + "$ref": "./examples/DdosCustomPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_CreateOrUpdate", + "description": "Creates or updates a DDoS custom policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + }, + "description": "Parameters supplied to the create or update operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create DDoS custom policy": { + "$ref": "./examples/DdosCustomPolicyCreate.json" + } + } + }, + "patch": { + "tags": [ + "ddosCustomPolicies" + ], + "operationId": "DdosCustomPolicies_UpdateTags", + "description": "Update a DDoS custom policy tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosCustomPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS custom policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update DDoS custom policy resource tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting DDoS custom policy resource.", + "schema": { + "$ref": "#/definitions/DdosCustomPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DDoS Custom policy Update tags": { + "$ref": "./examples/DdosCustomPolicyUpdateTags.json" + } + } + } + } + }, + "definitions": { + "DdosCustomPolicy": { + "description": "A DDoS custom policy in a resource group.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DdosCustomPolicyPropertiesFormat", + "description": "Properties of the DDoS custom policy." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "DdosCustomPolicyPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the DDoS custom policy resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the DDoS custom policy resource." + }, + "publicIPAddresses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of public IPs associated with the DDoS custom policy resource. This list is read-only." + }, + "protocolCustomSettings": { + "readOnly": false, + "type": "array", + "items": { + "$ref": "#/definitions/ProtocolCustomSettingsFormat" + }, + "description": "The protocol-specific DDoS policy customization parameters." + } + }, + "description": "DDoS custom policy properties." + }, + "ProtocolCustomSettingsFormat": { + "properties": { + "protocol": { + "readOnly": false, + "type": "string", + "enum": [ + "Tcp", + "Udp", + "Syn" + ], + "x-ms-enum": { + "name": "DdosCustomPolicyProtocol", + "modelAsString": true + }, + "description": "The protocol for which the DDoS protection policy is being customized." + }, + "triggerRateOverride": { + "readOnly": false, + "type": "string", + "description": "The customized DDoS protection trigger rate." + }, + "sourceRateOverride": { + "readOnly": false, + "type": "string", + "description": "The customized DDoS protection source rate." + }, + "triggerSensitivityOverride": { + "readOnly": false, + "type": "string", + "enum": [ + "Relaxed", + "Low", + "Default", + "High" + ], + "x-ms-enum": { + "name": "DdosCustomPolicyTriggerSensitivityOverride", + "modelAsString": true + }, + "description": "The customized DDoS protection trigger rate sensitivity degrees. High: Trigger rate set with most sensitivity w.r.t. normal traffic. Default: Trigger rate set with moderate sensitivity w.r.t. normal traffic. Low: Trigger rate set with less sensitivity w.r.t. normal traffic. Relaxed: Trigger rate set with least sensitivity w.r.t. normal traffic." + } + }, + "description": "DDoS custom policy properties." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ddosProtectionPlan.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ddosProtectionPlan.json new file mode 100644 index 000000000000..e789716acb4b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ddosProtectionPlan.json @@ -0,0 +1,436 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans/{ddosProtectionPlanName}": { + "delete": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_Delete", + "description": "Deletes the specified DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanDelete.json" + } + } + }, + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_Get", + "description": "Gets information about the specified DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the specified DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanGet.json" + } + } + }, + "put": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_CreateOrUpdate", + "description": "Creates or updates a DDoS protection plan.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + }, + "description": "Parameters supplied to the create or update operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create DDoS protection plan": { + "$ref": "./examples/DdosProtectionPlanCreate.json" + } + } + }, + "patch": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_UpdateTags", + "description": "Update a DDoS protection plan tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ddosProtectionPlanName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the DDoS protection plan." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the update DDoS protection plan resource tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting DDoS protection plan resource.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlan" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DDoS protection plan Update tags": { + "$ref": "./examples/DdosProtectionPlanUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ddosProtectionPlans": { + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_List", + "description": "Gets all DDoS protection plans in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of DDoS protection plan resources.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List all DDoS protection plans": { + "$ref": "./examples/DdosProtectionPlanListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ddosProtectionPlans": { + "get": { + "tags": [ + "DdosProtectionPlans" + ], + "operationId": "DdosProtectionPlans_ListByResourceGroup", + "description": "Gets all the DDoS protection plans in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of DDoS protection plan resources.", + "schema": { + "$ref": "#/definitions/DdosProtectionPlanListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List DDoS protection plans in resource group": { + "$ref": "./examples/DdosProtectionPlanList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "DdosProtectionPlan": { + "description": "A DDoS protection plan in a resource group.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DdosProtectionPlanPropertiesFormat", + "description": "Properties of the DDoS protection plan." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + } + }, + "DdosProtectionPlanPropertiesFormat": { + "properties": { + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the DDoS protection plan resource. It uniquely identifies the resource, even if the user changes its name or migrate the resource across subscriptions or resource groups." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the DDoS protection plan resource." + }, + "virtualNetworks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The list of virtual networks associated with the DDoS protection plan resource. This list is read-only." + } + }, + "description": "DDoS protection plan properties." + }, + "DdosProtectionPlanListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DdosProtectionPlan" + }, + "description": "A list of DDoS protection plans." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "A list of DDoS protection plans." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/endpointService.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/endpointService.json new file mode 100644 index 000000000000..5165886a880f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/endpointService.json @@ -0,0 +1,119 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/virtualNetworkAvailableEndpointServices": { + "get": { + "operationId": "AvailableEndpointServices_List", + "description": "List what values of endpoint services are available for use.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location to check available endpoint services." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns list of available endpoint services.", + "schema": { + "$ref": "#/definitions/EndpointServicesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "EndpointServicesList": { + "$ref": "./examples/EndpointServicesList.json" + } + } + } + } + }, + "definitions": { + "EndpointServicesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EndpointServiceResult" + }, + "description": "List of available endpoint services in a region." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListAvailableEndpointServices API service call." + }, + "EndpointServiceResult": { + "properties": { + "name": { + "type": "string", + "description": "Name of the endpoint service.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the endpoint service.", + "readOnly": true + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Endpoint service." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json new file mode 100644 index 000000000000..32fb57e48a9a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableRequestHeadersGet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4" + }, + "responses": { + "200": { + "body": [ + "Accept-Charset" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json new file mode 100644 index 000000000000..a385b26bc967 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableResponseHeadersGet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4" + }, + "responses": { + "200": { + "body": [ + "Access-Control-Allow-Origin" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableServerVariablesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableServerVariablesGet.json new file mode 100644 index 000000000000..09f100379cc2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableServerVariablesGet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "72f988bf-86f1-41af-91ab-2d7cd0dddd4" + }, + "responses": { + "200": { + "body": [ + "request_query" + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsGet.json new file mode 100644 index 000000000000..e66d9214d17e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsGet.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "default", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default", + "type": "Microsoft.Network/ApplicationGatewayAvailableSslOptions", + "properties": { + "predefinedPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20150501" + }, + { + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401" + }, + { + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401S" + } + ], + "defaultPolicy": "AppGwSslPolicy20150501", + "availableCipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" + ], + "availableProtocols": [ + "TLSv1_0", + "TLSv1_1", + "TLSv1_2" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json new file mode 100644 index 000000000000..7d71ebbd36d9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPoliciesGet.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AppGwSslPolicy20150501", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20150501", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_0" + } + }, + { + "name": "AppGwSslPolicy20170401", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_1" + } + }, + { + "name": "AppGwSslPolicy20170401S", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20170401S", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_2" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json new file mode 100644 index 000000000000..05c421d3fccf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableSslOptionsPredefinedPolicyGet.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "predefinedPolicyName": "AppGwSslPolicy20150501" + }, + "responses": { + "200": { + "body": { + "name": "AppGwSslPolicy20150501", + "id": "/subscriptions/subid/resourceGroups//providers/Microsoft.Network/ApplicationGatewayAvailableSslOptions/default/ApplicationGatewaySslPredefinedPolicy/AppGwSslPolicy20150501", + "properties": { + "cipherSuites": [ + "TLS_ECDHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_256_GCM_SHA384", + "TLS_DHE_RSA_WITH_AES_128_GCM_SHA256", + "TLS_DHE_RSA_WITH_AES_256_CBC_SHA", + "TLS_DHE_RSA_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_AES_256_GCM_SHA384", + "TLS_RSA_WITH_AES_128_GCM_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA256", + "TLS_RSA_WITH_AES_128_CBC_SHA256", + "TLS_RSA_WITH_AES_256_CBC_SHA", + "TLS_RSA_WITH_AES_128_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_256_GCM_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_GCM_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA384", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA256", + "TLS_ECDHE_ECDSA_WITH_AES_256_CBC_SHA", + "TLS_ECDHE_ECDSA_WITH_AES_128_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA256", + "TLS_DHE_DSS_WITH_AES_256_CBC_SHA", + "TLS_DHE_DSS_WITH_AES_128_CBC_SHA", + "TLS_RSA_WITH_3DES_EDE_CBC_SHA", + "TLS_DHE_DSS_WITH_3DES_EDE_CBC_SHA" + ], + "minProtocolVersion": "TLSv1_0" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json new file mode 100644 index 000000000000..e2211bb4100d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayAvailableWafRuleSetsGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "OWASP_3.0", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/applicationGatewayAvailableWafRuleSets/", + "type": "Microsoft.Network/applicationGatewayAvailableWafRuleSets", + "properties": { + "provisioningState": "Succeeded", + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0", + "ruleGroups": [ + { + "ruleGroupName": "General", + "description": "", + "rules": [ + { + "ruleId": 200004, + "description": "Possible Multipart Unmatched Boundary." + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayBackendHealthGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayBackendHealthGet.json new file mode 100644 index 000000000000..6002e7ace8fa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayBackendHealthGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "appgw", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "backendAddressPools": [ + { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHttpSettingsCollection": [ + { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.8", + "health": "Up" + } + ] + } + ] + }, + { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFPool" + }, + "backendHttpSettingsCollection": [ + { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.4", + "health": "Up" + }, + { + "address": "10.220.1.5", + "health": "Up" + } + ] + } + ] + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayBackendHealthTest.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayBackendHealthTest.json new file mode 100644 index 000000000000..cdf304399485 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayBackendHealthTest.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "probeRequest": { + "protocol": "Http", + "pickHostNameFromBackendHttpSettings": true, + "path": "/", + "timeout": 30, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + } + } + }, + "responses": { + "200": { + "body": { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendaddressPools/MFAnalyticsPool" + }, + "backendHealthHttpSettings": { + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/MFPoolSettings" + }, + "servers": [ + { + "address": "10.220.1.4", + "health": "Up" + }, + { + "address": "10.220.1.5", + "health": "Up" + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayCreate.json new file mode 100644 index 000000000000..ae3e81d68173 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayCreate.json @@ -0,0 +1,771 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "parameters": { + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "eastus", + "properties": { + "sku": { + "name": "Standard_v2", + "tier": "Standard_v2", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "****", + "password": "****" + } + }, + { + "name": "sslcert2", + "properties": { + "keyVaultSecretId": "https://kv/secret" + } + } + ], + "trustedRootCertificates": [ + { + "name": "rootcert", + "properties": { + "data": "****" + } + }, + { + "name": "rootcert1", + "properties": { + "keyVaultSecretId": "https://kv/secret" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + }, + { + "name": "appgwfp80", + "properties": { + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "properties": { + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "pathRules": [ + { + "name": "apiPaths", + "properties": { + "paths": [ + "/api", + "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "priority": 10, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + }, + { + "name": "appgwPathBasedRule", + "properties": { + "ruleType": "PathBasedRouting", + "priority": 20, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "properties": { + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_add_x_forwarded_for_proxy}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc" + } + } + } + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", + "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "reroute": true + } + } + } + ] + } + } + ], + "probes": [] + } + } + }, + "200": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + }, + "privateLinkConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLinkConfig1" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", + "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "modifiedQueryString": "x=y&a=b" + } + } + } + ] + } + } + ], + "probes": [], + "privateLinkConfigurations": [ + { + "name": "privateLinkConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLinkConfig1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "natNicIpconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLinkConfig1/ipConfigurations/natNicIpconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "primary": true, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayDelete.json new file mode 100644 index 000000000000..7fd928b77d5b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayGet.json new file mode 100644 index 000000000000..ab63f6d37d85 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayGet.json @@ -0,0 +1,294 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "name": "appgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/gatewayIPConfigurations/appgwipc", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert", + "properties": { + "provisioningState": "Succeeded", + "publicCertData": "*****" + } + } + ], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp", + "properties": { + "provisioningState": "Succeeded", + "port": 443 + } + }, + { + "name": "appgwfp80", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + }, + { + "name": "appgwhttplistener", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp80" + }, + "protocol": "Http" + } + } + ], + "urlPathMaps": [ + { + "name": "pathMap1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1", + "properties": { + "provisioningState": "Succeeded", + "defaultBackendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "defaultBackendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "defaultRewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + }, + "pathRules": [ + { + "name": "apiPaths", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1/pathRules/apiPaths", + "properties": { + "provisioningState": "Succeeded", + "paths": [ + "/api", + "/v1/api" + ], + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + } + ] + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwrule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "priority": 10, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + }, + "rewriteRuleSet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1" + } + } + }, + { + "name": "appgwPathBasedRule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/requestRoutingRules/appgwPathBasedRule", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "PathBasedRouting", + "priority": 20, + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhttplistener" + }, + "urlPathMap": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/urlPathMaps/pathMap1" + } + } + } + ], + "rewriteRuleSets": [ + { + "name": "rewriteRuleSet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/rewriteRuleSets/rewriteRuleSet1", + "properties": { + "provisioningState": "Succeeded", + "rewriteRules": [ + { + "name": "Set X-Forwarded-For", + "ruleSequence": 102, + "conditions": [ + { + "variable": "http_req_Authorization", + "pattern": "^Bearer", + "ignoreCase": true, + "negate": false + } + ], + "actionSet": { + "requestHeaderConfigurations": [ + { + "headerName": "X-Forwarded-For", + "headerValue": "{var_remote-addr}" + } + ], + "responseHeaderConfigurations": [ + { + "headerName": "Strict-Transport-Security", + "headerValue": "max-age=31536000" + } + ], + "urlConfiguration": { + "modifiedPath": "/abc", + "modifiedQueryString": "x=y&a=b", + "reroute": false + } + } + } + ] + } + } + ], + "probes": [], + "privateLinkConfigurations": [ + { + "name": "privateLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "natNicIpconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "primary": true, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + }, + { + "name": "natNicIpconfig2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkConfigurations/privateLink1/privateLinkConfigurations/privateLink1/ipConfigurations/natNicIpconfig2", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/virtualNetwork1/subnets/appgwsubnet" + } + } + } + ] + } + } + ], + "privateEndpointConnections": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayList.json new file mode 100644 index 000000000000..5fd6c52da529 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayList.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "base64-pfxData", + "password": "pass1" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayListAll.json new file mode 100644 index 000000000000..8164ed6b71e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayListAll.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "appgw", + "type": "Microsoft.Network/applicationGateways", + "location": "southcentralus", + "properties": { + "sku": { + "name": "Standard_Medium", + "tier": "Standard", + "capacity": 3 + }, + "gatewayIPConfigurations": [ + { + "name": "appgwipc", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/appgwsubnet" + } + } + } + ], + "sslCertificates": [ + { + "name": "sslcert", + "properties": { + "data": "base64-pfxData", + "password": "pass1" + } + } + ], + "frontendIPConfigurations": [ + { + "name": "appgwfip", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/appgwpip" + } + } + } + ], + "frontendPorts": [ + { + "name": "appgwfp", + "properties": { + "port": 443 + } + } + ], + "backendAddressPools": [ + { + "name": "appgwpool", + "properties": { + "backendAddresses": [ + { + "ipAddress": "10.0.1.1" + }, + { + "ipAddress": "10.0.1.2" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "appgwbhs", + "properties": { + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "appgwhl", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendIPConfigurations/appgwfip" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/frontendPorts/appgwfp" + }, + "protocol": "Https", + "sslCertificate": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/sslCertificates/sslcert" + }, + "requireServerNameIndication": false + } + } + ], + "requestRoutingRules": [ + { + "name": "appgwrule", + "properties": { + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/httpListeners/appgwhl" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendAddressPools/appgwpool" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/backendHttpSettingsCollection/appgwbhs" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json new file mode 100644 index 000000000000..d4a1fde0f818 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "connectionName": "connection1" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json new file mode 100644 index 000000000000..8050a44736a8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "connectionName": "connection1" + }, + "responses": { + "200": { + "body": { + "name": "coonection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/connection1", + "type": "Microsoft.Network/applicationGateways/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approval Done" + }, + "linkIdentifier": "805319460" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json new file mode 100644 index 000000000000..8d8a67e89a94 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "coonection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/connection1", + "type": "Microsoft.Network/applicationGateways/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Approval Done" + }, + "linkIdentifier": "805319460" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json new file mode 100644 index 000000000000..14af12cd9540 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateEndpointConnectionUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw", + "connectionName": "connection1", + "parameters": { + "name": "connection1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId2/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + }, + "linkIdentifier": "linkId" + } + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateLinkResourceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateLinkResourceList.json new file mode 100644 index 000000000000..1dc3afec7b9a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayPrivateLinkResourceList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "privateLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/appgw/privateLinkResources/privateLink1", + "type": "Microsoft.Network/applicationGateways/privateLinkResources", + "properties": { + "groupId": "privateLink1", + "requiredMembers": [ + "privateLink1" + ], + "requiredZoneNames": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayStart.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayStart.json new file mode 100644 index 000000000000..459cfbca2283 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayStop.json new file mode 100644 index 000000000000..459cfbca2283 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "appgw" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayUpdateTags.json new file mode 100644 index 000000000000..813ce7051bca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationGatewayUpdateTags.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationGatewayName": "AppGw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "AppGw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw", + "type": "Microsoft.Network/applicationGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "sku": { + "name": "Standard_Small", + "tier": "Standard", + "capacity": 2 + }, + "operationalState": "Running", + "gatewayIPConfigurations": [ + { + "name": "GatewayIp01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/gatewayIPConfigurations/GatewayIp01", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet1" + } + } + } + ], + "sslCertificates": [], + "authenticationCertificates": [], + "frontendIPConfigurations": [ + { + "name": "FrontEndConfig01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/publicIp1" + } + } + } + ], + "frontendPorts": [ + { + "name": "FrontEndPort01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01", + "properties": { + "provisioningState": "Succeeded", + "port": 80 + } + } + ], + "backendAddressPools": [ + { + "name": "Pool01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01", + "properties": { + "provisioningState": "Succeeded", + "backendAddresses": [ + { + "ipAddress": "10.10.10.1" + }, + { + "ipAddress": "10.10.10.2" + }, + { + "ipAddress": "10.10.10.3" + } + ] + } + } + ], + "backendHttpSettingsCollection": [ + { + "name": "PoolSetting01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01", + "properties": { + "provisioningState": "Succeeded", + "port": 80, + "protocol": "Http", + "cookieBasedAffinity": "Disabled", + "pickHostNameFromBackendAddress": false, + "requestTimeout": 30 + } + } + ], + "httpListeners": [ + { + "name": "listener1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendIPConfigurations/FrontEndConfig01" + }, + "frontendPort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/frontendPorts/FrontEndPort01" + }, + "protocol": "Http", + "requireServerNameIndication": false + } + } + ], + "urlPathMaps": [], + "requestRoutingRules": [ + { + "name": "Rule01", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/requestRoutingRules/Rule01", + "properties": { + "provisioningState": "Succeeded", + "ruleType": "Basic", + "httpListener": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/httpListeners/listener1" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendAddressPools/Pool01" + }, + "backendHttpSettings": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationGateways/AppGw/backendHttpSettingsCollection/PoolSetting01" + } + } + } + ], + "probes": [], + "redirectConfigurations": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupCreate.json new file mode 100644 index 000000000000..c85ab5617ab9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupCreate.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg", + "parameters": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + }, + "201": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupDelete.json new file mode 100644 index 000000000000..f789808ee057 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupGet.json new file mode 100644 index 000000000000..7216a0ef880f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg" + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupList.json new file mode 100644 index 000000000000..55162ce81127 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg1", + "name": "asg1", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg2", + "name": "asg2", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupListAll.json new file mode 100644 index 000000000000..3d370a770056 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupListAll.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg1", + "name": "asg1", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/asg2", + "name": "asg2", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupUpdateTags.json new file mode 100644 index 000000000000..605de299a759 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ApplicationSecurityGroupUpdateTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "applicationSecurityGroupName": "test-asg", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-asg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/applicationSecurityGroups/test-asg", + "type": "Microsoft.Network/applicationSecurityGroups", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AutoApprovedPrivateLinkServicesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AutoApprovedPrivateLinkServicesGet.json new file mode 100644 index 000000000000..3b46079a0e9a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AutoApprovedPrivateLinkServicesGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "location": "regionName", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls3" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json new file mode 100644 index 000000000000..e6bab235a153 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "location": "regionName", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2" + }, + { + "privateLinkService": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls3" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableDelegationsResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableDelegationsResourceGroupGet.json new file mode 100644 index 000000000000..20a6026b42a9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableDelegationsResourceGroupGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "location": "westcentralus", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableDelegationsSubscriptionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableDelegationsSubscriptionGet.json new file mode 100644 index 000000000000..9454f2aafaf7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableDelegationsSubscriptionGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "location": "westcentralus", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Provider.resourceType", + "id": "/subscriptions/subId/providers/Microsoft.Network/availableDelegations/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availableDelegations", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/resource/action" + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailablePrivateEndpointTypesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailablePrivateEndpointTypesGet.json new file mode 100644 index 000000000000..4d0387658986 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailablePrivateEndpointTypesGet.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "location": "regionName", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/providers/Microsoft.Network/availablePrivateEndpointTypes/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availablePrivateEndpointTypes", + "resourceName": "Microsoft.Provider/resourceType" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json new file mode 100644 index 000000000000..d30df0e455d4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailablePrivateEndpointTypesResourceGroupGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "location": "regionName", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/availablePrivateEndpointTypes/Microsoft.Provider.resourceType", + "type": "Microsoft.Network/availablePrivateEndpointTypes", + "resourceName": "Microsoft.Provider/resourceType" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableServiceAliasesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableServiceAliasesList.json new file mode 100644 index 000000000000..9f79af94cfd6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableServiceAliasesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "location": "westcentralus", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "servicesAzure", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzure", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure" + }, + { + "name": "servicesAzureManagedInstance", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzureManagedInstance", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure/ManagedInstance" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableServiceAliasesListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableServiceAliasesListByResourceGroup.json new file mode 100644 index 000000000000..274ca173ca39 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AvailableServiceAliasesListByResourceGroup.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "location": "westcentralus", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "servicesAzure", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzure", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure" + }, + { + "name": "servicesAzureManagedInstance", + "id": "/subscriptions/subId/providers/Microsoft.Network/AvailableServiceAliases/servicesAzureManagedInstance", + "type": "Microsoft.Network/AvailableServiceAliases", + "resourceName": "/services/Azure/ManagedInstance" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallDelete.json new file mode 100644 index 000000000000..f49a332cb79c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallFqdnTagsListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallFqdnTagsListBySubscription.json new file mode 100644 index 000000000000..a38fd17f89c4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallFqdnTagsListBySubscription.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "azfwfqdntag", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewallFqdnTags/azfwfqdntag", + "type": "Microsoft.Network/azureFirewallFqdnTags", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "fqdnTagName": "azfwfqdntag" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGet.json new file mode 100644 index 000000000000..6769e23be355 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGet.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithAdditionalProperties.json new file mode 100644 index 000000000000..aad199ca2520 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithAdditionalProperties.json @@ -0,0 +1,179 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithIpGroups.json new file mode 100644 index 000000000000..ccf78baecce6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithIpGroups.json @@ -0,0 +1,189 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups3" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [ + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "changeNumber": "5" + }, + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2", + "changeNumber": "4" + }, + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups3", + "changeNumber": "1" + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithMgmtSubnet.json new file mode 100644 index 000000000000..fb5dcf8eb7e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithMgmtSubnet.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithZones.json new file mode 100644 index 000000000000..8b51895be2ee --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallGetWithZones.json @@ -0,0 +1,181 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall" + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US 2", + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallListByResourceGroup.json new file mode 100644 index 000000000000..f1aaf75212f9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallListByResourceGroup.json @@ -0,0 +1,193 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallListBySubscription.json new file mode 100644 index 000000000000..25a3612601ff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallListBySubscription.json @@ -0,0 +1,192 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewallgw/ipConfigurations/azureFirewallMgmtIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPut.json new file mode 100644 index 000000000000..ec517caa08d8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPut.json @@ -0,0 +1,497 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutInHub.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutInHub.json new file mode 100644 index 000000000000..afb86ae26c94 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutInHub.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_Hub", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "firewallPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/policy1" + }, + "hubIPAddresses": { + "publicIPs": { + "addresses": [], + "count": 1 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_Hub", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "firewallPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/policy1" + }, + "hubIPAddresses": { + "publicIPs": { + "addresses": [ + { + "address": "13.73.240.12" + } + ], + "count": 1 + }, + "privateIPAddress": "10.0.0.0" + }, + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_Hub", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "firewallPolicy": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/policy1" + }, + "hubIPAddresses": { + "publicIPs": { + "addresses": [ + { + "address": "13.73.240.12" + } + ], + "count": 1 + }, + "privateIPAddress": "10.0.0.0" + }, + "ipGroups": [], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithAdditionalProperties.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithAdditionalProperties.json new file mode 100644 index 000000000000..8a6f988eaf1a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithAdditionalProperties.json @@ -0,0 +1,507 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": { + "key1": "value1", + "key2": "value2" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithIpGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithIpGroups.json new file mode 100644 index 000000000000..b150e6a1b9c8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithIpGroups.json @@ -0,0 +1,505 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationIpGroups": [ + "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [ + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "changeNumber": "5" + }, + { + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups2", + "changeNumber": "4" + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithMgmtSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithMgmtSubnet.json new file mode 100644 index 000000000000..d2654c5ad5e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithMgmtSubnet.json @@ -0,0 +1,507 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "zones": [], + "properties": { + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "managementIpConfiguration": { + "name": "azureFirewallMgmtIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallManagementSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/managementPipName" + } + } + }, + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedPort": "880", + "translatedFqdn": "internalhttpserver" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "protocols": [ + "TCP" + ], + "destinationFqdns": [ + "www.amazon.com" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "zones": [], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithZones.json new file mode 100644 index 000000000000..5eedc2cdb1a0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallPutWithZones.json @@ -0,0 +1,509 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "azureFirewallName": "azurefirewall", + "parameters": { + "location": "West US 2", + "tags": { + "key1": "value1" + }, + "zones": [ + "1", + "2", + "3" + ], + "properties": { + "threatIntelMode": "Alert", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US 2", + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "ipGroups": [], + "additionalProperties": {} + } + } + }, + "201": { + "body": { + "name": "azurefirewall", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall", + "type": "Microsoft.Network/azureFirewalls", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US 2", + "zones": [ + "1", + "2", + "3" + ], + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "sku": { + "name": "AZFW_VNet", + "tier": "Standard" + }, + "threatIntelMode": "Alert", + "ipConfigurations": [ + { + "name": "azureFirewallIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azfirewallgw/ipConfigurations/azureFirewallIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.0", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/AzureFirewallSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ], + "applicationRuleCollections": [ + { + "name": "apprulecoll", + "properties": { + "priority": 110, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "rule1", + "description": "Deny inbound rule", + "protocols": [ + { + "protocolType": "Https", + "port": 443 + } + ], + "targetFqdns": [ + "www.test.com" + ], + "sourceAddresses": [ + "216.58.216.164", + "10.0.0.0/24" + ] + } + ] + } + } + ], + "natRuleCollections": [ + { + "name": "natrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Dnat" + }, + "rules": [ + { + "name": "DNAT-HTTPS-traffic", + "description": "D-NAT all outbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "443" + ], + "protocols": [ + "TCP" + ], + "translatedAddress": "1.2.3.5", + "translatedPort": "8443" + }, + { + "name": "DNAT-HTTP-traffic-With-FQDN", + "description": "D-NAT all inbound web traffic for inspection", + "sourceAddresses": [ + "*" + ], + "destinationAddresses": [ + "1.2.3.4" + ], + "destinationPorts": [ + "80" + ], + "protocols": [ + "TCP" + ], + "translatedFqdn": "internalhttpserver", + "translatedPort": "880" + } + ] + } + } + ], + "networkRuleCollections": [ + { + "name": "netrulecoll", + "properties": { + "priority": 112, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "L4-traffic", + "description": "Block traffic based on source IPs and ports", + "sourceAddresses": [ + "192.168.1.1-192.168.1.12", + "10.1.4.12-10.1.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationAddresses": [ + "*" + ], + "protocols": [ + "TCP" + ] + }, + { + "name": "L4-traffic-with-FQDN", + "description": "Block traffic based on source IPs and ports to amazon", + "sourceAddresses": [ + "10.2.4.12-10.2.4.255" + ], + "destinationPorts": [ + "443-444", + "8443" + ], + "destinationFqdns": [ + "www.amazon.com" + ], + "protocols": [ + "TCP" + ] + } + ] + } + } + ], + "additionalProperties": {} + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallUpdateTags.json new file mode 100644 index 000000000000..13851342a491 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/AzureFirewallUpdateTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "azfwtest", + "azureFirewallName": "fw1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "fw1", + "id": "/subscriptions/subid/resourceGroups/azfwtest/providers/Microsoft.Network/azureFirewalls/fw1", + "type": "Microsoft.Network/azureFirewalls", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostDelete.json new file mode 100644 index 000000000000..8ee66c76baad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostGet.json new file mode 100644 index 000000000000..7a3250f8aaa5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant'" + }, + "responses": { + "200": { + "body": { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostListByResourceGroup.json new file mode 100644 index 000000000000..72a113d311ec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostListBySubscription.json new file mode 100644 index 000000000000..24547e97ef8e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostListBySubscription.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostPut.json new file mode 100644 index 000000000000..5ea5e56dd4ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionHostPut.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant'", + "parameters": { + "properties": { + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "bastionhost'", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant'", + "type": "Microsoft.Network/bastionHosts", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "properties": { + "provisioningState": "Succeeded", + "dnsName": "bst-9d89d361-100e-4c01-b92d-466548c476dc.bastion.azure.com", + "ipConfigurations": [ + { + "name": "bastionHostIpConfiguration", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/bastionHosts/bastionhosttenant/bastionHostIpConfigurations/bastionHostIpConfiguration", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/bastionHosts/bastionHostIpConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/BastionHostSubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pipName" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionSessionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionSessionDelete.json new file mode 100644 index 000000000000..8480e242f24c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionSessionDelete.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "sessionIds": [ + "session1", + "session2", + "session3" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sessionId": "session1", + "message": "session session1 invalidated!", + "state": "Disconnected" + }, + { + "sessionId": "session2", + "message": "session session2 could not be disconnected!", + "state": "Failed" + }, + { + "sessionId": "session3", + "message": "session session3 not found!", + "state": "NotFound" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionSessionsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionSessionsList.json new file mode 100644 index 000000000000..ddd9548be167 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionSessionsList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sessionId": "sessionId", + "startTime": "2019-1-1T12:00:00.0000Z", + "targetSubscriptionId": "subid", + "resourceType": "VM", + "targetHostName": "vm01", + "targetResourceGroup": "rg1", + "userName": "user", + "targetIpAddress": "1.1.1.1", + "protocol": "SSH", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm01", + "sessionDurationInMins": 0.0 + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkCreate.json new file mode 100644 index 000000000000..ac47bcd31759 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkCreate.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslRequest": { + "vms": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm1", + "createdAt": "2019-10-18T12:00:00.0000Z" + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm2", + "createdAt": "2019-10-17T12:00:00.0000Z" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkDelete.json new file mode 100644 index 000000000000..7e607e8bef72 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslRequest": { + "vms": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + } + } + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkGet.json new file mode 100644 index 000000000000..b479471c17d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/BastionShareableLinkGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "bastionHostName": "bastionhosttenant", + "bslRequest": { + "vms": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm1", + "createdAt": "2019-10-18T12:00:00.0000Z" + }, + { + "vm": { + "id": "/subscriptions/subid/resourceGroups/rgx/providers/Microsoft.Compute/virtualMachines/vm2" + }, + "bsl": "http://bst-bastionhostid.bastion.com/api/shareable-url/tokenvm2", + "createdAt": "2019-10-17T12:00:00.0000Z" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckDnsNameAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckDnsNameAvailability.json new file mode 100644 index 000000000000..7bdf07511610 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckDnsNameAvailability.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "location": "westus", + "domainNameLabel": "testdns" + }, + "responses": { + "200": { + "body": { + "available": false + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibility.json new file mode 100644 index 000000000000..90eae91deb38 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibility.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "location": "westus", + "parameters": { + "privateLinkServiceAlias": "mypls.00000000-0000-0000-0000-000000000000.azure.privatelinkservice" + } + }, + "responses": { + "200": { + "body": { + "visible": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json new file mode 100644 index 000000000000..db32cdcb2184 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "location": "westus", + "resourceGroupName": "rg1", + "parameters": { + "privateLinkServiceAlias": "mypls.00000000-0000-0000-0000-000000000000.azure.privatelinkservice" + } + }, + "responses": { + "200": { + "body": { + "visible": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyCreate.json new file mode 100644 index 000000000000..52b54d34e1c6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyCreate.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy", + "parameters": { + "location": "centraluseuap", + "properties": { + "protocolCustomSettings": [ + { + "protocol": "Tcp" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [], + "protocolCustomSettings": [ + { + "protocol": "Tcp", + "triggerRateOverride": "20000" + } + ] + } + } + }, + "201": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [], + "protocolCustomSettings": [ + { + "protocol": "Tcp", + "triggerRateOverride": "20000" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyDelete.json new file mode 100644 index 000000000000..c176ebc8b503 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy", + "parameters": { + "properties": {} + } + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyGet.json new file mode 100644 index 000000000000..9789716598c1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy" + }, + "responses": { + "200": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyUpdateTags.json new file mode 100644 index 000000000000..f64bfe740555 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosCustomPolicyUpdateTags.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosCustomPolicyName": "test-ddos-custom-policy", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ddos-custom-policy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosCustomPolicies/test-ddos-custom-policy", + "type": "Microsoft.Network/ddosCustomPolicies", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "publicIPAddresses": [], + "protocolCustomSettings": [ + { + "protocol": "Tcp", + "triggerRateOverride": "20000" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanCreate.json new file mode 100644 index 000000000000..538098674a91 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan", + "parameters": { + "location": "westus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [] + } + } + }, + "201": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanDelete.json new file mode 100644 index 000000000000..d487a82fc923 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanGet.json new file mode 100644 index 000000000000..1699a56e1acf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan" + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanList.json new file mode 100644 index 000000000000..cb30ffda3736 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1", + "name": "plan1", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2", + "name": "plan2", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanListAll.json new file mode 100644 index 000000000000..9e5a21f6457a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanListAll.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan1", + "name": "plan1", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet1" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/plan2", + "name": "plan2", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet3" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanUpdateTags.json new file mode 100644 index 000000000000..7c1d08774490 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DdosProtectionPlanUpdateTags.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ddosProtectionPlanName": "test-plan", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-plan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ddosProtectionPlans/test-plan", + "type": "Microsoft.Network/ddosProtectionPlans", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworks": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DefaultSecurityRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DefaultSecurityRuleGet.json new file mode 100644 index 000000000000..cd4c45079a99 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DefaultSecurityRuleGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1", + "defaultSecurityRuleName": "AllowVnetInBound" + }, + "responses": { + "200": { + "body": { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DefaultSecurityRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DefaultSecurityRuleList.json new file mode 100644 index 000000000000..907d84c91ecd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/DefaultSecurityRuleList.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "networkSecurityGroupName": "nsg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound", + "sourcePortRanges": [], + "destinationPortRanges": [], + "sourceAddressPrefixes": [], + "destinationAddressPrefixes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForConnection.json new file mode 100644 index 000000000000..b279686ffaec --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForConnection.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2020-05-01", + "effectiveRoutesParameters": { + "resourceId": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "virtualWanResourceType": "ExpressRouteConnection" + } + }, + "responses": { + "200": { + "description": "Request successful. Follow the location header for the effective routes list." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForRouteTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForRouteTable.json new file mode 100644 index 000000000000..2ba6b6e83e6b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForRouteTable.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2020-05-01", + "effectiveRoutesParameters": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "virtualWanResourceType": "RouteTable" + } + }, + "responses": { + "200": { + "description": "Request successful. Follow the location header for the effective routes list." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForVirtualHub.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForVirtualHub.json new file mode 100644 index 000000000000..4b9d8a96389e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EffectiveRoutesListForVirtualHub.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "virtualHub1", + "api-version": "2020-05-01", + "effectiveRoutesParameters": null + }, + "responses": { + "200": { + "description": "Request successful. Follow the location header for the effective routes list." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EndpointServicesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EndpointServicesList.json new file mode 100644 index 000000000000..8f3cf62d5d7a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/EndpointServicesList.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Storage", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Storage", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.Sql", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.Sql", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + }, + { + "name": "Microsoft.AzureActiveDirectory", + "id": "/subscriptions/subid/providers/Microsoft.Network/virtualNetworkEndpointServices/Microsoft.AzureActiveDirectory", + "type": "Microsoft.Network/virtualNetworkEndpointServices" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitARPTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitARPTableList.json new file mode 100644 index 000000000000..e2b7e84bae25 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitARPTableList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "age": 0, + "interface": "Microsoft", + "ipAddress": "IPAddress", + "macAddress": "macAddress" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationCreate.json new file mode 100644 index 000000000000..7f1122c0729b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "authorizationName": "authorizatinName", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "authorizationParameters": { + "properties": {} + } + }, + "responses": { + "201": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/authorizationName", + "etag": "W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties": { + "provisioningState": "Updating", + "authorizationUseStatus": "Available" + } + } + }, + "200": { + "body": { + "name": "authorizationName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/authorizationName", + "etag": "W/\"e22dd4b2-4c24-44cf-b702-70a472b62914\"", + "properties": { + "provisioningState": "Updating", + "authorizationUseStatus": "Available" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationDelete.json new file mode 100644 index 000000000000..70c3664e188a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationGet.json new file mode 100644 index 000000000000..6ea4c392d0b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "authorizationName": "authorizationName" + }, + "responses": { + "200": { + "body": { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available" + }, + "type": "Microsoft.Network/expressRouteCircuits/authorizations" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationList.json new file mode 100644 index 000000000000..a68bbea0f5ca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitAuthorizationList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authKey", + "authorizationUseStatus": "Available" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionCreate.json new file mode 100644 index 000000000000..de3bdbe29b74 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionCreate.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering", + "type": "Microsoft.Network/expressRouteCircuits/peerings/connections", + "expressRouteCircuitConnectionParameters": { + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/29", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::/125" + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionDelete.json new file mode 100644 index 000000000000..2febfeeb30d5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering", + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionGet.json new file mode 100644 index 000000000000..30d9ee4fb700 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "connectionName": "circuitConnectionUSAUS", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + }, + "type": "Microsoft.Network/expressRouteCircuits/peerings/connections" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionList.json new file mode 100644 index 000000000000..41a7434f98c1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitConnectionList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSAUS", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSAUS", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/dedharcktpeer/providers/Microsoft.Network/expressRouteCircuits/dedharcktremote/peerings/AzurePrivatePeering" + }, + "authorizationKey": "946a1918-b7a2-4917-b43c-8c4cdaee006a", + "addressPrefix": "10.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded", + "ipv6CircuitConnectionConfig": { + "addressPrefix": "aa:bb::1/125", + "circuitConnectionStatus": "Connected" + } + } + }, + { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/connections/circuitConnectionUSEUR", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "circuitConnectionUSEUR", + "properties": { + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharcktinit/providers/Microsoft.Network/expressRouteCircuits/dedharcktlocal/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/dedharckteurope/providers/Microsoft.Network/expressRouteCircuits/dedharcktams/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/24", + "circuitConnectionStatus": "Connected", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitCreate.json new file mode 100644 index 000000000000..8a0f2ba4374f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitCreate.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "parameters": { + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + }, + "properties": { + "authorizations": [], + "peerings": [], + "allowClassicOperations": false, + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 200 + } + }, + "location": "Brazil South" + } + }, + "responses": { + "201": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "Brazil South", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + }, + "200": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "Brazil South", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json new file mode 100644 index 000000000000..dcec2c7159a7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitCreateOnExpressRoutePort.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "type": "Microsoft.Network/expressRouteCircuits", + "circuitName": "expressRouteCircuit1", + "parameters": { + "location": "westus", + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + }, + "properties": { + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName" + }, + "bandwidthInGbps": 10 + } + } + }, + "responses": { + "200": { + "body": { + "name": "expressRouteCircuit1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuit1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName" + }, + "bandwidthInGbps": 10, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "20", + "serviceKey": "d281f746-ee01-4d00-8b0a-edec4833772b", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + } + } + }, + "201": { + "body": { + "name": "expressRouteCircuit1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/expressRouteCircuit1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "expressRoutePort": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName" + }, + "bandwidthInGbps": 10, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "20", + "serviceKey": "d281f746-ee01-4d00-8b0a-edec4833772b", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Premium_MeteredData", + "tier": "Premium", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitDelete.json new file mode 100644 index 000000000000..6ec2429eada6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitGet.json new file mode 100644 index 000000000000..7060f3a3d72d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "circuitName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "serviceKey": "a1410692-0000-4ceb-b94a-b90b94d398d1", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitListByResourceGroup.json new file mode 100644 index 000000000000..09672d5988d8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitListByResourceGroup.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "circuitName1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "113", + "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + }, + { + "name": "circuitName2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitListBySubscription.json new file mode 100644 index 000000000000..a969719774ac --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitListBySubscription.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "circuitName1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/authorizations/MyAuthorization1", + "etag": "W/\"832b28c3-f5fd-4d2a-a2cb-6e4a2fe452b3\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "113", + "serviceKey": "a1410692-ed3b-4ceb-b94a-b90b95d398d1", + "serviceProviderProvisioningState": "Provisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + }, + { + "name": "circuitName2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peerings": [], + "authorizations": [ + { + "name": "MyAuthorization2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName2/authorizations/MyAuthorization2", + "etag": "W/\"e33c875f-48df-4a91-b7d3-eb95b5ddbb89\"", + "properties": { + "provisioningState": "Succeeded", + "authorizationKey": "authkey", + "authorizationUseStatus": "Available" + } + } + ], + "serviceProviderProperties": { + "serviceProviderName": "providerName", + "peeringLocation": "peeringLocation", + "bandwidthInMbps": 200 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "6569625a-9ba4-498b-9719-14d778eef609", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringCreate.json new file mode 100644 index 000000000000..ec3200598801 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringCreate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "peeringParameters": { + "properties": { + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "vlanId": 200 + } + } + }, + "responses": { + "201": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName" + } + } + } + }, + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringDelete.json new file mode 100644 index 000000000000..b81cbc458413 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "peeringName": "peeringName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringGet.json new file mode 100644 index 000000000000..ed47ea25dfeb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringGet.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "peeringName": "MicrosoftPeering" + }, + "responses": { + "200": { + "body": { + "name": "MicrosoftPeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "MicrosoftPeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "123.0.0.0/30", + "secondaryPeerAddressPrefix": "123.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 300, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "123.1.0.0/24" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + }, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "3FFE:FFFF:0:CD31::/120" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + } + }, + "routeFilter": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName" + } + }, + "type": "Microsoft.Network/expressRouteCircuits/peerings" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringList.json new file mode 100644 index 000000000000..fe27bfcfaeff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringList.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "MicrosoftPeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/MicrosoftPeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "MicrosoftPeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "123.0.0.0/30", + "secondaryPeerAddressPrefix": "123.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 300, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "123.1.0.0/24" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + }, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled", + "microsoftPeeringConfig": { + "advertisedPublicPrefixes": [ + "3FFE:FFFF:0:CD31::/120" + ], + "advertisedCommunities": [], + "advertisedPublicPrefixesState": "ValidationNeeded", + "customerASN": 23, + "legacyMode": 0, + "routingRegistryName": "ARIN" + } + }, + "expressRouteConnection": "" + } + }, + { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering", + "etag": "W/\"b2a25b98-2e6d-4d46-87f2-089de5f6fdf9\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 100, + "primaryPeerAddressPrefix": "10.0.0.0/30", + "secondaryPeerAddressPrefix": "10.0.0.4/30", + "primaryAzurePort": "A51-TEST-06GMR-CIS-1-PRI-A", + "secondaryAzurePort": "A51-TEST-06GMR-CIS-2-SEC-A", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "103", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + }, + "expressRouteConnection": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringStats.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringStats.json new file mode 100644 index 000000000000..23f8d8d884d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitPeeringStats.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "peeringName": "peeringName" + }, + "responses": { + "200": { + "body": { + "primarybytesIn": 537408, + "primarybytesOut": 44032550, + "secondarybytesIn": 0, + "secondarybytesOut": 39002500 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitRouteTableList.json new file mode 100644 index 000000000000..699515de6639 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitRouteTableList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "network": "", + "nextHop": "", + "locPrf": "", + "weight": 0, + "path": "" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitRouteTableSummaryList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitRouteTableSummaryList.json new file mode 100644 index 000000000000..145adedec159 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitRouteTableSummaryList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "peeringName": "peeringName", + "devicePath": "devicePath" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "neighbor": "100.65.171.1", + "v": 4, + "as": 9583, + "upDown": "never", + "statePfxRcd": "Idle" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitStats.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitStats.json new file mode 100644 index 000000000000..877a351fccb9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitStats.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "circuitName": "circuitName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primarybytesIn": 537408, + "primarybytesOut": 44032550, + "secondarybytesIn": 0, + "secondarybytesOut": 39002500 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitUpdateTags.json new file mode 100644 index 000000000000..095feb4e6fa6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCircuitUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "ertest", + "circuitName": "er1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1", + "type": "Microsoft.Network/expressRouteCircuits", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "peerings": [], + "authorizations": [], + "serviceProviderProperties": { + "serviceProviderName": "Equinix", + "peeringLocation": "Silicon Valley", + "bandwidthInMbps": 1000 + }, + "circuitProvisioningState": "Enabled", + "allowClassicOperations": false, + "gatewayManagerEtag": "", + "serviceKey": "0b392c2e-1e9d-46d7-b5e0-9ce90ca6b60c", + "serviceProviderProvisioningState": "NotProvisioned" + }, + "sku": { + "name": "Standard_MeteredData", + "tier": "Standard", + "family": "MeteredData" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionCreate.json new file mode 100644 index 000000000000..b73d7f946c3e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionCreate.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "expressRouteGatewayName": "gateway-2", + "resourceGroupName": "resourceGroupName", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "connectionName": "connectionName", + "putExpressRouteConnectionParameters": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2/expressRouteConnections/connectionName", + "name": "connectionName", + "properties": { + "routingWeight": 2, + "authorizationKey": "authorizationKey", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 2, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + }, + "201": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 2, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionDelete.json new file mode 100644 index 000000000000..4cf7614048a6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "connectionName": "connectionName", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionGet.json new file mode 100644 index 000000000000..1573a23873e4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionGet.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "connectionName": "connectionName" + }, + "responses": { + "200": { + "body": { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 1, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionList.json new file mode 100644 index 000000000000..8b809fb9589b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteConnectionList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "resourceGroupName", + "expressRouteGatewayName": "expressRouteGatewayName", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "authorizationKey", + "routingWeight": 1, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json new file mode 100644 index 000000000000..9ec8f96e55bb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringCreate.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "peeringParameters": { + "properties": { + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "vlanId": 200, + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + }, + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json new file mode 100644 index 000000000000..acadde9c69c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json new file mode 100644 index 000000000000..5d8253212129 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-Boydton1DC/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json new file mode 100644 index 000000000000..661c0f014126 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionBgpPeeringList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "AzurePrivatePeering", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections//peerings/AzurePrivatePeering", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peeringType": "AzurePrivatePeering", + "azureASN": 12076, + "peerASN": 200, + "primaryPeerAddressPrefix": "192.168.16.252/30", + "secondaryPeerAddressPrefix": "192.168.18.252/30", + "primaryAzurePort": "", + "secondaryAzurePort": "", + "state": "Enabled", + "vlanId": 200, + "gatewayManagerEtag": "", + "lastModifiedBy": "Customer", + "ipv6PeeringConfig": { + "primaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::/126", + "secondaryPeerAddressPrefix": "3FFE:FFFF:0:CD30::4/126", + "state": "Enabled" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionGet.json new file mode 100644 index 000000000000..21f526730989 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "CrossConnection-SiliconValley", + "crossConnectionName": "" + }, + "responses": { + "200": { + "body": { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnection-SiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "etag": "W/\"c0e6477e-8150-4d4f-9bf6-bb10e6acb63a\"", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionList.json new file mode 100644 index 000000000000..41b117dfe4e1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json new file mode 100644 index 000000000000..6d7ff10f344e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionListByResourceGroup.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "CrossConnection-SiliconValley", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSilicon-Valley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionUpdate.json new file mode 100644 index 000000000000..2dcb8cba695c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "CrossConnection-SiliconValley", + "crossConnectionName": "", + "parameters": { + "properties": { + "serviceProviderProvisioningState": "NotProvisioned" + } + } + }, + "responses": { + "200": { + "body": { + "name": "", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "properties": { + "provisioningState": "Enabled", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionUpdateTags.json new file mode 100644 index 000000000000..cece90a7d84f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionUpdateTags.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "CrossConnection-SiliconValley", + "crossConnectionName": "", + "crossConnectionParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "er1", + "id": "/subscriptions/subid/resourceGroups/CrossConnectionSiliconValley/providers/Microsoft.Network/expressRouteCrossConnections/", + "type": "Microsoft.Network/expressRouteCrossConnections", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Failed", + "expressRouteCircuit": { + "id": "/subscriptions/subid/resourceGroups/ertest/providers/Microsoft.Network/expressRouteCircuits/er1" + }, + "peerings": [], + "peeringLocation": "SiliconValley", + "bandwidthInMbps": 1000, + "primaryAzurePort": "bvtazureixp01", + "secondaryAzurePort": "bvtazureixp01", + "sTag": 2, + "serviceProviderProvisioningState": "NotProvisioned" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsArpTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsArpTable.json new file mode 100644 index 000000000000..acc5f6a2608f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsArpTable.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "age": 0, + "interface": "Microsoft", + "ipAddress": "192.116.14.254", + "macAddress": "885a.9269.9110" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsRouteTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsRouteTable.json new file mode 100644 index 000000000000..83b44c63b2e1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsRouteTable.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "network": "10.6.0.0/16", + "nextHop": "10.6.1.12", + "locPrf": "", + "weight": 0, + "path": "65514" + }, + { + "network": "10.7.0.0/16", + "nextHop": "10.7.1.13", + "locPrf": "", + "weight": 0, + "path": "65514" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json new file mode 100644 index 000000000000..a1eae83620a9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteCrossConnectionsRouteTableSummary.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "peeringName": "AzurePrivatePeering", + "crossConnectionName": "", + "resourceGroupName": "CrossConnection-SiliconValley", + "devicePath": "primary", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "neighbor": "10.6.1.112", + "asn": 65514, + "upDown": "1d14h", + "stateOrPrefixesReceived": "Active" + }, + { + "neighbor": "10.6.1.113", + "asn": 65514, + "upDown": "1d14h", + "stateOrPrefixesReceived": "1" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayCreate.json new file mode 100644 index 000000000000..a7bc4f9ea2a7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayCreate.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "expressRouteGatewayName": "gateway-2", + "subscriptionId": "subid", + "resourceGroupName": "resourceGroupName", + "api-version": "2020-05-01", + "putExpressRouteGatewayParameters": { + "location": "westus", + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupId/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "gateway-2", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + } + } + } + }, + "200": { + "body": { + "name": "gateway-2", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/gateway-2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 3 + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayDelete.json new file mode 100644 index 000000000000..3942fe402592 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayGet.json new file mode 100644 index 000000000000..afb526f51869 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "expressRouteGatewayName": "expressRouteGatewayName", + "resourceGroupName": "resourceGroupName", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayListByResourceGroup.json new file mode 100644 index 000000000000..b74ae45e0009 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayListByResourceGroup.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "resourceGroupName", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2 + } + }, + "expressRouteConnections": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "f28e9c99-78d8-4248-a855-c54cf6beb99d", + "routingWeight": 1, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hvirtualHubNameub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayListBySubscription.json new file mode 100644 index 000000000000..e5f7efcb206c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteGatewayListBySubscription.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "expressRouteGatewayName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "westus", + "type": "Microsoft.Network/expressRouteGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName" + }, + "autoScaleConfiguration": { + "bounds": { + "min": 2 + } + }, + "expressRouteConnections": [ + { + "name": "connectionName", + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteGateways/expressRouteGatewayName/expressRouteConnections/connectionName", + "properties": { + "provisioningState": "Provisioned", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/expressRouteCircuits/circuitName/peerings/AzurePrivatePeering" + }, + "authorizationKey": "f28e9c99-78d8-4248-a855-c54cf6beb99d", + "routingWeight": 1, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/virtualHubName/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/resourceGroupName/providers/Microsoft.Network/virtualHubs/hvirtualHubNameub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteLinkGet.json new file mode 100644 index 000000000000..ca05ee99a18c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteLinkGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "linkName": "linkName" + }, + "responses": { + "200": { + "body": { + "name": "linkName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/linkName", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteLinkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteLinkList.json new file mode 100644 index 000000000000..66d6b4d70dfb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteLinkList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "name": "link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortCreate.json new file mode 100644 index 000000000000..000c313da50c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortCreate.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "location": "westus", + "properties": { + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "encapsulation": "QinQ" + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + }, + "201": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortDelete.json new file mode 100644 index 000000000000..db0e7cff4fb4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortGet.json new file mode 100644 index 000000000000..2d2a094043e3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName" + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortList.json new file mode 100644 index 000000000000..cf88de0558f3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortList.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortListByResourceGroup.json new file mode 100644 index 000000000000..541a8709c9bd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortListByResourceGroup.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortUpdateLink.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortUpdateLink.json new file mode 100644 index 000000000000..8348dd0b9630 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortUpdateLink.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "location": "westus", + "properties": { + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "encapsulation": "QinQ", + "links": [ + { + "name": "link1", + "properties": { + "adminState": "Enabled" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Enabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + }, + "201": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Enabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortUpdateTags.json new file mode 100644 index 000000000000..f3a61a0bee63 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortUpdateTags.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "expressRoutePortName": "portName", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "portName", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName", + "type": "Microsoft.Network/expressRoutePorts", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "peeringLocation": "peeringLocationName", + "bandwidthInGbps": 100, + "provisionedBandwidthInGbps": 0.0, + "mtu": "1500", + "encapsulation": "QinQ", + "etherType": "0x8100", + "allocationDate": "Friday, July 1, 2018", + "links": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link1", + "name": "link1", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router1", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId1", + "rackId": "rackId1", + "connectorType": "LC", + "adminState": "Disabled" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRoutePorts/portName/links/link2", + "name": "link2", + "properties": { + "provisioningState": "Succeeded", + "routerName": "router2", + "interfaceName": "Ethernet 0/0", + "patchPanelId": "patchPanelId2", + "rackId": "rackId2", + "connectorType": "LC", + "adminState": "Disabled" + } + } + ], + "circuits": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortsLocationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortsLocationGet.json new file mode 100644 index 000000000000..57facc82fd66 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortsLocationGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01", + "locationName": "locationName" + }, + "responses": { + "200": { + "body": { + "name": "locationName", + "id": "/subscriptions/subid/providers/Microsoft.Network/expressRoutePortsLocations/locationName", + "type": "Microsoft.Network/expressRoutePortsLocations", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "address": "123 Main Street, City, State, Zip", + "contact": "email@address.com", + "availableBandwidths": [ + { + "offerName": "100 Gbps", + "valueInGbps": 100 + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortsLocationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortsLocationList.json new file mode 100644 index 000000000000..1fec90102c8c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRoutePortsLocationList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "locationName", + "id": "/subscriptions/subid/providers/Microsoft.Network/expressRoutePortsLocations/locationName", + "type": "Microsoft.Network/expressRoutePortsLocations", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "address": "123 Main Street, City, State, Zip", + "contact": "email@address.com", + "availableBandwidths": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteProviderList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteProviderList.json new file mode 100644 index 000000000000..f131b787a5b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ExpressRouteProviderList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "providerName", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/expressRouteServiceProviders/", + "type": "Microsoft.Network/expressRouteServiceProviders", + "properties": { + "provisioningState": "Succeeded", + "peeringLocations": [ + "peeringLocation1", + "peeringLocation2" + ], + "bandwidthsOffered": [ + { + "offerName": "50Mbps", + "valueInMbps": 50 + }, + { + "offerName": "100Mbps", + "valueInMbps": 100 + }, + { + "offerName": "200Mbps", + "valueInMbps": 200 + }, + { + "offerName": "500Mbps", + "valueInMbps": 500 + }, + { + "offerName": "1Gbps", + "valueInMbps": 1000 + }, + { + "offerName": "2Gbps", + "valueInMbps": 2000 + }, + { + "offerName": "5Gbps", + "valueInMbps": 5000 + }, + { + "offerName": "10Gbps", + "valueInMbps": 10000 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyDelete.json new file mode 100644 index 000000000000..3f8b5f687643 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyGet.json new file mode 100644 index 000000000000..e29677f2e32d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy" + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "firewalls": [], + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyListByResourceGroup.json new file mode 100644 index 000000000000..fb198f806851 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyListByResourceGroup.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "firewalls": [], + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyListBySubscription.json new file mode 100644 index 000000000000..a9d84e0a50cb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyListBySubscription.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + } + ], + "firewalls": [], + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyPut.json new file mode 100644 index 000000000000..8e4febe1cb29 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyPut.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup2" + } + ], + "firewalls": [], + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + } + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "type": "Microsoft.Network/firewallPolicies", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "threatIntelMode": "Alert", + "threatIntelWhitelist": { + "ipAddresses": [ + "20.3.4.5" + ], + "fqdns": [ + "*.microsoft.com" + ] + }, + "ruleCollectionGroups": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup2" + } + ], + "firewalls": [], + "dnsSettings": { + "servers": [ + "30.3.4.5" + ], + "enableProxy": true, + "requireProxyForNetworkRules": false + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupDelete.json new file mode 100644 index 000000000000..87663c53603b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleCollectionGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupGet.json new file mode 100644 index 000000000000..8f1118730047 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleCollectionGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 200, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupList.json new file mode 100644 index 000000000000..4947622e4f88 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "name": "Example-Filter-Rule-Collection", + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "priority": 120, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "network-rule-1", + "ruleType": "NetworkRule", + "description": "Network rule", + "destinationAddresses": [ + "*" + ], + "sourceAddresses": [ + "10.1.25.0/24" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupPut.json new file mode 100644 index 000000000000..1d458ceb2a22 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupPut.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "sourceAddresses": [ + "10.1.25.0/24" + ], + "destinationAddresses": [ + "*" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json new file mode 100644 index 000000000000..f46a42fb45c5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "ruleCollectionGroupName": "ruleGroup1", + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "ruleGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleGroups/ruleGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "priority": 200, + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-rule1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json new file mode 100644 index 000000000000..a57ae20aa2b0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "firewallPolicyName": "firewallPolicy", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "name": "Example-Filter-Rule-Collection", + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "priority": 120, + "action": { + "type": "Deny" + }, + "rules": [ + { + "name": "network-rule-1", + "ruleType": "NetworkRule", + "description": "Network rule", + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ], + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ] + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json new file mode 100644 index 000000000000..0e7ea965c4df --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "firewallPolicyName": "firewallPolicy", + "ruleCollectionGroupName": "ruleCollectionGroup1", + "parameters": { + "properties": { + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ruleCollectionGroup1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy/ruleCollectionGroups/ruleCollectionGroup1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "firewallPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/firewallPolicies/firewallPolicy", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "priority": 110, + "ruleCollections": [ + { + "ruleCollectionType": "FirewallPolicyFilterRuleCollection", + "name": "Example-Filter-Rule-Collection", + "action": { + "type": "Deny" + }, + "rules": [ + { + "ruleType": "NetworkRule", + "name": "network-1", + "ipProtocols": [ + "TCP" + ], + "destinationPorts": [ + "*" + ], + "sourceIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups1" + ], + "destinationIpGroups": [ + "/subscriptions/subid/providers/Microsoft.Network/resourceGroup/rg1/ipGroups/ipGroups2" + ] + } + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json new file mode 100644 index 000000000000..db99179749ee --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualWANName": "wan1", + "vpnClientParams": { + "vpnServerConfigurationResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1", + "authenticationMethod": "EAPTLS" + } + }, + "responses": { + "202": {}, + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/GetVirtualWanVpnServerConfigurations.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/GetVirtualWanVpnServerConfigurations.json new file mode 100644 index 000000000000..2b68f3ca4b6e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/GetVirtualWanVpnServerConfigurations.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "virtualWANName": "wan1" + }, + "responses": { + "200": { + "description": "Request successful.", + "body": { + "vpnServerConfigurationResourceIds": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnconfig2" + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableDelete.json new file mode 100644 index 000000000000..a6e43aea0d1e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "routeTableName": "hubRouteTable1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableGet.json new file mode 100644 index 000000000000..19ca08f432b4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "routeTableName": "hubRouteTable1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "hubRouteTable1", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableList.json new file mode 100644 index 000000000000..0c382ffed9a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTableList.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "hubRouteTable1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1a", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + }, + { + "name": "hubRouteTable2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route2a", + "destinationType": "CIDR", + "destinations": [ + "40.0.0.0/8", + "50.0.0.0/8", + "60.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubVirtualNetworkConnections/vn1" + } + ], + "labels": [ + "label3" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn4" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn2", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn1" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTablePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTablePut.json new file mode 100644 index 000000000000..54c93fcd3003 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubRouteTablePut.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "routeTableName": "hubRouteTable1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1", + "routeTableParameters": { + "properties": { + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "hubRouteTable1", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "hubRouteTable1", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "destinationType": "CIDR", + "destinations": [ + "10.0.0.0/8", + "20.0.0.0/8", + "30.0.0.0/8" + ], + "nextHopType": "ResourceId", + "nextHop": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azureFirewall1" + } + ], + "labels": [ + "label1", + "label2" + ], + "associatedConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/vnetConnn2" + ], + "propagatingConnections": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/expressRouteGateways/erg1/expressRouteConnections/erConn1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw1/vpnConnections/vpnConn2" + ] + }, + "type": "Microsoft.Network/virtualHubs/hubRouteTables" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionDelete.json new file mode 100644 index 000000000000..e3be839f0547 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionGet.json new file mode 100644 index 000000000000..7af6355d981d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionGet.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionList.json new file mode 100644 index 000000000000..acfd275743f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionList.json @@ -0,0 +1,123 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ] + } + } + } + }, + { + "name": "connection2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/virtualHubVnetConnections/connection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ] + } + } + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionPut.json new file mode 100644 index 000000000000..23f40ba0ba35 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/HubVirtualNetworkConnectionPut.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "connectionName": "connection1", + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "hubVirtualNetworkConnectionParameters": { + "properties": { + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ] + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Updating", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ] + } + } + } + } + }, + "201": { + "body": { + "name": "connection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubVirtualNetworkConnections/connection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Updating", + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/SpokeVnet1" + }, + "enableInternetSecurity": false, + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [ + { + "name": "route1", + "addressPrefixes": [ + "10.1.0.0/16", + "10.2.0.0/16" + ], + "nextHopIpAddress": "10.0.0.68" + }, + { + "name": "route2", + "addressPrefixes": [ + "10.3.0.0/16", + "10.4.0.0/16" + ], + "nextHopIpAddress": "10.0.0.65" + } + ] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleCreate.json new file mode 100644 index 000000000000..70cbae5d018f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1", + "inboundNatRuleParameters": { + "properties": { + "protocol": "Tcp", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "idleTimeoutInMinutes": 4, + "enableTcpReset": false, + "enableFloatingIP": false + } + } + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": false, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + }, + "201": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": false, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleDelete.json new file mode 100644 index 000000000000..344545ff5c18 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleGet.json new file mode 100644 index 000000000000..aaef72801468 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1", + "inboundNatRuleName": "natRule1.1" + }, + "responses": { + "200": { + "body": { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleList.json new file mode 100644 index 000000000000..4d00c465255b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/InboundNatRuleList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "loadBalancerName": "lb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "natRule1.1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.1", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3390, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + }, + { + "name": "natRule1.3", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natRule1.3", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/ip1" + }, + "frontendPort": 3392, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 4, + "protocol": "Tcp", + "enableTcpReset": true, + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationCreate.json new file mode 100644 index 000000000000..dc81cf7d7f98 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationCreate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation", + "parameters": { + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + }, + "location": "centraluseuap" + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + }, + "201": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationDelete.json new file mode 100644 index 000000000000..e286a1dd32b7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationGet.json new file mode 100644 index 000000000000..8bed1f0443cf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation" + }, + "responses": { + "200": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationList.json new file mode 100644 index 000000000000..cddae724430f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipallocation1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation1", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + }, + { + "name": "test-ipallocation2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation2", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.6.0/24", + "ipamAllocationId": "57dc7256-2ff7-43f2-b9c8-85a70b5c6408", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationListByResourceGroup.json new file mode 100644 index 000000000000..8ab689756303 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationListByResourceGroup.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipallocation1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation1", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + }, + { + "name": "test-ipallocation2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation2", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "properties": { + "type": "Hypernet", + "prefix": "3.2.6.0/24", + "ipamAllocationId": "57dc7256-2ff7-43f2-b9c8-85a70b5c6408", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet2" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationUpdateTags.json new file mode 100644 index 000000000000..be171b9efff0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpAllocationUpdateTags.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "ipAllocationName": "test-ipallocation", + "location": "centraluseuap", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipallocation", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/IpAllocations/test-ipallocation", + "type": "Microsoft.Network/IpAllocations", + "location": "centraluseuap", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "type": "Hypernet", + "prefix": "3.2.5.0/24", + "ipamAllocationId": "916d3b28-663f-448b-9abc-1bea9d5fed8f", + "allocationTags": { + "VNetID": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/HypernetVnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsCreate.json new file mode 100644 index 000000000000..f876f172497a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsCreate.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup", + "ipGroupsName": "ipGroups1", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + }, + "201": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsDelete.json new file mode 100644 index 000000000000..30ca2d5327df --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup", + "ipGroupsName": "ipGroups1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsGet.json new file mode 100644 index 000000000000..0a1402c1162a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup", + "ipGroupsName": "ipGroups1" + }, + "responses": { + "200": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsListByResourceGroup.json new file mode 100644 index 000000000000..3d679637a225 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsListByResourceGroup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + }, + { + "name": "ipGroups2", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "14.64.39.16/32", + "41.74.146.80/31", + "42.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsListBySubscription.json new file mode 100644 index 000000000000..67f24c18f030 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsListBySubscription.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "iptag1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup1/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + }, + { + "name": "iptag2", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup2/ipGroups", + "type": "Microsoft.Network/ipGroups", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "14.64.39.16/32", + "41.74.146.80/31", + "42.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsUpdateTags.json new file mode 100644 index 000000000000..04ad419ad979 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/IpGroupsUpdateTags.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "ipGroupsName": "ipGroups1", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-05-01", + "subscriptionId": "subId", + "parameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "ipGroups1", + "id": "/subscriptions/subId/providers/Microsoft.Network/resourceGroup/myResourceGroup/ipGroups/ipGroups1", + "type": "Microsoft.Network/ipGroups", + "location": "westcentralus", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "ipAddresses": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ], + "firewalls": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/azureFirewalls/azurefirewall" + } + ] + }, + "etag": "w/\\00000000-0000-0000-0000-000000000000\\" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json new file mode 100644 index 000000000000..eebaff0df484 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json new file mode 100644 index 000000000000..e8177866cca6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json new file mode 100644 index 000000000000..117a96a2a85a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPut.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + }, + "201": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.4" + } + }, + { + "name": "address2", + "properties": { + "virtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb" + }, + "ipAddress": "10.0.0.5" + } + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json new file mode 100644 index 000000000000..eadf70581c3e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "networkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig1" + } + } + }, + { + "name": "address2", + "properties": { + "networkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig2" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "networkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig1" + } + } + }, + { + "name": "address2", + "properties": { + "networkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig2" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancerBackendAddresses": [ + { + "name": "address1", + "properties": { + "networkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig1" + } + } + }, + { + "name": "address2", + "properties": { + "networkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig2" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolDelete.json new file mode 100644 index 000000000000..8500be41293c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2020-05-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolGet.json new file mode 100644 index 000000000000..2ba843add064 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "backendAddressPoolName": "backend", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic/ipConfigurations/default-ip-config" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolList.json new file mode 100644 index 000000000000..11a307515e48 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerBackendAddressPoolList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "backend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic/ipConfigurations/default-ip-config" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreate.json new file mode 100644 index 000000000000..7ad17ae05b6e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreate.json @@ -0,0 +1,339 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "inboundNatPools": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateStandardSku.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateStandardSku.json new file mode 100644 index 000000000000..c7bfa2baf5f5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateStandardSku.json @@ -0,0 +1,339 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithInboundNatPool.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithInboundNatPool.json new file mode 100644 index 000000000000..f641f599b94e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithInboundNatPool.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + } + }, + "name": "test", + "zones": [], + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + }, + "protocol": "Tcp", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "enableTcpReset": true + }, + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + }, + "inboundNatPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test", + "type": "Microsoft.Network/loadBalancers/inboundNatPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "protocol": "Tcp", + "enableTcpReset": true, + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + } + } + ] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/lbvnet/subnets/lbsubnet" + }, + "inboundNatPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test" + } + ] + } + } + ], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "outboundRules": [], + "inboundNatPools": [ + { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatPools/test", + "type": "Microsoft.Network/loadBalancers/inboundNatPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendPortRangeStart": 8080, + "frontendPortRangeEnd": 8085, + "backendPort": 8888, + "idleTimeoutInMinutes": 10, + "enableFloatingIP": true, + "protocol": "Tcp", + "enableTcpReset": true, + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/test" + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithOutboundRules.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithOutboundRules.json new file mode 100644 index 000000000000..8a9148f174e5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithOutboundRules.json @@ -0,0 +1,423 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip" + } + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "protocol": "Tcp", + "loadDistribution": "Default", + "frontendPort": 80, + "backendPort": 80, + "idleTimeoutInMinutes": 15, + "enableFloatingIP": true, + "disableOutboundSnat": true + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [ + { + "name": "rule1", + "properties": { + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "protocol": "All" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ], + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "disableOutboundSnat": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "outboundRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "allocatedOutboundPorts": 1024, + "protocol": "All", + "enableTcpReset": false, + "idleTimeoutInMinutes": 4, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ] + } + } + ], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/pip" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ], + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "outboundRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false, + "loadDistribution": "Default", + "disableOutboundSnat": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": false + } + } + ], + "outboundRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "allocatedOutboundPorts": 1024, + "protocol": "All", + "enableTcpReset": false, + "idleTimeoutInMinutes": 4, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ] + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithZones.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithZones.json new file mode 100644 index 000000000000..864f4c85935a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerCreateWithZones.json @@ -0,0 +1,348 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + }, + "zones": [ + "1" + ] + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "properties": {} + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + } + } + } + ], + "probes": [ + { + "name": "probe-lb", + "properties": { + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2 + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "properties": { + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "inboundNatPools": [], + "outboundRules": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + }, + "201": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "eastus", + "sku": { + "name": "Standard" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "type": "Microsoft.Network/loadBalancers/probes", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerDelete.json new file mode 100644 index 000000000000..cbe319222cb4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerFrontendIPConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerFrontendIPConfigurationGet.json new file mode 100644 index 000000000000..3da6354f55c9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerFrontendIPConfigurationGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "frontendIPConfigurationName": "frontend", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "frontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/frontend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerFrontendIPConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerFrontendIPConfigurationList.json new file mode 100644 index 000000000000..efdf788817fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerFrontendIPConfigurationList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "resourceGroupName": "testrg", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "frontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/frontend", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerGet.json new file mode 100644 index 000000000000..bd2884509529 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerGet.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb" + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerList.json new file mode 100644 index 000000000000..734390646d09 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerList.json @@ -0,0 +1,161 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "inboundNatPools": [] + } + }, + { + "name": "lb2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb2", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerListAll.json new file mode 100644 index 000000000000..cd9c60e695a7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerListAll.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [ + { + "name": "felb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/frontendIPConfigurations", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "belb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/backendAddressPools", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/belb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb" + } + } + } + ], + "probes": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inrlb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inrlb", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers/inboundNatRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/felb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true + } + } + ], + "inboundNatPools": [] + } + }, + { + "name": "lb3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb3", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "sku": { + "name": "Basic" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "frontendIPConfigurations": [], + "backendAddressPools": [], + "loadBalancingRules": [], + "probes": [], + "inboundNatRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerLoadBalancingRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerLoadBalancingRuleGet.json new file mode 100644 index 000000000000..79c78c059aab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerLoadBalancingRuleGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "loadBalancingRuleName": "rule1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerLoadBalancingRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerLoadBalancingRuleList.json new file mode 100644 index 000000000000..5400b5bcc6ca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerLoadBalancingRuleList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/loadBalancingRules/rule1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/loadBalancingRules", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/probes/probe1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerNetworkInterfaceListSimple.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerNetworkInterfaceListSimple.json new file mode 100644 index 000000000000..7aad2d7a6930 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerNetworkInterfaceListSimple.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mynic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/frontendSubnet" + }, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/inbound1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": false, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerNetworkInterfaceListVmss.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerNetworkInterfaceListVmss.json new file mode 100644 index 000000000000..ac67c290ee34 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerNetworkInterfaceListVmss.json @@ -0,0 +1,112 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vmss1Nic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/vmss1Nic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "vmss1IpConfig", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/vmss1Nic/ipConfigurations/vmss1IpConfig", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vmss1Vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/natpool.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "aaaaaaaaaaaaaaaaaaaaaaaaaa.dx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "vmss1Nic", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/vmss1Nic", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "vmss1IpConfig", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/vmss1Nic/ipConfigurations/vmss1IpConfig", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vmss1Vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/bepool" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/natpool.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "aaaaaaaaaaaaaaaaaaaaaaaaaa.dx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerOutboundRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerOutboundRuleGet.json new file mode 100644 index 000000000000..56c68daaae5b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerOutboundRuleGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "outboundRuleName": "rule1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + } + ], + "allocatedOutboundPorts": 64, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerOutboundRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerOutboundRuleList.json new file mode 100644 index 000000000000..a2332c983668 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerOutboundRuleList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/outboundRules/rule1", + "type": "Microsoft.Network/loadBalancers/outboundRules", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/frontendIPConfigurations/lbfrontend" + } + ], + "allocatedOutboundPorts": 64, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "enableTcpReset": true, + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/bepool1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerProbeGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerProbeGet.json new file mode 100644 index 000000000000..729b233f5261 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerProbeGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "probeName": "probe1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "probe1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/probe1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerProbeList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerProbeList.json new file mode 100644 index 000000000000..a3c1cce9d1b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerProbeList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "loadBalancerName": "lb", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "prlb", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/probes/prlb", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/loadBalancers/probes", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerUpdateTags.json new file mode 100644 index 000000000000..cd0ebe5282c6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LoadBalancerUpdateTags.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "loadBalancerName": "lb", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfigurations": [ + { + "name": "fe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "be-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb", + "properties": { + "provisioningState": "Succeeded", + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rulelb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/be-lb" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb" + }, + "disableOutboundSnat": false + } + } + ], + "probes": [ + { + "name": "probe-lb", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/probes/probe-lb", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/loadBalancingRules/rulelb" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "in-nat-rule", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/inboundNatRules/in-nat-rule", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": true, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp" + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayCreate.json new file mode 100644 index 000000000000..f03b7221f804 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayCreate.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "localgw", + "parameters": { + "properties": { + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "11.12.13.14", + "fqdn": "site1.contoso.com" + }, + "location": "Central US" + } + }, + "responses": { + "201": { + "body": { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "11.12.13.14" + } + } + }, + "200": { + "body": { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "11.12.13.14" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayDelete.json new file mode 100644 index 000000000000..1cdbf0176cf3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "localgw" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayGet.json new file mode 100644 index 000000000000..4eeba28998a4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "localgw" + }, + "responses": { + "200": { + "body": { + "name": "localgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayList.json new file mode 100644 index 000000000000..009db6c93313 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayList.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "localgw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + }, + { + "name": "localgw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/localNetworkGateways", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.2.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayUpdateTags.json new file mode 100644 index 000000000000..bc81c26d9201 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LocalNetworkGatewayUpdateTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "localNetworkGatewayName": "lgw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "lgw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "type": "Microsoft.Network/localNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "localNetworkAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "gatewayIpAddress": "12.0.0.1" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayCreateOrUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayCreateOrUpdate.json new file mode 100644 index 000000000000..99beabf8007e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayCreateOrUpdate.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natgateway", + "parameters": { + "location": "westus", + "sku": { + "name": "Standard" + }, + "properties": { + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + }, + "201": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + }, + "202": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayDelete.json new file mode 100644 index 000000000000..f86c7d0273f3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayGet.json new file mode 100644 index 000000000000..ffb22a280bf4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway" + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayList.json new file mode 100644 index 000000000000..23c6a4506b02 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayList.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateway/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + }, + { + "name": "test-natGateway2", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGateway/test-natGateway2", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayListAll.json new file mode 100644 index 000000000000..5388e98bef31 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayListAll.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + }, + { + "name": "test-natGateway2", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/natGatewayes/test-natGateway2", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "type": "Microsoft.Network/natGateways" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayUpdateTags.json new file mode 100644 index 000000000000..44cf2b98f324 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NatGatewayUpdateTags.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "natGatewayName": "test-natGateway", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-natGateway", + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/natGateways/test-natGateway", + "location": "westus", + "properties": { + "idleTimeoutInMinutes": 5, + "provisioningState": "Succeeded", + "publicIpAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ], + "publicIpPrefixes": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/PublicIpPrefix1" + } + ], + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1" + } + ] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/natGateways" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceCreate.json new file mode 100644 index 000000000000..6539628ba932 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceCreate.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "properties": { + "enableAcceleratedNetworking": true, + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + } + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + }, + "201": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceDelete.json new file mode 100644 index 000000000000..1b0bf4b69b12 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceEffectiveNSGList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceEffectiveNSGList.json new file mode 100644 index 000000000000..9dba27acb8a8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceEffectiveNSGList.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/test-nsg" + }, + "association": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "networkInterface": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "effectiveSecurityRules": [ + { + "name": "securityRules/rule1", + "protocol": "Tcp", + "sourcePortRange": "456-456", + "destinationPortRange": "6579-6579", + "sourceAddressPrefix": "0.0.0.0/32", + "destinationAddressPrefix": "0.0.0.0/32", + "access": "Allow", + "priority": 234, + "direction": "Inbound" + }, + { + "name": "securityRules/default-allow-rdp", + "protocol": "Tcp", + "sourcePortRange": "0-65535", + "destinationPortRange": "3389-3389", + "sourceAddressPrefix": "1.1.1.1/32", + "destinationAddressPrefix": "0.0.0.0/0", + "access": "Allow", + "priority": 1000, + "direction": "Inbound" + }, + { + "name": "defaultSecurityRules/AllowInternetOutBound", + "protocol": "All", + "sourcePortRange": "0-65535", + "destinationPortRange": "0-65535", + "sourceAddressPrefix": "0.0.0.0/0", + "destinationAddressPrefix": "Internet", + "expandedDestinationAddressPrefix": [ + "32.0.0.0/3", + "4.0.0.0/6", + "2.0.0.0/7", + "1.0.0.0/8" + ], + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + ] + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceEffectiveRouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceEffectiveRouteTableList.json new file mode 100644 index 000000000000..e0e055a9e914 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceEffectiveRouteTableList.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.20.2.0/24" + ], + "nextHopType": "VnetLocal", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "0.0.0.0/0" + ], + "nextHopType": "Internet", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "10.0.0.0/8" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "100.64.0.0/10" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "172.16.0.0/12" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + }, + { + "source": "Default", + "state": "Active", + "addressPrefix": [ + "192.168.0.0/16" + ], + "nextHopType": "None", + "nextHopIpAddress": [] + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceGet.json new file mode 100644 index 000000000000..1acc4720a046 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceGet.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic" + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "test.bx.internal.cloudapp.net" + }, + "macAddress": "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking": true, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceIPConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceIPConfigurationGet.json new file mode 100644 index 000000000000..9edd7228778c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceIPConfigurationGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "ipConfigurationName": "ipconfig1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/myVirtualNetwork/subnets/frontendSubnet" + }, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1" + } + ], + "virtualNetworkTaps": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/vTAP1" + }, + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/vTAP2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceIPConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceIPConfigurationList.json new file mode 100644 index 000000000000..576715e50cb1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceIPConfigurationList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "nic1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworks/vnet12/subnets/subnet12" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceList.json new file mode 100644 index 000000000000..b0ff91a26b8d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceList.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "test.bx.internal.cloudapp.net" + }, + "macAddress": "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking": true, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type": "Microsoft.Network/networkInterfaces" + }, + { + "name": "test-nic2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet2/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceListAll.json new file mode 100644 index 000000000000..88748466eb9e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceListAll.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "test.bx.internal.cloudapp.net" + }, + "macAddress": "00-0D-3A-1B-C7-21", + "enableAcceleratedNetworking": true, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "type": "Microsoft.Network/networkInterfaces" + }, + { + "name": "test-nic2", + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/networkInterfaces/test-nic2/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/publicIPAddresses/test-ip2" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rgnew/providers/Microsoft.Network/virtualNetworks/rgnew-vnet2/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceLoadBalancerList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceLoadBalancerList.json new file mode 100644 index 000000000000..1bbf4047e3c3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceLoadBalancerList.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "nic1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "lbname1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "type": "Microsoft.Network/loadBalancers", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "frontendIPConfigurations": [ + { + "name": "lbfrontend", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/publicIPAddresses/myDynamicPublicIP" + }, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ], + "inboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1" + } + ] + } + } + ], + "backendAddressPools": [ + { + "name": "bepool1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "backendIPConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1" + } + ], + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ] + } + } + ], + "loadBalancingRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 80, + "backendPort": 80, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "loadDistribution": "Default", + "backendAddressPool": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/backendAddressPools/bepool1" + }, + "probe": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/probes/probe1" + } + } + } + ], + "probes": [ + { + "name": "probe1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/probes/probe1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "protocol": "Http", + "port": 80, + "requestPath": "healthcheck.aspx", + "intervalInSeconds": 15, + "numberOfProbes": 2, + "loadBalancingRules": [ + { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/loadBalancingRules/rule1" + } + ] + } + } + ], + "inboundNatRules": [ + { + "name": "inbound1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/inboundNatRules/inbound1", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "properties": { + "provisioningState": "Succeeded", + "frontendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/loadBalancers/lbname1/frontendIPConfigurations/lbfrontend" + }, + "frontendPort": 3389, + "backendPort": 3389, + "enableFloatingIP": false, + "idleTimeoutInMinutes": 15, + "protocol": "Tcp", + "backendIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1" + } + } + } + ], + "outboundRules": [], + "inboundNatPools": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationCreate.json new file mode 100644 index 000000000000..d8b546cf662f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationCreate.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "tapConfigurationName": "tapconfiguration1", + "api-version": "2020-05-01", + "tapConfigurationParameters": { + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + }, + "201": { + "body": { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationDelete.json new file mode 100644 index 000000000000..758daea7175f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-networkinterface", + "tapConfigurationName": "test-tapconfiguration" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationGet.json new file mode 100644 index 000000000000..97feb155abc8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "networkInterfaceName": "mynic", + "tapConfigurationName": "tapconfiguration1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationList.json new file mode 100644 index 000000000000..74086f97dab0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceTapConfigurationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "mynic" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "tapConfiguration1", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/networkInterfaces/mynic/tapConfigurations/tapConfiguration1", + "etag": "etag", + "type": "Microsoft.Network/networkInterfaces/tapConfigurations", + "properties": { + "virtualNetworkTap": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkTaps/testvtap" + }, + "provisioningState": "Succeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceUpdateTags.json new file mode 100644 index 000000000000..adb7b6d63270 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkInterfaceUpdateTags.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "test-nic", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-nic", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-nic/ipConfigurations/ipconfig1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "172.20.2.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/rg1-vnet/subnets/default" + }, + "primary": true, + "privateIPAddressVersion": "IPv4" + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [] + }, + "enableAcceleratedNetworking": true, + "enableIPForwarding": false + }, + "type": "Microsoft.Network/networkInterfaces" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileCreateConfigOnly.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileCreateConfigOnly.json new file mode 100644 index 000000000000..1709a606af75 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileCreateConfigOnly.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1", + "parameters": { + "location": "westus", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "properties": { + "ipConfigurations": [ + { + "name": "ipconfig1", + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfig1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + }, + "201": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfig1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileDelete.json new file mode 100644 index 000000000000..9919812b31ab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileGetConfigOnly.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileGetConfigOnly.json new file mode 100644 index 000000000000..162663ceafdd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileGetConfigOnly.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + }, + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileGetWithContainerNic.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileGetWithContainerNic.json new file mode 100644 index 000000000000..7772fa6d2525 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileGetWithContainerNic.json @@ -0,0 +1,203 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "networkProfile1" + }, + "responses": { + "200": { + "body": { + "name": "networkProfile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ], + "containerNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth0" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth0" + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + }, + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ], + "containerNetworkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth1" + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [ + { + "name": "containerGroup1_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup1" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup1_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup1_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup1" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup2_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup2" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup2_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup2_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup2" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup3_eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth0", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup3" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + }, + { + "name": "containerGroup3_eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaces/containerGroup3_eth1", + "etag": "W/\"de9b89d2-83b0-4da3-b488-6ea8b0557edd\"", + "properties": { + "provisioningState": "Succeeded", + "containerNetworkInterfaceConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1" + }, + "container": { + "id": "/subscriptions/subid/resourceGroups/networkProfilesDemo/providers/Microsoft.ContainerInstance/containerGroups/containerGroup3" + }, + "ipConfigurations": [] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaces" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileList.json new file mode 100644 index 000000000000..3a5d39b88a7b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileList.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "name": "networkProfile1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + }, + { + "name": "ipconfigprofile2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile2", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile2", + "name": "networkProfile2", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileListAll.json new file mode 100644 index 000000000000..427f3a4f7ece --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileListAll.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1", + "name": "networkProfile1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile2", + "name": "networkProfile2", + "properties": { + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth1/ipConfigurations/ipconfigprofile3", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileUpdateTags.json new file mode 100644 index 000000000000..6e8ad0326944 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkProfileUpdateTags.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkProfileName": "test-np", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-np", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/test-np", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "1570d8b6-ab8a-4ad2-81d6-d2799b429cbf", + "containerNetworkInterfaceConfigurations": [ + { + "name": "eth0", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ipconfigprofile1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1", + "etag": "W/\"4d705a71-752f-4e0a-8057-c02b125b1c08\"", + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations/ipConfigurations", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/networkProfileVnet/subnets/networkProfileSubnet1" + } + } + } + ] + }, + "type": "Microsoft.Network/networkProfiles/containerNetworkInterfaceConfigurations" + } + ], + "containerNetworkInterfaces": [] + }, + "type": "Microsoft.Network/networkProfiles", + "location": "centraluseuap" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupCreate.json new file mode 100644 index 000000000000..40e3bbb4eb18 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupCreate.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupCreateWithRule.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupCreateWithRule.json new file mode 100644 index 000000000000..744271dd6caa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupCreateWithRule.json @@ -0,0 +1,282 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "parameters": { + "properties": { + "securityRules": [ + { + "name": "rule1", + "properties": { + "protocol": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "destinationPortRange": "80", + "sourcePortRange": "*", + "priority": 130, + "direction": "Inbound" + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupDelete.json new file mode 100644 index 000000000000..a11f83e54ae4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupGet.json new file mode 100644 index 000000000000..6d044f756515 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupGet.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg" + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupList.json new file mode 100644 index 000000000000..6db88c5c73d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupList.json @@ -0,0 +1,231 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupListAll.json new file mode 100644 index 000000000000..45bd8a80dd18 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupListAll.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nsg1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + }, + { + "name": "nsg3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg3/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleCreate.json new file mode 100644 index 000000000000..d5f1ec2eb48d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleCreate.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1", + "securityRuleParameters": { + "properties": { + "protocol": "*", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "destinationPortRange": "8080", + "sourcePortRange": "*", + "priority": 100, + "direction": "Outbound" + } + } + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "8080", + "sourceAddressPrefix": "10.0.0.0/8", + "destinationAddressPrefix": "11.0.0.0/8", + "access": "Deny", + "priority": 100, + "direction": "Outbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleDelete.json new file mode 100644 index 000000000000..2537a3521104 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleGet.json new file mode 100644 index 000000000000..605c350764cc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "securityRuleName": "rule1" + }, + "responses": { + "200": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleList.json new file mode 100644 index 000000000000..83fcdd31e240 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupRuleList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "provisioningState": "Succeeded", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "80", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 130, + "direction": "Inbound" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupUpdateTags.json new file mode 100644 index 000000000000..baab9365e944 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkSecurityGroupUpdateTags.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkSecurityGroupName": "testnsg", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg", + "type": "Microsoft.Network/networkSecurityGroups", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "securityRules": [], + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + }, + { + "name": "AllowAzureLoadBalancerInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowAzureLoadBalancerInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from azure load balancer", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "AzureLoadBalancer", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 65001, + "direction": "Inbound" + } + }, + { + "name": "DenyAllInBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllInBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all inbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Inbound" + } + }, + { + "name": "AllowVnetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowVnetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Outbound" + } + }, + { + "name": "AllowInternetOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/AllowInternetOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow outbound traffic from all VMs to Internet", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "Internet", + "access": "Allow", + "priority": 65001, + "direction": "Outbound" + } + }, + { + "name": "DenyAllOutBound", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/defaultSecurityRules/DenyAllOutBound", + "properties": { + "provisioningState": "Succeeded", + "description": "Deny all outbound traffic", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceDelete.json new file mode 100644 index 000000000000..3c7456aa808d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceGet.json new file mode 100644 index 000000000000..2b85ebcb976e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceGet.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "virtualApplianceNics": [ + { + "name": "managementNic", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1" + }, + { + "name": "privateNic-1", + "privateIpAddress": "192.168.12.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceListByResourceGroup.json new file mode 100644 index 000000000000..1130edb38cc1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceListByResourceGroup.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "virtualApplianceNics": [ + { + "name": "managementNic", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1" + }, + { + "name": "privateNic-1", + "privateIpAddress": "192.168.12.2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceListBySubscription.json new file mode 100644 index 000000000000..b950a32535db --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceListBySubscription.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "virtualApplianceNics": [ + { + "name": "managementNic", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1" + }, + { + "name": "privateNic-1", + "privateIpAddress": "192.168.12.2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualAppliancePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualAppliancePut.json new file mode 100644 index 000000000000..9954c35baad4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualAppliancePut.json @@ -0,0 +1,143 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "location": "West US", + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000 + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "virtualApplianceNics": [ + { + "name": "managementNic", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1" + }, + { + "name": "privateNic-1", + "privateIpAddress": "192.168.12.2" + } + ] + } + } + }, + "201": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "virtualApplianceNics": [ + { + "name": "managementNic", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1" + }, + { + "name": "privateNic-1", + "privateIpAddress": "192.168.12.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteDelete.json new file mode 100644 index 000000000000..bb408aa94fe7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteGet.json new file mode 100644 index 000000000000..be46142ea4ca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteList.json new file mode 100644 index 000000000000..a42afca04295 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSiteList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSitePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSitePut.json new file mode 100644 index 000000000000..3d2f6f86b0fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSitePut.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "siteName": "site1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "properties": { + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + }, + "201": { + "body": { + "name": "site1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva/virtualApplianceSites/site1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "192.168.1.0/24", + "o365Policy": { + "breakOutCategories": { + "allow": true, + "optimize": true, + "default": true + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSkuGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSkuGet.json new file mode 100644 index 000000000000..06d0b52142b0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSkuGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "skuName": "ciscoSdwan" + }, + "responses": { + "200": { + "body": { + "name": "ciscoSdwan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualApplianceSkus/ciscoSdwan", + "type": "Microsoft.Network/networkVirtualApplianceSkus", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "vendor": "Cisco", + "availableVersions": [ + "11.12" + ], + "availableScaleUnits": [ + { + "scaleUnit": "1", + "instanceCount": 2 + }, + { + "scaleUnit": "2", + "instanceCount": 2 + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSkuList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSkuList.json new file mode 100644 index 000000000000..9ecf12b4f0cf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceSkuList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ciscoSdwan", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualApplianceSkus/ciscoSdwan", + "type": "Microsoft.Network/networkVirtualApplianceSkus", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "vendor": "Cisco", + "availableVersions": [ + "11.12" + ], + "availableScaleUnits": [ + { + "scaleUnit": "1", + "instanceCount": 2 + }, + { + "scaleUnit": "2", + "instanceCount": 2 + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceUpdateTags.json new file mode 100644 index 000000000000..9f7db9998f6a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkVirtualApplianceUpdateTags.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkVirtualApplianceName": "nva", + "parameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nva", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkVirtualAppliances/nva", + "type": "Microsoft.Network/networkVirtualAppliances", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + }, + "properties": { + "nvaSku": { + "vendor": "Cisco SDWAN", + "bundledScaleUnit": "1", + "marketPlaceVersion": "12.1" + }, + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + }, + "virtualApplianceSites": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networtkVirtualAppliances/nva/virtualApplianceSites/site1" + } + ], + "provisioningState": "Succeeded", + "bootStrapConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrbootstrapconfig" + ], + "cloudInitConfigurationBlobs": [ + "https://csrncvhdstorage1.blob.core.windows.net/csrncvhdstoragecont/csrcloudinitconfig" + ], + "virtualApplianceAsn": 10000, + "virtualApplianceNics": [ + { + "name": "managementNic", + "publicIpAddress": "40.30.2.2", + "privateIpAddress": "192.168.12.1" + }, + { + "name": "privateNic-1", + "privateIpAddress": "192.168.12.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherAvailableProvidersListGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherAvailableProvidersListGet.json new file mode 100644 index 000000000000..20823da95998 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherAvailableProvidersListGet.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "azureLocations": [ + "West US" + ], + "country": "United States", + "state": "washington", + "city": "seattle" + } + }, + "responses": { + "200": { + "body": { + "countries": [ + { + "countryName": "United States", + "states": [ + { + "stateName": "washington", + "cities": [ + { + "cityName": "seattle", + "providers": [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } + ] + } + }, + "202": { + "body": { + "countries": [ + { + "countryName": "United States", + "states": [ + { + "stateName": "washington", + "cities": [ + { + "cityName": "seattle", + "providers": [ + "Comcast Cable Communications, Inc. - ASN 7922", + "Comcast Cable Communications, LLC - ASN 7922", + "Level 3 Communications, Inc. (GBLX) - ASN 3549", + "Qwest Communications Company, LLC - ASN 209" + ] + } + ] + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherAzureReachabilityReportGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherAzureReachabilityReportGet.json new file mode 100644 index 000000000000..1ed2005b7cd4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherAzureReachabilityReportGet.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "providerLocation": { + "country": "United States", + "state": "washington" + }, + "providers": [ + "Frontier Communications of America, Inc. - ASN 5650" + ], + "azureLocations": [ + "West US" + ], + "startTime": "2017-09-07T00:00:00Z", + "endTime": "2017-09-10T00:00:00Z" + } + }, + "responses": { + "200": { + "body": { + "aggregationLevel": "State", + "providerLocation": { + "country": "United States", + "state": "washington" + }, + "reachabilityReport": [ + { + "provider": "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-09-07T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-08T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-09T00:00:00Z", + "score": 94 + } + ] + } + ] + } + }, + "202": { + "body": { + "aggregationLevel": "State", + "providerLocation": { + "country": "United States", + "state": "washington" + }, + "reachabilityReport": [ + { + "provider": "Frontier Communications of America, Inc. - ASN 5650", + "azureLocation": "West US", + "latencies": [ + { + "timeStamp": "2017-09-07T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-08T00:00:00Z", + "score": 94 + }, + { + "timeStamp": "2017-09-09T00:00:00Z", + "score": 94 + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorCreate.json new file mode 100644 index 000000000000..c179bd13d88b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorCreate.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "location": "centraluseuap", + "parameters": { + "properties": { + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60 + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "provisioningState": "Updating", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "monitoringStatus": "NotStarted" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + }, + "201": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "provisioningState": "Updating", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "monitoringStatus": "NotStarted" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorDelete.json new file mode 100644 index 000000000000..18fdbee8f05c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorGet.json new file mode 100644 index 000000000000..9d21c687fcd2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "startTime": "2018-01-08T03:42:33.3387305Z", + "monitoringStatus": "Running" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorList.json new file mode 100644 index 000000000000..94d86e8c650b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "startTime": "2018-01-08T03:42:33.3387305Z", + "monitoringStatus": "Running" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + }, + { + "name": "cm2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm2", + "port": 0 + }, + "destination": { + "address": "google.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 30, + "autoStart": true, + "startTime": "2018-01-08T05:42:33.3387305Z", + "monitoringStatus": "Running" + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorQuery.json new file mode 100644 index 000000000000..a79872b1f571 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorQuery.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "200": { + "body": { + "sourceStatus": "Active", + "states": [ + { + "connectionState": "Reachable", + "startTime": "2018-01-08T03:42:33.3387305Z", + "endTime": "2018-01-08T05:12:41.5265438Z", + "evaluationState": "Completed", + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "VirtualNetwork", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "192.168.100.4", + "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds": [], + "issues": [] + } + ] + } + ] + } + }, + "202": { + "body": { + "sourceStatus": "Active", + "states": [ + { + "connectionState": "Reachable", + "startTime": "2018-01-08T03:42:33.3387305Z", + "endTime": "2018-01-08T05:12:41.5265438Z", + "evaluationState": "Completed", + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "VirtualNetwork", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "192.168.100.4", + "resourceId": "subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds": [], + "issues": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorStart.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorStart.json new file mode 100644 index 000000000000..27c5440d58db --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorStart.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorStop.json new file mode 100644 index 000000000000..27c5440d58db --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorStop.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json new file mode 100644 index 000000000000..4bd3b9c4166c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorUpdateTags.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/`/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachines/vm1", + "port": 0 + }, + "destination": { + "address": "bing.com", + "port": 80 + }, + "monitoringIntervalInSeconds": 60, + "autoStart": true, + "startTime": "2019-09-04T02:48:10.6797393Z", + "monitoringStatus": "Running" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/networkWatchers/connectionMonitors", + "location": "westcentralus" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorV2Create.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorV2Create.json new file mode 100644 index 000000000000..9a709780b9b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectionMonitorV2Create.json @@ -0,0 +1,206 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "connectionMonitorName": "cm1", + "location": "centraluseuap", + "parameters": { + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NwRgIrinaCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm1" + }, + { + "name": "CanaryWorkspaceVamshi", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/vasamudrRG/providers/Microsoft.OperationalInsights/workspaces/vasamudrWorkspace", + "filter": { + "type": "Include", + "items": [ + { + "type": "AgentAddress", + "address": "npmuser" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "CanaryWorkspaceVamshi" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + } + } + }, + "responses": { + "200": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NwRgIrinaCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm1" + }, + { + "name": "CanaryWorkspaceVamshi", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/vasamudrRG/providers/Microsoft.OperationalInsights/workspaces/vasamudrWorkspace", + "filter": { + "type": "Include", + "items": [ + { + "type": "AgentAddress", + "address": "npmuser" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "CanaryWorkspaceVamshi" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + }, + "201": { + "body": { + "name": "cm1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/connectionMonitors/cm1", + "etag": "W/\"e7497f26-5f09-4559-900b-fe98f3dedb6f\"", + "properties": { + "endpoints": [ + { + "name": "vm1", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NwRgIrinaCentralUSEUAP/providers/Microsoft.Compute/virtualMachines/vm1" + }, + { + "name": "CanaryWorkspaceVamshi", + "resourceId": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/vasamudrRG/providers/Microsoft.OperationalInsights/workspaces/vasamudrWorkspace", + "filter": { + "type": "Include", + "items": [ + { + "type": "AgentAddress", + "address": "npmuser" + } + ] + } + }, + { + "name": "bing", + "address": "bing.com" + }, + { + "name": "google", + "address": "google.com" + } + ], + "testConfigurations": [ + { + "name": "testConfig1", + "testFrequencySec": 60, + "protocol": "Tcp", + "tcpConfiguration": { + "port": 80, + "disableTraceRoute": false + } + } + ], + "testGroups": [ + { + "name": "test1", + "disable": false, + "testConfigurations": [ + "testConfig1" + ], + "sources": [ + "vm1", + "CanaryWorkspaceVamshi" + ], + "destinations": [ + "bing", + "google" + ] + } + ], + "outputs": [] + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/connectionMonitors" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectivityCheck.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectivityCheck.json new file mode 100644 index 000000000000..21d6a0ae1870 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherConnectivityCheck.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "source": { + "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + }, + "destination": { + "address": "192.168.100.4", + "port": 3389 + }, + "preferredIPVersion": "IPv4" + } + }, + "responses": { + "200": { + "body": { + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "VirtualNetwork", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "192.168.100.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds": [], + "issues": [] + } + ], + "connectionStatus": "Connected", + "avgLatencyInMs": 1, + "minLatencyInMs": 1, + "maxLatencyInMs": 4, + "probesSent": 100, + "probesFailed": 0 + } + }, + "202": { + "body": { + "hops": [ + { + "type": "Source", + "id": "7dbbe7aa-60ba-4650-831e-63d775d38e9e", + "address": "10.1.1.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic0/ipConfigurations/ipconfig1", + "nextHopIds": [ + "75c8d819-b208-4584-a311-1aa45ce753f9" + ], + "issues": [] + }, + { + "type": "VirtualNetwork", + "id": "75c8d819-b208-4584-a311-1aa45ce753f9", + "address": "192.168.100.4", + "resourceId": "subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1/ipConfigurations/ipconfig1", + "nextHopIds": [], + "issues": [] + } + ], + "connectionStatus": "Connected", + "avgLatencyInMs": 1, + "minLatencyInMs": 1, + "maxLatencyInMs": 4, + "probesSent": 100, + "probesFailed": 0 + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherCreate.json new file mode 100644 index 000000000000..6c89de946222 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherCreate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "location": "eastus", + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherDelete.json new file mode 100644 index 000000000000..d19a05fb8285 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogConfigure.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogConfigure.json new file mode 100644 index 000000000000..cbc525d272d7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogConfigure.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + } + } + }, + "responses": { + "200": { + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + } + } + }, + "202": { + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogCreate.json new file mode 100644 index 000000000000..c79242816274 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogCreate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "flowLogName": "fl", + "parameters": { + "location": "centraluseuap", + "properties": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabled": true, + "format": { + "type": "JSON", + "version": 1 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Updating", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 1 + } + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "location": "centraluseuap" + } + }, + "201": { + "body": { + "name": "Microsoft.Networkdesmond-rgdesmondcentral-nsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw/FlowLogs/fl", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/desmondcentral-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/nwtest1mgvbfmqsigdxe", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 1 + } + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "location": "centraluseuap" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogDelete.json new file mode 100644 index 000000000000..87815417a1e5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "flowLogName": "fl" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogGet.json new file mode 100644 index 000000000000..22b8675fc832 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogGet.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "flowLogName": "flowLog1" + }, + "responses": { + "200": { + "body": { + "name": "flowLog1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/тц1/FlowLogs/flowLog1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/vm5-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/wzstorage002", + "enabled": true, + "flowAnalyticsConfiguration": { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": false, + "workspaceId": "-", + "workspaceRegion": "-", + "trafficAnalyticsInterval": 60 + } + }, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 2 + } + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/FlowLogs" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogList.json new file mode 100644 index 000000000000..780d3ae8a213 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogList.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "flowLog1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/тц1/FlowLogs/flowLog1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/vm5-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/wzstorage002", + "enabled": true, + "flowAnalyticsConfiguration": { + "networkWatcherFlowAnalyticsConfiguration": { + "enabled": false, + "workspaceId": "-", + "workspaceRegion": "-", + "trafficAnalyticsInterval": 60 + } + }, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 2 + } + }, + "location": "centraluseuap", + "type": "Microsoft.Network/networkWatchers/FlowLogs" + }, + { + "name": "flowLog2", + "id": "/subscriptions/96e68903-0a56-4819-9987-8d08ad6a1f99/resourceGroups/NetworkWatcherRG/providers/Microsoft.Network/networkWatchers/NetworkWatcher_centraluseuap/FlowLogs/flowLog2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "targetResourceId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/networkSecurityGroups/DSCP-test-vm1-nsg", + "targetResourceGuid": "00000000-0000-0000-0000-000000000000", + "storageId": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Storage/storageAccounts/iraflowlogtest2diag", + "enabled": true, + "flowAnalyticsConfiguration": {}, + "retentionPolicy": { + "days": 0, + "enabled": false + }, + "format": { + "type": "JSON", + "version": 2 + } + }, + "type": "Microsoft.Network/networkWatchers/FlowLogs", + "location": "centraluseuap" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogStatusQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogStatusQuery.json new file mode 100644 index 000000000000..930f8d0f1665 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherFlowLogStatusQuery.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + } + }, + "responses": { + "200": { + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + } + } + }, + "202": { + "body": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "enabled": true + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherGet.json new file mode 100644 index 000000000000..1a1d63c099df --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherIpFlowVerify.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherIpFlowVerify.json new file mode 100644 index 000000000000..d6cede702275 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherIpFlowVerify.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "direction": "Outbound", + "protocol": "TCP", + "localPort": "80", + "remotePort": "80", + "localIPAddress": "10.2.0.4", + "remoteIPAddress": "121.10.1.1" + } + }, + "responses": { + "200": { + "body": { + "access": "Allow", + "ruleName": "Rule1" + } + }, + "202": { + "body": { + "access": "Allow", + "ruleName": "Rule1" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherList.json new file mode 100644 index 000000000000..fbf8d5ae828d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherListAll.json new file mode 100644 index 000000000000..90a558cfeb17 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherListAll.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + }, + { + "name": "nw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "westus", + "tags": {}, + "properties": { + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json new file mode 100644 index 000000000000..86a063fa6c79 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherNetworkConfigurationDiagnostic.json @@ -0,0 +1,198 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "profiles": [ + { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + } + ] + } + }, + "responses": { + "200": { + "body": { + "results": [ + { + "profile": { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + }, + "networkSecurityGroupResult": { + "securityRuleAccessResult": "Allow", + "evaluatedNetworkSecurityGroups": [ + { + "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_Cleanuptool-Allow-100", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-101", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-102", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Deny-103", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + }, + { + "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + } + ] + } + } + ] + } + }, + "202": { + "body": { + "results": [ + { + "profile": { + "direction": "Inbound", + "protocol": "TCP", + "source": "10.1.0.4", + "destination": "12.11.12.14", + "destinationPort": "12100" + }, + "networkSecurityGroupResult": { + "securityRuleAccessResult": "Allow", + "evaluatedNetworkSecurityGroups": [ + { + "networkSecurityGroupId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/nsg1", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/subnets/AppSubnet", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_Cleanuptool-Allow-100", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-101", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Allow-102", + "protocolMatched": true, + "sourceMatched": false, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_Cleanuptool-Deny-103", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": false + }, + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + }, + { + "networkSecurityGroupId": "/subscriptions/61cc8a98-a8be-4bfe-a04e-0b461f93fe35/resourceGroups/NwRgCentralUSEUAP_copy/providers/Microsoft.Network/networkSecurityGroups/AppNSG", + "appliedTo": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet/networkInterfaces/nic", + "matchedRule": { + "ruleName": "UserRule_fe_rule", + "action": "Allow" + }, + "rulesEvaluationResult": [ + { + "name": "UserRule_fe_rule", + "protocolMatched": true, + "sourceMatched": true, + "sourcePortMatched": true, + "destinationMatched": true, + "destinationPortMatched": true + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherNextHopGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherNextHopGet.json new file mode 100644 index 000000000000..400b222506f1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherNextHopGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "sourceIPAddress": "10.0.0.5", + "destinationIPAddress": "10.0.0.10", + "targetNicResourceId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/nic1" + } + }, + "responses": { + "200": { + "body": { + "nextHopType": "VnetLocal", + "nextHopIpAddress": "10.0.0.1", + "routeTableId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/rt1" + } + }, + "202": { + "body": { + "nextHopType": "VnetLocal", + "nextHopIpAddress": "10.0.0.1", + "routeTableId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/rt1" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureCreate.json new file mode 100644 index 000000000000..00f30368fc87 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureCreate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1", + "parameters": { + "properties": { + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "properties": { + "provisioningState": "Updating", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureDelete.json new file mode 100644 index 000000000000..f359375349b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureGet.json new file mode 100644 index 000000000000..41ff109d05b5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "200": { + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Updating", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureQueryStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureQueryStatus.json new file mode 100644 index 000000000000..4d00c282bd1f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureQueryStatus.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "200": { + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "captureStartTime": "2016-09-07T12:35:24Z", + "packetCaptureStatus": "Stopped", + "stopReason": "TimeExceeded", + "packetCaptureError": [] + } + }, + "202": { + "body": { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "captureStartTime": "2016-09-07T12:35:24Z", + "packetCaptureStatus": "Stopped", + "stopReason": "TimeExceeded", + "packetCaptureError": [] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureStop.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureStop.json new file mode 100644 index 000000000000..ac37cf5aaa04 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCaptureStop.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "packetCaptureName": "pc1" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCapturesList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCapturesList.json new file mode 100644 index 000000000000..5119d9cb53a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherPacketCapturesList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "pc1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Updating", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc1.cap", + "filePath": "D:\\capture\\pc1.cap" + }, + "filters": [ + { + "protocol": "TCP", + "localIPAddress": "10.0.0.4", + "localPort": "80" + } + ] + } + }, + { + "name": "pc2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1/packetCaptures/pc2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "target": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "bytesToCapturePerPacket": 10000, + "totalBytesPerSession": 100000, + "timeLimitInSeconds": 100, + "storageLocation": { + "storageId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Storage/storageAccounts/pcstore", + "storagePath": "https://mytestaccountname.blob.core.windows.net/capture/pc2.cap", + "filePath": "D:\\capture\\pc2.cap" + }, + "filters": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherSecurityGroupViewGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherSecurityGroupViewGet.json new file mode 100644 index 000000000000..d65a9b81b49f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherSecurityGroupViewGet.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "responses": { + "200": { + "body": { + "networkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1", + "securityRuleAssociations": { + "subnetAssociation": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "securityRules": [ + { + "name": "fe_rule", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow Frontend", + "protocol": "Tcp", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "10.1.0.0/24", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 100, + "direction": "Inbound" + } + } + ] + }, + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + } + ], + "effectiveSecurityRules": [ + { + "name": "DefaultOutboundDenyAll", + "protocol": "All", + "sourcePortRange": "0-65535", + "destinationPortRange": "0-65535", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + ] + } + } + ] + } + }, + "202": { + "body": { + "networkInterfaces": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/nic1", + "securityRuleAssociations": { + "subnetAssociation": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "securityRules": [ + { + "name": "fe_rule", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkSecurityGroups/AppNSG/securityRules/fe_rule", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow Frontend", + "protocol": "Tcp", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "10.1.0.0/24", + "destinationAddressPrefix": "*", + "access": "Allow", + "priority": 100, + "direction": "Inbound" + } + } + ] + }, + "defaultSecurityRules": [ + { + "name": "AllowVnetInBound", + "id": "/subscriptions//resourceGroups//providers/Microsoft.Network/networkSecurityGroups//defaultSecurityRules/", + "properties": { + "provisioningState": "Succeeded", + "description": "Allow inbound traffic from all VMs in VNET", + "protocol": "*", + "sourcePortRange": "*", + "destinationPortRange": "*", + "sourceAddressPrefix": "VirtualNetwork", + "destinationAddressPrefix": "VirtualNetwork", + "access": "Allow", + "priority": 65000, + "direction": "Inbound" + } + } + ], + "effectiveSecurityRules": [ + { + "name": "DefaultOutboundDenyAll", + "protocol": "All", + "sourcePortRange": "0-65535", + "destinationPortRange": "0-65535", + "sourceAddressPrefix": "*", + "destinationAddressPrefix": "*", + "access": "Deny", + "priority": 65500, + "direction": "Outbound" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTopologyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTopologyGet.json new file mode 100644 index 000000000000..44b399b85a4f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTopologyGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceGroupName": "rg2" + } + }, + "responses": { + "200": { + "body": { + "id": "ce592f46-8164-4bf2-ad36-b8e4acf6fb68", + "createdDateTime": "2017-08-02T19:31:55.9461781Z", + "lastModified": "2017-05-27T00:00:13.2005337Z", + "resources": [ + { + "name": "MultiTierApp0", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/MultiTierApp0", + "location": "westus", + "associations": [ + { + "name": "appNic0", + "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/appNic0", + "associationType": "Contains" + }, + { + "name": "appNic10", + "resourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/networkInterfaces/appNic10", + "associationType": "Contains" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTroubleshootGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTroubleshootGet.json new file mode 100644 index 000000000000..d6cb768f0d58 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTroubleshootGet.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1", + "properties": { + "storageId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Storage/storageAccounts/st1", + "storagePath": "https://st1.blob.core.windows.net/cn1" + } + } + }, + "responses": { + "200": { + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + }, + "202": { + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTroubleshootResultQuery.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTroubleshootResultQuery.json new file mode 100644 index 000000000000..48d281e3ba16 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherTroubleshootResultQuery.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "targetResourceId": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Compute/virtualMachines/vm1" + } + }, + "responses": { + "200": { + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + }, + "202": { + "body": { + "startTime": "2017-01-12T00:19:47.0442834Z", + "endTime": "2017-01-12T00:20:09.914Z", + "code": "UnHealthy", + "results": [ + { + "id": "000000", + "reasonType": "VipUnResponsive", + "summary": "We are sorry, your VPN gateway is unreachable from the Internet", + "detail": "During this time S2S VPN tunnels to on premises sites or other Azure virtual networks will be disconnected", + "recommendedActions": [ + { + "actionText": "Verify if there is a network security group (NSG) applied to the GatewaySubnet", + "actionUri": "https://docs.microsoft.com/en-us/azure/virtual-network/virtual-networks-create-nsg-arm-pportal", + "actionUriText": "Verify" + }, + { + "actionText": "If your VPN gateway isn't up and running by the expected resolution time, contact support", + "actionUri": "http://azure.microsoft.com/support", + "actionUriText": "contact support" + } + ] + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherUpdateTags.json new file mode 100644 index 000000000000..4739c5f140a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/NetworkWatcherUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkWatcherName": "nw1", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "nw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkWatchers/nw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/networkWatchers", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/OperationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/OperationList.json new file mode 100644 index 000000000000..bfd7ac8c3ab6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/OperationList.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Network/localnetworkgateways/read", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Get LocalNetworkGateway", + "description": "Gets LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/write", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Create or update LocalNetworkGateway", + "description": "Creates or updates an existing LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/localnetworkgateways/delete", + "display": { + "provider": "Microsoft Network", + "resource": "LocalNetworkGateway", + "operation": "Delete LocalNetworkGateway", + "description": "Deletes LocalNetworkGateway" + } + }, + { + "name": "Microsoft.Network/networkInterfaces/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Interface metric definition", + "operation": "Read Network Interface metric definitions", + "description": "Gets available metrics for the Network Interface" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "BytesSentRate", + "displayName": "Bytes Sent", + "displayDescription": "Number of bytes the Network Interface sent", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + }, + { + "name": "BytesReceivedRate", + "displayName": "Bytes Received", + "displayDescription": "Number of bytes the Network Interface received", + "unit": "Count", + "aggregationType": "Total", + "availabilities": [ + { + "timeGrain": "00:01:00", + "retention": "00:00:00", + "blobDuration": "01:00:00" + }, + { + "timeGrain": "01:00:00", + "retention": "00:00:00", + "blobDuration": "1.00:00:00" + } + ], + "enableRegionalMdmAccount": false, + "metricFilterPattern": "^__Ready__$", + "fillGapWithZero": false, + "dimensions": [], + "isInternal": false + } + ] + } + } + }, + { + "name": "Microsoft.Network/networksecuritygroups/providers/Microsoft.Insights/logDefinitions/read", + "display": { + "provider": "Microsoft Network", + "resource": "Network Security Groups Log Definitions", + "operation": "Get Network Security Group Event Log Definitions", + "description": "Gets the events for network security group" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "NetworkSecurityGroupEvent", + "displayName": "Network Security Group Event", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupRuleCounter", + "displayName": "Network Security Group Rule Counter", + "blobDuration": "PT1H" + }, + { + "name": "NetworkSecurityGroupFlowEvent", + "displayName": "Network Security Group Rule Flow Event", + "blobDuration": "PT1H" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayDelete.json new file mode 100644 index 000000000000..f111a55fe7a7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGenerateVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGenerateVpnProfile.json new file mode 100644 index 000000000000..6d2b662ea009 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGenerateVpnProfile.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "gatewayName": "p2sVpnGateway1", + "parameters": { + "authenticationMethod": "EAPTLS" + } + }, + "responses": { + "202": {}, + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGet.json new file mode 100644 index 000000000000..b629a16ea26f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGet.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGetConnectionHealth.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGetConnectionHealth.json new file mode 100644 index 000000000000..828f61f639a0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGetConnectionHealth.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + } + } + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json new file mode 100644 index 000000000000..9ffe068b8227 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayGetConnectionHealthDetailed.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "p2s-vpn-gateway-test", + "gatewayName": "p2svpngateway", + "api-version": "2020-05-01", + "request": { + "vpnUserNamesFilter": [ + "vpnUser1", + "vpnUser2" + ], + "outputBlobSasUrl": "https://blobcortextesturl.blob.core.windows.net/folderforconfig/p2sconnectionhealths?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b" + } + }, + "responses": { + "200": { + "body": "" + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayList.json new file mode 100644 index 000000000000..15452a793508 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayList.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + } + } + }, + { + "name": "p2sVpnGateway2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.4.0.0/16" + ] + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "4.4.4.4" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayListByResourceGroup.json new file mode 100644 index 000000000000..b697e300f02f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayListByResourceGroup.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + } + } + }, + { + "name": "p2sVpnGateway2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "4.4.4.4" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayPut.json new file mode 100644 index 000000000000..cd85626cf577 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayPut.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "p2SVpnGatewayParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "1.1.1.1", + "2.2.2.2" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "1.1.1.1", + "2.2.2.2" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 0, + "allocatedIpAddresses": [], + "totalIngressBytesTransferred": 0, + "totalEgressBytesTransferred": 0 + } + } + } + }, + "201": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "1.1.1.1", + "2.2.2.2" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 0, + "allocatedIpAddresses": [], + "totalIngressBytesTransferred": 0, + "totalEgressBytesTransferred": 0 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayUpdateTags.json new file mode 100644 index 000000000000..3886b46480ff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2SVpnGatewayUpdateTags.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "gatewayName": "p2sVpnGateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "p2SVpnGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "p2sVpnGateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/P2SvpnGateways/p2sVpnGateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/p2sVpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "vpnServerConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1" + }, + "p2SConnectionConfigurations": [ + { + "name": "P2SConnectionConfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/p2sVpnGateways/p2sVpnGateway1/p2sConnectionConfigurations/P2SConnectionConfig1", + "properties": { + "vpnClientAddressPool": { + "addressPrefixes": [ + "101.3.0.0/16" + ] + } + } + } + ], + "vpnGatewayScaleUnit": 1, + "customDnsServers": [ + "3.3.3.3" + ], + "vpnClientConnectionHealth": { + "vpnClientConnectionsCount": 2, + "allocatedIpAddresses": [ + "1.1.1.1", + "2.2.2.2" + ], + "totalIngressBytesTransferred": 2000, + "totalEgressBytesTransferred": 3000 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json new file mode 100644 index 000000000000..01c7951601b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "p2s-vpn-gateway-test", + "p2sVpnGatewayName": "p2svpngateway", + "api-version": "2020-05-01", + "request": { + "vpnConnectionIds": [ + "vpnconnId1", + "vpnconnId2" + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PeerExpressRouteCircuitConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PeerExpressRouteCircuitConnectionGet.json new file mode 100644 index 000000000000..252169e5a784 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PeerExpressRouteCircuitConnectionGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "connectionName": "60aee347-e889-4a42-8c1b-0aae8b1e4013", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "name": "60aee347-e889-4a42-8c1b-0aae8b1e4013", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/60aee347-e889-4a42-8c1b-0aae8b1e4013", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitB/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionWestusEastus", + "authResourceGuid": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PeerExpressRouteCircuitConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PeerExpressRouteCircuitConnectionList.json new file mode 100644 index 000000000000..358b9caf9470 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PeerExpressRouteCircuitConnectionList.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid1", + "circuitName": "ExpressRouteARMCircuitA", + "peeringName": "AzurePrivatePeering" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "60aee347-e889-4a42-8c1b-0aae8b1e4013", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/60aee347-e889-4a42-8c1b-0aae8b1e4013", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitB/peerings/AzurePrivatePeering" + }, + "addressPrefix": "20.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionWestusEastus", + "authResourceGuid": "" + } + }, + { + "name": "c8b17193-8dd3-4f61-866d-8cdd2e2e268e", + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering/peerConnections/c8b17193-8dd3-4f61-866d-8cdd2e2e268e", + "etag": "W/\"6ffbbb06-da20-44ca-a34f-280c4653b1e9\"", + "properties": { + "provisioningState": "Succeeded", + "expressRouteCircuitPeering": { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitA/peerings/AzurePrivatePeering" + }, + "peerExpressRouteCircuitPeering": { + "id": "/subscriptions/subid2/resourceGroups/rg1/providers/Microsoft.Network/expressRouteCircuits/ExpressRouteARMCircuitC/peerings/AzurePrivatePeering" + }, + "addressPrefix": "30.0.0.0/29", + "circuitConnectionStatus": "Connected", + "connectionName": "circuitConnectionCentralusEastus", + "authResourceGuid": "64283012-d377-421d-8398-f6aeb2ac7ea0" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointCreate.json new file mode 100644 index 000000000000..39ef52e2e27d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointCreate.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "parameters": { + "location": "eastus2euap", + "properties": { + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection." + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointCreateForManualApproval.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointCreateForManualApproval.json new file mode 100644 index 000000000000..441f483c3750 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointCreateForManualApproval.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "parameters": { + "location": "eastus", + "properties": { + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection." + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ] + } + } + }, + "201": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDelete.json new file mode 100644 index 000000000000..c7ca1aca4ffe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupCreate.json new file mode 100644 index 000000000000..cae145e95d27 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupCreate.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "privateDnsZoneGroupName": "testPdnsgroup", + "parameters": { + "properties": { + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPdnsgroup", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testPdnsgroup", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupDelete.json new file mode 100644 index 000000000000..22268fc9ee35 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "privateDnsZoneGroupName": "testPdnsgroup" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupGet.json new file mode 100644 index 000000000000..a8ad98013e19 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupGet.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe", + "privateDnsZoneGroupName": "testPdnsgroup" + }, + "responses": { + "200": { + "body": { + "name": "testPdnsgroup", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + }, + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone2.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone2.com", + "ipAddresses": [ + "10.0.0.6" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone2.com", + "ipAddresses": [ + "10.0.0.7" + ] + } + ] + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupList.json new file mode 100644 index 000000000000..c737c03e6d19 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointDnsZoneGroupList.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPdnsgroup1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup1", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone1.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc", + "fqdn": "abc.zone1.com", + "ipAddresses": [ + "10.0.0.4" + ] + }, + { + "recordType": "A", + "recordSetName": "abc2", + "fqdn": "abc2.zone1.com", + "ipAddresses": [ + "10.0.0.5" + ] + } + ] + } + } + ] + } + }, + { + "name": "testPdnsgroup2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPe/privateDnsZoneGroups/testPdnsgroup2", + "properties": { + "provisioningState": "Succeeded", + "privateDnsZoneConfigs": [ + { + "properties": { + "privateDnsZoneId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateDnsZones/zone2.com", + "recordSets": [ + { + "recordType": "A", + "recordSetName": "abc3", + "fqdn": "abc3.zone2.com", + "ipAddresses": [ + "10.0.0.6" + ] + }, + { + "recordType": "A", + "recordSetName": "abc4", + "fqdn": "abc4.zone2.com", + "ipAddresses": [ + "10.0.0.7" + ] + } + ] + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointGet.json new file mode 100644 index 000000000000..3526918c0227 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointGet.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointGetForManualApproval.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointGetForManualApproval.json new file mode 100644 index 000000000000..2d20a46d3899 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointGetForManualApproval.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "privateEndpointName": "testPe" + }, + "responses": { + "200": { + "body": { + "name": "testPe", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPe.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointList.json new file mode 100644 index 000000000000..21208347dd46 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointList.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1", + "name": "pe1", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection for pe1.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "manualPrivateLinkServiceConnections": [], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/pe1.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe2", + "name": "pe2", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection for pe2.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet2" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/pe2.nic.zyxw9876" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc3.cosmos1.com", + "ipAddresses": [ + "192.168.0.6" + ] + }, + { + "fqdn": "abc4.cosmos1.com", + "ipAddresses": [ + "192.168.0.7" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointListAll.json new file mode 100644 index 000000000000..0182a0824dfa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateEndpointListAll.json @@ -0,0 +1,156 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/pe1", + "name": "pe1", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection for pe1.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/pe1.nic.abcd1234" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc.cosmos.com", + "ipAddresses": [ + "192.168.0.4" + ] + }, + { + "fqdn": "abc2.cosmos.com", + "ipAddresses": [ + "192.168.0.5" + ] + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2", + "name": "pe2", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [], + "manualPrivateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please manually approve my connection for pe2.", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Awaiting approval", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet2" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/pe2.nic.zyxw9876" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc3.cosmos1.com", + "ipAddresses": [ + "192.168.0.5" + ] + }, + { + "fqdn": "abc4.cosmos1.com", + "ipAddresses": [ + "192.168.0.6" + ] + } + ] + } + }, + { + "id": "/subscriptions/subId/resourceGroups/rg3/providers/Microsoft.Network/privateEndpoints/pe3", + "name": "pe3", + "type": "Microsoft.Network/privateEndpoints", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnections": [ + { + "properties": { + "privateLinkServiceId": "/subscriptions/subId/resourceGroups/rg3/providers/Microsoft.Network/privateLinkServices/testPls3", + "groupIds": [ + "groupIdFromResource" + ], + "requestMessage": "Please approve my connection for pe3.", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-approved", + "actionsRequired": "None" + } + } + } + ], + "subnet": { + "id": "/subscriptions/subId/resourceGroups/rg3/providers/Microsoft.Network/virtualNetworks/myVnet/subnets/mySubnet3" + }, + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg3/provders/Microsoft.Network/networkInterfaces/pe3.nic.efgh5463" + } + ], + "customDnsConfigs": [ + { + "fqdn": "abc5.cosmos2.com", + "ipAddresses": [ + "192.168.0.7" + ] + }, + { + "fqdn": "abc6.cosmos2.com", + "ipAddresses": [ + "192.168.0.8" + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceCreate.json new file mode 100644 index 000000000000..a42ff2ee8256 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceCreate.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "parameters": { + "location": "eastus", + "properties": { + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPls", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls.nic.abcd1234" + } + ] + } + } + }, + "201": { + "body": { + "name": "testPls", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceDelete.json new file mode 100644 index 000000000000..4c3fb1f375c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..d0d86d85052d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceDeletePrivateEndpointConnection.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "peConnectionName": "testPlePeConnection" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceGet.json new file mode 100644 index 000000000000..e4c7252eba49 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceGet.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls" + }, + "responses": { + "200": { + "body": { + "name": "testPls", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "privateEndpointConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls.nic.abcd1234" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..07a447b34806 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceGetPrivateEndpointConnection.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "peConnectionName": "testPlePeConnection" + }, + "responses": { + "200": { + "body": { + "name": "testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceList.json new file mode 100644 index 000000000000..f620c958dfff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceList.json @@ -0,0 +1,141 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPls1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb1" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb1", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb1" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls1.nic.abcd1234" + } + ] + } + }, + { + "name": "testPls2", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls2", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb2" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb2", + "properties": { + "privateIPAddress": "10.0.1.5", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb2" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec2", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls2.nic.efgh5678" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceListAll.json new file mode 100644 index 000000000000..82e4e3adca6a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceListAll.json @@ -0,0 +1,142 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPls1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateLinkServices/testPls1", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2", + "subscription3" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2", + "fqdn3" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb1" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb1", + "properties": { + "privateIPAddress": "10.0.1.4", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb1" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/provders/Microsoft.Network/networkInterfaces/testPls1.nic.abcd1234" + } + ] + } + }, + { + "name": "testPls2", + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateLinkServices/testPls2", + "type": "Microsoft.Network/privateLinkServices", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "visibility": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "autoApproval": { + "subscriptions": [ + "subscription1", + "subscription2" + ] + }, + "fqdns": [ + "fqdn1", + "fqdn2" + ], + "alias": "ContosoService.{guid}.azure.privatelinkservice", + "loadBalancerFrontendIpConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe-lb2" + } + ], + "ipConfigurations": [ + { + "name": "fe-lb2", + "properties": { + "privateIPAddress": "10.0.1.5", + "privateIPAllocationMethod": "Static", + "privateIPAddressVersion": "IPv4", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnetlb/subnets/subnetlb2" + } + } + } + ], + "privateEndpointConnections": [ + { + "name": "pec1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/testPe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + ], + "networkInterfaces": [ + { + "id": "/subscriptions/subId/resourceGroups/rg2/provders/Microsoft.Network/networkInterfaces/testPls2.nic.efgh5678" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json new file mode 100644 index 000000000000..3e5e12598603 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceListPrivateEndpointConnection.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPlePeConnection1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + }, + { + "name": "testPlePeConnection2", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe2" + }, + "privateLinkServiceConnectionState": { + "status": "Rejected", + "description": "rejected by some reason." + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json new file mode 100644 index 000000000000..d4c5ba4e6b15 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "serviceName": "testPls", + "peConnectionName": "testPlePeConnection", + "parameters": { + "name": "testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "testPlePeConnection", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/privateEndpoints/testPe" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "approved it for some reason." + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateCustomizedValues.json new file mode 100644 index 000000000000..16312085e115 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateCustomizedValues.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "zones": [ + "1" + ], + "parameters": { + "properties": { + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "publicIPAddressVersion": "IPv4" + }, + "sku": { + "name": "Standard" + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateDefaults.json new file mode 100644 index 000000000000..f350d53490f8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateDefaults.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Basic" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateDns.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateDns.json new file mode 100644 index 000000000000..9f1c5c3b8967 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressCreateDns.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "properties": { + "dnsSettings": { + "domainNameLabel": "dnslbl" + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "dnslbl", + "fqdn": "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + }, + "201": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "dnslbl", + "fqdn": "dnslbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressDelete.json new file mode 100644 index 000000000000..2c3b29ebfe3a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressGet.json new file mode 100644 index 000000000000..96e97833274e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "testDNS-ip" + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + }, + { + "ipTagType": "FirstPartyUsage", + "tag": "Storage" + } + ] + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressList.json new file mode 100644 index 000000000000..09051b9aa093 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + }, + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + }, + { + "ipTagType": "FirstPartyUsage", + "tag": "Storage" + } + ] + }, + "type": "Microsoft.Network/publicIPAddresses" + }, + { + "name": "ip03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/ip03", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.85.154.247", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "testlbl", + "fqdn": "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressListAll.json new file mode 100644 index 000000000000..d91c92e4175b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressListAll.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testDNS-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + }, + { + "name": "ip01", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPAddresses/ip01", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.85.154.247", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Dynamic", + "idleTimeoutInMinutes": 4, + "dnsSettings": { + "domainNameLabel": "testlbl", + "fqdn": "testlbl.westus.cloudapp.azure.com" + }, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/loadBalancers/testLb/frontendIPConfigurations/LoadBalancerFrontEnd" + } + }, + "type": "Microsoft.Network/publicIPAddresses" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressUpdateTags.json new file mode 100644 index 000000000000..6dbf4fe08443 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpAddressUpdateTags.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpAddressName": "test-ip", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testDNS-ip", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ip", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "publicIPAddressVersion": "IPv4", + "publicIPAllocationMethod": "Static", + "idleTimeoutInMinutes": 10, + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testDNS649/ipConfigurations/ipconfig1" + } + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "type": "Microsoft.Network/publicIPAddresses" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixCreateCustomizedValues.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixCreateCustomizedValues.json new file mode 100644 index 000000000000..538c1f659933 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixCreateCustomizedValues.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "zones": [ + "1" + ], + "parameters": { + "location": "westus", + "properties": { + "publicIPAddressVersion": "IPv4", + "prefixLength": 30 + }, + "sku": { + "name": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + }, + "201": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "zones": [ + "1" + ], + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixCreateDefaults.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixCreateDefaults.json new file mode 100644 index 000000000000..6f278d6f8be7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixCreateDefaults.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": { + "location": "westus", + "properties": { + "prefixLength": 30 + }, + "sku": { + "name": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + }, + "201": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixDelete.json new file mode 100644 index 000000000000..122a464b27e6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixGet.json new file mode 100644 index 000000000000..cec0625f2de4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix" + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "192.168.254.2/30", + "ipTags": [], + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixList.json new file mode 100644 index 000000000000..7b8db88158c5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "40.85.154.2/30", + "ipTags": [ + { + "ipTagType": "FirstPartyUsage", + "tag": "SQL" + } + ] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + }, + { + "name": "ipprefix03", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/ipprefix03", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 31, + "ipPrefix": "40.85.153.2/31", + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixListAll.json new file mode 100644 index 000000000000..49a40be2b32c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixListAll.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipPrefix": "41.85.154.247/30", + "ipTags": [], + "publicIPAddresses": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/PublicIpAddress1" + } + ] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + }, + { + "name": "ipprefix01", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/publicIPPrefixes/ipprefix01", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "ipPrefix": "40.85.154.247/30", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipTags": [] + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + }, + { + "name": "pfx", + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/publicIPPrefixes/pfx", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "type": "Microsoft.Network/publicIPPrefixes", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "ipPrefix": "25.101.84.16/30", + "publicIPAddressVersion": "IPv4", + "prefixLength": 30, + "ipTags": [], + "loadBalancerFrontendIpConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg3/providers/Microsoft.Network/loadBalancers/lb-pfx/frontendIPConfigurations/ipconfig1" + } + }, + "sku": { + "name": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixUpdateTags.json new file mode 100644 index 000000000000..47ca5d005b9a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/PublicIpPrefixUpdateTags.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "publicIpPrefixName": "test-ipprefix", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-ipprefix", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPPrefixes/test-ipprefix", + "etag": "W/\"00000000-0000-0000-0000-00000000\"", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-00000000", + "publicIPAddressVersion": "IPv4", + "ipPrefix": "40.85.154.247/30", + "prefixLength": 30, + "ipTags": [] + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "sku": { + "name": "Standard" + }, + "type": "Microsoft.Network/publicIPPrefixes" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterCreate.json new file mode 100644 index 000000000000..996ea0db2611 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterCreate.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "routeFilterParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "rules": [ + { + "name": "ruleName", + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterDelete.json new file mode 100644 index 000000000000..5f3c99802cb6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterGet.json new file mode 100644 index 000000000000..e08f4a5ad0b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterList.json new file mode 100644 index 000000000000..20ab386f07ce --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterList.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterListByResourceGroup.json new file mode 100644 index 000000000000..a68218c39406 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterListByResourceGroup.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ], + "peerings": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleCreate.json new file mode 100644 index 000000000000..7ead45178944 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleCreate.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "routeFilterRuleParameters": { + "properties": { + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleDelete.json new file mode 100644 index 000000000000..638dbb7ce658 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "ruleName": "ruleName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleGet.json new file mode 100644 index 000000000000..45355069f1a4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "ruleName": "filterName", + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleListByRouteFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleListByRouteFilter.json new file mode 100644 index 000000000000..65fcfc060384 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterRuleListByRouteFilter.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "routeFilterName": "filterName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030", + "12076:5040" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterUpdateTags.json new file mode 100644 index 000000000000..3c6d28aa4216 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteFilterUpdateTags.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "routeFilterName": "filterName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "parameters": { + "tags": { + "key1": "value1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "filterName", + "type": "Microsoft.Network/routeFilters", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "rules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeFilters/filterName/routeFilterRules/ruleName", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "ruleName", + "properties": { + "provisioningState": "Succeeded", + "access": "Allow", + "routeFilterRuleType": "Community", + "communities": [ + "12076:5030" + ] + } + } + ], + "peerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableCreate.json new file mode 100644 index 000000000000..961b1aef5e3f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableCreate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [], + "disableBgpRoutePropagation": true + } + } + }, + "201": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableCreateWithRoute.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableCreateWithRoute.json new file mode 100644 index 000000000000..9ac7e6e54583 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableCreateWithRoute.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "parameters": { + "properties": { + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableDelete.json new file mode 100644 index 000000000000..b72e6d6bc177 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableGet.json new file mode 100644 index 000000000000..1d178cc0d384 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt" + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": false, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableList.json new file mode 100644 index 000000000000..2be2cff72f14 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "disableBgpRoutePropagation": true, + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt2", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "disableBgpRoutePropagation": true, + "provisioningState": "Succeeded", + "routes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableListAll.json new file mode 100644 index 000000000000..fd8775d702f7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableListAll.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + }, + { + "name": "testrt3", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/routeTables/testrt3", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "routes": [] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteCreate.json new file mode 100644 index 000000000000..274d607c85fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteCreate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "routeName": "route1", + "routeParameters": { + "properties": { + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + }, + "201": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteDelete.json new file mode 100644 index 000000000000..2869de543100 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "routeName": "route1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteGet.json new file mode 100644 index 000000000000..659f2c08dc4e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "routeName": "route1" + }, + "responses": { + "200": { + "body": { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteList.json new file mode 100644 index 000000000000..65ad078fb356 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableRouteList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "route1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.3.0/24", + "nextHopType": "Internet" + } + }, + { + "name": "route2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt/routes/route2", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.2.0/24", + "nextHopType": "VirtualNetworkGateway" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableUpdateTags.json new file mode 100644 index 000000000000..ea1b0524f3ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/RouteTableUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "routeTableName": "testrt", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testrt", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/routeTables/testrt", + "type": "Microsoft.Network/routeTables", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "routes": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderDelete.json new file mode 100644 index 000000000000..e6eb47dadbb6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderGet.json new file mode 100644 index 000000000000..9aa35b6ab1f6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider" + }, + "responses": { + "200": { + "body": { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "connectionStatus": "Unknown", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderListByResourceGroup.json new file mode 100644 index 000000000000..b6233d5575a7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderListByResourceGroup.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "connectionStatus": "Unknown", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderListBySubscription.json new file mode 100644 index 000000000000..67e9f2d659be --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderListBySubscription.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "connectionStatus": "Unknown", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderPut.json new file mode 100644 index 000000000000..410274f8bf31 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderPut.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "securityProviderName": "ZScaler", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + }, + "201": { + "body": { + "name": "securityPartnerProvider", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderUpdateTags.json new file mode 100644 index 000000000000..10316e09642b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SecurityPartnerProviderUpdateTags.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "securityPartnerProviderName": "securityPartnerProvider", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "fw1", + "id": "/subscriptions/subid/resourceGroups/azfwtest/providers/Microsoft.Network/securityPartnerProviders/securityPartnerProvider", + "type": "Microsoft.Network/securityPartnerProviders", + "location": "brazilsouth", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "securityProviderName": "ZScaler" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceCommunityList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceCommunityList.json new file mode 100644 index 000000000000..eea3a1c58726 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceCommunityList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities/skype", + "name": "skype", + "type": "Microsoft.Network/bgpServiceCommunities", + "properties": { + "serviceName": "skype", + "bgpCommunities": [ + { + "serviceSupportedRegion": "Global", + "communityName": "Skype For Business Online", + "communityValue": "12076:5030", + "communityPrefixes": [ + "13.67.56.225/32", + "13.67.186.105/32" + ], + "isAuthorizedToUse": true, + "serviceGroup": "O365" + } + ] + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.Network/bgpServiceCommunities/exchange", + "name": "exchange", + "type": "Microsoft.Network/bgpServiceCommunities", + "properties": { + "serviceName": "exchange", + "bgpCommunities": [ + { + "serviceSupportedRegion": "Global", + "communityName": "Exchange Online", + "communityValue": "12076:5040", + "communityPrefixes": [ + "13.67.56.225/32", + "13.67.186.105/32" + ], + "isAuthorizedToUse": true, + "serviceGroup": "O365" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyCreate.json new file mode 100644 index 000000000000..f32251e5cdb9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyCreate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "parameters": { + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyCreateWithDefinition.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyCreateWithDefinition.json new file mode 100644 index 000000000000..9666a141fef4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyCreateWithDefinition.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "parameters": { + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + }, + "201": { + "body": { + "name": "testnsg", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ServiceEndpointPolicies/testpolicy", + "type": "Microsoft.Network/ServiceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionCreate.json new file mode 100644 index 000000000000..9dcbf839f5f5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionCreate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition", + "ServiceEndpointPolicyDefinitions": { + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "testDefinition", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + }, + "201": { + "body": { + "name": "rule1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/testnsg/securityRules/rule1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionDelete.json new file mode 100644 index 000000000000..32c20c947a55 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionGet.json new file mode 100644 index 000000000000..1bf128424757 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy", + "serviceEndpointPolicyDefinitionName": "testDefinition" + }, + "responses": { + "200": { + "body": { + "name": "testDefinition", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionList.json new file mode 100644 index 000000000000..5b5d859628cb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDefinitionList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testPolicy" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testDef", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy/serviceEndpointPolicyDefinitions/testDef", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDelete.json new file mode 100644 index 000000000000..6b4465ec70a3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "serviceEndpointPolicy1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyGet.json new file mode 100644 index 000000000000..3fd273a2daba --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testServiceEndpointPolicy" + }, + "responses": { + "200": { + "body": { + "name": "testServiceEndpointPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyList.json new file mode 100644 index 000000000000..e84480205644 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyList.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testServiceEndpointPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + }, + { + "name": "testServiceEndpointPolicy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy1", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyListAll.json new file mode 100644 index 000000000000..a4f90a94ce3a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyListAll.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition1", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + }, + { + "name": "testPolicy1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/serviceEndpointPolicies/testPolicy2", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "properties": { + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition2", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [], + "provisioningState": "Succeeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyUpdateTags.json new file mode 100644 index 000000000000..57529ae19064 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceEndpointPolicyUpdateTags.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "serviceEndpointPolicyName": "testServiceEndpointPolicy", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "testServiceEndpointPolicy", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/serviceEndpointPolicies/testServiceEndpointPolicy", + "type": "Microsoft.Network/serviceEndpointPolicies", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "serviceEndpointPolicyDefinitions": [ + { + "name": "StorageServiceEndpointPolicyDefinition", + "properties": { + "description": "Storage Service EndpointPolicy Definition", + "service": "Microsoft.Storage", + "serviceResources": [ + "/subscriptions/subid1", + "/subscriptions/subid1/resourceGroups/storageRg", + "/subscriptions/subid1/resourceGroups/storageRg/providers/Microsoft.Storage/storageAccounts/stAccount" + ] + } + } + ], + "subnets": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceTagsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceTagsList.json new file mode 100644 index 000000000000..bfced3013a16 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/ServiceTagsList.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "location": "westcentralus", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "name": "public", + "id": "/subscriptions/subId/providers/Microsoft.Network/serviceTags/public", + "type": "Microsoft.Network/serviceTags", + "changeNumber": "63", + "cloud": "Public", + "values": [ + { + "name": "ApiManagement", + "id": "ApiManagement", + "properties": { + "changeNumber": "7", + "region": "", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "13.64.39.16/32", + "40.74.146.80/31", + "40.74.147.32/28" + ] + } + }, + { + "name": "ApiManagement.AustraliaCentral", + "id": "ApiManagement.AustraliaCentral", + "properties": { + "changeNumber": "2", + "region": "australiacentral", + "systemService": "AzureApiManagement", + "addressPrefixes": [ + "20.36.106.68/31", + "20.36.107.176/28" + ] + } + }, + { + "name": "AppService", + "id": "AppService", + "properties": { + "changeNumber": "13", + "region": "", + "systemService": "AzureAppService", + "addressPrefixes": [ + "13.64.73.110/32", + "191.235.208.12/32", + "191.235.215.184/32" + ] + } + }, + { + "name": "ServiceBus", + "id": "ServiceBus", + "properties": { + "changeNumber": "10", + "region": "", + "systemService": "AzureServiceBus", + "addressPrefixes": [ + "23.98.82.96/29", + "40.68.127.68/32", + "40.70.146.64/29" + ] + } + }, + { + "name": "ServiceBus.EastUS2", + "id": "ServiceBus.EastUS2", + "properties": { + "changeNumber": "1", + "region": "eastus2", + "systemService": "AzureServiceBus", + "addressPrefixes": [ + "13.68.110.36/32", + "40.70.146.64/29" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreate.json new file mode 100644 index 000000000000..afabbf864264 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreateServiceEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreateServiceEndpoint.json new file mode 100644 index 000000000000..e9f98d46697a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreateServiceEndpoint.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + } + ], + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ], + "provisioningState": "Succeeded" + } + ], + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreateWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreateWithDelegation.json new file mode 100644 index 000000000000..8f6702136693 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetCreateWithDelegation.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2020-05-01", + "subscriptionId": "subId", + "subnetParameters": { + "properties": { + "addressPrefix": "10.0.0.0/16" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetDelete.json new file mode 100644 index 000000000000..b34fa404daf9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetGet.json new file mode 100644 index 000000000000..cf4439bcf578 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetGet.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetGetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetGetWithDelegation.json new file mode 100644 index 000000000000..d657cd002eae --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetGetWithDelegation.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subnetName": "subnet1", + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2020-05-01", + "subscriptionId": "subId" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subId/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetList.json new file mode 100644 index 000000000000..714b9de07ead --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "virtualNetworkName": "vnetname", + "resourceGroupName": "subnet-test", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet1", + "name": "subnet1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/subnet-test/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/subnet2", + "name": "subnet2", + "properties": { + "addressPrefix": "10.0.0.0/16", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetPrepareNetworkPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetPrepareNetworkPolicies.json new file mode 100644 index 000000000000..df50d4649b8b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetPrepareNetworkPolicies.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "subnetName": "subnet1", + "prepareNetworkPoliciesRequestParameters": { + "serviceName": "Microsoft.Sql/managedInstances" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetUnprepareNetworkPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetUnprepareNetworkPolicies.json new file mode 100644 index 000000000000..26ce5cf24993 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/SubnetUnprepareNetworkPolicies.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "subnetName": "subnet1", + "unprepareNetworkPoliciesRequestParameters": { + "serviceName": "Microsoft.Sql/managedInstances" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/UsageList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/UsageList.json new file mode 100644 index 000000000000..1b8eecdb0d4c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/UsageList.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "location": "westus", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/VirtualNetworks", + "limit": 50.0, + "name": { + "localizedValue": "Virtual Networks", + "value": "VirtualNetworks" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/StaticPublicIPAddresses", + "limit": 20.0, + "name": { + "localizedValue": "Static Public IP Addresses", + "value": "StaticPublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkSecurityGroups", + "limit": 100.0, + "name": { + "localizedValue": "Network Security Groups", + "value": "NetworkSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 8.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PublicIPAddresses", + "limit": 60.0, + "name": { + "localizedValue": "Public IP Addresses", + "value": "PublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkInterfaces", + "limit": 350.0, + "name": { + "localizedValue": "Network Interfaces", + "value": "NetworkInterfaces" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/LoadBalancers", + "limit": 100.0, + "name": { + "localizedValue": "Load Balancers", + "value": "LoadBalancers" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/ApplicationGateways", + "limit": 50.0, + "name": { + "localizedValue": "Application Gateways", + "value": "ApplicationGateways" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteTables", + "limit": 100.0, + "name": { + "localizedValue": "Route Tables", + "value": "RouteTables" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilters", + "limit": 1000.0, + "name": { + "localizedValue": "Route Filters", + "value": "RouteFilters" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/NetworkWatchers", + "limit": 1.0, + "name": { + "localizedValue": "Network Watchers", + "value": "NetworkWatchers" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PacketCaptures", + "limit": 10.0, + "name": { + "localizedValue": "Packet Captures", + "value": "PacketCaptures" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/DnsServersPerVirtualNetwork", + "limit": 9.0, + "name": { + "localizedValue": "DNS servers per Virtual Network", + "value": "DnsServersPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SubnetsPerVirtualNetwork", + "limit": 1000.0, + "name": { + "localizedValue": "Subnets per Virtual Network", + "value": "SubnetsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/IPConfigurationsPerVirtualNetwork", + "limit": 4096.0, + "name": { + "localizedValue": "IP Configurations per Virtual Network", + "value": "IPConfigurationsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/PeeringsPerVirtualNetwork", + "limit": 10.0, + "name": { + "localizedValue": "Peerings per Virtual Network", + "value": "PeeringsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRulesPerNetworkSecurityGroup", + "limit": 200.0, + "name": { + "localizedValue": "Security rules per Network Security Group", + "value": "SecurityRulesPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", + "limit": 2000.0, + "name": { + "localizedValue": "Security rules addresses or ports per Network Security Group", + "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerLoadBalancer", + "limit": 150.0, + "name": { + "localizedValue": "Inbound Rules per Load Balancer", + "value": "InboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/FrontendIPConfigurationPerLoadBalancer", + "limit": 10.0, + "name": { + "localizedValue": "Frontend IP Configurations per Load Balancer", + "value": "FrontendIPConfigurationPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/outboundRulesPerLoadBalancer", + "limit": 5.0, + "name": { + "localizedValue": "Outbound Rules per Load Balancer", + "value": "outboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RoutesPerRouteTable", + "limit": 100.0, + "name": { + "localizedValue": "Routes per Route Table", + "value": "RoutesPerRouteTable" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/SecondaryIPConfigurationsPerNetworkInterface", + "limit": 256.0, + "name": { + "localizedValue": "Secondary IP Configurations per Network Interface", + "value": "SecondaryIPConfigurationsPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/InboundRulesPerNetworkInterface", + "limit": 500.0, + "name": { + "localizedValue": "Inbound rules per Network Interface", + "value": "InboundRulesPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFilterRulesPerRouteFilter", + "limit": 1.0, + "name": { + "localizedValue": "Route filter rules per Route Filter", + "value": "RouteFilterRulesPerRouteFilter" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/westus/usages/RouteFiltersPerExpressRouteBgpPeering", + "limit": 1.0, + "name": { + "localizedValue": "Route filters per Express route BGP Peering", + "value": "RouteFiltersPerExpressRouteBgpPeering" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/UsageListSpacedLocation.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/UsageListSpacedLocation.json new file mode 100644 index 000000000000..c532d31fa4bb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/UsageListSpacedLocation.json @@ -0,0 +1,335 @@ +{ + "parameters": { + "location": "West US", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": 12.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/VirtualNetworks", + "limit": 50.0, + "name": { + "localizedValue": "Virtual Networks", + "value": "VirtualNetworks" + }, + "unit": "Count" + }, + { + "currentValue": 1.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/StaticPublicIPAddresses", + "limit": 20.0, + "name": { + "localizedValue": "Static Public IP Addresses", + "value": "StaticPublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkSecurityGroups", + "limit": 100.0, + "name": { + "localizedValue": "Network Security Groups", + "value": "NetworkSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 12.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PublicIPAddresses", + "limit": 60.0, + "name": { + "localizedValue": "Public IP Addresses", + "value": "PublicIPAddresses" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PublicIpPrefixes", + "limit": 2147483647.0, + "name": { + "localizedValue": "Public Ip Prefixes", + "value": "PublicIpPrefixes" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkInterfaces", + "limit": 24000.0, + "name": { + "localizedValue": "Network Interfaces", + "value": "NetworkInterfaces" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/LoadBalancers", + "limit": 100.0, + "name": { + "localizedValue": "Load Balancers", + "value": "LoadBalancers" + }, + "unit": "Count" + }, + { + "currentValue": 3.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ApplicationGateways", + "limit": 50.0, + "name": { + "localizedValue": "Application Gateways", + "value": "ApplicationGateways" + }, + "unit": "Count" + }, + { + "currentValue": 5.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteTables", + "limit": 100.0, + "name": { + "localizedValue": "Route Tables", + "value": "RouteTables" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFilters", + "limit": 1000.0, + "name": { + "localizedValue": "Route Filters", + "value": "RouteFilters" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkWatchers", + "limit": 1.0, + "name": { + "localizedValue": "Network Watchers", + "value": "NetworkWatchers" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PacketCaptures", + "limit": 100.0, + "name": { + "localizedValue": "Packet Captures", + "value": "PacketCaptures" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ApplicationSecurityGroups", + "limit": 500.0, + "name": { + "localizedValue": "Application Security Groups.", + "value": "ApplicationSecurityGroups" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/DdosProtectionPlans", + "limit": 1.0, + "name": { + "localizedValue": "DDoS Protection Plans.", + "value": "DdosProtectionPlans" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/ServiceEndpointPolicies", + "limit": 200.0, + "name": { + "localizedValue": "Service Endpoint Policies", + "value": "ServiceEndpointPolicies" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/NetworkIntentPolicies", + "limit": 200.0, + "name": { + "localizedValue": "Network Intent Policies", + "value": "NetworkIntentPolicies" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/DnsServersPerVirtualNetwork", + "limit": 9.0, + "name": { + "localizedValue": "DNS servers per Virtual Network", + "value": "DnsServersPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SubnetsPerVirtualNetwork", + "limit": 1000.0, + "name": { + "localizedValue": "Subnets per Virtual Network", + "value": "SubnetsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/IPConfigurationsPerVirtualNetwork", + "limit": 16384.0, + "name": { + "localizedValue": "IP Configurations per Virtual Network", + "value": "IPConfigurationsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/PeeringsPerVirtualNetwork", + "limit": 50.0, + "name": { + "localizedValue": "Peerings per Virtual Network", + "value": "PeeringsPerVirtualNetwork" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRulesPerNetworkSecurityGroup", + "limit": 1000.0, + "name": { + "localizedValue": "Security rules per Network Security Group", + "value": "SecurityRulesPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRulesPerNetworkIntentPolicy", + "limit": 100.0, + "name": { + "localizedValue": "Security rules per Network Intent Policy", + "value": "SecurityRulesPerNetworkIntentPolicy" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RoutesPerNetworkIntentPolicy", + "limit": 100.0, + "name": { + "localizedValue": "Routes per Network Intent Policy", + "value": "RoutesPerNetworkIntentPolicy" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecurityRuleAddressesOrPortsPerNetworkSecurityGroup", + "limit": 2000.0, + "name": { + "localizedValue": "Security rules addresses or ports per Network Security Group", + "value": "SecurityRuleAddressesOrPortsPerNetworkSecurityGroup" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/InboundRulesPerLoadBalancer", + "limit": 150.0, + "name": { + "localizedValue": "Inbound Rules per Load Balancer", + "value": "InboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/FrontendIPConfigurationPerLoadBalancer", + "limit": 10.0, + "name": { + "localizedValue": "Frontend IP Configurations per Load Balancer", + "value": "FrontendIPConfigurationPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/OutboundRulesPerLoadBalancer", + "limit": 5.0, + "name": { + "localizedValue": "Outbound Rules per Load Balancer", + "value": "OutboundRulesPerLoadBalancer" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RoutesPerRouteTable", + "limit": 400.0, + "name": { + "localizedValue": "Routes per Route Table", + "value": "RoutesPerRouteTable" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/SecondaryIPConfigurationsPerNetworkInterface", + "limit": 256.0, + "name": { + "localizedValue": "Secondary IP Configurations per Network Interface", + "value": "SecondaryIPConfigurationsPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/InboundRulesPerNetworkInterface", + "limit": 500.0, + "name": { + "localizedValue": "Inbound rules per Network Interface", + "value": "InboundRulesPerNetworkInterface" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFilterRulesPerRouteFilter", + "limit": 1.0, + "name": { + "localizedValue": "Route filter rules per Route Filter", + "value": "RouteFilterRulesPerRouteFilter" + }, + "unit": "Count" + }, + { + "currentValue": 0.0, + "id": "/subscriptions/subid/providers/Microsoft.Network/locations/West US/usages/RouteFiltersPerExpressRouteBgpPeering", + "limit": 1.0, + "name": { + "localizedValue": "Route filters per Express route BGP Peering", + "value": "RouteFiltersPerExpressRouteBgpPeering" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionDelete.json new file mode 100644 index 000000000000..a56c207b73b6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "connectionName": "conn1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionGet.json new file mode 100644 index 000000000000..4c7376e78ea8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "connectionName": "conn1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": { + "body": { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionList.json new file mode 100644 index 000000000000..11b6200399f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionPut.json new file mode 100644 index 000000000000..977a6ea53a9c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubBgpConnectionPut.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "connectionName": "conn1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1", + "parameters": { + "properties": { + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + }, + "responses": { + "200": { + "body": { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected" + } + } + }, + "201": { + "body": { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/bgpConnections/conn1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000, + "connectionState": "Connected" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubDelete.json new file mode 100644 index 000000000000..39372222539c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubGet.json new file mode 100644 index 000000000000..1b6e7f1f9996 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationDelete.json new file mode 100644 index 000000000000..f8bb5ad29ce3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "ipConfigName": "ipconfig1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationGet.json new file mode 100644 index 000000000000..453bd31142f3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1", + "ipConfigName": "ipconfig1" + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationList.json new file mode 100644 index 000000000000..96ac9c19ba94 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationPut.json new file mode 100644 index 000000000000..6f8312ac3bb0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubIpConfigurationPut.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "ipConfigName": "ipconfig1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualHubName": "hub1", + "parameters": { + "properties": { + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + }, + "201": { + "body": { + "name": "ipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/ipConfigurations/ipconfig1", + "type": "Microsoft.Network/virtualHubs/ipConfigurations", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubList.json new file mode 100644 index 000000000000..cc70f0ad9c14 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubList.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "10.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "210.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubListByResourceGroup.json new file mode 100644 index 000000000000..463ebef48942 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubListByResourceGroup.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub1", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "10.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2/routeTables/virtualHubRouteTable2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "rt2a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + ], + "addressPrefix": "210.10.1.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubPut.json new file mode 100644 index 000000000000..31c37a35ab10 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubPut.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "virtualHubName": "virtualHub2", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "virtualHubParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "addressPrefix": "10.168.0.0/24", + "sku": "Basic" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.168.0.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.168.0.0/24", + "sku": "Basic", + "routingState": "Provisioned", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Delete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Delete.json new file mode 100644 index 000000000000..9d9870240eb9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "routeTableName": "virtualHubRouteTable1a", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Get.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Get.json new file mode 100644 index 000000000000..cfd32a10eeb4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Get.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "routeTableName": "virtualHubRouteTable1a", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "virtualHubRouteTable1a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2List.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2List.json new file mode 100644 index 000000000000..b7cf16db18c7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2List.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "virtualHubName": "virtualHub1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "virtualHubRouteTable1a", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + }, + { + "name": "virtualHubRouteTable1b", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1b", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.30.0.0/16", + "20.40.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Branches" + ] + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Put.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Put.json new file mode 100644 index 000000000000..06124c7290c8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubRouteTableV2Put.json @@ -0,0 +1,113 @@ +{ + "parameters": { + "routeTableName": "virtualHubRouteTable1a", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "virtualHubName": "virtualHub1", + "virtualHubRouteTableV2Parameters": { + "properties": { + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "virtualHubRouteTable1a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/routeTables/virtualHubRouteTable1a", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "name": "virtualHubRouteTable1a", + "properties": { + "provisioningState": "Succeeded", + "routes": [ + { + "destinationType": "CIDR", + "destinations": [ + "20.10.0.0/16", + "20.20.0.0/16" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + }, + { + "destinationType": "CIDR", + "destinations": [ + "0.0.0.0/0" + ], + "nextHopType": "IPAddress", + "nextHops": [ + "10.0.0.68" + ] + } + ], + "attachedConnections": [ + "All_Vnets" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubUpdateTags.json new file mode 100644 index 000000000000..72a7db146924 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualHubUpdateTags.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "virtualHubName": "virtualHub2", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "virtualHubParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "virtualHub2", + "type": "Microsoft.Network/virtualHubs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWans/virtualWan1" + }, + "virtualHubRouteTableV2s": [], + "addressPrefix": "10.168.0.0/24", + "sku": "Basic", + "virtualRouterAsn": 65515, + "virtualRouterIps": [ + "10.10.1.12", + "10.10.1.13" + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCheckIPAddressAvailability.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCheckIPAddressAvailability.json new file mode 100644 index 000000000000..d89101271f1f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCheckIPAddressAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "ipAddress": "10.0.1.4" + }, + "responses": { + "200": { + "body": { + "available": false, + "availableIPAddresses": [ + "10.0.1.5", + "10.0.1.6", + "10.0.1.7", + "10.0.1.8", + "10.0.1.9" + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreate.json new file mode 100644 index 000000000000..be97d876f576 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json new file mode 100644 index 000000000000..9b12ba956514 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateServiceEndpointPolicy.json @@ -0,0 +1,126 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "vnetTest", + "virtualNetworkName": "vnet1", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ], + "serviceEndpointPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1" + } + ] + } + } + ] + }, + "location": "eastus2euap" + } + }, + "responses": { + "200": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "serviceEndpointPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1" + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus2euap", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "serviceEndpointPolicies": [ + { + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/serviceEndpointPolicies/ServiceEndpointPolicy1" + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateServiceEndpoints.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateServiceEndpoints.json new file mode 100644 index 000000000000..476c4ca14910 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateServiceEndpoints.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "vnetTest", + "virtualNetworkName": "vnet1", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "serviceEndpoints": [ + { + "service": "Microsoft.Storage" + } + ] + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "vnet1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "id": "/subscriptions/subid/resourceGroups/vnetTest/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "properties": { + "addressPrefix": "10.0.0.0/16", + "ipConfigurations": [], + "resourceNavigationLinks": [], + "serviceEndpoints": [ + { + "provisioningState": "Succeeded", + "service": "Microsoft.Storage", + "locations": [ + "eastus2(stage)", + "usnorth(stage)" + ] + } + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnet.json new file mode 100644 index 000000000000..148049a18f46 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnet.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json new file mode 100644 index 000000000000..2fa784d6cfd1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.0.1.0/28" + ] + } + } + ] + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-2", + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.1.0.0/28" + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-2", + "name": "test-2", + "properties": { + "addressPrefixes": [ + "10.0.0.0/28", + "10.0.1.0/28" + ], + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnetWithDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnetWithDelegation.json new file mode 100644 index 000000000000..c3a61b25aa0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateSubnetWithDelegation.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "delegations": [ + { + "name": "myDelegation", + "properties": { + "serviceName": "Microsoft.Sql/managedInstances" + } + } + ] + } + } + ] + }, + "location": "westcentralus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Sql/managedInstances", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westcentralus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded", + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Sql/managedInstances", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateWithBgpCommunities.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateWithBgpCommunities.json new file mode 100644 index 000000000000..5e396f22f25e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkCreateWithBgpCommunities.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "parameters": { + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24" + } + } + ], + "bgpCommunities": { + "virtualNetworkCommunity": "12076:60000" + } + }, + "location": "eastus" + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "bgpCommunities": { + "virtualNetworkCommunity": "12076:60000", + "regionalCommunity": "12076:51004" + }, + "virtualNetworkPeerings": [] + } + } + }, + "201": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "bgpCommunities": { + "virtualNetworkCommunity": "12076:60000", + "regionalCommunity": "12076:51004" + }, + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkDelete.json new file mode 100644 index 000000000000..ce2bbadd62bc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionCreate.json new file mode 100644 index 000000000000..587e9b40d99e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionCreate.json @@ -0,0 +1,136 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S", + "parameters": { + "properties": { + "virtualNetworkGateway1": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1" + } + ], + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1" + }, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + } + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "location": "centralus", + "tags": {} + }, + "localNetworkGateway2": { + "properties": { + "localNetworkAddressSpace": { + "addressPrefixes": [ + "10.1.0.0/16" + ] + }, + "gatewayIpAddress": "x.x.x.x" + }, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "location": "centralus", + "tags": {} + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "sharedKey": "Abc123", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [] + }, + "location": "centralus" + } + }, + "responses": { + "201": { + "body": { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "sharedKey": "Abc123", + "enableBgp": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + }, + "200": { + "body": { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Updating", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "sharedKey": "Abc123", + "enableBgp": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionDelete.json new file mode 100644 index 000000000000..bb8f57ec60e2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "conn1" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionGet.json new file mode 100644 index 000000000000..383005693dff --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S" + }, + "responses": { + "200": { + "body": { + "name": "connS2S", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/connS2S", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw", + "properties": {} + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "sharedKey": "Abc123", + "enableBgp": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "connectionStatus": "Connecting", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json new file mode 100644 index 000000000000..f226f60f1626 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionGetSharedKey.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S" + }, + "responses": { + "200": { + "body": { + "value": "AzureAbc123" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json new file mode 100644 index 000000000000..d97aae22dd0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionResetSharedKey.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "conn1", + "parameters": { + "keyLength": 128 + } + }, + "responses": { + "200": { + "body": { + "keyLength": 128 + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json new file mode 100644 index 000000000000..a5b706e0302e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionSetSharedKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "connS2S", + "parameters": { + "value": "AzureAbc123" + } + }, + "responses": { + "200": { + "body": { + "value": "AzureAbc123" + } + }, + "201": { + "body": { + "value": "AzureAbc123" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json new file mode 100644 index 000000000000..10c680865274 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCapture.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1" + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json new file mode 100644 index 000000000000..ac8a3ce10530 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1", + "parameters": { + "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}" + } + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json new file mode 100644 index 000000000000..8e2346611f9c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionStopPacketCapture.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngwcn1", + "parameters": { + "sasUrl": "https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D" + } + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json new file mode 100644 index 000000000000..e447ba65493e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionUpdateTags.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "test", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "test", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/test", + "type": "Microsoft.Network/connections", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/lgw", + "properties": {} + }, + "connectionType": "IPsec", + "routingWeight": 0, + "sharedKey": "temp1234", + "enableBgp": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "connectionStatus": "Unknown", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionsList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionsList.json new file mode 100644 index 000000000000..b514713ba102 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayConnectionsList.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "conn1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1", + "properties": {} + }, + "localNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw1", + "properties": {} + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv1", + "routingWeight": 0, + "dpdTimeoutSeconds": 30, + "enableBgp": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + }, + { + "name": "conn2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/connections/conn2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/connections", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2", + "properties": {} + }, + "localNetworkGateway2": { + "properties": {}, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/localNetworkGateways/localgw2" + }, + "connectionType": "IPsec", + "connectionProtocol": "IKEv2", + "routingWeight": 0, + "dpdTimeoutSeconds": 20, + "enableBgp": false, + "useLocalAzureIpAddress": true, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayDelete.json new file mode 100644 index 000000000000..184c7a109c56 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json new file mode 100644 index 000000000000..713f40b9f589 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGenerateVpnClientPackage.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": {} + }, + "responses": { + "200": { + "body": "" + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json new file mode 100644 index 000000000000..ce6e26d1a501 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGenerateVpnProfile.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": {} + }, + "responses": { + "202": {}, + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGet.json new file mode 100644 index 000000000000..22f878ab6687 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGet.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "enablePrivateIpAddress": false, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.1.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json new file mode 100644 index 000000000000..fd5a5ef47ae2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetAdvertisedRoutes.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "peer": "test" + }, + "responses": { + "202": {}, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json new file mode 100644 index 000000000000..87081aacbbdf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetBGPPeerStatus.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": {}, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json new file mode 100644 index 000000000000..44401cadd45e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "200": { + "body": { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json new file mode 100644 index 000000000000..4f317fe2fdf0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": {}, + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json new file mode 100644 index 000000000000..74c3781c361c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "resourceGroupName": "p2s-vnet-test", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "virtualNetworkGatewayName": "vpnp2sgw" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "vpnConnectionId": "IKEv2_1e1cfe59-5c7c-4315-a876-b11fbfdfeed4", + "vpnConnectionDuration": 900, + "vpnConnectionTime": "2019-05-02T22:26:22", + "publicIpAddress": "167.220.2.232:45522", + "privateIpAddress": "192.168.210.2", + "vpnUserName": "gwp2schildcert", + "maxBandwidth": 240000000, + "egressPacketsTransferred": 557, + "egressBytesTransferred": 33420, + "ingressPacketsTransferred": 557, + "ingressBytesTransferred": 33420, + "maxPacketsPerSecond": 4 + }, + { + "vpnConnectionId": "IKEv2_571cfe59-2c7d-1415-e813-c51fbfdfea16", + "vpnConnectionDuration": 800, + "vpnConnectionTime": "2019-05-01T21:06:12", + "publicIpAddress": "167.220.2.232:45213", + "privateIpAddress": "192.168.210.1", + "vpnUserName": "gwp2schildcert", + "maxBandwidth": 220000000, + "egressPacketsTransferred": 357, + "egressBytesTransferred": 23420, + "ingressPacketsTransferred": 357, + "ingressBytesTransferred": 23420, + "maxPacketsPerSecond": 4 + } + ] + } + }, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayLearnedRoutes.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayLearnedRoutes.json new file mode 100644 index 000000000000..87081aacbbdf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayLearnedRoutes.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": {}, + "200": { + "body": {} + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayList.json new file mode 100644 index 000000000000..8bd1534edc44 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayList.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vpngw1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "loc1", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw1/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/vpngw1-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "enablePrivateIpAddress": false, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.14", + "peerWeight": 0 + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + } + }, + { + "name": "vpngw2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "loc2", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw2/ipConfigurations/default", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "privateIPAddress": "10.1.0.7", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/vpngw2-ip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "enablePrivateIpAddress": true, + "activeActive": false, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.1.0.46", + "peerWeight": 0 + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayReset.json new file mode 100644 index 000000000000..1f11142e04fa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayReset.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json new file mode 100644 index 000000000000..97b036546e24 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayResetVpnClientSharedKey.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json new file mode 100644 index 000000000000..c9b68ff2c411 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "vpnclientIpsecParams": { + "saLifeTimeSeconds": 86473, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup2", + "pfsGroup": "PFS2" + } + }, + "responses": { + "202": {}, + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStartPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStartPacketCapture.json new file mode 100644 index 000000000000..666f521f9f99 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStartPacketCapture.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json new file mode 100644 index 000000000000..936241c12e0f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "filterData": "{'TracingFlags': 11,'MaxPacketBufferSize': 120,'MaxFileSize': 200,'Filters': [{'SourceSubnets': ['20.1.1.0/24'],'DestinationSubnets': ['10.1.1.0/24'],'SourcePort': [500],'DestinationPort': [4500],'Protocol': 6,'TcpFlags': 16,'CaptureSingleDirectionTrafficOnly': true}]}" + } + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStopPacketCapture.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStopPacketCapture.json new file mode 100644 index 000000000000..c508950ae837 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayStopPacketCapture.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "sasUrl": "https://teststorage.blob.core.windows.net/?sv=2018-03-28&ss=bfqt&srt=sco&sp=rwdlacup&se=2019-09-13T07:44:05Z&st=2019-09-06T23:44:05Z&spr=https&sig=V1h9D1riltvZMI69d6ihENnFo%2FrCvTqGgjO2lf%2FVBhE%3D" + } + }, + "responses": { + "202": {}, + "200": { + "body": "\"{\"Status\":\"Successful\",\"Data\":null}\"" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json new file mode 100644 index 000000000000..035e321ba0fe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaySupportedVpnDevice.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw" + }, + "responses": { + "200": { + "body": "" + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayUpdate.json new file mode 100644 index 000000000000..1f8fc3ce63e3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayUpdate.json @@ -0,0 +1,220 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "properties": { + "ipConfigurations": [ + { + "properties": { + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + }, + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + } + }, + "name": "gwipconfig1" + } + ], + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "enableDnsForwarding": true, + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1" + }, + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20, + "radiusServerSecret": "radiusServerSecret" + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0 + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + }, + "location": "centralus" + } + }, + "responses": { + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "activeActive": false, + "enableDnsForwarding": true, + "inboundDnsForwardingEndpoint": "10.0.1.14", + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + } + } + }, + "201": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "centralus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "gwipconfig1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/gwpip" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 0 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "enableBgp": false, + "activeActive": false, + "enableDnsForwarding": true, + "enablePrivateIpAddress": false, + "inboundDnsForwardingEndpoint": "10.0.1.14", + "vpnClientConfiguration": { + "vpnClientProtocols": [ + "OpenVPN" + ], + "vpnClientRootCertificates": [], + "vpnClientRevokedCertificates": [], + "radiusServers": [ + { + "radiusServerAddress": "10.2.0.0", + "radiusServerScore": 20 + } + ] + }, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayUpdateTags.json new file mode 100644 index 000000000000..13f93e14c43b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayUpdateTags.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayName": "vpngw", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw", + "type": "Microsoft.Network/virtualNetworkGateways", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "ipConfigurations": [ + { + "name": "default", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/default", + "properties": { + "provisioningState": "Succeeded", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/testpub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2/subnets/GatewaySubnet" + } + } + } + ], + "sku": { + "name": "VpnGw1", + "tier": "VpnGw1", + "capacity": 2 + }, + "gatewayType": "Vpn", + "vpnType": "RouteBased", + "vpnGatewayGeneration": "None", + "enableBgp": false, + "activeActive": false, + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.0.254", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vpngw/ipConfigurations/gwipconfig1", + "defaultBgpIpAddresses": [ + "10.3.1.254" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "52.161.10.135" + ] + } + ] + }, + "customRoutes": { + "addressPrefixes": [ + "101.168.0.6/32" + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json new file mode 100644 index 000000000000..67ccd1c2e3e2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkGatewayConnectionName": "vpngw", + "parameters": { + "vendor": "Cisco", + "deviceFamily": "ISR", + "firmwareVersion": "IOS 15.1 (Preview)" + } + }, + "responses": { + "200": { + "body": "! Microsoft Corporation\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Sample VPN tunnel configuration template for IOS-based devices\r\n!\r\n! This configuration template applies to Cisco VPN devices running IOS 15.1 or beyond (ISR or ASR)\r\n!\r\n\r\n\r\n\t\t\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! ACL rules\r\n!\r\n! Some VPN devices require explicit ACL rules to allow cross-premises traffic:\r\n!\r\n! 1. Allow traffic between on premises address ranges and VNet address ranges\r\n! 2. Allow IKE traffic (UDP:500) between on premises VPN devices and Azure VPN gateway\r\n! 3. Allow IPsec traffic (Proto:ESP) between on premises VPN devices and Azure VPN gateway\r\n!\r\n\t\t\r\naccess-list 101 permit ip 10.1.0.0 0.0.255.255 10.0.0.0 0.0.255.255\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Internet Key Exchange (IKE) configuration\r\n!\r\n! This section specifies the authentication, encryption, hashing, and Diffie-Hellman group parameters for IKE\r\n! main mode or phase 1\r\n!\r\n\r\ncrypto ikev2 proposal SwaggerS2S-proposal\r\n encryption DES3\r\n integrity SHA384\r\n group DHGroup24\r\n lifetime 3600\r\n exit\r\n\r\ncrypto ikev2 policy SwaggerS2S-policy\r\n proposal SwaggerS2S-proposal\r\n exit\r\n\r\ncrypto ikev2 keyring SwaggerBranch-keyring\r\n\t\t\r\n\t\tpeer 52.173.199.254\r\n\t\taddress 52.173.199.254\r\n\t\tpre-shared-key lALEHuppeopJmA94exRNiRr2QzuZ6lOsvzu5IlJUEA6LthbTc8g5MTT86MCsGNMzGkTAaLuLnEJoD1Cn4cIlr94qKZm9drsgllzWvsPNezS71stAkaW1Bb7h6GBnDlDP\r\n exit\r\n\r\ncrypto ikev2 profile SwaggerS2S-profile\r\n match address local 10.3.0.0\r\n\tmatch identity remote address 52.173.199.254 255.255.255.255\r\n\t\t\r\n authentication remote pre-share\r\n authentication local pre-share\r\n keyring SwaggerBranch-keyring\r\n exit\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! IPsec configuration\r\n!\r\n! This section specifies encryption, authentication, tunnel mode properties for the Phase 2 negotiation\r\n!\r\ncrypto ipsec transform-set SwaggerS2S-TransformSet DES3 DES3\r\n mode tunnel\r\n exit\r\n\r\n! ---------------------------------------------------------------------------------------------------------------------\r\n! Crypto map configuration\r\n!\r\n! This section defines a crypto profile that binds the cross-premises network traffic to the IPsec and IKE\r\n! policy profiles for this connection. Then defines the VTI (virtual tunnel interface) with the crypto\r\n! profile. A random interface number (tunnel 1) was used with a random link local address (169.254.0.1/28)\r\n! for the tunnel interface. If either selection is already used in the VPN device, please select another\r\n! interface number or address. The only requirement is that they must not overlap with another interface\r\n! on the same VPN device.\r\n!\r\ncrypto ipsec profile SwaggerS2S-IPsecProfile\r\n set transform-set SwaggerS2S-TransformSet\r\n set ikev2-profile SwaggerS2S-profile\r\n set pfs None\r\n set security-association lifetime 3600\r\n exit\r\n\r\n\r\nint tunnel 52.173.199.254\r\n ip address 169.254.0.1 255.255.255.252\r\n ip tcp adjust-mss 1350\r\n tunnel source 10.3.0.0\r\n tunnel mode ipsec ipv4\r\n tunnel destination 52.173.199.254\r\n tunnel protection ipsec profile SwaggerS2S-IPsecProfile\r\n exit\r\n\r\n\tip route 10.0.0.0 255.255.0.0 tunnel 52.173.199.254 " + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json new file mode 100644 index 000000000000..6f9f669e83b8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "vpn-gateway-test", + "virtualNetworkGatewayName": "vpngateway", + "api-version": "2020-05-01", + "request": { + "vpnConnectionIds": [ + "vpnconnId1", + "vpnconnId2" + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaysListConnections.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaysListConnections.json new file mode 100644 index 000000000000..f4d14545f011 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGatewaysListConnections.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "testrg", + "virtualNetworkGatewayName": "test-vpn-gateway-1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "test-vpn-connection", + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/connections/test-vpn-connection", + "etag": "W/\\\"00000000-0000-0000-0000-000000000000\\\"", + "type": "Microsoft.Network/connections", + "location": "eastus", + "properties": { + "provisioningState": "Succeeded", + "resourceGuid": "00000000-0000-0000-0000-000000000000", + "virtualNetworkGateway1": { + "id": "/subscriptions/subid/resourceGroups/testrg/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-1" + }, + "virtualNetworkGateway2": { + "id": "/subscriptions/subid/resourceGroups/testrg-2/providers/Microsoft.Network/virtualNetworkGateways/test-vpn-gateway-2" + }, + "connectionType": "Vnet2Vnet", + "routingWeight": 22, + "enableBgp": true, + "usePolicyBasedTrafficSelectors": false, + "ipsecPolicies": [], + "trafficSelectorPolicies": [], + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGet.json new file mode 100644 index 000000000000..add9d2aa19ab --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGet.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.1.0/24", + "ipConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + } + ] + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetResourceNavigationLinks.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetResourceNavigationLinks.json new file mode 100644 index 000000000000..78c77964215c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetResourceNavigationLinks.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "vnet", + "subnetName": "subnet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "redisCache_redis-tester", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet/resourceNavigationLinks/redisCache_redis-tester", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworks/subnets/resourceNavigationLinks", + "properties": { + "provisioningState": "Succeeded", + "linkedResourceType": "Microsoft.Cache/redis", + "link": "/subscriptions/subid/resourceGroups/another-rg/providers/Microsoft.Cache/Redis/redis-tester" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetServiceAssociationLinks.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetServiceAssociationLinks.json new file mode 100644 index 000000000000..357b79b92cd8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetServiceAssociationLinks.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "vnet", + "subnetName": "subnet" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "acisal", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet/subnets/subnet/serviceAssociationLinks/acisal", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/virtualNetworks/subnets/serviceAssociationLinks", + "properties": { + "provisioningState": "Succeeded", + "linkedResourceType": "Microsoft.ContainerInstance/containerGroups", + "allowDelete": true, + "locations": [ + "westus" + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetWithServiceAssociationLink.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetWithServiceAssociationLink.json new file mode 100644 index 000000000000..7f71984c32cb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetWithServiceAssociationLink.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.214.0/24", + "ipConfigurationProfiles": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/networkProfiles/networkProfile1/containerNetworkInterfaceConfigurations/eth0/ipConfigurations/ipconfigprofile1" + } + ], + "serviceAssociationLinks": [ + { + "name": "serviceAssociationLink1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/serviceAssociationLinks/serviceAssociationLink1", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "linkedResourceType": "Microsoft.Provider/resourceType" + } + } + ], + "serviceEndpoints": [], + "delegations": [ + { + "name": "aciDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/aciDelegation", + "etag": "W/\"4d3e91b4-f67f-48be-880b-e4a8abdd019e\"", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [ + "Microsoft.Network/virtualNetworks/subnets/action" + ] + } + } + ] + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetWithSubnetDelegation.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetWithSubnetDelegation.json new file mode 100644 index 000000000000..340c3753885c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkGetWithSubnetDelegation.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subId", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet" + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [ + { + "name": "subnet1", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1", + "properties": { + "provisioningState": "Succeeded", + "addressPrefix": "10.0.1.0/24", + "ipConfigurations": [ + { + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/frontendIPConfigurations/fe" + } + ], + "delegations": [ + { + "name": "myDelegation", + "id": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet/subnets/subnet1/delegations/myDelegation", + "properties": { + "provisioningState": "Succeeded", + "serviceName": "Microsoft.Provider/resourceType", + "actions": [] + } + } + ], + "purpose": "" + } + } + ], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkList.json new file mode 100644 index 000000000000..7817f88541c2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkList.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkListAll.json new file mode 100644 index 000000000000..323e279bc67d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkListAll.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1", + "name": "vnet1", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/8" + ] + }, + "dhcpOptions": { + "dnsServers": [] + }, + "subnets": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/test-1", + "name": "test-1", + "properties": { + "addressPrefix": "10.0.0.0/24", + "provisioningState": "Succeeded" + } + } + ], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualNetworks/vnet2", + "name": "vnet2", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "properties": { + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "dhcpOptions": { + "dnsServers": [ + "8.8.8.8" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [], + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkListUsage.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkListUsage.json new file mode 100644 index 000000000000..87b5e67289d6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkListUsage.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "virtualNetworkName": "vnetName", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "currentValue": -1.0, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/GatewaySubnet", + "limit": -1.0, + "name": { + "localizedValue": "Subnet size and usage", + "value": "SubnetSpace" + }, + "unit": "Count" + }, + { + "currentValue": 2.0, + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnetName/subnets/newSubnet", + "limit": 3.0, + "name": { + "localizedValue": "Subnet size and usage", + "value": "SubnetSpace" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringCreate.json new file mode 100644 index 000000000000..b877579ac1e7 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "VirtualNetworkPeeringParameters": { + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringDelete.json new file mode 100644 index 000000000000..2b27464bf9d9 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringGet.json new file mode 100644 index 000000000000..6cce10d5f23e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringGet.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "virtualNetworkPeeringName": "peer", + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringList.json new file mode 100644 index 000000000000..72ef23a871a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkPeeringList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "virtualNetworkName": "vnet1", + "resourceGroupName": "peerTest", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": true, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet2" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "12.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet1/virtualNetworkPeerings/peer2", + "name": "peer", + "properties": { + "allowVirtualNetworkAccess": true, + "allowForwardedTraffic": false, + "allowGatewayTransit": false, + "useRemoteGateways": false, + "remoteVirtualNetwork": { + "id": "/subscriptions/subid/resourceGroups/peerTest/providers/Microsoft.Network/virtualNetworks/vnet3" + }, + "remoteAddressSpace": { + "addressPrefixes": [ + "13.0.0.0/8" + ] + }, + "peeringState": "Initiated", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapCreate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapCreate.json new file mode 100644 index 000000000000..930094b792b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapCreate.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap", + "parameters": { + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/ipconfig1" + } + }, + "location": "centraluseuap" + } + }, + "responses": { + "200": { + "body": { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + }, + "201": { + "body": { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapDelete.json new file mode 100644 index 000000000000..ca1475bea030 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapGet.json new file mode 100644 index 000000000000..bfac277570eb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapGet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "testvtap" + }, + "responses": { + "200": { + "body": { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapList.json new file mode 100644 index 000000000000..a64c0efbddc1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapList.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + }, + { + "name": "testvtap2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap2", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface3/tapConfigurations/testtapConfiguration" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapListAll.json new file mode 100644 index 000000000000..a59c6188378d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapListAll.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "testvtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + } + }, + { + "name": "testvtap2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/testvtap2", + "etag": "etag", + "type": "Microsoft.Network/virtualNetworkTaps", + "location": "centraluseuap", + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "resourceGuid": "6A7C139D-8B8D-499B-B7CB-4F3F02A8A44F", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface3/tapConfigurations/testtapConfiguration" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapUpdateTags.json new file mode 100644 index 000000000000..a1d3b32bfdb1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkTapUpdateTags.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "tapName": "test-vtap", + "tapParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vtap", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkTaps/test-vtap", + "location": "eastus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "destinationNetworkInterfaceIPConfiguration": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface/ipConfigurations/testIPConfig1" + }, + "destinationPort": 4789, + "provisioningState": "Succeded", + "networkInterfaceTapConfigurations": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/testNetworkInterface2/tapConfigurations/testtapConfiguration" + } + ] + }, + "type": "Microsoft.Network/virtualNetworkTaps" + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkUpdateTags.json new file mode 100644 index 000000000000..cdfe547f2f19 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualNetworkUpdateTags.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualNetworkName": "test-vnet", + "location": "westus", + "parameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "test-vnet", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/test-vnet", + "type": "Microsoft.Network/virtualNetworks", + "location": "westus", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "subnets": [], + "virtualNetworkPeerings": [] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterDelete.json new file mode 100644 index 000000000000..81d225e49a5f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterGet.json new file mode 100644 index 000000000000..ec65131fd9b3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": { + "body": { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterListByResourceGroup.json new file mode 100644 index 000000000000..672df08f4c6b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterListByResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterListBySubscription.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterListBySubscription.json new file mode 100644 index 000000000000..5b3012d99c36 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterListBySubscription.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringDelete.json new file mode 100644 index 000000000000..cd752a64b7cd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "peeringName": "peering1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringGet.json new file mode 100644 index 000000000000..effc5a1ef804 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "peeringName": "peering1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": { + "body": { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringList.json new file mode 100644 index 000000000000..4a58a391647b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringPut.json new file mode 100644 index 000000000000..a8da4bd2fadc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPeeringPut.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "peeringName": "peering1", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter", + "parameters": { + "properties": { + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + }, + "responses": { + "200": { + "body": { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + }, + "201": { + "body": { + "name": "peering1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1", + "etag": "W/\"72090554-7e3b-43f2-80ad-99a9020dcb11\"", + "properties": { + "provisioningState": "Succeeded", + "peerIp": "192.168.1.5", + "peerAsn": 20000 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPut.json new file mode 100644 index 000000000000..3ee6e28e4b0a --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualRouterPut.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualRouterName": "virtualRouter", + "parameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + }, + "201": { + "body": { + "name": "virtualRouter", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter", + "type": "Microsoft.Network/virtualRouters", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualRouterAsn": 10000, + "virtualRouterIps": [ + "192.168.1.1", + "192.168.1.2" + ], + "hostedGateway": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworkGateways/vnetGateway" + }, + "peerings": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualRouters/virtualRouter/peerings/peering1" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANDelete.json new file mode 100644 index 000000000000..83bc6505c745 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "VirtualWANName": "virtualWan1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANGet.json new file mode 100644 index 000000000000..8245aca06416 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANList.json new file mode 100644 index 000000000000..54cb1d00e497 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANList.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "wan2", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANListByResourceGroup.json new file mode 100644 index 000000000000..d53975e668da --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "wan2", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub4" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite3", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite4" + ], + "type": "Basic" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANPut.json new file mode 100644 index 000000000000..115bdaecedcc --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANPut.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "WANParameters": { + "location": "West US", + "tags": { + "key1": "value1" + }, + "properties": { + "disableVpnEncryption": false, + "type": "Basic" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANUpdateTags.json new file mode 100644 index 000000000000..e2960c92b9ed --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWANUpdateTags.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "VirtualWANName": "wan1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "WANParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "wan1", + "type": "Microsoft.Network/virtualWANs", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "disableVpnEncryption": false, + "virtualHubs": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub2" + ], + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2" + ], + "type": "Basic" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWanSupportedSecurityProviders.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWanSupportedSecurityProviders.json new file mode 100644 index 000000000000..801958bb311c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VirtualWanSupportedSecurityProviders.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "virtualWANName": "wan1" + }, + "responses": { + "200": { + "description": "Request successful.", + "body": { + "supportedProviders": [ + { + "name": "AzureFirewall", + "url": "", + "type": "Native" + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceGet.json new file mode 100644 index 000000000000..146f80e3d7f4 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceGet.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "networkInterfaceName": "nic1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses": { + "200": { + "body": { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "dns.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceIpConfigGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceIpConfigGet.json new file mode 100644 index 000000000000..5b7c23b7b56b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceIpConfigGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceIpConfigList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceIpConfigList.json new file mode 100644 index 000000000000..e14de4e82a72 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceIpConfigList.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "2", + "networkInterfaceName": "nic1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/2/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.6", + "privateIPAllocationMethod": "Dynamic", + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceList.json new file mode 100644 index 000000000000..0ec937148391 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssNetworkInterfaceList.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.4", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.0" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/0" + } + } + }, + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssPublicIpGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssPublicIpGet.json new file mode 100644 index 000000000000..229c15712a0d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssPublicIpGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1", + "publicIpAddressName": "pub1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssPublicIpListAll.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssPublicIpListAll.json new file mode 100644 index 000000000000..605e0b831869 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssPublicIpListAll.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2018-10-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/3/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm3.testvmssacc", + "fqdn": "vm3.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.118.216", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssVmNetworkInterfaceList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssVmNetworkInterfaceList.json new file mode 100644 index 000000000000..e4f1cbf14ebf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssVmNetworkInterfaceList.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2018-10-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "virtualMachineScaleSetName": "vmss1", + "virtualmachineIndex": "1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "nic1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1", + "properties": { + "provisioningState": "Succeeded", + "ipConfigurations": [ + { + "name": "ip1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1", + "properties": { + "provisioningState": "Succeeded", + "privateIPAddress": "10.0.0.5", + "privateIPAllocationMethod": "Dynamic", + "publicIPAddress": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1" + }, + "subnet": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + }, + "primary": true, + "privateIPAddressVersion": "IPv4", + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/backendAddressPools/addressPool1" + } + ], + "loadBalancerInboundNatRules": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb1/inboundNatRules/natPool1.1" + } + ] + } + } + ], + "dnsSettings": { + "dnsServers": [], + "appliedDnsServers": [], + "internalDomainNameSuffix": "ruw4wz3grewudjsyzrxj44pxod.cdmx.internal.cloudapp.net" + }, + "macAddress": "00-00-00-00-00-00", + "enableAcceleratedNetworking": false, + "enableIPForwarding": false, + "networkSecurityGroup": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkSecurityGroups/nsg1" + }, + "primary": true, + "virtualMachine": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1" + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssVmPublicIpList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssVmPublicIpList.json new file mode 100644 index 000000000000..d21f5d40ed03 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VmssVmPublicIpList.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "virtualMachineScaleSetName": "vmss1", + "resourceGroupName": "vmss-tester", + "api-version": "2018-10-01", + "subscriptionId": "subid", + "virtualmachineIndex": 1, + "networkInterfaceName": "nic1", + "ipConfigurationName": "ip1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1/publicIPAddresses/pub1", + "name": "pub1", + "properties": { + "publicIPAllocationMethod": "Dynamic", + "publicIPAddressVersion": "IPv4", + "ipConfiguration": { + "id": "/subscriptions/subid/resourceGroups/vmss-tester/providers/Microsoft.Compute/virtualMachineScaleSets/vmss1/virtualMachines/1/networkInterfaces/nic1/ipConfigurations/ip1" + }, + "dnsSettings": { + "domainNameLabel": "vm1.testvmssacc", + "fqdn": "vm1.testvmssacc.southeastasia.cloudapp.azure.com" + }, + "ipAddress": "13.67.119.72", + "idleTimeoutInMinutes": 10, + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionDelete.json new file mode 100644 index 000000000000..f04ae3db84e0 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionGet.json new file mode 100644 index 000000000000..9b206e6a1c92 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionGet.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionList.json new file mode 100644 index 000000000000..d023c6599860 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionList.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionPut.json new file mode 100644 index 000000000000..d2e355d71065 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnConnectionPut.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "connectionName": "vpnConnection1", + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "VpnConnectionParameters": { + "properties": { + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "properties": { + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + }, + "201": { + "body": { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/hub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayDelete.json new file mode 100644 index 000000000000..255e421cc21d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayGet.json new file mode 100644 index 000000000000..e3ff7bf8a94e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayGet.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayList.json new file mode 100644 index 000000000000..2d5fcbc616d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayList.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + } + } + }, + { + "name": "gateway2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "useLocalAzureIpAddress": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayListByResourceGroup.json new file mode 100644 index 000000000000..2d5fcbc616d3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayListByResourceGroup.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + }, + { + "name": "Connection-Link2", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link2", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink2" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + } + } + }, + { + "name": "gateway2", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnGateways/gateway2/vpnConnections/vpnConnection2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "useLocalAzureIpAddress": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualHubs/virtualHub2/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayPut.json new file mode 100644 index 000000000000..fc11c7e67b83 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayPut.json @@ -0,0 +1,286 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "vpnGatewayParameters": { + "location": "westcentralus", + "tags": { + "key1": "value1" + }, + "properties": { + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "properties": { + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "properties": { + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key" + } + } + ] + } + } + ], + "bgpSettings": { + "asn": 65515, + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "customBgpIpAddresses": [ + "169.254.21.5" + ] + }, + { + "ipconfigurationId": "Instance1", + "customBgpIpAddresses": [ + "169.254.21.10" + ] + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + } + } + } + }, + "201": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "enableInternetSecurity": false, + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "vpnLinkConnections": [ + { + "name": "Connection-Link1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + ], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayReset.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayReset.json new file mode 100644 index 000000000000..1bb0c69b57a5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayReset.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "gatewayName": "vpngw", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "200": { + "body": { + "name": "vpngw", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/vpngw/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "connectionBandwidth": 100, + "sharedKey": "key", + "enableBgp": false, + "useLocalAzureIpAddress": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65514, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayUpdateTags.json new file mode 100644 index 000000000000..f303c2eafd10 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnGatewayUpdateTags.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "vpnGatewayParameters": { + "tags": { + "tag1": "value1", + "tag2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "name": "gateway1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "type": "Microsoft.Network/vpnGateways", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualHub": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1" + }, + "connections": [ + { + "name": "vpnConnection1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "remoteVpnSite": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1" + }, + "connectionStatus": "Connected", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "routingWeight": 0, + "sharedKey": "key", + "enableBgp": false, + "ipsecPolicies": [], + "routingConfiguration": { + "associatedRouteTable": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + "propagatedRouteTables": { + "labels": [ + "label1", + "label2" + ], + "ids": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable1" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable2" + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualHubs/virtualHub1/hubRouteTables/hubRouteTable3" + } + ] + }, + "vnetRoutes": { + "staticRoutes": [] + } + } + } + } + ], + "bgpSettings": { + "asn": 65515, + "bgpPeeringAddress": "10.0.1.30", + "peerWeight": 0, + "bgpPeeringAddresses": [ + { + "ipconfigurationId": "Instance0", + "defaultBgpIpAddresses": [ + "10.30.0.4" + ], + "customBgpIpAddresses": [ + "169.254.21.5" + ], + "tunnelIpAddresses": [ + "104.208.48.178" + ] + }, + { + "ipconfigurationId": "Instance1", + "defaultBgpIpAddresses": [ + "10.30.0.5" + ], + "customBgpIpAddresses": [ + "169.254.21.10" + ], + "tunnelIpAddresses": [ + "104.208.48.179" + ] + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationDelete.json new file mode 100644 index 000000000000..60e37a2bfad3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationGet.json new file mode 100644 index 000000000000..ebc7b83a50ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationGet.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationList.json new file mode 100644 index 000000000000..c3121f3b87e1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationList.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret": "123_abc", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "vpnServerConfiguration2", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationListByResourceGroup.json new file mode 100644 index 000000000000..a41538fdb156 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationListByResourceGroup.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret": "123_abc", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration2", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret": "123_abc", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationPut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationPut.json new file mode 100644 index 000000000000..a72811a22fe2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationPut.json @@ -0,0 +1,190 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "VpnServerConfigurationParameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25, + "radiusServerSecret": "radiusServerSecret" + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnAuthenticationTypes": [ + "Certificate" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServers": [ + { + "radiusServerAddress": "10.0.0.0", + "radiusServerScore": 25 + } + ], + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationUpdateTags.json new file mode 100644 index 000000000000..7518727d1860 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnServerConfigurationUpdateTags.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "vpnServerConfigurationName": "vpnServerConfiguration1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "VpnServerConfigurationParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnServerConfigurations/vpnServerConfiguration1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnServerConfiguration1", + "type": "Microsoft.Network/vpnServerConfigurations", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "vpnProtocols": [ + "IkeV2" + ], + "vpnClientIpsecPolicies": [ + { + "saLifeTimeSeconds": 86472, + "saDataSizeKilobytes": 429497, + "ipsecEncryption": "AES256", + "ipsecIntegrity": "SHA256", + "ikeEncryption": "AES256", + "ikeIntegrity": "SHA384", + "dhGroup": "DHGroup14", + "pfsGroup": "PFS14" + } + ], + "vpnClientRootCertificates": [ + { + "name": "vpnServerConfigVpnClientRootCert1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuN" + } + ], + "vpnClientRevokedCertificates": [ + { + "name": "vpnServerConfigVpnClientRevokedCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ], + "radiusServerAddress": "8.9.9.9", + "radiusServerSecret": "123_abc", + "radiusServerRootCertificates": [ + { + "name": "vpnServerConfigRadiusServerRootCer1", + "publicCertData": "MIIC5zCCAc+gAwIBAgIQErQ0Hk4aDJxIA+Q5RagB+jANBgkqhkiG9w0BAQsFADAWMRQwEgYDVQQDDAtQMlNSb290Q2VydDAeFw0xNzEyMTQyMTA3MzhaFw0xODEyMTQyMTI3MzhaMBYxFDASBgNVBAMMC1AyU1Jvb3RDZXJ0MIIBIjANBgkqhkiG9w0BAQEFAAOCAQ8AMIIBCgKCAQEArP7/NQXmW7cQ/ZR1mv3Y3I29Lt7HTOqzo/1KUOoVH3NItbQIRAQbwKy3UWrOFz4eGNX2GWtNRMdCyWsKeqy9Ltsdfcm1IbKXkl84DFeU/ZacXu4Dl3xX3gV5du4TLZjEowJELyur11Ea2YcjPRQ/FzAF9/hGuboS1HZQEPLx4FdUs9OxCYOtc0MxBCwLfVTTRqarb0Ne+arNYd4kCzIhAke1nOyKAJBda5ZL+VHy3S5S8qGlD46jm8HXugmAkUygS4oIIXOmj/1O9sNAi3LN60zufSzCmP8Rm/iUGX+DHAGGiXxwZOKQLEDaZXKqoHjMPP0XudmSWwOIbyeQVrLhkwIDAQABozEwLzAOBgNVHQ8BAf8EBAMCAgQwHQYDVR0OBBYEFEfeNU2trYxNLF9ONmuJUsT13pKDMA0GCSqGSIb3DQEBCwUAA4IBAQBmM6RJzsGGipxyMhimHKN2xlkejhVsgBoTAhOU0llW9aUSwINJ9zFUGgI8IzUFy1VG776fchHp0LMRmPSIUYk5btEPxbsrPtumPuMH8EQGrS+Rt4pD+78c8H1fEPkq5CmDl/PKu4JoFGv+aFcE+Od0hlILstIF10Qysf++QXDolKfzJa/56bgMeYKFiju73loiRM57ns8ddXpfLl792UVpRkFU62LNns6Y1LKTwapmUF4IvIuAIzd6LZNOQng64LAKXtKnViJ1JQiXwf4CEzhgvAti3/ejpb3U90hsrUcyZi6wBv9bZLcAJRWpz61JNYliM1d1grSwQDKGXNQE4xuM" + } + ], + "radiusClientRootCertificates": [ + { + "name": "vpnServerConfigRadiusClientRootCert1", + "thumbprint": "83FFBFC8848B5A5836C94D0112367E16148A286F" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteDelete.json new file mode 100644 index 000000000000..da6cc56687ea --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteGet.json new file mode 100644 index 000000000000..35f1a5ed3285 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkConnectionGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkConnectionGet.json new file mode 100644 index 000000000000..fe18798e50fd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkConnectionGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "connectionName": "vpnConnection1", + "linkConnectionName": "Connection-Link1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkConnectionList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkConnectionList.json new file mode 100644 index 000000000000..fd104881fea8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkConnectionList.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "gatewayName": "gateway1", + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "connectionName": "vpnConnection1" + }, + "responses": { + "200": { + "body": [ + { + "name": "Connection-Link1", + "type": "Microsoft.Network/vpnGateways/vpnConnections/VpnSiteLinkConnections", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnGateways/gateway1/vpnConnections/vpnConnection1/VpnSiteLinkConnections/Connection-Link1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "properties": { + "provisioningState": "Succeeded", + "vpnSiteLink": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/siteLink1" + }, + "connectionBandwidth": 200, + "ipsecPolicies": [], + "vpnConnectionProtocolType": "IKEv2", + "sharedKey": "key", + "ingressBytesTransferred": 0, + "egressBytesTransferred": 0, + "enableBgp": false, + "enableRateLimiting": false, + "useLocalAzureIpAddress": false, + "usePolicyBasedTrafficSelectors": false, + "routingWeight": 0 + } + } + ] + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkGet.json new file mode 100644 index 000000000000..11b29a591a6b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "vpnSiteLinkName": "vpnSiteLink1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkListByVpnSite.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkListByVpnSite.json new file mode 100644 index 000000000000..63ca1c559bdd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteLinkListByVpnSite.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "vpnSiteName": "vpnSite1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 200 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + }, + { + "name": "vpnSiteLink2", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink2", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "40.40.40.46", + "linkProperties": { + "linkSpeedInMbps": 200 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.1", + "asn": 1234 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteList.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteList.json new file mode 100644 index 000000000000..2092c563468d --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteList.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "East US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg2/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + }, + "isSecuritySite": false + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteListByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteListByResourceGroup.json new file mode 100644 index 000000000000..be543f99b569 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteListByResourceGroup.json @@ -0,0 +1,88 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + }, + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite2", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite2", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.1.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSitePut.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSitePut.json new file mode 100644 index 000000000000..c9011c1a7754 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSitePut.json @@ -0,0 +1,137 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1" + }, + "location": "West US", + "properties": { + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "properties": { + "ipAddress": "50.50.50.56", + "fqdn": "link1.vpnsite1.contoso.com", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "type": "Microsoft.Network/vpnSites/vpnSiteLinks", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1" + }, + "deviceProperties": { + "linkSpeedInMbps": 0 + }, + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "isSecuritySite": false, + "vpnSiteLinks": [ + { + "name": "vpnSiteLink1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1/vpnSiteLinks/vpnSiteLink1", + "etag": "W/\"00000000-0000-0000-0000-000000000000\"", + "properties": { + "provisioningState": "Succeeded", + "ipAddress": "50.50.50.56", + "linkProperties": { + "linkProviderName": "vendor1", + "linkSpeedInMbps": 0 + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteUpdateTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteUpdateTags.json new file mode 100644 index 000000000000..9974e9d1e97b --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSiteUpdateTags.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "vpnSiteName": "vpnSite1", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "subscriptionId": "subid", + "VpnSiteParameters": { + "tags": { + "key1": "value1", + "key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/vpnSite1", + "etag": "w/\\00000000-0000-0000-0000-000000000000\\", + "location": "West US", + "name": "vpnSite1", + "type": "Microsoft.Network/vpnSites", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "provisioningState": "Succeeded", + "virtualWan": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/virtualWANs/wan1", + "deviceProperties": { + "deviceVendor": "vendor1", + "deviceModel": "model01", + "linkSpeedInMbps": 200 + }, + "ipAddress": "10.0.0.0", + "addressSpace": { + "addressPrefixes": [ + "10.0.0.0/16" + ] + }, + "bgpProperties": { + "bgpPeeringAddress": "192.168.0.0", + "asn": 1234 + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSitesConfigurationDownload.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSitesConfigurationDownload.json new file mode 100644 index 000000000000..fb556caab7a2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/VpnSitesConfigurationDownload.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2020-05-01", + "virtualWANName": "wan1", + "request": { + "vpnSites": [ + "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/vpnSites/abc" + ], + "outputBlobSasUrl": "https://blobcortextesturl.blob.core.windows.net/folderforconfig/vpnFile?sp=rw&se=2018-01-10T03%3A42%3A04Z&sv=2017-04-17&sig=WvXrT5bDmDFfgHs%2Brz%2BjAu123eRCNE9BO0eQYcPDT7pY%3D&sr=b" + } + }, + "responses": { + "200": { + "description": "Request successful. Follow the location header for sas-url to output blob." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json new file mode 100644 index 000000000000..32158faaedfd --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Prevention", + "maxRequestBodySizeInKb": 128, + "fileUploadLimitInMb": 750, + "requestBodyCheck": true + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ], + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json new file mode 100644 index 000000000000..0faa1a7f616f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "maxRequestBodySizeInKb": 128, + "fileUploadLimitInMb": 750, + "requestBodyCheck": true + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json new file mode 100644 index 000000000000..63ec90cd9645 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json @@ -0,0 +1,258 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1", + "parameters": { + "location": "WestUs", + "properties": { + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "action": "Block", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ] + } + ] + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeaders", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "maxRequestBodySizeInKb": 128, + "fileUploadLimitInMb": 750, + "requestBodyCheck": true + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ] + } + } + }, + "201": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Detection", + "maxRequestBodySizeInKb": 128, + "fileUploadLimitInMb": 750, + "requestBodyCheck": true + }, + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0" + } + ] + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ] + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json new file mode 100644 index 000000000000..c887714443bf --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json new file mode 100644 index 000000000000..50555ffcb9ad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "policyName": "Policy1" + }, + "responses": { + "200": { + "body": { + "name": "Policy1", + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", + "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "location": "WestUs", + "properties": { + "resourceState": "Enabled", + "provisioningState": "Succeeded", + "policySettings": { + "state": "Enabled", + "mode": "Prevention", + "maxRequestBodySizeInKb": 128, + "fileUploadLimitInMb": 750, + "requestBodyCheck": true + }, + "customRules": [ + { + "name": "Rule1", + "priority": 1, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24", + "10.0.0.0/24" + ], + "transforms": [] + } + ], + "action": "Block" + }, + { + "name": "Rule2", + "priority": 2, + "ruleType": "MatchRule", + "matchConditions": [ + { + "matchVariables": [ + { + "variableName": "RemoteAddr", + "selector": null + } + ], + "operator": "IPMatch", + "negationConditon": false, + "matchValues": [ + "192.168.1.0/24" + ] + }, + { + "matchVariables": [ + { + "variableName": "RequestHeader", + "selector": "UserAgent" + } + ], + "operator": "Contains", + "negationConditon": false, + "matchValues": [ + "Windows" + ] + } + ], + "action": "Block" + } + ], + "managedRules": { + "managedRuleSets": [ + { + "ruleSetType": "OWASP", + "ruleSetVersion": "3.0", + "ruleGroupOverrides": [ + { + "ruleGroupName": "REQUEST-942-APPLICATION-ATTACK-SQLI", + "rules": [ + { + "ruleId": "942130", + "state": "Disabled" + }, + { + "ruleId": "942110", + "state": "Disabled" + } + ] + }, + { + "ruleGroupName": "REQUEST-920-PROTOCOL-ENFORCEMENT", + "rules": [ + { + "ruleId": "920100", + "state": "Disabled" + }, + { + "ruleId": "920120", + "state": "Disabled" + } + ] + } + ] + } + ], + "exclusions": [ + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "Equals", + "selector": "testHeader1" + }, + { + "matchVariable": "RequestHeaderNames", + "selectorMatchOperator": "StartsWith", + "selector": "testHeader2" + } + ] + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRouteCircuit.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRouteCircuit.json new file mode 100644 index 000000000000..e07eae845e71 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRouteCircuit.json @@ -0,0 +1,2507 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations/{authorizationName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_Delete", + "description": "Deletes the specified authorization from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_Get", + "description": "Gets the specified authorization from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_CreateOrUpdate", + "description": "Creates or updates an authorization in the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the authorization." + }, + { + "name": "authorizationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "Parameters supplied to the create or update express route circuit authorization operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/authorizations": { + "get": { + "tags": [ + "ExpressRouteCircuitAuthorizations" + ], + "operationId": "ExpressRouteCircuitAuthorizations_List", + "description": "Gets all authorizations in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitAuthorization resources.", + "schema": { + "$ref": "#/definitions/AuthorizationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Authorization": { + "$ref": "./examples/ExpressRouteCircuitAuthorizationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_Delete", + "description": "Deletes the specified peering from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit Peerings": { + "$ref": "./examples/ExpressRouteCircuitPeeringDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_Get", + "description": "Gets the specified peering for the express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit Peering": { + "$ref": "./examples/ExpressRouteCircuitPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified express route circuits.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "peeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "Parameters supplied to the create or update express route circuit peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRouteCircuit Peerings": { + "$ref": "./examples/ExpressRouteCircuitPeeringCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings": { + "get": { + "tags": [ + "ExpressRouteCircuitPeerings" + ], + "operationId": "ExpressRouteCircuitPeerings_List", + "description": "Gets all peerings in a specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitPeering resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Peerings": { + "$ref": "./examples/ExpressRouteCircuitPeeringList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections/{connectionName}": { + "delete": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_Delete", + "description": "Deletes the specified Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitConnectionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_Get", + "description": "Gets the specified Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Express Route Circuit Connection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCircuitConnectionGet": { + "$ref": "./examples/ExpressRouteCircuitConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_CreateOrUpdate", + "description": "Creates or updates a Express Route Circuit Connection in the specified express route circuits.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit connection." + }, + { + "name": "expressRouteCircuitConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "Parameters supplied to the create or update express route circuit connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuitPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCircuitConnectionCreate": { + "$ref": "./examples/ExpressRouteCircuitConnectionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/connections": { + "get": { + "tags": [ + "ExpressRouteCircuitConnections" + ], + "operationId": "ExpressRouteCircuitConnections_List", + "description": "Gets all global reach connections associated with a private peering in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuitConnections resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuit Connection": { + "$ref": "./examples/ExpressRouteCircuitConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections/{connectionName}": { + "get": { + "tags": [ + "PeerExpressRouteCircuitConnections" + ], + "operationId": "PeerExpressRouteCircuitConnections_Get", + "description": "Gets the specified Peer Express Route Circuit Connection from the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peer express route circuit connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Peer Express Route Circuit Connection resource.", + "schema": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PeerExpressRouteCircuitConnectionGet": { + "$ref": "./examples/PeerExpressRouteCircuitConnectionGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/peerConnections": { + "get": { + "tags": [ + "PeerExpressRouteCircuitConnections" + ], + "operationId": "PeerExpressRouteCircuitConnections_List", + "description": "Gets all global reach peer connections associated with a private peering in an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PeerExpressRouteCircuitConnections resources.", + "schema": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Peer ExpressRouteCircuit Connection": { + "$ref": "./examples/PeerExpressRouteCircuitConnectionList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}": { + "delete": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_Delete", + "description": "Deletes the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Disabling' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_Get", + "description": "Gets information about the specified express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_CreateOrUpdate", + "description": "Creates or updates an express route circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + }, + "description": "Parameters supplied to the create or update express route circuit operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create ExpressRouteCircuit": { + "$ref": "./examples/ExpressRouteCircuitCreate.json" + }, + "Create ExpressRouteCircuit on ExpressRoutePort": { + "$ref": "./examples/ExpressRouteCircuitCreateOnExpressRoutePort.json" + } + } + }, + "patch": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_UpdateTags", + "description": "Updates an express route circuit tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the circuit." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update express route circuit tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCircuit resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuit" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Express Route Circuit Tags": { + "$ref": "./examples/ExpressRouteCircuitUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/arpTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitArpTable" + ], + "operationId": "ExpressRouteCircuits_ListArpTable", + "description": "Gets the currently advertised ARP table associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsArpTable resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsArpTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "List ARP Table": { + "$ref": "./examples/ExpressRouteCircuitARPTableList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitRoutesTable" + ], + "operationId": "ExpressRouteCircuits_ListRoutesTable", + "description": "Gets the currently advertised routes table associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsRouteTable resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "List Route Tables": { + "$ref": "./examples/ExpressRouteCircuitRouteTableList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCircuitRoutesTableSummary" + ], + "operationId": "ExpressRouteCircuits_ListRoutesTableSummary", + "description": "Gets the currently advertised routes table summary associated with the express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitsRoutesTableSummary resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitsRoutesTableSummaryListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "List Route Table Summary": { + "$ref": "./examples/ExpressRouteCircuitRouteTableSummaryList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/stats": { + "get": { + "tags": [ + "ExpressRouteCircuitStats" + ], + "operationId": "ExpressRouteCircuits_GetStats", + "description": "Gets all the stats from an express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitStats resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitStats" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRoute Circuit Traffic Stats": { + "$ref": "./examples/ExpressRouteCircuitStats.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits/{circuitName}/peerings/{peeringName}/stats": { + "get": { + "tags": [ + "ExpressRouteCircuitStats" + ], + "operationId": "ExpressRouteCircuits_GetPeeringStats", + "description": "Gets all stats from an express route circuit in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "circuitName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the express route circuit." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitStats resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitStats" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get ExpressRoute Circuit Peering Traffic Stats": { + "$ref": "./examples/ExpressRouteCircuitPeeringStats.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCircuits": { + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_List", + "description": "Gets all the express route circuits in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCircuitAuthorization resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuits in a resource group": { + "$ref": "./examples/ExpressRouteCircuitListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCircuits": { + "get": { + "tags": [ + "ExpressRouteCircuits" + ], + "operationId": "ExpressRouteCircuits_ListAll", + "description": "Gets all the express route circuits in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCircuit resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCircuitListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRouteCircuits in a subscription": { + "$ref": "./examples/ExpressRouteCircuitListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteServiceProviders": { + "get": { + "tags": [ + "ExpressRouteServiceProviders" + ], + "operationId": "ExpressRouteServiceProviders_List", + "description": "Gets all the available express route service providers.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteServiceProvider resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteServiceProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List ExpressRoute providers": { + "$ref": "./examples/ExpressRouteProviderList.json" + } + } + } + } + }, + "definitions": { + "AuthorizationPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorization key." + }, + "authorizationUseStatus": { + "type": "string", + "description": "The authorization use status.", + "enum": [ + "Available", + "InUse" + ], + "x-ms-enum": { + "name": "AuthorizationUseStatus", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the authorization resource." + } + }, + "description": "Properties of ExpressRouteCircuitAuthorization." + }, + "ExpressRouteCircuitAuthorization": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AuthorizationPropertiesFormat", + "description": "Properties of the express route circuit authorization." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Authorization in an ExpressRouteCircuit resource." + }, + "AuthorizationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "The authorizations in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListAuthorizations API service call retrieves all authorizations that belongs to an ExpressRouteCircuit." + }, + "ExpressRouteCircuitPeeringConfig": { + "properties": { + "advertisedPublicPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The reference to AdvertisedPublicPrefixes." + }, + "advertisedCommunities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The communities of bgp peering. Specified for microsoft peering." + }, + "advertisedPublicPrefixesState": { + "readOnly": true, + "type": "string", + "description": "The advertised public prefix state of the Peering resource.", + "enum": [ + "NotConfigured", + "Configuring", + "Configured", + "ValidationNeeded" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitPeeringAdvertisedPublicPrefixState", + "modelAsString": true + } + }, + "legacyMode": { + "type": "integer", + "format": "int32", + "description": "The legacy mode of the peering." + }, + "customerASN": { + "type": "integer", + "format": "int32", + "description": "The CustomerASN of the peering." + }, + "routingRegistryName": { + "type": "string", + "description": "The RoutingRegistryName of the configuration." + } + }, + "description": "Specifies the peering configuration." + }, + "Ipv6ExpressRouteCircuitPeeringConfig": { + "properties": { + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "microsoftPeeringConfig": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "routeFilter": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the RouteFilter resource." + }, + "state": { + "type": "string", + "description": "The state of peering.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitPeeringState", + "modelAsString": true + } + } + }, + "description": "Contains IPv6 peering config." + }, + "ExpressRouteCircuitStats": { + "properties": { + "primarybytesIn": { + "type": "integer", + "format": "int64", + "description": "The Primary BytesIn of the peering." + }, + "primarybytesOut": { + "type": "integer", + "format": "int64", + "description": "The primary BytesOut of the peering." + }, + "secondarybytesIn": { + "type": "integer", + "format": "int64", + "description": "The secondary BytesIn of the peering." + }, + "secondarybytesOut": { + "type": "integer", + "format": "int64", + "description": "The secondary BytesOut of the peering." + } + }, + "description": "Contains stats associated with the peering." + }, + "ExpressRouteCircuitPeeringPropertiesFormat": { + "properties": { + "peeringType": { + "$ref": "#/definitions/ExpressRoutePeeringType", + "description": "The peering type." + }, + "state": { + "$ref": "#/definitions/ExpressRoutePeeringState", + "description": "The peering state." + }, + "azureASN": { + "type": "integer", + "format": "int32", + "description": "The Azure ASN." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 4294967295, + "description": "The peer ASN." + }, + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "primaryAzurePort": { + "type": "string", + "description": "The primary port." + }, + "secondaryAzurePort": { + "type": "string", + "description": "The secondary port." + }, + "sharedKey": { + "type": "string", + "description": "The shared key." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "The VLAN ID." + }, + "microsoftPeeringConfig": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "stats": { + "$ref": "#/definitions/ExpressRouteCircuitStats", + "description": "The peering stats of express route circuit." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route circuit peering resource." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "lastModifiedBy": { + "readOnly": true, + "type": "string", + "description": "Who was the last to modify the peering." + }, + "routeFilter": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the RouteFilter resource." + }, + "ipv6PeeringConfig": { + "$ref": "#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", + "description": "The IPv6 peering configuration." + }, + "expressRouteConnection": { + "$ref": "./virtualWan.json#/definitions/ExpressRouteConnectionId", + "description": "The ExpressRoute connection." + }, + "connections": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "The list of circuit connections associated with Azure Private Peering for this circuit." + }, + "peeredConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnection" + }, + "readOnly": true, + "description": "The list of peered circuit connections associated with Azure Private Peering for this circuit." + } + }, + "description": "Properties of the express route circuit peering." + }, + "ExpressRouteCircuitPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitPeeringPropertiesFormat", + "description": "Properties of the express route circuit peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peering in an ExpressRouteCircuit resource." + }, + "ExpressRouteCircuitPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "The peerings in an express route circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCircuit." + }, + "ExpressRoutePeeringType": { + "type": "string", + "description": "The peering type.", + "enum": [ + "AzurePublicPeering", + "AzurePrivatePeering", + "MicrosoftPeering" + ], + "x-ms-enum": { + "name": "ExpressRoutePeeringType", + "modelAsString": true + } + }, + "ExpressRoutePeeringState": { + "type": "string", + "description": "The state of peering.", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "ExpressRoutePeeringState", + "modelAsString": true + } + }, + "Ipv6CircuitConnectionConfig": { + "description": "IPv6 Circuit Connection properties for global reach.", + "properties": { + "addressPrefix": { + "type": "string", + "description": "/125 IP address space to carve out customer addresses for global reach." + }, + "circuitConnectionStatus": { + "readOnly": true, + "$ref": "#/definitions/CircuitConnectionStatus", + "description": "Express Route Circuit connection state." + } + } + }, + "ExpressRouteCircuitConnectionPropertiesFormat": { + "properties": { + "expressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the circuit initiating connection." + }, + "peerExpressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the peered circuit." + }, + "addressPrefix": { + "type": "string", + "description": "/29 IP address space to carve out Customer addresses for tunnels." + }, + "authorizationKey": { + "type": "string", + "description": "The authorization key." + }, + "ipv6CircuitConnectionConfig": { + "$ref": "#/definitions/Ipv6CircuitConnectionConfig", + "description": "IPv6 Address PrefixProperties of the express route circuit connection." + }, + "circuitConnectionStatus": { + "$ref": "#/definitions/CircuitConnectionStatus", + "description": "Express Route Circuit connection state." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route circuit connection resource." + } + }, + "description": "Properties of the express route circuit connection." + }, + "ExpressRouteCircuitConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitConnectionPropertiesFormat", + "description": "Properties of the express route circuit connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Express Route Circuit Connection in an ExpressRouteCircuitPeering resource." + }, + "ExpressRouteCircuitConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitConnection" + }, + "description": "The global reach connection associated with Private Peering in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListConnections API service call retrieves all global reach connections that belongs to a Private Peering for an ExpressRouteCircuit." + }, + "PeerExpressRouteCircuitConnectionPropertiesFormat": { + "properties": { + "expressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the circuit." + }, + "peerExpressRouteCircuitPeering": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to Express Route Circuit Private Peering Resource of the peered circuit." + }, + "addressPrefix": { + "type": "string", + "description": "/29 IP address space to carve out Customer addresses for tunnels." + }, + "circuitConnectionStatus": { + "$ref": "#/definitions/CircuitConnectionStatus", + "description": "Express Route Circuit connection state." + }, + "connectionName": { + "type": "string", + "description": "The name of the express route circuit connection resource." + }, + "authResourceGuid": { + "type": "string", + "description": "The resource guid of the authorization used for the express route circuit connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the peer express route circuit connection resource." + } + }, + "description": "Properties of the peer express route circuit connection." + }, + "PeerExpressRouteCircuitConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PeerExpressRouteCircuitConnectionPropertiesFormat", + "description": "Properties of the peer express route circuit connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peer Express Route Circuit Connection in an ExpressRouteCircuitPeering resource." + }, + "PeerExpressRouteCircuitConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PeerExpressRouteCircuitConnection" + }, + "description": "The global reach peer circuit connection associated with Private Peering in an ExpressRoute Circuit." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeeredConnections API service call retrieves all global reach peer circuit connections that belongs to a Private Peering for an ExpressRouteCircuit." + }, + "ExpressRouteCircuitSku": { + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU." + }, + "tier": { + "type": "string", + "description": "The tier of the SKU.", + "enum": [ + "Standard", + "Premium", + "Basic", + "Local" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitSkuTier", + "modelAsString": true + } + }, + "family": { + "type": "string", + "description": "The family of the SKU.", + "enum": [ + "UnlimitedData", + "MeteredData" + ], + "x-ms-enum": { + "name": "ExpressRouteCircuitSkuFamily", + "modelAsString": true + } + } + }, + "description": "Contains SKU in an ExpressRouteCircuit." + }, + "ExpressRouteCircuitServiceProviderProperties": { + "properties": { + "serviceProviderName": { + "type": "string", + "description": "The serviceProviderName." + }, + "peeringLocation": { + "type": "string", + "description": "The peering location." + }, + "bandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "The BandwidthInMbps." + } + }, + "description": "Contains ServiceProviderProperties in an ExpressRouteCircuit." + }, + "ExpressRouteCircuitPropertiesFormat": { + "properties": { + "allowClassicOperations": { + "type": "boolean", + "description": "Allow classic operations." + }, + "circuitProvisioningState": { + "type": "string", + "description": "The CircuitProvisioningState state of the resource." + }, + "serviceProviderProvisioningState": { + "$ref": "#/definitions/ServiceProviderProvisioningState", + "description": "The ServiceProviderProvisioningState state of the resource." + }, + "authorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitAuthorization" + }, + "description": "The list of authorizations." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitPeering" + }, + "description": "The list of peerings." + }, + "serviceKey": { + "type": "string", + "description": "The ServiceKey." + }, + "serviceProviderNotes": { + "type": "string", + "description": "The ServiceProviderNotes." + }, + "serviceProviderProperties": { + "$ref": "#/definitions/ExpressRouteCircuitServiceProviderProperties", + "description": "The ServiceProviderProperties." + }, + "expressRoutePort": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the ExpressRoutePort resource when the circuit is provisioned on an ExpressRoutePort resource." + }, + "bandwidthInGbps": { + "type": "number", + "description": "The bandwidth of the circuit when the circuit is provisioned on an ExpressRoutePort resource." + }, + "stag": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The identifier of the circuit traffic. Outer tag for QinQ encapsulation." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route circuit resource." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "globalReachEnabled": { + "type": "boolean", + "description": "Flag denoting global reach status." + } + }, + "description": "Properties of ExpressRouteCircuit." + }, + "ExpressRouteCircuit": { + "properties": { + "sku": { + "$ref": "#/definitions/ExpressRouteCircuitSku", + "description": "The SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCircuitPropertiesFormat", + "description": "Properties of the express route circuit." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteCircuit resource." + }, + "ExpressRouteCircuitArpTable": { + "properties": { + "age": { + "type": "integer", + "format": "int32", + "description": "Entry age in minutes." + }, + "interface": { + "type": "string", + "description": "Interface address." + }, + "ipAddress": { + "type": "string", + "description": "The IP address." + }, + "macAddress": { + "type": "string", + "description": "The MAC address." + } + }, + "description": "The ARP table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsArpTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitArpTable" + }, + "description": "A list of the ARP tables." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListArpTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitRoutesTable": { + "properties": { + "network": { + "type": "string", + "description": "IP address of a network entity." + }, + "nextHop": { + "type": "string", + "description": "NextHop address." + }, + "locPrf": { + "type": "string", + "description": "Local preference value as set with the set local-preference route-map configuration command." + }, + "weight": { + "type": "integer", + "format": "int32", + "description": "Route Weight." + }, + "path": { + "type": "string", + "description": "Autonomous system paths to the destination network." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsRoutesTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitRoutesTable" + }, + "description": "The list of routes table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitRoutesTableSummary": { + "properties": { + "neighbor": { + "type": "string", + "description": "IP address of the neighbor." + }, + "v": { + "type": "integer", + "format": "int32", + "description": "BGP version number spoken to the neighbor." + }, + "as": { + "type": "integer", + "format": "int32", + "description": "Autonomous system number." + }, + "upDown": { + "type": "string", + "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." + }, + "statePfxRcd": { + "type": "string", + "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCircuitsRoutesTableSummaryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuitRoutesTableSummary" + }, + "description": "A list of the routes table." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Circuits API." + }, + "ExpressRouteCircuitListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCircuit" + }, + "description": "A list of ExpressRouteCircuits in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteCircuit API service call." + }, + "ExpressRouteServiceProviderBandwidthsOffered": { + "properties": { + "offerName": { + "type": "string", + "description": "The OfferName." + }, + "valueInMbps": { + "type": "integer", + "format": "int32", + "description": "The ValueInMbps." + } + }, + "description": "Contains bandwidths offered in ExpressRouteServiceProvider resources." + }, + "ExpressRouteServiceProviderPropertiesFormat": { + "properties": { + "peeringLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of peering locations." + }, + "bandwidthsOffered": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteServiceProviderBandwidthsOffered" + }, + "description": "A list of bandwidths offered." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route service provider resource." + } + }, + "description": "Properties of ExpressRouteServiceProvider." + }, + "ExpressRouteServiceProvider": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteServiceProviderPropertiesFormat", + "description": "Properties of the express route service provider." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A ExpressRouteResourceProvider object." + }, + "ExpressRouteServiceProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteServiceProvider" + }, + "description": "A list of ExpressRouteResourceProvider resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListExpressRouteServiceProvider API service call." + }, + "CircuitConnectionStatus": { + "type": "string", + "readOnly": true, + "description": "Express Route Circuit connection state.", + "enum": [ + "Connected", + "Connecting", + "Disconnected" + ], + "x-ms-enum": { + "name": "CircuitConnectionStatus", + "modelAsString": true + } + }, + "ServiceProviderProvisioningState": { + "type": "string", + "description": "The ServiceProviderProvisioningState state of the resource.", + "enum": [ + "NotProvisioned", + "Provisioning", + "Provisioned", + "Deprovisioning" + ], + "x-ms-enum": { + "name": "ServiceProviderProvisioningState", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRouteCrossConnection.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRouteCrossConnection.json new file mode 100644 index 000000000000..71382d2c3b09 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRouteCrossConnection.json @@ -0,0 +1,1006 @@ +{ + "swagger": "2.0", + "info": { + "title": "ExpressRouteCrossConnection REST APIs", + "description": "The Microsoft Azure ExpressRouteCrossConnection Resource Provider REST APIs describes the operations for the connectivity provider to provision ExpressRoute circuit, create and modify BGP peering entities and troubleshoot connectivity on customer's ExpressRoute circuit.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteCrossConnections": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_List", + "description": "Retrieves all the ExpressRouteCrossConnections in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionList": { + "$ref": "./examples/ExpressRouteCrossConnectionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_ListByResourceGroup", + "description": "Retrieves all the ExpressRouteCrossConnections in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.The operation returns a list of ExpressRouteCrossConnection resources. If there are no cross connection resources an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionListByResourceGroup": { + "$ref": "./examples/ExpressRouteCrossConnectionListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}": { + "get": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_Get", + "description": "Gets details about the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group (peering location of the circuit)." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection (service key of the circuit)." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnection": { + "$ref": "./examples/ExpressRouteCrossConnectionGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_CreateOrUpdate", + "description": "Update the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + }, + "description": "Parameters supplied to the update express route crossConnection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateExpressRouteCrossConnection": { + "$ref": "./examples/ExpressRouteCrossConnectionUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ExpressRouteCrossConnections" + ], + "operationId": "ExpressRouteCrossConnections_UpdateTags", + "description": "Updates an express route cross connection tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the cross connection." + }, + { + "name": "crossConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update express route cross connection tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnection resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateExpressRouteCrossConnectionTags": { + "$ref": "./examples/ExpressRouteCrossConnectionUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings": { + "get": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_List", + "description": "Gets all peerings in a specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteCrossConnectionPeering resources.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionBgpPeeringList": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_Delete", + "description": "Deletes the specified peering from the ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteExpressRouteCrossConnectionBgpPeering": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_Get", + "description": "Gets the specified peering for the ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionBgpPeering": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRouteCrossConnectionPeerings" + ], + "operationId": "ExpressRouteCrossConnectionPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified ExpressRouteCrossConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "peeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "Parameters supplied to the create or update ExpressRouteCrossConnection peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRouteCrossConnectionPeering resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteCrossConnectionBgpPeeringCreate": { + "$ref": "./examples/ExpressRouteCrossConnectionBgpPeeringCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/arpTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionArpTable" + ], + "operationId": "ExpressRouteCrossConnections_ListArpTable", + "description": "Gets the currently advertised ARP table associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsArpTable resource.", + "schema": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitsArpTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsArpTable": { + "$ref": "./examples/ExpressRouteCrossConnectionsArpTable.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTablesSummary/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionRouteTableSummary" + ], + "operationId": "ExpressRouteCrossConnections_ListRoutesTableSummary", + "description": "Gets the route table summary associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsRouteTableSummary resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteCrossConnectionsRoutesTableSummaryListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsRouteTableSummary": { + "$ref": "./examples/ExpressRouteCrossConnectionsRouteTableSummary.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteCrossConnections/{crossConnectionName}/peerings/{peeringName}/routeTables/{devicePath}": { + "post": { + "tags": [ + "ExpressRouteCrossConnectionRouteTable" + ], + "operationId": "ExpressRouteCrossConnections_ListRoutesTable", + "description": "Gets the currently advertised routes table associated with the express route cross connection in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "crossConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteCrossConnection." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "devicePath", + "in": "path", + "required": true, + "type": "string", + "description": "The path of the device." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ExpressRouteCrossConnectionsRouteTable resource.", + "schema": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitsRoutesTableListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetExpressRouteCrossConnectionsRouteTable": { + "$ref": "./examples/ExpressRouteCrossConnectionsRouteTable.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "ExpressRouteCrossConnectionRoutesTableSummary": { + "properties": { + "neighbor": { + "type": "string", + "description": "IP address of Neighbor router." + }, + "asn": { + "type": "integer", + "format": "int32", + "description": "Autonomous system number." + }, + "upDown": { + "type": "string", + "description": "The length of time that the BGP session has been in the Established state, or the current status if not in the Established state." + }, + "stateOrPrefixesReceived": { + "type": "string", + "description": "Current state of the BGP session, and the number of prefixes that have been received from a neighbor or peer group." + } + }, + "description": "The routes table associated with the ExpressRouteCircuit." + }, + "ExpressRouteCrossConnectionsRoutesTableSummaryListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionRoutesTableSummary" + }, + "description": "A list of the routes table." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListRoutesTable associated with the Express Route Cross Connections." + }, + "ExpressRouteCircuitReference": { + "properties": { + "id": { + "type": "string", + "description": "Corresponding Express Route Circuit Id." + } + }, + "description": "Reference to an express route circuit." + }, + "ExpressRouteCrossConnectionProperties": { + "properties": { + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The name of the secondary port." + }, + "sTag": { + "readOnly": true, + "type": "integer", + "description": "The identifier of the circuit traffic." + }, + "peeringLocation": { + "type": "string", + "description": "The peering location of the ExpressRoute circuit." + }, + "bandwidthInMbps": { + "type": "integer", + "format": "int32", + "description": "The circuit bandwidth In Mbps." + }, + "expressRouteCircuit": { + "$ref": "#/definitions/ExpressRouteCircuitReference", + "description": "The ExpressRouteCircuit." + }, + "serviceProviderProvisioningState": { + "$ref": "./expressRouteCircuit.json#/definitions/ServiceProviderProvisioningState", + "description": "The provisioning state of the circuit in the connectivity provider system." + }, + "serviceProviderNotes": { + "type": "string", + "description": "Additional read only notes set by the connectivity provider." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route cross connection resource." + }, + "peerings": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "The list of peerings." + } + }, + "description": "Properties of ExpressRouteCrossConnection." + }, + "ExpressRouteCrossConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCrossConnectionProperties", + "description": "Properties of the express route cross connection." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRouteCrossConnection resource." + }, + "ExpressRouteCrossConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnection" + }, + "description": "A list of ExpressRouteCrossConnection resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListExpressRouteCrossConnection API service call." + }, + "ExpressRouteCrossConnectionPeeringProperties": { + "properties": { + "peeringType": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRoutePeeringType", + "description": "The peering type." + }, + "state": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRoutePeeringState", + "description": "The peering state." + }, + "azureASN": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The Azure ASN." + }, + "peerASN": { + "type": "integer", + "format": "int64", + "minimum": 1, + "maximum": 4294967295, + "description": "The peer ASN." + }, + "primaryPeerAddressPrefix": { + "type": "string", + "description": "The primary address prefix." + }, + "secondaryPeerAddressPrefix": { + "type": "string", + "description": "The secondary address prefix." + }, + "primaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The primary port." + }, + "secondaryAzurePort": { + "readOnly": true, + "type": "string", + "description": "The secondary port." + }, + "sharedKey": { + "type": "string", + "description": "The shared key." + }, + "vlanId": { + "type": "integer", + "format": "int32", + "description": "The VLAN ID." + }, + "microsoftPeeringConfig": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeeringConfig", + "description": "The Microsoft peering configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route cross connection peering resource." + }, + "gatewayManagerEtag": { + "type": "string", + "description": "The GatewayManager Etag." + }, + "lastModifiedBy": { + "readOnly": true, + "type": "string", + "description": "Who was the last to modify the peering." + }, + "ipv6PeeringConfig": { + "$ref": "./expressRouteCircuit.json#/definitions/Ipv6ExpressRouteCircuitPeeringConfig", + "description": "The IPv6 peering configuration." + } + }, + "description": "Properties of express route cross connection peering." + }, + "ExpressRouteCrossConnectionPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteCrossConnectionPeeringProperties", + "description": "Properties of the express route cross connection peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peering in an ExpressRoute Cross Connection resource." + }, + "ExpressRouteCrossConnectionPeeringList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteCrossConnectionPeering" + }, + "description": "The peerings in an express route cross connection." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPeering API service call retrieves all peerings that belong to an ExpressRouteCrossConnection." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRoutePort.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRoutePort.json new file mode 100644 index 000000000000..ca0543ecd149 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/expressRoutePort.json @@ -0,0 +1,869 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations": { + "get": { + "tags": [ + "ExpressRoutePortsLocations" + ], + "operationId": "ExpressRoutePortsLocations_List", + "description": "Retrieves all ExpressRoutePort peering locations. Does not return available bandwidths for each location. Available bandwidths can only be obtained when retrieving a specific peering location.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of all ExpressRoutePort peering locations.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortsLocationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortsLocationList": { + "$ref": "./examples/ExpressRoutePortsLocationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePortsLocations/{locationName}": { + "get": { + "tags": [ + "ExpressRoutePortsLocations" + ], + "operationId": "ExpressRoutePortsLocations_Get", + "description": "Retrieves a single ExpressRoutePort peering location, including the list of available bandwidths available at said peering location.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the requested ExpressRoutePort peering location." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRoutePort peering location.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortsLocation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortsLocationGet": { + "$ref": "./examples/ExpressRoutePortsLocationGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}": { + "delete": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_Delete", + "description": "Deletes the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "ExpressRoutePortDelete": { + "$ref": "./examples/ExpressRoutePortDelete.json" + } + } + }, + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_Get", + "description": "Retrieves the requested ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of ExpressRoutePort." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortGet": { + "$ref": "./examples/ExpressRoutePortGet.json" + } + } + }, + "put": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_CreateOrUpdate", + "description": "Creates or updates the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + }, + "description": "Parameters supplied to the create ExpressRoutePort operation." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "ExpressRoutePortCreate": { + "$ref": "./examples/ExpressRoutePortCreate.json" + }, + "ExpressRoutePortUpdateLink": { + "$ref": "./examples/ExpressRoutePortUpdateLink.json" + } + } + }, + "patch": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_UpdateTags", + "description": "Update ExpressRoutePort tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update ExpressRoutePort resource tags." + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoutePort resource.", + "schema": { + "$ref": "#/definitions/ExpressRoutePort" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRoutePortUpdateTags": { + "$ref": "./examples/ExpressRoutePortUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts": { + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_ListByResourceGroup", + "description": "List all the ExpressRoutePort resources in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortListByResourceGroup": { + "$ref": "./examples/ExpressRoutePortListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ExpressRoutePorts": { + "get": { + "tags": [ + "ExpressRoutePorts" + ], + "operationId": "ExpressRoutePorts_List", + "description": "List all the ExpressRoutePort resources in the specified subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRoutePort resources. If there are no ExpressRoutePort resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRoutePortListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRoutePortList": { + "$ref": "./examples/ExpressRoutePortList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links/{linkName}": { + "get": { + "tags": [ + "ExpressRouteLinks" + ], + "operationId": "ExpressRouteLinks_Get", + "description": "Retrieves the specified ExpressRouteLink resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + }, + { + "name": "linkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRouteLink resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested ExpressRouteLink resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExpressRouteLinkGet": { + "$ref": "./examples/ExpressRouteLinkGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ExpressRoutePorts/{expressRoutePortName}/links": { + "get": { + "tags": [ + "ExpressRouteLinks" + ], + "operationId": "ExpressRouteLinks_List", + "description": "Retrieve the ExpressRouteLink sub-resources of the specified ExpressRoutePort resource.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRoutePortName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoutePort resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ExpressRouteLink resources. If there are no ExpressRouteLink resources then an empty list is returned.", + "schema": { + "$ref": "#/definitions/ExpressRouteLinkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ExpressRouteLinkGet": { + "$ref": "./examples/ExpressRouteLinkList.json" + } + } + } + } + }, + "definitions": { + "ExpressRoutePortsLocationBandwidths": { + "title": "ExpressRoutePorts Location Bandwidths", + "description": "Real-time inventory of available ExpressRoute port bandwidths.", + "properties": { + "offerName": { + "type": "string", + "readOnly": true, + "description": "Bandwidth descriptive name." + }, + "valueInGbps": { + "type": "integer", + "readOnly": true, + "description": "Bandwidth value in Gbps." + } + } + }, + "ExpressRoutePortsLocationPropertiesFormat": { + "title": "ExpressRoutePorts Location Properties", + "description": "Properties specific to ExpressRoutePorts peering location resources.", + "properties": { + "address": { + "type": "string", + "readOnly": true, + "description": "Address of peering location." + }, + "contact": { + "type": "string", + "readOnly": true, + "description": "Contact details of peering locations." + }, + "availableBandwidths": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortsLocationBandwidths" + }, + "description": "The inventory of available ExpressRoutePort bandwidths." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route port location resource." + } + } + }, + "ExpressRoutePortsLocation": { + "title": "ExpressRoutePorts Peering Location", + "description": "Definition of the ExpressRoutePorts peering location resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortsLocationPropertiesFormat", + "description": "ExpressRoutePort peering location properties." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ExpressRoutePortsLocationListResult": { + "title": "ExpressRoutePorts Location List Result", + "description": "Response for ListExpressRoutePortsLocations API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePortsLocation" + }, + "description": "The list of all ExpressRoutePort peering locations." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "ExpressRouteLinkMacSecConfig": { + "description": "ExpressRouteLink Mac Security Configuration.", + "title": "Definition of ExpressRouteLink Mac Security configuration.", + "properties": { + "cknSecretIdentifier": { + "type": "string", + "description": "Keyvault Secret Identifier URL containing Mac security CKN key." + }, + "cakSecretIdentifier": { + "type": "string", + "description": "Keyvault Secret Identifier URL containing Mac security CAK key." + }, + "cipher": { + "type": "string", + "description": "Mac security cipher.", + "enum": [ + "gcm-aes-128", + "gcm-aes-256" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkMacSecCipher", + "modelAsString": true + } + } + } + }, + "ExpressRouteLinkPropertiesFormat": { + "title": "ExpressRouteLink Resource Properties", + "description": "Properties specific to ExpressRouteLink resources.", + "properties": { + "routerName": { + "readOnly": true, + "type": "string", + "description": "Name of Azure router associated with physical port." + }, + "interfaceName": { + "readOnly": true, + "type": "string", + "description": "Name of Azure router interface." + }, + "patchPanelId": { + "readOnly": true, + "type": "string", + "description": "Mapping between physical port to patch panel port." + }, + "rackId": { + "readOnly": true, + "type": "string", + "description": "Mapping of physical patch panel to rack." + }, + "connectorType": { + "readOnly": true, + "type": "string", + "description": "Physical fiber port type.", + "enum": [ + "LC", + "SC" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkConnectorType", + "modelAsString": true + } + }, + "adminState": { + "type": "string", + "description": "Administrative state of the physical port.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "ExpressRouteLinkAdminState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route link resource." + }, + "macSecConfig": { + "$ref": "#/definitions/ExpressRouteLinkMacSecConfig", + "description": "MacSec configuration." + } + } + }, + "ExpressRouteLink": { + "title": "ExpressRouteLink", + "description": "ExpressRouteLink child resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteLinkPropertiesFormat", + "description": "ExpressRouteLink properties." + }, + "name": { + "type": "string", + "description": "Name of child port resource that is unique among child port resources of the parent." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ] + }, + "ExpressRouteLinkListResult": { + "title": "ExpressRouteLink List Result", + "description": "Response for ListExpressRouteLinks API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteLink" + }, + "description": "The list of ExpressRouteLink sub-resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + }, + "ExpressRoutePortPropertiesFormat": { + "title": "ExpressRoutePort Properties", + "description": "Properties specific to ExpressRoutePort resources.", + "properties": { + "peeringLocation": { + "type": "string", + "description": "The name of the peering location that the ExpressRoutePort is mapped to physically." + }, + "bandwidthInGbps": { + "type": "integer", + "description": "Bandwidth of procured ports in Gbps." + }, + "provisionedBandwidthInGbps": { + "readOnly": true, + "type": "number", + "description": "Aggregate Gbps of associated circuit bandwidths." + }, + "mtu": { + "readOnly": true, + "type": "string", + "description": "Maximum transmission unit of the physical port pair(s)." + }, + "encapsulation": { + "type": "string", + "description": "Encapsulation method on physical ports.", + "enum": [ + "Dot1Q", + "QinQ" + ], + "x-ms-enum": { + "name": "ExpressRoutePortsEncapsulation", + "modelAsString": true + } + }, + "etherType": { + "readOnly": true, + "type": "string", + "description": "Ether type of the physical port." + }, + "allocationDate": { + "readOnly": true, + "type": "string", + "description": "Date of the physical port allocation to be used in Letter of Authorization." + }, + "links": { + "title": "ExpressRouteLink Sub-Resources", + "description": "The set of physical links of the ExpressRoutePort resource.", + "readOnly": false, + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteLink" + } + }, + "circuits": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Reference the ExpressRoute circuit(s) that are provisioned on this ExpressRoutePort resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route port resource." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the express route port resource." + } + } + }, + "ExpressRoutePort": { + "title": "ExpressRoute Port", + "description": "ExpressRoutePort resource definition.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRoutePortPropertiesFormat", + "description": "ExpressRoutePort properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The identity of ExpressRoutePort, if configured." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "ExpressRoutePortListResult": { + "title": "ExpressRoute Port List Result", + "description": "Response for ListExpressRoutePorts API service call.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRoutePort" + }, + "description": "A list of ExpressRoutePort resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/firewallPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/firewallPolicy.json new file mode 100644 index 000000000000..f15fb1e7a7b2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/firewallPolicy.json @@ -0,0 +1,1224 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}": { + "delete": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_Delete", + "description": "Deletes the specified Firewall Policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Firewall Policy": { + "$ref": "./examples/FirewallPolicyDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_Get", + "description": "Gets the specified Firewall Policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Firewall Policy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get FirewallPolicy": { + "$ref": "./examples/FirewallPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_CreateOrUpdate", + "description": "Creates or updates the specified Firewall Policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallPolicy" + }, + "description": "Parameters supplied to the create or update Firewall Policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting FirewallPolicy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting FirewallPolicy resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create FirewallPolicy": { + "$ref": "./examples/FirewallPolicyPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies": { + "get": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_List", + "description": "Lists all Firewall Policies in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of FirewallPolicy resources.", + "schema": { + "$ref": "#/definitions/FirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Firewall Policies for a given resource group": { + "$ref": "./examples/FirewallPolicyListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/firewallPolicies": { + "get": { + "tags": [ + "FirewallPolicies" + ], + "operationId": "FirewallPolicies_ListAll", + "description": "Gets all the Firewall Policies in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of FirewallPolicy resources.", + "schema": { + "$ref": "#/definitions/FirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Firewall Policies for a given subscription": { + "$ref": "./examples/FirewallPolicyListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups/{ruleCollectionGroupName}": { + "delete": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_Delete", + "description": "Deletes the specified FirewallPolicyRuleCollectionGroup.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "ruleCollectionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the FirewallPolicyRuleCollectionGroup." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete FirewallPolicyRuleCollectionGroup": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_Get", + "description": "Gets the specified FirewallPolicyRuleCollectionGroup.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "ruleCollectionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the FirewallPolicyRuleCollectionGroup." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a FirewallPolicyRuleCollectionGroup resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get FirewallPolicyRuleCollectionGroup": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupGet.json" + }, + "Get FirewallPolicyRuleCollectionGroup With IpGroups": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithIpGroupsGet.json" + } + } + }, + "put": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_CreateOrUpdate", + "description": "Creates or updates the specified FirewallPolicyRuleCollectionGroup.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "name": "ruleCollectionGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the FirewallPolicyRuleCollectionGroup." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + }, + "description": "Parameters supplied to the create or update FirewallPolicyRuleCollectionGroup operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting FirewallPolicyRuleCollectionGroup resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting FirewallPolicyRuleCollectionGroup resource.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create FirewallPolicyRuleCollectionGroup": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupPut.json" + }, + "Create FirewallPolicyRuleCollectionGroup With IpGroups": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithIpGroupsPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/firewallPolicies/{firewallPolicyName}/ruleCollectionGroups": { + "get": { + "tags": [ + "FirewallPolicyRuleCollectionGroups" + ], + "operationId": "FirewallPolicyRuleCollectionGroups_List", + "description": "Lists all FirewallPolicyRuleCollectionGroups in a FirewallPolicy resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "firewallPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Firewall Policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of FirewallPolicyRuleCollectionGroup resources.", + "schema": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all FirewallPolicyRuleCollectionGroups for a given FirewallPolicy": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupList.json" + }, + "List all FirewallPolicyRuleCollectionGroups with IpGroups for a given FirewallPolicy": { + "$ref": "./examples/FirewallPolicyRuleCollectionGroupWithIpGroupsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "FirewallPolicy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FirewallPolicyPropertiesFormat", + "description": "Properties of the firewall policy." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The identity of the firewall policy." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "FirewallPolicy Resource." + }, + "FirewallPolicyPropertiesFormat": { + "properties": { + "ruleCollectionGroups": { + "type": "array", + "readOnly": true, + "description": "List of references to FirewallPolicyRuleCollectionGroups.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the firewall policy resource." + }, + "basePolicy": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The parent firewall policy from which rules are inherited." + }, + "firewalls": { + "type": "array", + "readOnly": true, + "description": "List of references to Azure Firewalls that this Firewall Policy is associated with.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "childPolicies": { + "type": "array", + "readOnly": true, + "description": "List of references to Child Firewall Policies.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "threatIntelMode": { + "description": "The operation mode for Threat Intelligence.", + "$ref": "./azureFirewall.json#/definitions/AzureFirewallThreatIntelMode" + }, + "threatIntelWhitelist": { + "description": "ThreatIntel Whitelist for Firewall Policy.", + "$ref": "#/definitions/FirewallPolicyThreatIntelWhitelist" + }, + "intrusionSystemMode": { + "description": "The operation mode for Intrusion system.", + "$ref": "#/definitions/FirewallPolicyIntrusionSystemMode" + }, + "transportSecurity": { + "description": "TLS Configuration definition.", + "$ref": "#/definitions/FirewallPolicyTransportSecurity" + }, + "dnsSettings": { + "description": "DNS Proxy Settings definition.", + "$ref": "#/definitions/DnsSettings" + } + }, + "description": "Firewall Policy definition." + }, + "FirewallPolicyTransportSecurity": { + "properties": { + "certificateAuthority": { + "$ref": "#/definitions/FirewallPolicyCertificateAuthority", + "description": "The CA used for intermediate CA generation." + }, + "excludedDomains": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of domains which are excluded from TLS termination." + }, + "trustedRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallPolicyTrustedRootCertificate", + "description": "A list of certificates which are to be trusted by the firewall." + }, + "description": "Certificates which are to be trusted by the firewall." + } + }, + "description": "Configuration needed to perform TLS termination & initiation." + }, + "FirewallPolicyTrustedRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FirewallPolicyTrustedRootCertificatePropertiesFormat", + "description": "Properties of the trusted root authorities." + }, + "name": { + "type": "string", + "description": "Name of the trusted root certificate that is unique within a firewall policy." + } + }, + "description": "Trusted Root certificates of a firewall policy." + }, + "FirewallPolicyTrustedRootCertificatePropertiesFormat": { + "properties": { + "keyVaultSecretId": { + "type": "string", + "description": "Secret Id of (base-64 encoded unencrypted pfx) the public certificate data stored in KeyVault." + } + }, + "description": "Trusted Root certificates properties for tls." + }, + "FirewallPolicyCertificateAuthority": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FirewallPolicyCertificateAuthorityPropertiesFormat", + "description": "Properties of the certificate authority." + }, + "name": { + "type": "string", + "description": "Name of the CA certificate." + } + }, + "description": "Trusted Root certificates properties for tls." + }, + "FirewallPolicyCertificateAuthorityPropertiesFormat": { + "properties": { + "keyVaultSecretId": { + "type": "string", + "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." + } + }, + "description": "Trusted Root certificates properties for tls." + }, + "FirewallPolicyRuleCollectionGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroupProperties", + "description": "The properties of the firewall policy rule collection group." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Rule Group type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Rule Collection Group resource." + }, + "FirewallPolicyRuleCollectionGroupProperties": { + "properties": { + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the Firewall Policy Rule Collection Group resource." + }, + "ruleCollections": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallPolicyRuleCollection" + }, + "description": "Group of Firewall Policy rule collections." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the firewall policy rule collection group resource." + } + }, + "description": "Properties of the rule collection group." + }, + "FirewallPolicyRuleCollection": { + "description": "Properties of the rule collection.", + "discriminator": "ruleCollectionType", + "required": [ + "ruleCollectionType" + ], + "properties": { + "ruleCollectionType": { + "type": "string", + "description": "The type of the rule collection.", + "enum": [ + "FirewallPolicyNatRuleCollection", + "FirewallPolicyFilterRuleCollection" + ], + "x-ms-enum": { + "name": "FirewallPolicyRuleCollectionType", + "modelAsString": true + } + }, + "name": { + "type": "string", + "description": "The name of the rule collection." + }, + "priority": { + "type": "integer", + "format": "int32", + "maximum": 65000, + "exclusiveMaximum": false, + "minimum": 100, + "exclusiveMinimum": false, + "description": "Priority of the Firewall Policy Rule Collection resource." + } + } + }, + "FirewallPolicyNatRuleCollection": { + "properties": { + "action": { + "$ref": "#/definitions/FirewallPolicyNatRuleCollectionAction", + "description": "The action type of a Nat rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallPolicyRule" + }, + "description": "List of rules included in a rule collection." + } + }, + "allOf": [ + { + "$ref": "#/definitions/FirewallPolicyRuleCollection" + } + ], + "x-ms-discriminator-value": "FirewallPolicyNatRuleCollection", + "description": "Firewall Policy NAT Rule Collection." + }, + "FirewallPolicyFilterRuleCollection": { + "properties": { + "action": { + "$ref": "#/definitions/FirewallPolicyFilterRuleCollectionAction", + "description": "The action type of a Filter rule collection." + }, + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallPolicyRule" + }, + "description": "List of rules included in a rule collection." + } + }, + "allOf": [ + { + "$ref": "#/definitions/FirewallPolicyRuleCollection" + } + ], + "x-ms-discriminator-value": "FirewallPolicyFilterRuleCollection", + "description": "Firewall Policy Filter Rule Collection." + }, + "FirewallPolicyRule": { + "description": "Properties of a rule.", + "discriminator": "ruleType", + "required": [ + "ruleType" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of the rule." + }, + "description": { + "type": "string", + "description": "Description of the rule." + }, + "ruleType": { + "type": "string", + "description": "Rule Type.", + "enum": [ + "ApplicationRule", + "NetworkRule", + "NatRule" + ], + "x-ms-enum": { + "name": "FirewallPolicyRuleType", + "modelAsString": true + } + } + } + }, + "ApplicationRule": { + "x-ms-discriminator-value": "ApplicationRule", + "allOf": [ + { + "$ref": "#/definitions/FirewallPolicyRule" + } + ], + "properties": { + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "destinationAddresses": { + "type": "array", + "description": "List of destination IP addresses or Service Tags.", + "items": { + "type": "string" + } + }, + "protocols": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallPolicyRuleApplicationProtocol" + }, + "description": "Array of Application Protocols." + }, + "targetUrls": { + "type": "array", + "description": "List of Urls for this rule condition.", + "items": { + "type": "string" + } + }, + "targetFqdns": { + "type": "array", + "description": "List of FQDNs for this rule.", + "items": { + "type": "string" + } + }, + "fqdnTags": { + "type": "array", + "description": "List of FQDN Tags for this rule.", + "items": { + "type": "string" + } + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + }, + "terminateTLS": { + "type": "boolean", + "description": "Terminate TLS connections for this rule." + } + }, + "description": "Rule of type application." + }, + "NatRule": { + "description": "Rule of type nat.", + "x-ms-discriminator-value": "NatRule", + "allOf": [ + { + "$ref": "#/definitions/FirewallPolicyRule" + } + ], + "properties": { + "ipProtocols": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallPolicyRuleNetworkProtocol" + }, + "description": "Array of FirewallPolicyRuleNetworkProtocols." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "destinationAddresses": { + "type": "array", + "description": "List of destination IP addresses or Service Tags.", + "items": { + "type": "string" + } + }, + "destinationPorts": { + "type": "array", + "description": "List of destination ports.", + "items": { + "type": "string" + } + }, + "translatedAddress": { + "type": "string", + "description": "The translated address for this NAT rule." + }, + "translatedPort": { + "type": "string", + "description": "The translated port for this NAT rule." + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + } + } + }, + "NetworkRule": { + "description": "Rule of type network.", + "x-ms-discriminator-value": "NetworkRule", + "allOf": [ + { + "$ref": "#/definitions/FirewallPolicyRule" + } + ], + "properties": { + "ipProtocols": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallPolicyRuleNetworkProtocol" + }, + "description": "Array of FirewallPolicyRuleNetworkProtocols." + }, + "sourceAddresses": { + "type": "array", + "description": "List of source IP addresses for this rule.", + "items": { + "type": "string" + } + }, + "destinationAddresses": { + "type": "array", + "description": "List of destination IP addresses or Service Tags.", + "items": { + "type": "string" + } + }, + "destinationPorts": { + "type": "array", + "description": "List of destination ports.", + "items": { + "type": "string" + } + }, + "sourceIpGroups": { + "type": "array", + "description": "List of source IpGroups for this rule.", + "items": { + "type": "string" + } + }, + "destinationIpGroups": { + "type": "array", + "description": "List of destination IpGroups for this rule.", + "items": { + "type": "string" + } + }, + "destinationFqdns": { + "type": "array", + "description": "List of destination FQDNs.", + "items": { + "type": "string" + } + } + } + }, + "FirewallPolicyRuleApplicationProtocol": { + "properties": { + "protocolType": { + "description": "Protocol type.", + "$ref": "#/definitions/FirewallPolicyRuleApplicationProtocolType" + }, + "port": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "exclusiveMaximum": false, + "minimum": 0, + "exclusiveMinimum": false, + "description": "Port number for the protocol, cannot be greater than 64000." + } + }, + "description": "Properties of the application rule protocol." + }, + "FirewallPolicyRuleApplicationProtocolType": { + "type": "string", + "description": "The application protocol type of a Rule.", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "FirewallPolicyRuleApplicationProtocolType", + "modelAsString": true + } + }, + "FirewallPolicyNatRuleCollectionActionType": { + "type": "string", + "description": "The action type of a rule.", + "enum": [ + "DNAT" + ], + "x-ms-enum": { + "name": "FirewallPolicyNatRuleCollectionActionType", + "modelAsString": true + } + }, + "FirewallPolicyNatRuleCollectionAction": { + "properties": { + "type": { + "description": "The type of action.", + "$ref": "#/definitions/FirewallPolicyNatRuleCollectionActionType" + } + }, + "description": "Properties of the FirewallPolicyNatRuleCollectionAction." + }, + "FirewallPolicyFilterRuleCollectionActionType": { + "type": "string", + "description": "The action type of a rule.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "FirewallPolicyFilterRuleCollectionActionType", + "modelAsString": true + } + }, + "FirewallPolicyFilterRuleCollectionAction": { + "properties": { + "type": { + "description": "The type of action.", + "$ref": "#/definitions/FirewallPolicyFilterRuleCollectionActionType" + } + }, + "description": "Properties of the FirewallPolicyFilterRuleCollectionAction." + }, + "FirewallPolicyRuleNetworkProtocol": { + "type": "string", + "description": "The Network protocol of a Rule.", + "enum": [ + "TCP", + "UDP", + "Any", + "ICMP" + ], + "x-ms-enum": { + "name": "FirewallPolicyRuleNetworkProtocol", + "modelAsString": true + } + }, + "FirewallPolicyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallPolicy" + }, + "description": "List of Firewall Policies in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListFirewallPolicies API service call." + }, + "FirewallPolicyRuleCollectionGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FirewallPolicyRuleCollectionGroup" + }, + "description": "List of FirewallPolicyRuleCollectionGroups in a FirewallPolicy." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListFirewallPolicyRuleCollectionGroups API service call." + }, + "FirewallPolicyIntrusionSystemMode": { + "type": "string", + "description": "The operation mode for Intrusion system mode.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "FirewallPolicyIntrusionSystemMode", + "modelAsString": true + } + }, + "FirewallPolicyThreatIntelWhitelist": { + "description": "ThreatIntel Whitelist for Firewall Policy.", + "x-ms-discriminator-value": "FirewallPolicyThreatIntelWhitelist", + "properties": { + "ipAddresses": { + "type": "array", + "description": "List of IP addresses for the ThreatIntel Whitelist.", + "items": { + "type": "string" + } + }, + "fqdns": { + "type": "array", + "description": "List of FQDNs for the ThreatIntel Whitelist.", + "items": { + "type": "string" + } + } + } + }, + "DnsSettings": { + "description": "DNS Proxy Settings in Firewall Policy.", + "x-ms-discriminator-value": "DnsSettings", + "properties": { + "servers": { + "type": "array", + "description": "List of Custom DNS Servers.", + "items": { + "type": "string" + } + }, + "enableProxy": { + "type": "boolean", + "description": "Enable DNS Proxy on Firewalls attached to the Firewall Policy." + }, + "requireProxyForNetworkRules": { + "type": "boolean", + "description": "FQDNs in Network Rules are supported when set to true.", + "x-nullable": true + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ipAllocation.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ipAllocation.json new file mode 100644 index 000000000000..938cc24f0e22 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ipAllocation.json @@ -0,0 +1,454 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations/{ipAllocationName}": { + "delete": { + "tags": [ + "IpAllocations" + ], + "operationId": "IpAllocations_Delete", + "description": "Deletes the specified IpAllocation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ipAllocationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IpAllocation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete IpAllocation": { + "$ref": "./examples/IpAllocationDelete.json" + } + } + }, + "get": { + "tags": [ + "IpAllocations" + ], + "operationId": "IpAllocations_Get", + "description": "Gets the specified IpAllocation by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ipAllocationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IpAllocation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting IpAllocation resource.", + "schema": { + "$ref": "#/definitions/IpAllocation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get IpAllocation": { + "$ref": "./examples/IpAllocationGet.json" + } + } + }, + "put": { + "tags": [ + "IpAllocations" + ], + "operationId": "IpAllocations_CreateOrUpdate", + "description": "Creates or updates an IpAllocation in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ipAllocationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IpAllocation." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IpAllocation" + }, + "description": "Parameters supplied to the create or update virtual network operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting IpAllocation resource.", + "schema": { + "$ref": "#/definitions/IpAllocation" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting IpAllocation resource.", + "schema": { + "$ref": "#/definitions/IpAllocation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create IpAllocation": { + "$ref": "./examples/IpAllocationCreate.json" + } + } + }, + "patch": { + "tags": [ + "IpAllocations" + ], + "operationId": "IpAllocations_UpdateTags", + "description": "Updates a IpAllocation tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ipAllocationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IpAllocation." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update IpAllocation tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting IpAllocation resource.", + "schema": { + "$ref": "#/definitions/IpAllocation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update virtual network tags": { + "$ref": "./examples/IpAllocationUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/IpAllocations": { + "get": { + "tags": [ + "IpAllocations" + ], + "operationId": "IpAllocations_List", + "description": "Gets all IpAllocations in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of IpAllocation resources.", + "schema": { + "$ref": "#/definitions/IpAllocationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all IpAllocations": { + "$ref": "./examples/IpAllocationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/IpAllocations": { + "get": { + "tags": [ + "IpAllocations" + ], + "operationId": "IpAllocations_ListByResourceGroup", + "description": "Gets all IpAllocations in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of IpAllocation resources.", + "schema": { + "$ref": "#/definitions/IpAllocationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List IpAllocations in resource group": { + "$ref": "./examples/IpAllocationListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "IpAllocationPropertiesFormat": { + "properties": { + "subnet": { + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", + "description": "The Subnet that using the prefix of this IpAllocation resource." + }, + "virtualNetwork": { + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualNetwork that using the prefix of this IpAllocation resource." + }, + "type": { + "$ref": "#/definitions/IpAllocationType", + "description": "The type for the IpAllocation." + }, + "prefix": { + "type": "string", + "description": "The address prefix for the IpAllocation." + }, + "prefixLength": { + "type": "integer", + "x-nullable": true, + "default": 0, + "description": "The address prefix length for the IpAllocation." + }, + "prefixType": { + "$ref": "./network.json#/definitions/IPVersion", + "default": null, + "description": "The address prefix Type for the IpAllocation." + }, + "ipamAllocationId": { + "type": "string", + "description": "The IPAM allocation ID." + }, + "allocationTags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "IpAllocation tags." + } + }, + "description": "Properties of the IpAllocation." + }, + "IpAllocation": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IpAllocationPropertiesFormat", + "description": "Properties of the IpAllocation." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "IpAllocation resource." + }, + "IpAllocationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IpAllocation" + }, + "description": "A list of IpAllocation resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListIpAllocations API service call." + }, + "IpAllocationType": { + "type": "string", + "description": "IpAllocation type.", + "enum": [ + "Undefined", + "Hypernet" + ], + "x-ms-enum": { + "name": "IpAllocationType", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ipGroups.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ipGroups.json new file mode 100644 index 000000000000..c2768451d884 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/ipGroups.json @@ -0,0 +1,422 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups/{ipGroupsName}": { + "get": { + "tags": [ + "IpGroups" + ], + "operationId": "IpGroups_Get", + "description": "Gets the specified ipGroups.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ipGroupsName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipGroups." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands resourceIds (of Firewalls/Network Security Groups etc.) back referenced by the IpGroups resource." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting IpGroups resource.", + "schema": { + "$ref": "#/definitions/IpGroup" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get_IpGroups": { + "$ref": "./examples/IpGroupsGet.json" + } + } + }, + "put": { + "tags": [ + "IpGroups" + ], + "operationId": "IpGroups_CreateOrUpdate", + "description": "Creates or updates an ipGroups in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ipGroupsName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipGroups." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/IpGroup" + }, + "description": "Parameters supplied to the create or update IpGroups operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ipGroups resource.", + "schema": { + "$ref": "#/definitions/IpGroup" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ipGroups resource.", + "schema": { + "$ref": "#/definitions/IpGroup" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "CreateOrUpdate_IpGroups": { + "$ref": "./examples/IpGroupsCreate.json" + } + } + }, + "patch": { + "tags": [ + "IpGroups" + ], + "operationId": "IpGroups_UpdateGroups", + "description": "Updates tags of an IpGroups resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ipGroupsName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipGroups." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to the update ipGroups operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ipGroups resource.", + "schema": { + "$ref": "#/definitions/IpGroup" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Update_IpGroups": { + "$ref": "./examples/IpGroupsUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "IpGroups" + ], + "operationId": "IpGroups_Delete", + "description": "Deletes the specified ipGroups.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "ipGroupsName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipGroups." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete_IpGroups": { + "$ref": "./examples/IpGroupsDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ipGroups": { + "get": { + "tags": [ + "IpGroups" + ], + "operationId": "IpGroups_ListByResourceGroup", + "description": "Gets all IpGroups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ipGroups resources.", + "schema": { + "$ref": "#/definitions/IpGroupListResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ListByResourceGroup_IpGroups": { + "$ref": "./examples/IpGroupsListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ipGroups": { + "get": { + "tags": [ + "IpGroups" + ], + "operationId": "IpGroups_List", + "description": "Gets all IpGroups in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ipGroups resources.", + "schema": { + "$ref": "#/definitions/IpGroupListResult" + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List_IpGroups": { + "$ref": "./examples/IpGroupsListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "IpGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IpGroupPropertiesFormat", + "description": "Properties of the IpGroups." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "The IpGroups resource information." + }, + "IpGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IpGroup" + }, + "description": "The list of IpGroups information resources." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for the ListIpGroups API service call." + }, + "IpGroupPropertiesFormat": { + "properties": { + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the IpGroups resource.", + "readOnly": true + }, + "ipAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "IpAddresses/IpAddressPrefixes in the IpGroups resource." + }, + "firewalls": { + "type": "array", + "readOnly": true, + "description": "List of references to Azure resources that this IpGroups is associated with.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + } + }, + "description": "The IpGroups property information." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json new file mode 100644 index 000000000000..20ae268b140c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json @@ -0,0 +1,2242 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}": { + "delete": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Delete", + "description": "Deletes the specified load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete load balancer": { + "$ref": "./examples/LoadBalancerDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_Get", + "description": "Gets the specified load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get load balancer": { + "$ref": "./examples/LoadBalancerGet.json" + } + } + }, + "put": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_CreateOrUpdate", + "description": "Creates or updates a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "Parameters supplied to the create or update load balancer operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create load balancer": { + "$ref": "./examples/LoadBalancerCreate.json" + }, + "Create load balancer with Standard SKU": { + "$ref": "./examples/LoadBalancerCreateStandardSku.json" + }, + "Create load balancer with Frontend IP in Zone 1": { + "$ref": "./examples/LoadBalancerCreateWithZones.json" + }, + "Create load balancer with inbound nat pool": { + "$ref": "./examples/LoadBalancerCreateWithInboundNatPool.json" + }, + "Create load balancer with outbound rules": { + "$ref": "./examples/LoadBalancerCreateWithOutboundRules.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_UpdateTags", + "description": "Updates a load balancer tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update load balancer tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting LoadBalancer resource.", + "schema": { + "$ref": "#/definitions/LoadBalancer" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update load balancer tags": { + "$ref": "./examples/LoadBalancerUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/loadBalancers": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_ListAll", + "description": "Gets all the load balancers in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all load balancers": { + "$ref": "./examples/LoadBalancerListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancers_List", + "description": "Gets all the load balancers in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List load balancers in resource group": { + "$ref": "./examples/LoadBalancerList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerBackendAddressPools_List", + "description": "Gets all the load balancer backed address pools.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer BackendAddressPool resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerBackendAddressPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LoadBalancerBackendAddressPoolList": { + "$ref": "./examples/LoadBalancerBackendAddressPoolList.json" + }, + "Load balancer with BackendAddressPool containing BackendAddresses": { + "$ref": "./examples/LBBackendAddressPoolListWithBackendAddressesPoolType.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/backendAddressPools/{backendAddressPoolName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerBackendAddressPools_Get", + "description": "Gets load balancer backend address pool.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "backendAddressPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backend address pool." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns LoadBalancer BackendAddressPool resource.", + "schema": { + "$ref": "#/definitions/BackendAddressPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LoadBalancerBackendAddressPoolGet": { + "$ref": "./examples/LoadBalancerBackendAddressPoolGet.json" + }, + "LoadBalancer with BackendAddressPool with BackendAddresses": { + "$ref": "./examples/LBBackendAddressPoolWithBackendAddressesGet.json" + } + } + }, + "put": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerBackendAddressPools_CreateOrUpdate", + "description": "Creates or updates a load balancer backend address pool.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "backendAddressPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backend address pool." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BackendAddressPool" + }, + "description": "Parameters supplied to the create or update load balancer backend address pool operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting BackendAddressPool resource.", + "schema": { + "$ref": "#/definitions/BackendAddressPool" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting BackendAddressPool resource.", + "schema": { + "$ref": "#/definitions/BackendAddressPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update load balancer backend pool with backend addresses containing virtual network and IP address.": { + "$ref": "./examples/LBBackendAddressPoolWithBackendAddressesPut.json" + }, + "Update load balancer backend pool with backend addresses containing virtual network and IP address defined in network interfaces.": { + "$ref": "./examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerBackendAddressPools_Delete", + "description": "Deletes the specified load balancer backend address pool.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "backendAddressPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the backend address pool." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BackendAddressPoolDelete": { + "$ref": "./examples/LoadBalancerBackendAddressPoolDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerFrontendIPConfigurations_List", + "description": "Gets all the load balancer frontend IP configurations.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer FrontendIPConfiguration resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerFrontendIPConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LoadBalancerFrontendIPConfigurationList": { + "$ref": "./examples/LoadBalancerFrontendIPConfigurationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/frontendIPConfigurations/{frontendIPConfigurationName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerFrontendIPConfigurations_Get", + "description": "Gets load balancer frontend IP configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "frontendIPConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the frontend IP configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns LoadBalancer FrontendIPConfiguration resource.", + "schema": { + "$ref": "#/definitions/FrontendIPConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LoadBalancerFrontendIPConfigurationGet": { + "$ref": "./examples/LoadBalancerFrontendIPConfigurationGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_List", + "description": "Gets all the inbound nat rules in a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer InboundNatRule resources.", + "schema": { + "$ref": "#/definitions/InboundNatRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "InboundNatRuleList": { + "$ref": "./examples/InboundNatRuleList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/inboundNatRules/{inboundNatRuleName}": { + "delete": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_Delete", + "description": "Deletes the specified load balancer inbound nat rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "inboundNatRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "InboundNatRuleDelete": { + "$ref": "./examples/InboundNatRuleDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_Get", + "description": "Gets the specified load balancer inbound nat rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "inboundNatRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound nat rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting InboundNatRule resource.", + "schema": { + "$ref": "#/definitions/InboundNatRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "InboundNatRuleGet": { + "$ref": "./examples/InboundNatRuleGet.json" + } + } + }, + "put": { + "tags": [ + "LoadBalancers" + ], + "operationId": "InboundNatRules_CreateOrUpdate", + "description": "Creates or updates a load balancer inbound nat rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "inboundNatRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the inbound nat rule." + }, + { + "name": "inboundNatRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InboundNatRule" + }, + "description": "Parameters supplied to the create or update inbound nat rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting InboundNatRule resource.", + "schema": { + "$ref": "#/definitions/InboundNatRule" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting InboundNatRule resource.", + "schema": { + "$ref": "#/definitions/InboundNatRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "InboundNatRuleCreate": { + "$ref": "./examples/InboundNatRuleCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerLoadBalancingRules_List", + "description": "Gets all the load balancing rules in a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer LoadBalancingRule resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerLoadBalancingRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LoadBalancerLoadBalancingRuleList": { + "$ref": "./examples/LoadBalancerLoadBalancingRuleList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/loadBalancingRules/{loadBalancingRuleName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerLoadBalancingRules_Get", + "description": "Gets the specified load balancer load balancing rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "loadBalancingRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancing rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LoadBalancingRule resource.", + "schema": { + "$ref": "#/definitions/LoadBalancingRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LoadBalancerLoadBalancingRuleGet": { + "$ref": "./examples/LoadBalancerLoadBalancingRuleGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerOutboundRules_List", + "description": "Gets all the outbound rules in a load balancer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer OutboundRule resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerOutboundRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "LoadBalancerOutboundRuleList": { + "$ref": "./examples/LoadBalancerOutboundRuleList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/outboundRules/{outboundRuleName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerOutboundRules_Get", + "description": "Gets the specified load balancer outbound rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "outboundRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the outbound rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting OutboundRule resource.", + "schema": { + "$ref": "#/definitions/OutboundRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LoadBalancerOutboundRuleGet": { + "$ref": "./examples/LoadBalancerOutboundRuleGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/networkInterfaces": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerNetworkInterfaces_List", + "description": "Gets associated load balancer network interfaces.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LoadBalancerNetworkInterfaceListVmss": { + "$ref": "./examples/LoadBalancerNetworkInterfaceListVmss.json" + }, + "LoadBalancerNetworkInterfaceListSimple": { + "$ref": "./examples/LoadBalancerNetworkInterfaceListSimple.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerProbes_List", + "description": "Gets all the load balancer probes.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LoadBalancer Probe resources.", + "schema": { + "$ref": "#/definitions/LoadBalancerProbeListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LoadBalancerProbeList": { + "$ref": "./examples/LoadBalancerProbeList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}": { + "get": { + "tags": [ + "LoadBalancers" + ], + "operationId": "LoadBalancerProbes_Get", + "description": "Gets load balancer probe.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "loadBalancerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the load balancer." + }, + { + "name": "probeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the probe." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns LoadBalancer Probe resource.", + "schema": { + "$ref": "#/definitions/Probe" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "LoadBalancerProbeGet": { + "$ref": "./examples/LoadBalancerProbeGet.json" + } + } + } + } + }, + "definitions": { + "LoadBalancerSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a load balancer SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "LoadBalancerSkuName", + "modelAsString": true + } + } + }, + "description": "SKU of a load balancer." + }, + "FrontendIPConfigurationPropertiesFormat": { + "properties": { + "inboundNatRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "An array of references to inbound rules that use this frontend IP." + }, + "inboundNatPools": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "An array of references to inbound pools that use this frontend IP." + }, + "outboundRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "An array of references to outbound rules that use this frontend IP." + }, + "loadBalancingRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "An array of references to load balancing rules that use this frontend IP." + }, + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The Private IP allocation method." + }, + "privateIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "Whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference to the Public IP resource." + }, + "publicIPPrefix": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the Public IP Prefix resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the frontend IP configuration resource." + } + }, + "description": "Properties of Frontend IP Configuration of the load balancer." + }, + "FrontendIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FrontendIPConfigurationPropertiesFormat", + "description": "Properties of the load balancer probe." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the set of frontend IP configurations used by the load balancer. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Frontend IP address of the load balancer." + }, + "LoadBalancerBackendAddressPropertiesFormat": { + "properties": { + "virtualNetwork": { + "$ref": "./virtualNetwork.json#/definitions/VirtualNetwork", + "description": "Reference to an existing virtual network." + }, + "ipAddress": { + "type": "string", + "description": "IP Address belonging to the referenced virtual network.", + "x-ms-azure-resource": false + }, + "networkInterfaceIPConfiguration": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "Reference to IP address defined in network interfaces." + } + }, + "description": "Properties of the load balancer backend addresses." + }, + "LoadBalancerBackendAddress": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoadBalancerBackendAddressPropertiesFormat", + "description": "Properties of load balancer backend address pool." + }, + "name": { + "type": "string", + "description": "Name of the backend address." + } + }, + "description": "Load balancer backend addresses." + }, + "BackendAddressPoolPropertiesFormat": { + "properties": { + "backendIPConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "An array of references to IP addresses defined in network interfaces." + }, + "loadBalancerBackendAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancerBackendAddress" + }, + "description": "An array of backend addresses." + }, + "loadBalancingRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "An array of references to load balancing rules that use this backend address pool." + }, + "outboundRule": { + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to an outbound rule that uses this backend address pool." + }, + "outboundRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "An array of references to outbound rules that use this backend address pool." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the backend address pool resource." + } + }, + "description": "Properties of the backend address pool." + }, + "BackendAddressPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BackendAddressPoolPropertiesFormat", + "description": "Properties of load balancer backend address pool." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the set of backend address pools used by the load balancer. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Pool of backend IP addresses." + }, + "LoadBalancingRulePropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to frontend IP addresses." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to a pool of DIPs. Inbound traffic is randomly load balanced across IPs in the backend IPs." + }, + "probe": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the load balancer probe used by the load balancing rule." + }, + "protocol": { + "$ref": "#/definitions/TransportProtocol", + "description": "The reference to the transport protocol used by the load balancing rule." + }, + "loadDistribution": { + "type": "string", + "description": "The load distribution policy for this rule.", + "enum": [ + "Default", + "SourceIP", + "SourceIPProtocol" + ], + "x-ms-enum": { + "name": "LoadDistribution", + "modelAsString": true + } + }, + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values are between 0 and 65534. Note that value 0 enables \"Any Port\"." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for internal connections on the endpoint. Acceptable values are between 0 and 65535. Note that value 0 enables \"Any Port\"." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." + }, + "enableFloatingIP": { + "type": "boolean", + "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." + }, + "enableTcpReset": { + "type": "boolean", + "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." + }, + "disableOutboundSnat": { + "type": "boolean", + "description": "Configures SNAT for the VMs in the backend pool to use the publicIP address specified in the frontend of the load balancing rule." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the load balancing rule resource." + } + }, + "required": [ + "protocol", + "frontendPort" + ], + "description": "Properties of the load balancer." + }, + "LoadBalancingRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoadBalancingRulePropertiesFormat", + "description": "Properties of load balancer load balancing rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the set of load balancing rules used by the load balancer. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A load balancing rule for a load balancer." + }, + "ProbePropertiesFormat": { + "properties": { + "loadBalancingRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The load balancer rules that use this probe." + }, + "protocol": { + "type": "string", + "description": "The protocol of the end point. If 'Tcp' is specified, a received ACK is required for the probe to be successful. If 'Http' or 'Https' is specified, a 200 OK response from the specifies URI is required for the probe to be successful.", + "enum": [ + "Http", + "Tcp", + "Https" + ], + "x-ms-enum": { + "name": "ProbeProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port for communicating the probe. Possible values range from 1 to 65535, inclusive." + }, + "intervalInSeconds": { + "type": "integer", + "format": "int32", + "description": "The interval, in seconds, for how frequently to probe the endpoint for health status. Typically, the interval is slightly less than half the allocated timeout period (in seconds) which allows two full probes before taking the instance out of rotation. The default value is 15, the minimum value is 5." + }, + "numberOfProbes": { + "type": "integer", + "format": "int32", + "description": "The number of probes where if no response, will result in stopping further traffic from being delivered to the endpoint. This values allows endpoints to be taken out of rotation faster or slower than the typical times used in Azure." + }, + "requestPath": { + "type": "string", + "description": "The URI used for requesting health status from the VM. Path is required if a protocol is set to http. Otherwise, it is not allowed. There is no default value." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the probe resource." + } + }, + "required": [ + "protocol", + "port" + ], + "description": "Load balancer probe resource." + }, + "Probe": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProbePropertiesFormat", + "description": "Properties of load balancer probe." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the set of probes used by the load balancer. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "A load balancer probe." + }, + "InboundNatRulePropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to frontend IP addresses." + }, + "backendIPConfiguration": { + "readOnly": true, + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "A reference to a private IP address defined on a network interface of a VM. Traffic sent to the frontend port of each of the frontend IP configurations is forwarded to the backend IP." + }, + "protocol": { + "$ref": "#/definitions/TransportProtocol", + "description": "The reference to the transport protocol used by the load balancing rule." + }, + "frontendPort": { + "type": "integer", + "format": "int32", + "description": "The port for the external endpoint. Port numbers for each rule must be unique within the Load Balancer. Acceptable values range from 1 to 65534." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for the internal endpoint. Acceptable values range from 1 to 65535." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." + }, + "enableFloatingIP": { + "type": "boolean", + "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." + }, + "enableTcpReset": { + "type": "boolean", + "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the inbound NAT rule resource." + } + }, + "description": "Properties of the inbound NAT rule." + }, + "InboundNatRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InboundNatRulePropertiesFormat", + "description": "Properties of load balancer inbound nat rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the set of inbound NAT rules used by the load balancer. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Inbound NAT rule of the load balancer." + }, + "InboundNatPoolPropertiesFormat": { + "properties": { + "frontendIPConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to frontend IP addresses." + }, + "protocol": { + "$ref": "#/definitions/TransportProtocol", + "description": "The reference to the transport protocol used by the inbound NAT pool." + }, + "frontendPortRangeStart": { + "type": "integer", + "format": "int32", + "description": "The first port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65534." + }, + "frontendPortRangeEnd": { + "type": "integer", + "format": "int32", + "description": "The last port number in the range of external ports that will be used to provide Inbound Nat to NICs associated with a load balancer. Acceptable values range between 1 and 65535." + }, + "backendPort": { + "type": "integer", + "format": "int32", + "description": "The port used for internal connections on the endpoint. Acceptable values are between 1 and 65535." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The timeout for the TCP idle connection. The value can be set between 4 and 30 minutes. The default value is 4 minutes. This element is only used when the protocol is set to TCP." + }, + "enableFloatingIP": { + "type": "boolean", + "description": "Configures a virtual machine's endpoint for the floating IP capability required to configure a SQL AlwaysOn Availability Group. This setting is required when using the SQL AlwaysOn Availability Groups in SQL server. This setting can't be changed after you create the endpoint." + }, + "enableTcpReset": { + "type": "boolean", + "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the inbound NAT pool resource." + } + }, + "required": [ + "protocol", + "frontendPortRangeStart", + "frontendPortRangeEnd", + "backendPort" + ], + "description": "Properties of Inbound NAT pool." + }, + "InboundNatPool": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/InboundNatPoolPropertiesFormat", + "description": "Properties of load balancer inbound nat pool." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the set of inbound NAT pools used by the load balancer. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Inbound NAT pool of the load balancer." + }, + "OutboundRulePropertiesFormat": { + "properties": { + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "description": "The number of outbound ports to be used for NAT." + }, + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "The Frontend IP addresses of the load balancer." + }, + "backendAddressPool": { + "$ref": "./network.json#/definitions/SubResource", + "description": "A reference to a pool of DIPs. Outbound traffic is randomly load balanced across IPs in the backend IPs." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the outbound rule resource." + }, + "protocol": { + "type": "string", + "description": "The protocol for the outbound rule in load balancer.", + "enum": [ + "Tcp", + "Udp", + "All" + ], + "x-ms-enum": { + "name": "LoadBalancerOutboundRuleProtocol", + "modelAsString": true + } + }, + "enableTcpReset": { + "type": "boolean", + "description": "Receive bidirectional TCP Reset on TCP flow idle timeout or unexpected connection termination. This element is only used when the protocol is set to TCP." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "description": "The timeout for the TCP idle connection." + } + }, + "required": [ + "backendAddressPool", + "frontendIPConfigurations", + "protocol" + ], + "description": "Outbound rule of the load balancer." + }, + "OutboundRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OutboundRulePropertiesFormat", + "description": "Properties of load balancer outbound rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within the set of outbound rules used by the load balancer. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Outbound rule of the load balancer." + }, + "LoadBalancerPropertiesFormat": { + "properties": { + "frontendIPConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendIPConfiguration" + }, + "description": "Object representing the frontend IPs to be used for the load balancer." + }, + "backendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/BackendAddressPool" + }, + "description": "Collection of backend address pools used by a load balancer." + }, + "loadBalancingRules": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancingRule" + }, + "description": "Object collection representing the load balancing rules Gets the provisioning." + }, + "probes": { + "type": "array", + "items": { + "$ref": "#/definitions/Probe" + }, + "description": "Collection of probe objects used in the load balancer." + }, + "inboundNatRules": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatRule" + }, + "description": "Collection of inbound NAT Rules used by a load balancer. Defining inbound NAT rules on your load balancer is mutually exclusive with defining an inbound NAT pool. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an Inbound NAT pool. They have to reference individual inbound NAT rules." + }, + "inboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatPool" + }, + "description": "Defines an external port range for inbound NAT to a single backend port on NICs associated with a load balancer. Inbound NAT rules are created automatically for each NIC associated with the Load Balancer using an external port from this range. Defining an Inbound NAT pool on your Load Balancer is mutually exclusive with defining inbound Nat rules. Inbound NAT pools are referenced from virtual machine scale sets. NICs that are associated with individual virtual machines cannot reference an inbound NAT pool. They have to reference individual inbound NAT rules." + }, + "outboundRules": { + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRule" + }, + "description": "The outbound rules." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the load balancer resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the load balancer resource." + } + }, + "description": "Properties of the load balancer." + }, + "LoadBalancer": { + "properties": { + "sku": { + "$ref": "#/definitions/LoadBalancerSku", + "description": "The load balancer SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LoadBalancerPropertiesFormat", + "description": "Properties of load balancer." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "LoadBalancer resource." + }, + "LoadBalancerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancer" + }, + "description": "A list of load balancers in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLoadBalancers API service call." + }, + "InboundNatRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InboundNatRule" + }, + "description": "A list of inbound nat rules in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListInboundNatRule API service call." + }, + "LoadBalancerBackendAddressPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BackendAddressPool" + }, + "description": "A list of backend address pools in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListBackendAddressPool API service call." + }, + "LoadBalancerFrontendIPConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FrontendIPConfiguration" + }, + "description": "A list of frontend IP configurations in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListFrontendIPConfiguration API service call." + }, + "LoadBalancerLoadBalancingRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LoadBalancingRule" + }, + "description": "A list of load balancing rules in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLoadBalancingRule API service call." + }, + "LoadBalancerOutboundRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/OutboundRule" + }, + "description": "A list of outbound rules in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListOutboundRule API service call." + }, + "LoadBalancerProbeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Probe" + }, + "description": "A list of probes in a load balancer." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListProbe API service call." + }, + "TransportProtocol": { + "type": "string", + "description": "The transport protocol for the endpoint.", + "enum": [ + "Udp", + "Tcp", + "All" + ], + "x-ms-enum": { + "name": "TransportProtocol", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/natGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/natGateway.json new file mode 100644 index 000000000000..cc76e7483881 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/natGateway.json @@ -0,0 +1,472 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways/{natGatewayName}": { + "delete": { + "tags": [ + "NatGateways" + ], + "operationId": "NatGateways_Delete", + "description": "Deletes the specified nat gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "natGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete nat gateway": { + "$ref": "./examples/NatGatewayDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NatGateways" + ], + "operationId": "NatGateways_Get", + "description": "Gets the specified nat gateway in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "natGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NatGateway resource.", + "schema": { + "$ref": "#/definitions/NatGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get nat gateway": { + "$ref": "./examples/NatGatewayGet.json" + } + } + }, + "put": { + "tags": [ + "NatGateways" + ], + "operationId": "NatGateways_CreateOrUpdate", + "description": "Creates or updates a nat gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "natGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NatGateway" + }, + "description": "Parameters supplied to the create or update nat gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NatGateway resource.", + "schema": { + "$ref": "#/definitions/NatGateway" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NatGateway resource.", + "schema": { + "$ref": "#/definitions/NatGateway" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NatGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create nat gateway": { + "$ref": "./examples/NatGatewayCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "NatGateways" + ], + "operationId": "NatGateways_UpdateTags", + "description": "Updates nat gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "natGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the nat gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update nat gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NatGateway resource.", + "schema": { + "$ref": "#/definitions/NatGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update nat gateway tags": { + "$ref": "./examples/NatGatewayUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/natGateways": { + "get": { + "tags": [ + "NatGateways" + ], + "operationId": "NatGateways_ListAll", + "description": "Gets all the Nat Gateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NatGateway resources.", + "schema": { + "$ref": "#/definitions/NatGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all nat gateways": { + "$ref": "./examples/NatGatewayListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/natGateways": { + "get": { + "tags": [ + "NatGateways" + ], + "operationId": "NatGateways_List", + "description": "Gets all nat gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NatGateway resources.", + "schema": { + "$ref": "#/definitions/NatGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List nat gateways in resource group": { + "$ref": "./examples/NatGatewayList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NatGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Name of Nat Gateway SKU.", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "NatGatewaySkuName", + "modelAsString": true + } + } + }, + "description": "SKU of nat gateway." + }, + "NatGatewayPropertiesFormat": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the nat gateway." + }, + "publicIpAddresses": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "An array of public ip addresses associated with the nat gateway resource." + }, + "publicIpPrefixes": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "An array of public ip prefixes associated with the nat gateway resource." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "An array of references to the subnets using this nat gateway resource." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the NAT gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the NAT gateway resource." + } + }, + "description": "Nat Gateway properties." + }, + "NatGateway": { + "properties": { + "sku": { + "$ref": "#/definitions/NatGatewaySku", + "description": "The nat gateway SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NatGatewayPropertiesFormat", + "description": "Nat Gateway properties." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the zone in which Nat Gateway should be deployed." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Nat Gateway resource." + }, + "NatGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NatGateway" + }, + "description": "A list of Nat Gateways that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListNatGateways API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/network.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/network.json new file mode 100644 index 000000000000..94c376106518 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/network.json @@ -0,0 +1,335 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ErrorDetails": { + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "description": "Common error details representation." + }, + "Error": { + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + }, + "target": { + "type": "string", + "description": "Error target." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ErrorDetails" + }, + "description": "Error details." + }, + "innerError": { + "type": "string", + "description": "Inner error message." + } + }, + "description": "Common error representation." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Cloud error body." + } + }, + "description": "An error response from the service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the service." + }, + "AzureAsyncOperationResult": { + "properties": { + "status": { + "type": "string", + "description": "Status of the Azure async operation.", + "enum": [ + "InProgress", + "Succeeded", + "Failed" + ], + "x-ms-enum": { + "name": "NetworkOperationStatus", + "modelAsString": true + } + }, + "error": { + "$ref": "#/definitions/Error", + "description": "Details of the error occurred during specified asynchronous operation." + } + }, + "description": "The response body contains the status of the specified asynchronous operation, indicating whether it has succeeded, is in progress, or has failed. Note that this status is distinct from the HTTP status code returned for the Get Operation Status operation itself. If the asynchronous operation succeeded, the response body includes the HTTP status code for the successful request. If the asynchronous operation failed, the response body includes the HTTP status code for the failed request and error information regarding the failure." + }, + "Resource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Common resource representation.", + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource ID." + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ManagedServiceIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the resource." + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Updating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "Access": { + "type": "string", + "description": "Access to be allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "Access", + "modelAsString": true + } + }, + "AuthenticationMethod": { + "type": "string", + "description": "VPN client authentication method.", + "enum": [ + "EAPTLS", + "EAPMSCHAPv2" + ], + "x-ms-enum": { + "name": "AuthenticationMethod", + "modelAsString": true + } + }, + "IPAllocationMethod": { + "type": "string", + "description": "IP address allocation method.", + "enum": [ + "Static", + "Dynamic" + ], + "x-ms-enum": { + "name": "IPAllocationMethod", + "modelAsString": true + } + }, + "IPVersion": { + "type": "string", + "description": "IP address version.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The subscription credentials which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + }, + "ApiVersionVmssParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "enum": [ + "2017-03-30" + ], + "x-ms-enum": { + "name": "ApiVersion", + "modelAsString": true + }, + "description": "Client API version." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkInterface.json new file mode 100644 index 000000000000..f7bb7836ec97 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkInterface.json @@ -0,0 +1,1522 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}": { + "delete": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_Delete", + "description": "Deletes the specified network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete network interface": { + "$ref": "./examples/NetworkInterfaceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_Get", + "description": "Gets information about the specified network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get network interface": { + "$ref": "./examples/NetworkInterfaceGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_CreateOrUpdate", + "description": "Creates or updates a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterface" + }, + "description": "Parameters supplied to the create or update network interface operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create network interface": { + "$ref": "./examples/NetworkInterfaceCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_UpdateTags", + "description": "Updates a network interface tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network interface tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "#/definitions/NetworkInterface" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update network interface tags": { + "$ref": "./examples/NetworkInterfaceUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListAll", + "description": "Gets all network interfaces in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all network interfaces": { + "$ref": "./examples/NetworkInterfaceListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_List", + "description": "Gets all network interfaces in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List network interfaces in resource group": { + "$ref": "./examples/NetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveRouteTable": { + "post": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetEffectiveRouteTable", + "description": "Gets all route tables applied to a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of EffectRoute resources.", + "schema": { + "$ref": "#/definitions/EffectiveRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Show network interface effective route tables": { + "$ref": "./examples/NetworkInterfaceEffectiveRouteTableList.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/effectiveNetworkSecurityGroups": { + "post": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListEffectiveNetworkSecurityGroups", + "description": "Gets all network security groups applied to a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroupListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List network interface effective network security groups": { + "$ref": "./examples/NetworkInterfaceEffectiveNSGList.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceIPConfigurations_List", + "description": "Get all ip configurations in a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface IPConfiguration resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceIPConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkInterfaceIPConfigurationList": { + "$ref": "./examples/NetworkInterfaceIPConfigurationList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceIPConfigurations_Get", + "description": "Gets the specified network interface ip configuration.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ip configuration name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface IPConfiguration resource.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkInterfaceIPConfigurationGet": { + "$ref": "./examples/NetworkInterfaceIPConfigurationGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/loadBalancers": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceLoadBalancers_List", + "description": "List all load balancers in a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface LoadBalancer resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceLoadBalancerListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkInterfaceLoadBalancerList": { + "$ref": "./examples/NetworkInterfaceLoadBalancerList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations/{tapConfigurationName}": { + "delete": { + "tags": [ + "Network Interfaces" + ], + "operationId": "NetworkInterfaceTapConfigurations_Delete", + "description": "Deletes the specified tap configuration from the NetworkInterface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "tapConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tap configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete tap configuration": { + "$ref": "./examples/NetworkInterfaceTapConfigurationDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceTapConfigurations_Get", + "description": "Get the specified tap configuration on a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "tapConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tap configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a tap configuration.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Network Interface Tap Configurations": { + "$ref": "./examples/NetworkInterfaceTapConfigurationGet.json" + } + } + }, + "put": { + "tags": [ + "Network Interfaces" + ], + "operationId": "NetworkInterfaceTapConfigurations_CreateOrUpdate", + "description": "Creates or updates a Tap configuration in the specified NetworkInterface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "tapConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tap configuration." + }, + { + "name": "tapConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + }, + "description": "Parameters supplied to the create or update tap configuration operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Tap Configuration resource.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Tap configuration resource.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Network Interface Tap Configurations": { + "$ref": "./examples/NetworkInterfaceTapConfigurationCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}/tapConfigurations": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaceTapConfigurations_List", + "description": "Get all Tap configurations in a network interface.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface TapConfiguration resources.", + "schema": { + "$ref": "#/definitions/NetworkInterfaceTapConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual network tap configurations": { + "$ref": "./examples/NetworkInterfaceTapConfigurationList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NetworkInterfaceTapConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceTapConfigurationPropertiesFormat", + "description": "Properties of the Virtual Network Tap configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Tap configuration in a Network Interface." + }, + "NetworkInterfaceTapConfigurationPropertiesFormat": { + "properties": { + "virtualNetworkTap": { + "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap", + "description": "The reference to the Virtual Network Tap resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network interface tap configuration resource." + } + }, + "description": "Properties of Virtual Network Tap configuration." + }, + "NetworkInterfaceIPConfigurationPropertiesFormat": { + "properties": { + "virtualNetworkTaps": { + "type": "array", + "items": { + "$ref": "./virtualNetworkTap.json#/definitions/VirtualNetworkTap" + }, + "description": "The reference to Virtual Network Taps." + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "./applicationGateway.json#/definitions/ApplicationGatewayBackendAddressPool" + }, + "description": "The reference to ApplicationGatewayBackendAddressPool resource." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/BackendAddressPool" + }, + "description": "The reference to LoadBalancerBackendAddressPool resource." + }, + "loadBalancerInboundNatRules": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/InboundNatRule" + }, + "description": "A list of references of LoadBalancerInboundNatRules." + }, + "privateIPAddress": { + "type": "string", + "description": "Private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "privateIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "Subnet bound to the IP configuration." + }, + "primary": { + "type": "boolean", + "description": "Whether this is a primary customer address on the network interface." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "Public IP address bound to the IP configuration." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "Application security groups in which the IP configuration is included." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network interface IP configuration." + }, + "privateLinkConnectionProperties": { + "$ref": "#/definitions/NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties", + "description": "PrivateLinkConnection properties for the network interface.", + "readOnly": true + } + }, + "description": "Properties of IP configuration." + }, + "NetworkInterfaceIPConfigurationPrivateLinkConnectionProperties": { + "properties": { + "groupId": { + "type": "string", + "readOnly": true, + "description": "The group ID for current private link connection." + }, + "requiredMemberName": { + "type": "string", + "readOnly": true, + "description": "The required member name for current private link connection." + }, + "fqdns": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "List of FQDNs for current private link connection." + } + }, + "description": "PrivateLinkConnection properties for the network interface." + }, + "NetworkInterfaceIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceIPConfigurationPropertiesFormat", + "description": "Network interface IP configuration properties." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IPConfiguration in a network interface." + }, + "NetworkInterfaceDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses. Use 'AzureProvidedDNS' to switch to azure provided DNS resolution. 'AzureProvidedDNS' value cannot be combined with other IPs, it must be the only value in dnsServers collection." + }, + "appliedDnsServers": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "If the VM that uses this NIC is part of an Availability Set, then this list will have the union of all DNS servers from all NICs that are part of the Availability Set. This property is what is configured on each of those VMs." + }, + "internalDnsNameLabel": { + "type": "string", + "description": "Relative DNS name for this NIC used for internal communications between VMs in the same virtual network." + }, + "internalFqdn": { + "readOnly": true, + "type": "string", + "description": "Fully qualified DNS name supporting internal communications between VMs in the same virtual network." + }, + "internalDomainNameSuffix": { + "readOnly": true, + "type": "string", + "description": "Even if internalDnsNameLabel is not specified, a DNS entry is created for the primary NIC of the VM. This DNS name can be constructed by concatenating the VM name with the value of internalDomainNameSuffix." + } + }, + "description": "DNS settings of a network interface." + }, + "NetworkInterfacePropertiesFormat": { + "properties": { + "virtualMachine": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to a virtual machine.", + "readOnly": true + }, + "networkSecurityGroup": { + "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", + "description": "The reference to the NetworkSecurityGroup resource." + }, + "privateEndpoint": { + "readOnly": true, + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", + "description": "A reference to the private endpoint to which the network interface is linked." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of IPConfigurations of the network interface." + }, + "tapConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + }, + "description": "A list of TapConfigurations of the network interface." + }, + "dnsSettings": { + "$ref": "#/definitions/NetworkInterfaceDnsSettings", + "description": "The DNS settings in network interface." + }, + "macAddress": { + "readOnly": true, + "type": "string", + "description": "The MAC address of the network interface." + }, + "primary": { + "readOnly": true, + "type": "boolean", + "description": "Whether this is a primary network interface on a virtual machine." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "If the network interface is accelerated networking enabled." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Indicates whether IP forwarding is enabled on this network interface." + }, + "hostedWorkloads": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "A list of references to linked BareMetal resources." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the network interface resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network interface resource." + } + }, + "description": "NetworkInterface properties." + }, + "NetworkInterface": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfacePropertiesFormat", + "description": "Properties of the network interface." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A network interface in a resource group." + }, + "NetworkInterfaceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterface" + }, + "description": "A list of network interfaces in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListNetworkInterface API service call." + }, + "NetworkInterfaceTapConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceTapConfiguration" + }, + "description": "A list of tap configurations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list tap configurations API service call." + }, + "NetworkInterfaceIPConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceIPConfiguration" + }, + "description": "A list of ip configurations." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list ip configurations API service call." + }, + "NetworkInterfaceLoadBalancerListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/LoadBalancer" + }, + "description": "A list of load balancers." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list ip configurations API service call." + }, + "EffectiveNetworkSecurityGroup": { + "properties": { + "networkSecurityGroup": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of network security group that is applied." + }, + "association": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroupAssociation", + "description": "Associated resources." + }, + "effectiveSecurityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityRule" + }, + "description": "A collection of effective security rules." + }, + "tagMap": { + "type": "string", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of IP Addresses within the tag (key)." + }, + "description": "Mapping of tags to list of IP Addresses included within the tag." + } + }, + "description": "Effective network security group." + }, + "EffectiveNetworkSecurityGroupAssociation": { + "properties": { + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the subnet if assigned." + }, + "networkInterface": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The ID of the network interface if assigned." + } + }, + "description": "The effective network security group association." + }, + "EffectiveNetworkSecurityRule": { + "properties": { + "name": { + "type": "string", + "description": "The name of the security rule specified by the user (if created by the user)." + }, + "protocol": { + "type": "string", + "description": "The network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "All" + ], + "x-ms-enum": { + "name": "EffectiveSecurityRuleProtocol", + "modelAsString": true + } + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range." + }, + "destinationPortRange": { + "type": "string", + "description": "The destination port or range." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination port ranges. Expected values include a single integer between 0 and 65535, a range using '-' as separator (e.g. 100-400), or an asterisk (*)." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The source address prefix." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix." + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The source address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. Expected values include CIDR IP ranges, Default Tags (VirtualNetwork, AzureLoadBalancer, Internet), System Tags, and the asterisk (*)." + }, + "expandedSourceAddressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The expanded source address prefix." + }, + "expandedDestinationAddressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Expanded destination address prefix." + }, + "access": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleAccess", + "description": "Whether network traffic is allowed or denied." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule." + }, + "direction": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleDirection", + "description": "The direction of the rule." + } + }, + "description": "Effective network security rules." + }, + "EffectiveNetworkSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveNetworkSecurityGroup" + }, + "description": "A list of effective network security groups." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list effective network security groups API service call." + }, + "EffectiveRoute": { + "properties": { + "name": { + "type": "string", + "description": "The name of the user defined route. This is optional." + }, + "disableBgpRoutePropagation": { + "type": "boolean", + "description": "If true, on-premises routes are not propagated to the network interfaces in the subnet." + }, + "source": { + "type": "string", + "description": "Who created the route.", + "enum": [ + "Unknown", + "User", + "VirtualNetworkGateway", + "Default" + ], + "x-ms-enum": { + "name": "EffectiveRouteSource", + "modelAsString": true + } + }, + "state": { + "type": "string", + "description": "The value of effective route.", + "enum": [ + "Active", + "Invalid" + ], + "x-ms-enum": { + "name": "EffectiveRouteState", + "modelAsString": true + } + }, + "addressPrefix": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The address prefixes of the effective routes in CIDR notation." + }, + "nextHopIpAddress": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The IP address of the next hop of the effective route." + }, + "nextHopType": { + "$ref": "./routeTable.json#/definitions/RouteNextHopType", + "description": "The type of Azure hop the packet should be sent to." + } + }, + "description": "Effective Route." + }, + "EffectiveRouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EffectiveRoute" + }, + "description": "A list of effective routes." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for list effective route API service call." + }, + "IPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference to the public IP resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the IP configuration resource." + } + }, + "description": "Properties of IP configuration." + }, + "IPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IPConfigurationPropertiesFormat", + "description": "Properties of the IP configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkProfile.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkProfile.json new file mode 100644 index 000000000000..253b1ed8594f --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkProfile.json @@ -0,0 +1,622 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles/{networkProfileName}": { + "delete": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_Delete", + "description": "Deletes the specified network profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the NetworkProfile." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete network profile": { + "$ref": "./examples/NetworkProfileDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_Get", + "description": "Gets the specified network profile in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get network profile": { + "$ref": "./examples/NetworkProfileGetConfigOnly.json" + }, + "Get network profile with container network interfaces": { + "$ref": "./examples/NetworkProfileGetWithContainerNic.json" + } + } + }, + "put": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_CreateOrUpdate", + "description": "Creates or updates a network profile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkProfile" + }, + "description": "Parameters supplied to the create or update network profile operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create network profile defaults": { + "$ref": "./examples/NetworkProfileCreateConfigOnly.json" + } + }, + "x-ms-long-running-operation": false + }, + "patch": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_UpdateTags", + "description": "Updates network profile tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkProfileName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network profile." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network profile tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkProfile resource.", + "schema": { + "$ref": "#/definitions/NetworkProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update network profile tags": { + "$ref": "./examples/NetworkProfileUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkProfiles": { + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_ListAll", + "description": "Gets all the network profiles in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkProfile resources.", + "schema": { + "$ref": "#/definitions/NetworkProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all network profiles": { + "$ref": "./examples/NetworkProfileListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkProfiles": { + "get": { + "tags": [ + "NetworkProfiles" + ], + "operationId": "NetworkProfiles_List", + "description": "Gets all network profiles in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkProfile resources.", + "schema": { + "$ref": "#/definitions/NetworkProfileListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group network profiles": { + "$ref": "./examples/NetworkProfileList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "NetworkProfilePropertiesFormat": { + "properties": { + "containerNetworkInterfaces": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterface" + }, + "description": "List of child container network interfaces." + }, + "containerNetworkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterfaceConfiguration" + }, + "description": "List of chid container network interface configurations." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the network profile resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network profile resource." + } + }, + "description": "Network profile properties." + }, + "NetworkProfile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkProfilePropertiesFormat", + "description": "Network profile properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network profile resource." + }, + "NetworkProfileListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkProfile" + }, + "description": "A list of network profiles that exist in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListNetworkProfiles API service call." + }, + "ContainerNetworkInterfacePropertiesFormat": { + "properties": { + "containerNetworkInterfaceConfiguration": { + "readOnly": true, + "$ref": "#/definitions/ContainerNetworkInterfaceConfiguration", + "description": "Container network interface configuration from which this container network interface is created." + }, + "container": { + "$ref": "#/definitions/Container", + "description": "Reference to the container to which this container network interface is attached." + }, + "ipConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ContainerNetworkInterfaceIpConfiguration" + }, + "description": "Reference to the ip configuration on this container nic." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the container network interface resource." + } + }, + "description": "Properties of container network interface." + }, + "ContainerNetworkInterface": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfacePropertiesFormat", + "description": "Container network interface properties." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Container network interface child resource." + }, + "ContainerNetworkInterfaceConfigurationPropertiesFormat": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigurationProfile" + }, + "description": "A list of ip configurations of the container network interface configuration." + }, + "containerNetworkInterfaces": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A list of container network interfaces created from this container network interface configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the container network interface configuration resource." + } + }, + "description": "Container network interface configuration properties." + }, + "ContainerNetworkInterfaceConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfaceConfigurationPropertiesFormat", + "description": "Container network interface configuration properties." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Container network interface configuration child resource." + }, + "IPConfigurationProfilePropertiesFormat": { + "properties": { + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource to create a container network interface ip configuration." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the IP configuration profile resource." + } + }, + "description": "IP configuration profile properties." + }, + "IPConfigurationProfile": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IPConfigurationProfilePropertiesFormat", + "description": "Properties of the IP configuration profile." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration profile child resource." + }, + "Container": { + "properties": {}, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Reference to container resource in remote resource provider." + }, + "ContainerNetworkInterfaceIpConfigurationPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the container network interface IP configuration resource." + } + }, + "description": "Properties of the container network interface IP configuration." + }, + "ContainerNetworkInterfaceIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ContainerNetworkInterfaceIpConfigurationPropertiesFormat", + "description": "Properties of the container network interface IP configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Sub Resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "The ip configuration for a container network interface." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkSecurityGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkSecurityGroup.json new file mode 100644 index 000000000000..59af13aae54c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkSecurityGroup.json @@ -0,0 +1,982 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}": { + "delete": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_Delete", + "description": "Deletes the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete network security group": { + "$ref": "./examples/NetworkSecurityGroupDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_Get", + "description": "Gets the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get network security group": { + "$ref": "./examples/NetworkSecurityGroupGet.json" + } + } + }, + "put": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_CreateOrUpdate", + "description": "Creates or updates a network security group in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "description": "Parameters supplied to the create or update network security group operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create network security group": { + "$ref": "./examples/NetworkSecurityGroupCreate.json" + }, + "Create network security group with rule": { + "$ref": "./examples/NetworkSecurityGroupCreateWithRule.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_UpdateTags", + "description": "Updates a network security group tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network security group tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting NetworkSecurityGroup resource.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update network security group tags": { + "$ref": "./examples/NetworkSecurityGroupUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkSecurityGroups": { + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_ListAll", + "description": "Gets all network security groups in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all network security groups": { + "$ref": "./examples/NetworkSecurityGroupListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups": { + "get": { + "tags": [ + "NetworkSecurityGroups" + ], + "operationId": "NetworkSecurityGroups_List", + "description": "Gets all network security groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkSecurityGroup resources.", + "schema": { + "$ref": "#/definitions/NetworkSecurityGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List network security groups in resource group": { + "$ref": "./examples/NetworkSecurityGroupList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules/{securityRuleName}": { + "delete": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_Delete", + "description": "Deletes the specified network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete network security rule from network security group": { + "$ref": "./examples/NetworkSecurityGroupRuleDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_Get", + "description": "Get the specified network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get network security rule in network security group": { + "$ref": "./examples/NetworkSecurityGroupRuleGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_CreateOrUpdate", + "description": "Creates or updates a security rule in the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "securityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the security rule." + }, + { + "name": "securityRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "Parameters supplied to the create or update network security rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create security rule": { + "$ref": "./examples/NetworkSecurityGroupRuleCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/securityRules": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "SecurityRules_List", + "description": "Gets all security rules in a network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of SecurityRule resources.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List network security rules in network security group": { + "$ref": "./examples/NetworkSecurityGroupRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "DefaultSecurityRules_List", + "description": "Gets all default security rules in a network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of SecurityRule resources.", + "schema": { + "$ref": "#/definitions/SecurityRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DefaultSecurityRuleList": { + "$ref": "./examples/DefaultSecurityRuleList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkSecurityGroups/{networkSecurityGroupName}/defaultSecurityRules/{defaultSecurityRuleName}": { + "get": { + "tags": [ + "SecurityRules" + ], + "operationId": "DefaultSecurityRules_Get", + "description": "Get the specified default network security rule.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkSecurityGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network security group." + }, + { + "name": "defaultSecurityRuleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the default security rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting SecurityRule resource.", + "schema": { + "$ref": "#/definitions/SecurityRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DefaultSecurityRuleGet": { + "$ref": "./examples/DefaultSecurityRuleGet.json" + } + } + } + } + }, + "definitions": { + "SecurityRulePropertiesFormat": { + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "protocol": { + "type": "string", + "description": "Network protocol this rule applies to.", + "enum": [ + "Tcp", + "Udp", + "Icmp", + "Esp", + "*", + "Ah" + ], + "x-ms-enum": { + "name": "SecurityRuleProtocol", + "modelAsString": true + } + }, + "sourcePortRange": { + "type": "string", + "description": "The source port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "destinationPortRange": { + "type": "string", + "description": "The destination port or range. Integer or range between 0 and 65535. Asterisk '*' can also be used to match all ports." + }, + "sourceAddressPrefix": { + "type": "string", + "description": "The CIDR or source IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used. If this is an ingress rule, specifies where network traffic originates from." + }, + "sourceAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The CIDR or source IP ranges." + }, + "sourceApplicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "The application security group specified as source." + }, + "destinationAddressPrefix": { + "type": "string", + "description": "The destination address prefix. CIDR or destination IP range. Asterisk '*' can also be used to match all source IPs. Default tags such as 'VirtualNetwork', 'AzureLoadBalancer' and 'Internet' can also be used." + }, + "destinationAddressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The destination address prefixes. CIDR or destination IP ranges." + }, + "destinationApplicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "./applicationSecurityGroup.json#/definitions/ApplicationSecurityGroup" + }, + "description": "The application security group specified as destination." + }, + "sourcePortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The source port." + }, + "description": "The source port ranges." + }, + "destinationPortRanges": { + "type": "array", + "items": { + "type": "string", + "description": "The destination port." + }, + "description": "The destination port ranges." + }, + "access": { + "$ref": "#/definitions/SecurityRuleAccess", + "description": "The network traffic is allowed or denied." + }, + "priority": { + "type": "integer", + "format": "int32", + "description": "The priority of the rule. The value can be between 100 and 4096. The priority number must be unique for each rule in the collection. The lower the priority number, the higher the priority of the rule." + }, + "direction": { + "$ref": "#/definitions/SecurityRuleDirection", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the security rule resource." + } + }, + "required": [ + "protocol", + "access", + "direction" + ], + "description": "Security rule resource." + }, + "SecurityRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityRulePropertiesFormat", + "description": "Properties of the security rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Network security rule." + }, + "SecurityRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "The security rules in a network security group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSecurityRule API service call. Retrieves all security rules that belongs to a network security group." + }, + "NetworkSecurityGroupPropertiesFormat": { + "properties": { + "securityRules": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "A collection of security rules of the network security group." + }, + "defaultSecurityRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SecurityRule" + }, + "description": "The default security rules of network security group." + }, + "networkInterfaces": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "A collection of references to network interfaces." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "flowLogs": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkWatcher.json#/definitions/FlowLog" + }, + "description": "A collection of references to flow log resources." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the network security group resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network security group resource." + } + }, + "description": "Network Security Group resource." + }, + "NetworkSecurityGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkSecurityGroupPropertiesFormat", + "description": "Properties of the network security group." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "NetworkSecurityGroup resource." + }, + "NetworkSecurityGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkSecurityGroup" + }, + "description": "A list of NetworkSecurityGroup resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListNetworkSecurityGroups API service call." + }, + "SecurityRuleAccess": { + "type": "string", + "description": "Whether network traffic is allowed or denied.", + "enum": [ + "Allow", + "Deny" + ], + "x-ms-enum": { + "name": "SecurityRuleAccess", + "modelAsString": true + } + }, + "SecurityRuleDirection": { + "type": "string", + "description": "The direction of the rule. The direction specifies if rule will be evaluated on incoming or outgoing traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "SecurityRuleDirection", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkVirtualAppliance.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkVirtualAppliance.json new file mode 100644 index 000000000000..e18827f2f4fb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkVirtualAppliance.json @@ -0,0 +1,1009 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}": { + "delete": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_Delete", + "description": "Deletes the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_Get", + "description": "Gets the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Network Virtual Appliance resource.", + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceGet.json" + } + } + }, + "patch": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_UpdateTags", + "description": "Updates a Network Virtual Appliance.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of Network Virtual Appliance." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to Update Network Virtual Appliance Tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of Network Virtual Appliance updated.", + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualApplianceUpdateTags.json" + } + } + }, + "put": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_CreateOrUpdate", + "description": "Creates or updates the specified Network Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of Network Virtual Appliance." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + }, + "description": "Parameters supplied to the create or update Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Network Virtual Appliance resource.", + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "201": { + "description": "Request received successfully. The operation returns the resulting Network Virtual Appliance resource.", + "schema": { + "$ref": "#/definitions/NetworkVirtualAppliance" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create NetworkVirtualAppliance": { + "$ref": "./examples/NetworkVirtualAppliancePut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances": { + "get": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_ListByResourceGroup", + "description": "Lists all Network Virtual Appliances in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Network Virtual Appliance resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Network Virtual Appliance for a given resource group": { + "$ref": "./examples/NetworkVirtualApplianceListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualAppliances": { + "get": { + "tags": [ + "NetworkVirtualAppliances" + ], + "operationId": "NetworkVirtualAppliances_List", + "description": "Gets all Network Virtual Appliances in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Network Virtual Appliance resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Network Virtual Appliances for a given subscription": { + "$ref": "./examples/NetworkVirtualApplianceListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites/{siteName}": { + "delete": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_Delete", + "description": "Deletes the specified site from a Virtual Appliance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the site." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Network Virtual Appliance Site": { + "$ref": "./examples/NetworkVirtualApplianceSiteDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_Get", + "description": "Gets the specified Virtual Appliance Site.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the site." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Network Virtual Appliance Site resource.", + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetNetwork Virtual Appliance Site": { + "$ref": "./examples/NetworkVirtualApplianceSiteGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_CreateOrUpdate", + "description": "Creates or updates the specified Network Virtual Appliance Site.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "name": "siteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the site." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + }, + "description": "Parameters supplied to the create or update Network Virtual Appliance Site operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Network Virtual Appliance Site resource.", + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + } + }, + "201": { + "description": "Request received successfully. The operation returns the resulting Network Virtual Appliance Site resource.", + "schema": { + "$ref": "#/definitions/VirtualApplianceSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Network Virtual Appliance Site": { + "$ref": "./examples/NetworkVirtualApplianceSitePut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkVirtualAppliances/{networkVirtualApplianceName}/virtualApplianceSites": { + "get": { + "tags": [ + "VirtualApplianceSites" + ], + "operationId": "VirtualApplianceSites_List", + "description": "Lists all Network Virtual Appliance Sites in a Network Virtual Appliance resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkVirtualApplianceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Virtual Appliance." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Network Virtual Appliance site resources.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceSiteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Network Virtual Appliance sites for a given Network Virtual Appliance": { + "$ref": "./examples/NetworkVirtualApplianceSiteList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualApplianceSkus": { + "get": { + "tags": [ + "VirtualApplianceSkus" + ], + "operationId": "VirtualApplianceSkus_List", + "description": "List all SKUs available for a virtual appliance.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of all virtual appliance skus.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceSkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "NetworkVirtualApplianceSkuListResult": { + "$ref": "./examples/NetworkVirtualApplianceSkuList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkVirtualApplianceSkus/{skuName}": { + "get": { + "tags": [ + "VirtualApplianceSkus" + ], + "operationId": "VirtualApplianceSkus_Get", + "description": "Retrieves a single available sku for network virtual appliance.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "skuName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the Sku." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the requested NetworkVirtualAppliance sku information.", + "schema": { + "$ref": "#/definitions/NetworkVirtualApplianceSku" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkVirtualApplianceSkuGet": { + "$ref": "./examples/NetworkVirtualApplianceSkuGet.json" + } + } + } + } + }, + "definitions": { + "NetworkVirtualAppliance": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkVirtualAppliancePropertiesFormat", + "description": "Properties of the Network Virtual Appliance." + }, + "identity": { + "$ref": "./network.json#/definitions/ManagedServiceIdentity", + "description": "The service principal that has read access to cloud-init and config blob." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "NetworkVirtualAppliance Resource." + }, + "NetworkVirtualAppliancePropertiesFormat": { + "properties": { + "nvaSku": { + "readOnly": false, + "description": "Network Virtual Appliance SKU.", + "$ref": "#/definitions/VirtualApplianceSkuProperties" + }, + "bootStrapConfigurationBlobs": { + "type": "array", + "readOnly": false, + "description": "BootStrapConfigurationBlobs storage URLs.", + "items": { + "type": "string" + } + }, + "virtualHub": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The Virtual Hub where Network Virtual Appliance is being deployed." + }, + "cloudInitConfigurationBlobs": { + "type": "array", + "readOnly": false, + "description": "CloudInitConfigurationBlob storage URLs.", + "items": { + "type": "string" + } + }, + "cloudInitConfiguration": { + "type": "string", + "readOnly": false, + "description": "CloudInitConfiguration string in plain text." + }, + "virtualApplianceAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "VirtualAppliance ASN." + }, + "virtualApplianceNics": { + "type": "array", + "readOnly": true, + "description": "List of Virtual Appliance Network Interfaces.", + "items": { + "$ref": "#/definitions/VirtualApplianceNicProperties" + } + }, + "virtualApplianceSites": { + "type": "array", + "readOnly": true, + "description": "List of references to VirtualApplianceSite.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Network Virtual Appliance definition." + }, + "VirtualApplianceSkuProperties": { + "properties": { + "vendor": { + "type": "string", + "readOnly": false, + "description": "Virtual Appliance Vendor." + }, + "bundledScaleUnit": { + "type": "string", + "readOnly": false, + "description": "Virtual Appliance Scale Unit." + }, + "marketPlaceVersion": { + "type": "string", + "readOnly": false, + "description": "Virtual Appliance Version." + } + }, + "description": "Network Virtual Appliance Sku Properties." + }, + "VirtualApplianceNicProperties": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "NIC name." + }, + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "Public IP address." + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "Private IP address." + } + }, + "description": "Network Virtual Appliance NIC properties." + }, + "VirtualApplianceSite": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualApplianceSiteProperties", + "description": "The properties of the Virtual Appliance Sites." + }, + "name": { + "type": "string", + "description": "Name of the virtual appliance site." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Site type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Virtual Appliance Site resource." + }, + "VirtualApplianceSiteProperties": { + "properties": { + "addressPrefix": { + "type": "string", + "readOnly": false, + "description": "Address Prefix." + }, + "o365Policy": { + "readOnly": false, + "description": "Office 365 Policy.", + "$ref": "#/definitions/Office365PolicyProperties" + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Properties of the rule group." + }, + "Office365PolicyProperties": { + "properties": { + "breakOutCategories": { + "readOnly": false, + "description": "Office 365 breakout categories.", + "$ref": "#/definitions/BreakOutCategoryPolicies" + } + }, + "description": "Network Virtual Appliance Sku Properties." + }, + "BreakOutCategoryPolicies": { + "properties": { + "allow": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control breakout of o365 allow category." + }, + "optimize": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control breakout of o365 optimize category." + }, + "default": { + "type": "boolean", + "readOnly": false, + "description": "Flag to control breakout of o365 default category." + } + }, + "description": "Network Virtual Appliance Sku Properties." + }, + "NetworkVirtualApplianceSku": { + "title": "Available NetworkVirtualApplianceSkus", + "description": "Definition of the NetworkVirtualApplianceSkus resource.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkVirtualApplianceSkuPropertiesFormat", + "description": "NetworkVirtualApplianceSku properties." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "NetworkVirtualApplianceSkuPropertiesFormat": { + "title": "Network Virtual Appliance Sku Properties", + "description": "Properties specific to NetworkVirtualApplianceSkus.", + "properties": { + "vendor": { + "type": "string", + "readOnly": true, + "description": "Network Virtual Appliance Sku vendor." + }, + "availableVersions": { + "type": "array", + "readOnly": true, + "description": "Available Network Virtual Appliance versions.", + "items": { + "type": "string" + } + }, + "availableScaleUnits": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualApplianceSkuInstances" + }, + "description": "The list of scale units available." + } + } + }, + "NetworkVirtualApplianceSkuInstances": { + "title": "Network Virtual Appliance Sku Instances", + "description": "List of available Sku and instances.", + "properties": { + "scaleUnit": { + "type": "string", + "readOnly": true, + "description": "Scale Unit." + }, + "instanceCount": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Instance Count." + } + } + }, + "NetworkVirtualApplianceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualAppliance" + }, + "description": "List of Network Virtual Appliances." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListNetworkVirtualAppliances API service call." + }, + "NetworkVirtualApplianceSiteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualApplianceSite" + }, + "description": "List of Network Virtual Appliance sites." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListNetworkVirtualApplianceSites API service call." + }, + "NetworkVirtualApplianceSkuListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkVirtualApplianceSku" + }, + "description": "List of Network Virtual Appliance Skus that are available." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListNetworkVirtualApplianceSkus API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkWatcher.json new file mode 100644 index 000000000000..edeedd8b860e --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkWatcher.json @@ -0,0 +1,4534 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}": { + "put": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_CreateOrUpdate", + "description": "Creates or updates a network watcher in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkWatcher" + }, + "description": "Parameters that define the network watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create network watcher": { + "$ref": "./examples/NetworkWatcherCreate.json" + } + } + }, + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_Get", + "description": "Gets the specified network watcher by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get network watcher": { + "$ref": "./examples/NetworkWatcherGet.json" + } + } + }, + "delete": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_Delete", + "description": "Deletes the specified network watcher resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete network watcher": { + "$ref": "./examples/NetworkWatcherDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_UpdateTags", + "description": "Updates a network watcher tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update network watcher tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/NetworkWatcher" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update network watcher tags": { + "$ref": "./examples/NetworkWatcherUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers": { + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_List", + "description": "Gets all network watchers by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network watcher resources.", + "schema": { + "$ref": "#/definitions/NetworkWatcherListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List network watchers": { + "$ref": "./examples/NetworkWatcherList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/networkWatchers": { + "get": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_ListAll", + "description": "Gets all network watchers by subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of network watcher resources.", + "schema": { + "$ref": "#/definitions/NetworkWatcherListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List all network watchers": { + "$ref": "./examples/NetworkWatcherListAll.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/topology": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTopology", + "description": "Gets the current network topology by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TopologyParameters" + }, + "description": "Parameters that define the representation of topology." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the topology of resource group.", + "schema": { + "$ref": "#/definitions/Topology" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Topology": { + "$ref": "./examples/NetworkWatcherTopologyGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/ipFlowVerify": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_VerifyIPFlow", + "description": "Verify IP flow from the specified VM to a location given the currently configured NSG rules.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VerificationIPFlowParameters" + }, + "description": "Parameters that define the IP flow to be verified." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the result of IP flow verification.", + "schema": { + "$ref": "#/definitions/VerificationIPFlowResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/VerificationIPFlowResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Ip flow verify": { + "$ref": "./examples/NetworkWatcherIpFlowVerify.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/nextHop": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetNextHop", + "description": "Gets the next hop from the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NextHopParameters" + }, + "description": "Parameters that define the source and destination endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the next hop from the VM.", + "schema": { + "$ref": "#/definitions/NextHopResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NextHopResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get next hop": { + "$ref": "./examples/NetworkWatcherNextHopGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/securityGroupView": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetVMSecurityRules", + "description": "Gets the configured and effective security group rules on the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityGroupViewParameters" + }, + "description": "Parameters that define the VM to check security groups for." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns security group rules on the VM.", + "schema": { + "$ref": "#/definitions/SecurityGroupViewResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/SecurityGroupViewResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get security group view": { + "$ref": "./examples/NetworkWatcherSecurityGroupViewGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}": { + "put": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Create", + "description": "Create and start a packet capture on the specified VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PacketCapture" + }, + "description": "Parameters that define the create packet capture operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting packet capture session.", + "schema": { + "$ref": "#/definitions/PacketCaptureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Get", + "description": "Gets a packet capture session by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a packet capture session.", + "schema": { + "$ref": "#/definitions/PacketCaptureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureGet.json" + } + } + }, + "delete": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Delete", + "description": "Deletes the specified packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/stop": { + "post": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_Stop", + "description": "Stops a specified packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the packet capture session." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop packet capture": { + "$ref": "./examples/NetworkWatcherPacketCaptureStop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures/{packetCaptureName}/queryStatus": { + "post": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_GetStatus", + "description": "Query the status of a running packet capture session.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "packetCaptureName", + "in": "path", + "required": true, + "type": "string", + "description": "The name given to the packet capture session." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful query of packet capture status.", + "schema": { + "$ref": "#/definitions/PacketCaptureQueryStatusResult" + } + }, + "202": { + "description": "Accepted query status of packet capture.", + "schema": { + "$ref": "#/definitions/PacketCaptureQueryStatusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query packet capture status": { + "$ref": "./examples/NetworkWatcherPacketCaptureQueryStatus.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/packetCaptures": { + "get": { + "tags": [ + "PacketCaptures" + ], + "operationId": "PacketCaptures_List", + "description": "Lists all packet capture sessions within the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful packet capture enumeration request.", + "schema": { + "$ref": "#/definitions/PacketCaptureListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List packet captures": { + "$ref": "./examples/NetworkWatcherPacketCapturesList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/troubleshoot": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTroubleshooting", + "description": "Initiate troubleshooting on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TroubleshootingParameters" + }, + "description": "Parameters that define the resource to troubleshoot." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful troubleshooting request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "202": { + "description": "Accepted get troubleshooting request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get troubleshooting": { + "$ref": "./examples/NetworkWatcherTroubleshootGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryTroubleshootResult": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetTroubleshootingResult", + "description": "Get the last completed troubleshooting result on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryTroubleshootingParameters" + }, + "description": "Parameters that define the resource to query the troubleshooting result." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful get troubleshooting result request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "202": { + "description": "Accepted get troubleshooting result request.", + "schema": { + "$ref": "#/definitions/TroubleshootingResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get troubleshoot result": { + "$ref": "./examples/NetworkWatcherTroubleshootResultQuery.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/configureFlowLog": { + "post": { + "tags": [ + "NetworkWatchers", + "TrafficAnalytics" + ], + "operationId": "NetworkWatchers_SetFlowLogConfiguration", + "description": "Configures flow log and traffic analytics (optional) on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLogInformation" + }, + "description": "Parameters that define the configuration of flow log." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for setting flow log and traffic analytics (optional) configuration.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Configure flow log": { + "$ref": "./examples/NetworkWatcherFlowLogConfigure.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/queryFlowLogStatus": { + "post": { + "tags": [ + "NetworkWatchers", + "TrafficAnalytics" + ], + "operationId": "NetworkWatchers_GetFlowLogStatus", + "description": "Queries status of flow log and traffic analytics (optional) on a specified resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLogStatusParameters" + }, + "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for query flow log and traffic analytics (optional) status.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/FlowLogInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get flow log status": { + "$ref": "./examples/NetworkWatcherFlowLogStatusQuery.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectivityCheck": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_CheckConnectivity", + "description": "Verifies the possibility of establishing a direct TCP connection from a virtual machine to a given endpoint including another VM or an arbitrary remote server.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectivityParameters" + }, + "description": "Parameters that determine how the connectivity check will be performed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for checking connectivity.", + "schema": { + "$ref": "#/definitions/ConnectivityInformation" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectivityInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check connectivity": { + "$ref": "./examples/NetworkWatcherConnectivityCheck.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/azureReachabilityReport": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetAzureReachabilityReport", + "description": "NOTE: This feature is currently in preview and still being tested for stability. Gets the relative latency score for internet service providers from a specified location to Azure regions.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AzureReachabilityReportParameters" + }, + "description": "Parameters that determine Azure reachability report configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for Azure reachability report.", + "schema": { + "$ref": "#/definitions/AzureReachabilityReport" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AzureReachabilityReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Azure Reachability Report": { + "$ref": "./examples/NetworkWatcherAzureReachabilityReportGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/availableProvidersList": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_ListAvailableProviders", + "description": "NOTE: This feature is currently in preview and still being tested for stability. Lists all available internet service providers for a specified Azure region.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher resource." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailableProvidersListParameters" + }, + "description": "Parameters that scope the list of available providers." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful request for list of available providers.", + "schema": { + "$ref": "#/definitions/AvailableProvidersList" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/AvailableProvidersList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get Available Providers List": { + "$ref": "./examples/NetworkWatcherAvailableProvidersListGet.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/networkConfigurationDiagnostic": { + "post": { + "tags": [ + "NetworkWatchers" + ], + "operationId": "NetworkWatchers_GetNetworkConfigurationDiagnostic", + "description": "Gets Network Configuration Diagnostic data to help customers understand and debug network behavior. It provides detailed information on what security rules were applied to a specified traffic flow and the result of evaluating these rules. Customers must provide details of a flow like source, destination, protocol, etc. The API returns whether traffic was allowed or denied, the rules evaluated for the specified flow and the evaluation results.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticParameters" + }, + "description": "Parameters to get network configuration diagnostic." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the result of network configuration diagnostic.", + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Network configuration diagnostic": { + "$ref": "./examples/NetworkWatcherNetworkConfigurationDiagnostic.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}": { + "put": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_CreateOrUpdate", + "description": "Create or update a connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionMonitor" + }, + "description": "Parameters that define the operation to create a connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting network watcher resource.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create connection monitor V1": { + "$ref": "./examples/NetworkWatcherConnectionMonitorCreate.json" + }, + "Create connection monitor V2": { + "$ref": "./examples/NetworkWatcherConnectionMonitorV2Create.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Get", + "description": "Gets a connection monitor by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a connection monitor.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorGet.json" + } + } + }, + "delete": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Delete", + "description": "Deletes the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_UpdateTags", + "description": "Update tags of the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update connection monitor tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns updated connection monitor.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Update connection monitor tags": { + "$ref": "./examples/NetworkWatcherConnectionMonitorUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/stop": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Stop", + "description": "Stops the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation stops the connection monitor." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Stop connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorStop.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/start": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Start", + "description": "Starts the specified connection monitor.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation starts the connection monitor." + }, + "202": { + "description": "Accepted. The operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Start connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorStart.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors/{connectionMonitorName}/query": { + "post": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_Query", + "description": "Query a snapshot of the most recent connection states.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "name": "connectionMonitorName", + "in": "path", + "required": true, + "type": "string", + "description": "The name given to the connection monitor." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful query of connection states.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorQueryResult" + } + }, + "202": { + "description": "Accepted query of connection states.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorQueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Query connection monitor": { + "$ref": "./examples/NetworkWatcherConnectionMonitorQuery.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/connectionMonitors": { + "get": { + "tags": [ + "ConnectionMonitors" + ], + "operationId": "ConnectionMonitors_List", + "description": "Lists all connection monitors for the specified Network Watcher.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful connection monitor enumeration request.", + "schema": { + "$ref": "#/definitions/ConnectionMonitorListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "List connection monitors": { + "$ref": "./examples/NetworkWatcherConnectionMonitorList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs/{flowLogName}": { + "put": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_CreateOrUpdate", + "description": "Create or update a flow log for the specified network security group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FlowLog" + }, + "description": "Parameters that define the create or update flow log resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting flow log resource.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting flow log resource.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Create or update flow log": { + "$ref": "./examples/NetworkWatcherFlowLogCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_Get", + "description": "Gets a flow log resource by name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a flow log resource.", + "schema": { + "$ref": "#/definitions/FlowLog" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Get flow log": { + "$ref": "./examples/NetworkWatcherFlowLogGet.json" + } + } + }, + "delete": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_Delete", + "description": "Deletes the specified flow log resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network watcher." + }, + { + "name": "flowLogName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the flow log resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Delete flow log": { + "$ref": "./examples/NetworkWatcherFlowLogDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkWatchers/{networkWatcherName}/flowLogs": { + "get": { + "tags": [ + "FlowLogs" + ], + "operationId": "FlowLogs_List", + "description": "Lists all flow log resources for the specified Network Watcher.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group containing Network Watcher." + }, + { + "name": "networkWatcherName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Network Watcher resource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Successful flow log enumeration request.", + "schema": { + "$ref": "#/definitions/FlowLogListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./networkWatcher.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List connection monitors": { + "$ref": "./examples/NetworkWatcherFlowLogList.json" + } + } + } + } + }, + "definitions": { + "ErrorResponse": { + "description": "The error object.", + "properties": { + "error": { + "title": "Error", + "$ref": "./network.json#/definitions/ErrorDetails", + "description": "The error details object." + } + } + }, + "NetworkWatcher": { + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkWatcherPropertiesFormat", + "description": "Properties of the network watcher." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network watcher in a resource group." + }, + "NetworkWatcherPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the network watcher resource." + } + }, + "description": "The network watcher properties." + }, + "NetworkWatcherListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkWatcher" + }, + "description": "List of network watcher resources." + } + }, + "description": "Response for ListNetworkWatchers API service call." + }, + "TopologyParameters": { + "properties": { + "targetResourceGroupName": { + "type": "string", + "description": "The name of the target resource group to perform topology on." + }, + "targetVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the Virtual Network resource." + }, + "targetSubnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the Subnet resource." + } + }, + "description": "Parameters that define the representation of topology." + }, + "Topology": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "GUID representing the operation id." + }, + "createdDateTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The datetime when the topology was initially created for the resource group." + }, + "lastModified": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The datetime when the topology was last modified." + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/TopologyResource" + }, + "description": "A list of topology resources." + } + }, + "description": "Topology of the specified resource group." + }, + "TopologyResource": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource." + }, + "id": { + "type": "string", + "description": "ID of the resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "associations": { + "type": "array", + "description": "Holds the associations the resource has with other resources in the resource group.", + "items": { + "$ref": "#/definitions/TopologyAssociation" + } + } + }, + "description": "The network resource topology information for the given resource group." + }, + "TopologyAssociation": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource that is associated with the parent resource." + }, + "resourceId": { + "type": "string", + "description": "The ID of the resource that is associated with the parent resource." + }, + "associationType": { + "type": "string", + "enum": [ + "Associated", + "Contains" + ], + "x-ms-enum": { + "name": "AssociationType", + "modelAsString": true + }, + "description": "The association type of the child resource to the parent resource." + } + }, + "description": "Resources that have an association with the parent resource." + }, + "VerificationIPFlowParameters": { + "description": "Parameters that define the IP flow to be verified.", + "required": [ + "targetResourceId", + "direction", + "protocol", + "localPort", + "remotePort", + "localIPAddress", + "remoteIPAddress" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The ID of the target resource to perform next-hop on." + }, + "direction": { + "$ref": "#/definitions/Direction", + "description": "The direction of the packet represented as a 5-tuple." + }, + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "IpFlowProtocol", + "modelAsString": true + }, + "description": "Protocol to be verified on." + }, + "localPort": { + "type": "string", + "description": "The local port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." + }, + "remotePort": { + "type": "string", + "description": "The remote port. Acceptable values are a single integer in the range (0-65535). Support for * for the source port, which depends on the direction." + }, + "localIPAddress": { + "type": "string", + "description": "The local IP address. Acceptable values are valid IPv4 addresses." + }, + "remoteIPAddress": { + "type": "string", + "description": "The remote IP address. Acceptable values are valid IPv4 addresses." + }, + "targetNicResourceId": { + "type": "string", + "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of them, then this parameter must be specified. Otherwise optional)." + } + } + }, + "VerificationIPFlowResult": { + "description": "Results of IP flow verification on the target resource.", + "properties": { + "access": { + "$ref": "./network.json#/definitions/Access", + "description": "Indicates whether the traffic is allowed or denied." + }, + "ruleName": { + "type": "string", + "description": "Name of the rule. If input is not matched against any security rule, it is not displayed." + } + } + }, + "NextHopParameters": { + "description": "Parameters that define the source and destination endpoint.", + "required": [ + "targetResourceId", + "sourceIPAddress", + "destinationIPAddress" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The resource identifier of the target resource against which the action is to be performed." + }, + "sourceIPAddress": { + "type": "string", + "description": "The source IP address." + }, + "destinationIPAddress": { + "type": "string", + "description": "The destination IP address." + }, + "targetNicResourceId": { + "type": "string", + "description": "The NIC ID. (If VM has multiple NICs and IP forwarding is enabled on any of the nics, then this parameter must be specified. Otherwise optional)." + } + } + }, + "NextHopResult": { + "description": "The information about next hop from the specified VM.", + "properties": { + "nextHopType": { + "type": "string", + "enum": [ + "Internet", + "VirtualAppliance", + "VirtualNetworkGateway", + "VnetLocal", + "HyperNetGateway", + "None" + ], + "x-ms-enum": { + "name": "NextHopType", + "modelAsString": true + }, + "description": "Next hop type." + }, + "nextHopIpAddress": { + "type": "string", + "description": "Next hop IP Address." + }, + "routeTableId": { + "type": "string", + "description": "The resource identifier for the route table associated with the route being returned. If the route being returned does not correspond to any user created routes then this field will be the string 'System Route'." + } + } + }, + "SecurityGroupViewParameters": { + "description": "Parameters that define the VM to check security groups for.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "ID of the target VM." + } + } + }, + "SecurityGroupViewResult": { + "description": "The information about security rules applied to the specified VM.", + "properties": { + "networkInterfaces": { + "type": "array", + "description": "List of network interfaces on the specified VM.", + "items": { + "$ref": "#/definitions/SecurityGroupNetworkInterface" + } + } + } + }, + "SecurityGroupNetworkInterface": { + "description": "Network interface and all its associated security rules.", + "properties": { + "id": { + "type": "string", + "description": "ID of the network interface." + }, + "securityRuleAssociations": { + "$ref": "#/definitions/SecurityRuleAssociations", + "description": "All security rules associated with the network interface." + } + } + }, + "SecurityRuleAssociations": { + "description": "All security rules associated with the network interface.", + "properties": { + "networkInterfaceAssociation": { + "$ref": "#/definitions/NetworkInterfaceAssociation", + "description": "Network interface and it's custom security rules." + }, + "subnetAssociation": { + "$ref": "#/definitions/SubnetAssociation", + "description": "Subnet and it's custom security rules." + }, + "defaultSecurityRules": { + "type": "array", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + }, + "description": "Collection of default security rules of the network security group." + }, + "effectiveSecurityRules": { + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/EffectiveNetworkSecurityRule" + }, + "description": "Collection of effective security rules." + } + } + }, + "NetworkInterfaceAssociation": { + "description": "Network interface and its custom security rules.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Network interface ID." + }, + "securityRules": { + "type": "array", + "description": "Collection of custom security rules.", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + } + } + } + }, + "SubnetAssociation": { + "description": "Subnet and it's custom security rules.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Subnet ID." + }, + "securityRules": { + "type": "array", + "description": "Collection of custom security rules.", + "items": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRule" + } + } + } + }, + "PacketCapture": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCaptureParameters", + "description": "Properties of the packet capture." + } + }, + "required": [ + "properties" + ], + "description": "Parameters that define the create packet capture operation." + }, + "PacketCaptureParameters": { + "properties": { + "target": { + "type": "string", + "description": "The ID of the targeted resource, only VM is currently supported." + }, + "bytesToCapturePerPacket": { + "type": "integer", + "default": 0, + "description": "Number of bytes captured per packet, the remaining bytes are truncated." + }, + "totalBytesPerSession": { + "type": "integer", + "default": 1073741824, + "description": "Maximum size of the capture output." + }, + "timeLimitInSeconds": { + "type": "integer", + "default": 18000, + "description": "Maximum duration of the capture session in seconds." + }, + "storageLocation": { + "$ref": "#/definitions/PacketCaptureStorageLocation", + "description": "The storage location for a packet capture session." + }, + "filters": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCaptureFilter" + }, + "description": "A list of packet capture filters." + } + }, + "required": [ + "target", + "storageLocation" + ], + "description": "Parameters that define the create packet capture operation." + }, + "PacketCaptureStorageLocation": { + "properties": { + "storageId": { + "type": "string", + "description": "The ID of the storage account to save the packet capture session. Required if no local file path is provided." + }, + "storagePath": { + "type": "string", + "description": "The URI of the storage path to save the packet capture. Must be a well-formed URI describing the location to save the packet capture." + }, + "filePath": { + "type": "string", + "description": "A valid local path on the targeting VM. Must include the name of the capture file (*.cap). For linux virtual machine it must start with /var/captures. Required if no storage ID is provided, otherwise optional." + } + }, + "description": "The storage location for a packet capture session." + }, + "PacketCaptureFilter": { + "properties": { + "protocol": { + "type": "string", + "enum": [ + "TCP", + "UDP", + "Any" + ], + "x-ms-enum": { + "name": "PcProtocol", + "modelAsString": true + }, + "default": "Any", + "description": "Protocol to be filtered on." + }, + "localIPAddress": { + "type": "string", + "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5\"? for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "remoteIPAddress": { + "type": "string", + "description": "Local IP Address to be filtered on. Notation: \"127.0.0.1\" for single address entry. \"127.0.0.1-127.0.0.255\" for range. \"127.0.0.1;127.0.0.5;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "localPort": { + "type": "string", + "description": "Local port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + }, + "remotePort": { + "type": "string", + "description": "Remote port to be filtered on. Notation: \"80\" for single port entry.\"80-85\" for range. \"80;443;\" for multiple entries. Multiple ranges not currently supported. Mixing ranges with multiple entries not currently supported. Default = null." + } + }, + "description": "Filter that is applied to packet capture request. Multiple filters can be applied." + }, + "PacketCaptureListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PacketCaptureResult" + }, + "description": "Information about packet capture sessions." + } + }, + "description": "List of packet capture sessions." + }, + "PacketCaptureResult": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the packet capture session." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "ID of the packet capture operation." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PacketCaptureResultProperties", + "description": "Properties of the packet capture result." + } + }, + "description": "Information about packet capture session." + }, + "PacketCaptureResultProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the packet capture session." + } + }, + "allOf": [ + { + "$ref": "#/definitions/PacketCaptureParameters" + } + ], + "description": "The properties of a packet capture session." + }, + "PacketCaptureQueryStatusResult": { + "properties": { + "name": { + "type": "string", + "description": "The name of the packet capture resource." + }, + "id": { + "type": "string", + "description": "The ID of the packet capture resource." + }, + "captureStartTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the packet capture session." + }, + "packetCaptureStatus": { + "type": "string", + "enum": [ + "NotStarted", + "Running", + "Stopped", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "PcStatus", + "modelAsString": true + }, + "description": "The status of the packet capture session." + }, + "stopReason": { + "type": "string", + "description": "The reason the current packet capture session was stopped." + }, + "packetCaptureError": { + "type": "array", + "description": "List of errors of packet capture session.", + "items": { + "type": "string", + "enum": [ + "InternalError", + "AgentStopped", + "CaptureFailed", + "LocalFileFailed", + "StorageFailed" + ], + "x-ms-enum": { + "name": "PcError", + "modelAsString": true + } + } + } + }, + "description": "Status of packet capture session." + }, + "TroubleshootingParameters": { + "description": "Parameters that define the resource to troubleshoot.", + "required": [ + "targetResourceId", + "properties" + ], + "properties": { + "targetResourceId": { + "description": "The target resource to troubleshoot.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/TroubleshootingProperties", + "description": "Properties of the troubleshooting resource." + } + } + }, + "QueryTroubleshootingParameters": { + "description": "Parameters that define the resource to query the troubleshooting result.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "description": "The target resource ID to query the troubleshooting result.", + "type": "string" + } + } + }, + "TroubleshootingProperties": { + "description": "Storage location provided for troubleshoot.", + "required": [ + "storageId", + "storagePath" + ], + "properties": { + "storageId": { + "description": "The ID for the storage account to save the troubleshoot result.", + "type": "string" + }, + "storagePath": { + "description": "The path to the blob to save the troubleshoot result in.", + "type": "string" + } + } + }, + "TroubleshootingResult": { + "description": "Troubleshooting information gained from specified resource.", + "properties": { + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the troubleshooting." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the troubleshooting." + }, + "code": { + "type": "string", + "description": "The result code of the troubleshooting." + }, + "results": { + "type": "array", + "description": "Information from troubleshooting.", + "items": { + "$ref": "#/definitions/TroubleshootingDetails" + } + } + } + }, + "TroubleshootingDetails": { + "description": "Information gained from troubleshooting of specified resource.", + "properties": { + "id": { + "type": "string", + "description": "The id of the get troubleshoot operation." + }, + "reasonType": { + "type": "string", + "description": "Reason type of failure." + }, + "summary": { + "type": "string", + "description": "A summary of troubleshooting." + }, + "detail": { + "type": "string", + "description": "Details on troubleshooting results." + }, + "recommendedActions": { + "type": "array", + "description": "List of recommended actions.", + "items": { + "$ref": "#/definitions/TroubleshootingRecommendedActions" + } + } + } + }, + "TroubleshootingRecommendedActions": { + "description": "Recommended actions based on discovered issues.", + "properties": { + "actionId": { + "description": "ID of the recommended action.", + "type": "string" + }, + "actionText": { + "description": "Description of recommended actions.", + "type": "string" + }, + "actionUri": { + "description": "The uri linking to a documentation for the recommended troubleshooting actions.", + "type": "string" + }, + "actionUriText": { + "description": "The information from the URI for the recommended troubleshooting actions.", + "type": "string" + } + } + }, + "FlowLogListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FlowLog" + }, + "description": "Information about flow log resource." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "List of flow logs." + }, + "FlowLog": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FlowLogPropertiesFormat", + "description": "Properties of the flow log." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "A flow log resource." + }, + "FlowLogPropertiesFormat": { + "description": "Parameters that define the configuration of flow log.", + "required": [ + "targetResourceId", + "storageId" + ], + "properties": { + "targetResourceId": { + "description": "ID of network security group to which flow log will be applied.", + "type": "string" + }, + "targetResourceGuid": { + "readOnly": true, + "description": "Guid of network security group to which flow log will be applied.", + "type": "string" + }, + "storageId": { + "description": "ID of the storage account which is used to store the flow log.", + "type": "string" + }, + "enabled": { + "description": "Flag to enable/disable flow logging.", + "type": "boolean" + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicyParameters", + "description": "Parameters that define the retention policy for flow log." + }, + "format": { + "$ref": "#/definitions/FlowLogFormatParameters", + "description": "Parameters that define the flow log format." + }, + "flowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsProperties", + "description": "Parameters that define the configuration of traffic analytics." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the flow log." + } + } + }, + "FlowLogProperties": { + "description": "Parameters that define the configuration of flow log.", + "required": [ + "storageId", + "enabled" + ], + "properties": { + "storageId": { + "description": "ID of the storage account which is used to store the flow log.", + "type": "string" + }, + "enabled": { + "description": "Flag to enable/disable flow logging.", + "type": "boolean" + }, + "retentionPolicy": { + "$ref": "#/definitions/RetentionPolicyParameters", + "description": "Parameters that define the retention policy for flow log." + }, + "format": { + "$ref": "#/definitions/FlowLogFormatParameters", + "description": "Parameters that define the flow log format." + } + } + }, + "FlowLogStatusParameters": { + "description": "Parameters that define a resource to query flow log and traffic analytics (optional) status.", + "required": [ + "targetResourceId" + ], + "properties": { + "targetResourceId": { + "description": "The target resource where getting the flow log and traffic analytics (optional) status.", + "type": "string" + } + } + }, + "RetentionPolicyParameters": { + "description": "Parameters that define the retention policy for flow log.", + "properties": { + "days": { + "description": "Number of days to retain flow log records.", + "type": "integer", + "default": 0 + }, + "enabled": { + "description": "Flag to enable/disable retention.", + "type": "boolean", + "default": false + } + } + }, + "FlowLogFormatParameters": { + "description": "Parameters that define the flow log format.", + "properties": { + "type": { + "type": "string", + "description": "The file type of flow log.", + "enum": [ + "JSON" + ], + "x-ms-enum": { + "name": "FlowLogFormatType", + "modelAsString": true + } + }, + "version": { + "description": "The version (revision) of the flow log.", + "type": "integer", + "default": 0 + } + } + }, + "FlowLogInformation": { + "description": "Information on the configuration of flow log and traffic analytics (optional) .", + "required": [ + "targetResourceId", + "properties" + ], + "properties": { + "targetResourceId": { + "description": "The ID of the resource to configure for flow log and traffic analytics (optional) .", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/FlowLogProperties", + "description": "Properties of the flow log." + }, + "flowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsProperties", + "description": "Parameters that define the configuration of traffic analytics." + } + } + }, + "TrafficAnalyticsProperties": { + "description": "Parameters that define the configuration of traffic analytics.", + "properties": { + "networkWatcherFlowAnalyticsConfiguration": { + "$ref": "#/definitions/TrafficAnalyticsConfigurationProperties", + "description": "Parameters that define the configuration of traffic analytics." + } + } + }, + "TrafficAnalyticsConfigurationProperties": { + "description": "Parameters that define the configuration of traffic analytics.", + "properties": { + "enabled": { + "description": "Flag to enable/disable traffic analytics.", + "type": "boolean" + }, + "workspaceId": { + "description": "The resource guid of the attached workspace.", + "type": "string" + }, + "workspaceRegion": { + "description": "The location of the attached workspace.", + "type": "string" + }, + "workspaceResourceId": { + "description": "Resource Id of the attached workspace.", + "type": "string" + }, + "trafficAnalyticsInterval": { + "description": "The interval in minutes which would decide how frequently TA service should do flow analytics.", + "type": "integer" + } + } + }, + "ConnectivityParameters": { + "description": "Parameters that determine how the connectivity check will be performed.", + "required": [ + "source", + "destination" + ], + "properties": { + "source": { + "$ref": "#/definitions/ConnectivitySource", + "description": "The source of the connection." + }, + "destination": { + "$ref": "#/definitions/ConnectivityDestination", + "description": "The destination of connection." + }, + "protocol": { + "type": "string", + "description": "Network protocol.", + "enum": [ + "Tcp", + "Http", + "Https", + "Icmp" + ], + "x-ms-enum": { + "name": "Protocol", + "modelAsString": true + } + }, + "protocolConfiguration": { + "$ref": "#/definitions/ProtocolConfiguration", + "description": "Configuration of the protocol." + }, + "preferredIPVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "Preferred IP version of the connection." + } + } + }, + "ConnectivitySource": { + "description": "Parameters that define the source of the connection.", + "required": [ + "resourceId" + ], + "properties": { + "resourceId": { + "description": "The ID of the resource from which a connectivity check will be initiated.", + "type": "string" + }, + "port": { + "description": "The source port from which a connectivity check will be performed.", + "type": "integer" + } + } + }, + "ConnectivityDestination": { + "description": "Parameters that define destination of connection.", + "properties": { + "resourceId": { + "description": "The ID of the resource to which a connection attempt will be made.", + "type": "string" + }, + "address": { + "description": "The IP address or URI the resource to which a connection attempt will be made.", + "type": "string" + }, + "port": { + "description": "Port on which check connectivity will be performed.", + "type": "integer" + } + } + }, + "ConnectivityInformation": { + "description": "Information on the connectivity status.", + "properties": { + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "#/definitions/ConnectivityHop" + } + }, + "connectionStatus": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "Connected", + "Disconnected", + "Degraded" + ], + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + }, + "description": "The connection status." + }, + "avgLatencyInMs": { + "description": "Average latency in milliseconds.", + "readOnly": true, + "type": "integer" + }, + "minLatencyInMs": { + "description": "Minimum latency in milliseconds.", + "readOnly": true, + "type": "integer" + }, + "maxLatencyInMs": { + "description": "Maximum latency in milliseconds.", + "readOnly": true, + "type": "integer" + }, + "probesSent": { + "description": "Total number of probes sent.", + "readOnly": true, + "type": "integer" + }, + "probesFailed": { + "description": "Number of failed probes.", + "readOnly": true, + "type": "integer" + } + } + }, + "ConnectivityHop": { + "description": "Information about a hop between the source and the destination.", + "properties": { + "type": { + "description": "The type of the hop.", + "readOnly": true, + "type": "string" + }, + "id": { + "description": "The ID of the hop.", + "readOnly": true, + "type": "string" + }, + "address": { + "description": "The IP address of the hop.", + "readOnly": true, + "type": "string" + }, + "resourceId": { + "description": "The ID of the resource corresponding to this hop.", + "readOnly": true, + "type": "string" + }, + "nextHopIds": { + "readOnly": true, + "type": "array", + "description": "List of next hop identifiers.", + "items": { + "type": "string" + } + }, + "previousHopIds": { + "readOnly": true, + "type": "array", + "description": "List of previous hop identifiers.", + "items": { + "type": "string" + } + }, + "links": { + "readOnly": true, + "type": "array", + "description": "List of hop links.", + "items": { + "$ref": "#/definitions/HopLink" + } + }, + "previousLinks": { + "readOnly": true, + "type": "array", + "description": "List of previous hop links.", + "items": { + "$ref": "#/definitions/HopLink" + } + }, + "issues": { + "readOnly": true, + "type": "array", + "description": "List of issues.", + "items": { + "$ref": "#/definitions/ConnectivityIssue" + } + } + } + }, + "HopLink": { + "description": "Hop link.", + "properties": { + "nextHopId": { + "description": "The ID of the next hop.", + "readOnly": true, + "type": "string" + }, + "linkType": { + "description": "Link type.", + "readOnly": true, + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HopLinkProperties", + "description": "Hop link properties." + }, + "issues": { + "readOnly": true, + "type": "array", + "description": "List of issues.", + "items": { + "$ref": "#/definitions/ConnectivityIssue" + } + }, + "context": { + "readOnly": true, + "type": "array", + "description": "Provides additional context on the issue.", + "items": { + "$ref": "#/definitions/IssueContext" + } + }, + "resourceId": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + } + } + }, + "HopLinkProperties": { + "description": "Hop link properties.", + "properties": { + "roundTripTimeMin": { + "description": "Minimum roundtrip time in milliseconds.", + "readOnly": true, + "format": "int32", + "type": "integer" + }, + "roundTripTimeAvg": { + "description": "Average roundtrip time in milliseconds.", + "readOnly": true, + "format": "int32", + "type": "integer" + }, + "roundTripTimeMax": { + "description": "Maximum roundtrip time in milliseconds.", + "readOnly": true, + "format": "int32", + "type": "integer" + } + } + }, + "ConnectivityIssue": { + "description": "Information about an issue encountered in the process of checking for connectivity.", + "properties": { + "origin": { + "readOnly": true, + "type": "string", + "enum": [ + "Local", + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Origin", + "modelAsString": true + }, + "description": "The origin of the issue." + }, + "severity": { + "readOnly": true, + "type": "string", + "enum": [ + "Error", + "Warning" + ], + "x-ms-enum": { + "name": "Severity", + "modelAsString": true + }, + "description": "The severity of the issue." + }, + "type": { + "readOnly": true, + "type": "string", + "enum": [ + "Unknown", + "AgentStopped", + "GuestFirewall", + "DnsResolution", + "SocketBind", + "NetworkSecurityRule", + "UserDefinedRoute", + "PortThrottled", + "Platform" + ], + "x-ms-enum": { + "name": "IssueType", + "modelAsString": true + }, + "description": "The type of issue." + }, + "context": { + "readOnly": true, + "type": "array", + "description": "Provides additional context on the issue.", + "items": { + "$ref": "#/definitions/IssueContext" + } + } + } + }, + "IssueContext": { + "description": "A key-value pair that provides additional context on the issue.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "ProtocolConfiguration": { + "description": "Configuration of the protocol.", + "properties": { + "HTTPConfiguration": { + "$ref": "#/definitions/HTTPConfiguration", + "description": "HTTP configuration of the connectivity check." + } + } + }, + "HTTPConfiguration": { + "properties": { + "method": { + "type": "string", + "description": "HTTP method.", + "enum": [ + "Get" + ], + "x-ms-enum": { + "name": "HTTPMethod", + "modelAsString": true + } + }, + "headers": { + "type": "array", + "description": "List of HTTP headers.", + "items": { + "$ref": "#/definitions/HTTPHeader" + } + }, + "validStatusCodes": { + "type": "array", + "items": { + "type": "integer" + }, + "description": "Valid status codes." + } + }, + "description": "HTTP configuration of the connectivity check." + }, + "HTTPHeader": { + "properties": { + "name": { + "type": "string", + "description": "The name in HTTP header." + }, + "value": { + "type": "string", + "description": "The value in HTTP header." + } + }, + "description": "The HTTP header." + }, + "AzureReachabilityReportParameters": { + "properties": { + "providerLocation": { + "$ref": "#/definitions/AzureReachabilityReportLocation", + "description": "Parameters that define a geographic location." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of Internet service providers." + }, + "azureLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional Azure regions to scope the query to." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time for the Azure reachability report." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time for the Azure reachability report." + } + }, + "required": [ + "providerLocation", + "startTime", + "endTime" + ], + "description": "Geographic and time constraints for Azure reachability report." + }, + "AzureReachabilityReportLocation": { + "properties": { + "country": { + "type": "string", + "description": "The name of the country." + }, + "state": { + "type": "string", + "description": "The name of the state." + }, + "city": { + "type": "string", + "description": "The name of the city or town." + } + }, + "required": [ + "country" + ], + "description": "Parameters that define a geographic location." + }, + "AzureReachabilityReport": { + "properties": { + "aggregationLevel": { + "type": "string", + "description": "The aggregation level of Azure reachability report. Can be Country, State or City." + }, + "providerLocation": { + "$ref": "#/definitions/AzureReachabilityReportLocation", + "description": "Parameters that define a geographic location." + }, + "reachabilityReport": { + "type": "array", + "description": "List of Azure reachability report items.", + "items": { + "$ref": "#/definitions/AzureReachabilityReportItem" + } + } + }, + "required": [ + "aggregationLevel", + "providerLocation", + "reachabilityReport" + ], + "description": "Azure reachability report details." + }, + "AzureReachabilityReportItem": { + "properties": { + "provider": { + "type": "string", + "description": "The Internet service provider." + }, + "azureLocation": { + "type": "string", + "description": "The Azure region." + }, + "latencies": { + "type": "array", + "description": "List of latency details for each of the time series.", + "items": { + "$ref": "#/definitions/AzureReachabilityReportLatencyInfo" + } + } + }, + "description": "Azure reachability report details for a given provider location." + }, + "AzureReachabilityReportLatencyInfo": { + "properties": { + "timeStamp": { + "type": "string", + "format": "date-time", + "description": "The time stamp." + }, + "score": { + "type": "integer", + "description": "The relative latency score between 1 and 100, higher values indicating a faster connection.", + "minimum": 1, + "maximum": 100 + } + }, + "description": "Details on latency for a time series." + }, + "AvailableProvidersListParameters": { + "properties": { + "azureLocations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Azure regions." + }, + "country": { + "type": "string", + "description": "The country for available providers list." + }, + "state": { + "type": "string", + "description": "The state for available providers list." + }, + "city": { + "type": "string", + "description": "The city or town for available providers list." + } + }, + "description": "Constraints that determine the list of available Internet service providers." + }, + "AvailableProvidersList": { + "properties": { + "countries": { + "type": "array", + "description": "List of available countries.", + "items": { + "$ref": "#/definitions/AvailableProvidersListCountry" + } + } + }, + "required": [ + "countries" + ], + "description": "List of available countries with details." + }, + "AvailableProvidersListCountry": { + "properties": { + "countryName": { + "type": "string", + "description": "The country name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + }, + "states": { + "type": "array", + "description": "List of available states in the country.", + "items": { + "$ref": "#/definitions/AvailableProvidersListState" + } + } + }, + "description": "Country details." + }, + "AvailableProvidersListState": { + "properties": { + "stateName": { + "type": "string", + "description": "The state name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + }, + "cities": { + "type": "array", + "description": "List of available cities or towns in the state.", + "items": { + "$ref": "#/definitions/AvailableProvidersListCity" + } + } + }, + "description": "State details." + }, + "AvailableProvidersListCity": { + "properties": { + "cityName": { + "type": "string", + "description": "The city or town name." + }, + "providers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of Internet service providers." + } + }, + "description": "City or town details." + }, + "NetworkConfigurationDiagnosticParameters": { + "description": "Parameters to get network configuration diagnostic.", + "required": [ + "targetResourceId", + "profiles" + ], + "properties": { + "targetResourceId": { + "type": "string", + "description": "The ID of the target resource to perform network configuration diagnostic. Valid options are VM, NetworkInterface, VMSS/NetworkInterface and Application Gateway." + }, + "verbosityLevel": { + "type": "string", + "enum": [ + "Normal", + "Minimum", + "Full" + ], + "x-ms-enum": { + "name": "VerbosityLevel", + "modelAsString": true + }, + "description": "Verbosity level." + }, + "profiles": { + "type": "array", + "description": "List of network configuration diagnostic profiles.", + "items": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile" + } + } + } + }, + "NetworkConfigurationDiagnosticProfile": { + "description": "Parameters to compare with network configuration.", + "required": [ + "direction", + "protocol", + "source", + "destination", + "destinationPort" + ], + "properties": { + "direction": { + "$ref": "#/definitions/Direction", + "description": "The direction of the traffic." + }, + "protocol": { + "type": "string", + "description": "Protocol to be verified on. Accepted values are '*', TCP, UDP." + }, + "source": { + "type": "string", + "description": "Traffic source. Accepted values are '*', IP Address/CIDR, Service Tag." + }, + "destination": { + "type": "string", + "description": "Traffic destination. Accepted values are: '*', IP Address/CIDR, Service Tag." + }, + "destinationPort": { + "type": "string", + "description": "Traffic destination port. Accepted values are '*' and a single port in the range (0 - 65535)." + } + } + }, + "NetworkConfigurationDiagnosticResponse": { + "description": "Results of network configuration diagnostic on the target resource.", + "properties": { + "results": { + "readOnly": true, + "type": "array", + "description": "List of network configuration diagnostic results.", + "items": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticResult" + } + } + } + }, + "NetworkConfigurationDiagnosticResult": { + "description": "Network configuration diagnostic result corresponded to provided traffic query.", + "properties": { + "profile": { + "$ref": "#/definitions/NetworkConfigurationDiagnosticProfile", + "description": "Network configuration diagnostic profile." + }, + "networkSecurityGroupResult": { + "$ref": "#/definitions/NetworkSecurityGroupResult", + "description": "Network security group result." + } + } + }, + "NetworkSecurityGroupResult": { + "description": "Network configuration diagnostic result corresponded provided traffic query.", + "properties": { + "securityRuleAccessResult": { + "$ref": "./networkSecurityGroup.json#/definitions/SecurityRuleAccess", + "description": "The network traffic is allowed or denied." + }, + "evaluatedNetworkSecurityGroups": { + "readOnly": true, + "type": "array", + "description": "List of results network security groups diagnostic.", + "items": { + "$ref": "#/definitions/EvaluatedNetworkSecurityGroup" + } + } + } + }, + "EvaluatedNetworkSecurityGroup": { + "description": "Results of network security group evaluation.", + "properties": { + "networkSecurityGroupId": { + "type": "string", + "description": "Network security group ID." + }, + "appliedTo": { + "type": "string", + "description": "Resource ID of nic or subnet to which network security group is applied." + }, + "matchedRule": { + "$ref": "#/definitions/MatchedRule", + "description": "Matched network security rule." + }, + "rulesEvaluationResult": { + "readOnly": true, + "type": "array", + "description": "List of network security rules evaluation results.", + "items": { + "$ref": "#/definitions/NetworkSecurityRulesEvaluationResult" + } + } + } + }, + "MatchedRule": { + "description": "Matched rule.", + "properties": { + "ruleName": { + "type": "string", + "description": "Name of the matched network security rule." + }, + "action": { + "type": "string", + "description": "The network traffic is allowed or denied. Possible values are 'Allow' and 'Deny'." + } + } + }, + "NetworkSecurityRulesEvaluationResult": { + "description": "Network security rules evaluation result.", + "properties": { + "name": { + "type": "string", + "description": "Name of the network security rule." + }, + "protocolMatched": { + "type": "boolean", + "description": "Value indicating whether protocol is matched." + }, + "sourceMatched": { + "type": "boolean", + "description": "Value indicating whether source is matched." + }, + "sourcePortMatched": { + "type": "boolean", + "description": "Value indicating whether source port is matched." + }, + "destinationMatched": { + "type": "boolean", + "description": "Value indicating whether destination is matched." + }, + "destinationPortMatched": { + "type": "boolean", + "description": "Value indicating whether destination port is matched." + } + } + }, + "Direction": { + "type": "string", + "description": "The direction of the traffic.", + "enum": [ + "Inbound", + "Outbound" + ], + "x-ms-enum": { + "name": "Direction", + "modelAsString": true + } + }, + "ConnectionMonitor": { + "properties": { + "location": { + "type": "string", + "description": "Connection monitor location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Connection monitor tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionMonitorParameters", + "description": "Properties of the connection monitor." + } + }, + "required": [ + "properties" + ], + "description": "Parameters that define the operation to create a connection monitor." + }, + "ConnectionMonitorParameters": { + "properties": { + "source": { + "$ref": "#/definitions/ConnectionMonitorSource", + "description": "Describes the source of connection monitor." + }, + "destination": { + "$ref": "#/definitions/ConnectionMonitorDestination", + "description": "Describes the destination of connection monitor." + }, + "autoStart": { + "type": "boolean", + "default": true, + "description": "Determines if the connection monitor will start automatically once created." + }, + "monitoringIntervalInSeconds": { + "type": "integer", + "default": 60, + "description": "Monitoring interval in seconds." + }, + "endpoints": { + "type": "array", + "description": "List of connection monitor endpoints.", + "items": { + "$ref": "#/definitions/ConnectionMonitorEndpoint" + } + }, + "testConfigurations": { + "type": "array", + "description": "List of connection monitor test configurations.", + "items": { + "$ref": "#/definitions/ConnectionMonitorTestConfiguration" + } + }, + "testGroups": { + "type": "array", + "description": "List of connection monitor test groups.", + "items": { + "$ref": "#/definitions/ConnectionMonitorTestGroup" + } + }, + "outputs": { + "type": "array", + "description": "List of connection monitor outputs.", + "items": { + "$ref": "#/definitions/ConnectionMonitorOutput" + } + }, + "notes": { + "type": "string", + "description": "Optional notes to be associated with the connection monitor." + } + }, + "description": "Parameters that define the operation to create a connection monitor." + }, + "ConnectionMonitorSource": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ID of the resource used as the source by connection monitor." + }, + "port": { + "type": "integer", + "description": "The source port used by connection monitor." + } + }, + "required": [ + "resourceId" + ], + "description": "Describes the source of connection monitor." + }, + "ConnectionMonitorDestination": { + "properties": { + "resourceId": { + "type": "string", + "description": "The ID of the resource used as the destination by connection monitor." + }, + "address": { + "type": "string", + "description": "Address of the connection monitor destination (IP or domain name)." + }, + "port": { + "type": "integer", + "description": "The destination port used by connection monitor." + } + }, + "description": "Describes the destination of connection monitor." + }, + "ConnectionMonitorEndpoint": { + "properties": { + "name": { + "type": "string", + "description": "The name of the connection monitor endpoint." + }, + "resourceId": { + "type": "string", + "description": "Resource ID of the connection monitor endpoint." + }, + "address": { + "type": "string", + "description": "Address of the connection monitor endpoint (IP or domain name)." + }, + "filter": { + "$ref": "#/definitions/ConnectionMonitorEndpointFilter", + "description": "Filter for sub-items within the endpoint." + } + }, + "required": [ + "name" + ], + "description": "Describes the connection monitor endpoint." + }, + "ConnectionMonitorEndpointFilter": { + "properties": { + "type": { + "type": "string", + "enum": [ + "Include" + ], + "x-ms-enum": { + "name": "ConnectionMonitorEndpointFilterType", + "modelAsString": true + }, + "description": "The behavior of the endpoint filter. Currently only 'Include' is supported." + }, + "items": { + "type": "array", + "description": "List of items in the filter.", + "items": { + "$ref": "#/definitions/ConnectionMonitorEndpointFilterItem" + } + } + }, + "description": "Describes the connection monitor endpoint filter." + }, + "ConnectionMonitorEndpointFilterItem": { + "properties": { + "type": { + "type": "string", + "enum": [ + "AgentAddress" + ], + "x-ms-enum": { + "name": "ConnectionMonitorEndpointFilterItemType", + "modelAsString": true + }, + "description": "The type of item included in the filter. Currently only 'AgentAddress' is supported." + }, + "address": { + "type": "string", + "description": "The address of the filter item." + } + }, + "description": "Describes the connection monitor endpoint filter item." + }, + "ConnectionMonitorTestGroup": { + "properties": { + "name": { + "type": "string", + "description": "The name of the connection monitor test group." + }, + "disable": { + "type": "boolean", + "description": "Value indicating whether test group is disabled." + }, + "testConfigurations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of test configuration names." + }, + "sources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of source endpoint names." + }, + "destinations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of destination endpoint names." + } + }, + "required": [ + "name", + "testConfigurations", + "sources", + "destinations" + ], + "description": "Describes the connection monitor test group." + }, + "ConnectionMonitorTestConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The name of the connection monitor test configuration." + }, + "testFrequencySec": { + "type": "integer", + "description": "The frequency of test evaluation, in seconds." + }, + "protocol": { + "type": "string", + "enum": [ + "Tcp", + "Http", + "Icmp" + ], + "x-ms-enum": { + "name": "ConnectionMonitorTestConfigurationProtocol", + "modelAsString": true + }, + "description": "The protocol to use in test evaluation." + }, + "preferredIPVersion": { + "type": "string", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "PreferredIPVersion", + "modelAsString": true + }, + "description": "The preferred IP version to use in test evaluation. The connection monitor may choose to use a different version depending on other parameters." + }, + "httpConfiguration": { + "$ref": "#/definitions/ConnectionMonitorHttpConfiguration", + "description": "The parameters used to perform test evaluation over HTTP." + }, + "tcpConfiguration": { + "$ref": "#/definitions/ConnectionMonitorTcpConfiguration", + "description": "The parameters used to perform test evaluation over TCP." + }, + "icmpConfiguration": { + "$ref": "#/definitions/ConnectionMonitorIcmpConfiguration", + "description": "The parameters used to perform test evaluation over ICMP." + }, + "successThreshold": { + "$ref": "#/definitions/ConnectionMonitorSuccessThreshold", + "description": "The threshold for declaring a test successful." + } + }, + "required": [ + "name", + "protocol" + ], + "description": "Describes a connection monitor test configuration." + }, + "ConnectionMonitorHttpConfiguration": { + "properties": { + "port": { + "type": "integer", + "description": "The port to connect to." + }, + "method": { + "type": "string", + "description": "The HTTP method to use.", + "enum": [ + "Get", + "Post" + ], + "x-ms-enum": { + "name": "HTTPConfigurationMethod", + "modelAsString": true + } + }, + "path": { + "type": "string", + "description": "The path component of the URI. For instance, \"/dir1/dir2\"." + }, + "requestHeaders": { + "type": "array", + "description": "The HTTP headers to transmit with the request.", + "items": { + "$ref": "#/definitions/HTTPHeader" + } + }, + "validStatusCodeRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "HTTP status codes to consider successful. For instance, \"2xx,301-304,418\"." + }, + "preferHTTPS": { + "type": "boolean", + "description": "Value indicating whether HTTPS is preferred over HTTP in cases where the choice is not explicit." + } + }, + "description": "Describes the HTTP configuration." + }, + "ConnectionMonitorTcpConfiguration": { + "properties": { + "port": { + "type": "integer", + "description": "The port to connect to." + }, + "disableTraceRoute": { + "type": "boolean", + "description": "Value indicating whether path evaluation with trace route should be disabled." + } + }, + "description": "Describes the TCP configuration." + }, + "ConnectionMonitorIcmpConfiguration": { + "properties": { + "disableTraceRoute": { + "type": "boolean", + "description": "Value indicating whether path evaluation with trace route should be disabled." + } + }, + "description": "Describes the ICMP configuration." + }, + "ConnectionMonitorSuccessThreshold": { + "properties": { + "checksFailedPercent": { + "type": "integer", + "description": "The maximum percentage of failed checks permitted for a test to evaluate as successful." + }, + "roundTripTimeMs": { + "type": "number", + "description": "The maximum round-trip time in milliseconds permitted for a test to evaluate as successful." + } + }, + "description": "Describes the threshold for declaring a test successful." + }, + "ConnectionMonitorOutput": { + "properties": { + "type": { + "type": "string", + "description": "Connection monitor output destination type. Currently, only \"Workspace\" is supported.", + "enum": [ + "Workspace" + ], + "x-ms-enum": { + "name": "OutputType", + "modelAsString": true + } + }, + "workspaceSettings": { + "$ref": "#/definitions/ConnectionMonitorWorkspaceSettings", + "description": "Describes the settings for producing output into a log analytics workspace." + } + }, + "description": "Describes a connection monitor output destination." + }, + "ConnectionMonitorWorkspaceSettings": { + "properties": { + "workspaceResourceId": { + "type": "string", + "description": "Log analytics workspace resource ID." + } + }, + "description": "Describes the settings for producing output into a log analytics workspace." + }, + "ConnectionStateSnapshot": { + "properties": { + "connectionState": { + "type": "string", + "enum": [ + "Reachable", + "Unreachable", + "Unknown" + ], + "x-ms-enum": { + "name": "ConnectionState", + "modelAsString": true + }, + "description": "The connection state." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the connection snapshot." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the connection snapshot." + }, + "evaluationState": { + "type": "string", + "enum": [ + "NotStarted", + "InProgress", + "Completed" + ], + "x-ms-enum": { + "name": "EvaluationState", + "modelAsString": true + }, + "description": "Connectivity analysis evaluation state." + }, + "avgLatencyInMs": { + "type": "integer", + "description": "Average latency in ms." + }, + "minLatencyInMs": { + "type": "integer", + "description": "Minimum latency in ms." + }, + "maxLatencyInMs": { + "type": "integer", + "description": "Maximum latency in ms." + }, + "probesSent": { + "type": "integer", + "description": "The number of sent probes." + }, + "probesFailed": { + "type": "integer", + "description": "The number of failed probes." + }, + "hops": { + "readOnly": true, + "type": "array", + "description": "List of hops between the source and the destination.", + "items": { + "$ref": "./networkWatcher.json#/definitions/ConnectivityHop" + } + } + }, + "description": "Connection state snapshot." + }, + "ConnectionMonitorListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionMonitorResult" + }, + "description": "Information about connection monitors." + } + }, + "description": "List of connection monitors." + }, + "ConnectionMonitorResult": { + "x-ms-azure-resource": true, + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the connection monitor." + }, + "id": { + "readOnly": true, + "type": "string", + "description": "ID of the connection monitor." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Connection monitor type." + }, + "location": { + "type": "string", + "description": "Connection monitor location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Connection monitor tags." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ConnectionMonitorResultProperties", + "description": "Properties of the connection monitor result." + } + }, + "description": "Information about the connection monitor." + }, + "ConnectionMonitorResultProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the connection monitor." + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date and time when the connection monitor was started." + }, + "monitoringStatus": { + "readOnly": true, + "type": "string", + "description": "The monitoring status of the connection monitor." + }, + "connectionMonitorType": { + "readOnly": true, + "type": "string", + "enum": [ + "MultiEndpoint", + "SingleSourceDestination" + ], + "x-ms-enum": { + "name": "ConnectionMonitorType", + "modelAsString": true + }, + "description": "Type of connection monitor." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ConnectionMonitorParameters" + } + ], + "description": "Describes the properties of a connection monitor." + }, + "ConnectionMonitorQueryResult": { + "properties": { + "sourceStatus": { + "type": "string", + "enum": [ + "Unknown", + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "ConnectionMonitorSourceStatus", + "modelAsString": true + }, + "description": "Status of connection monitor source." + }, + "states": { + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionStateSnapshot" + }, + "description": "Information about connection states." + } + }, + "description": "List of connection states snapshots." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/operation.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/operation.json new file mode 100644 index 000000000000..4838cfe73f10 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/operation.json @@ -0,0 +1,271 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Network/operations": { + "get": { + "operationId": "Operations_List", + "description": "Lists all of the available Network Rest API operations.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get a list of operations for a resource provider": { + "$ref": "./examples/OperationList.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Network operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of Network operations supported by the Network resource provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Network REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "description": "Display metadata associated with the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft Network.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Type of the operation: get, read, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation.", + "type": "string" + } + } + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationPropertiesFormat", + "description": "Operation properties format." + } + } + }, + "OperationPropertiesFormat": { + "description": "Description of operation properties format.", + "properties": { + "serviceSpecification": { + "description": "Specification of the service.", + "properties": { + "metricSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "description": "Operation service specification." + }, + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "description": "Operation log specification." + } + } + } + } + }, + "LogSpecification": { + "description": "Description of logging specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the specification." + }, + "displayName": { + "type": "string", + "description": "The display name of the specification." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the blob." + } + } + }, + "MetricSpecification": { + "description": "Description of metrics specification.", + "properties": { + "name": { + "type": "string", + "description": "The name of the metric." + }, + "displayName": { + "type": "string", + "description": "The display name of the metric." + }, + "displayDescription": { + "type": "string", + "description": "The description of the metric." + }, + "unit": { + "type": "string", + "description": "Units the metric to be displayed in." + }, + "aggregationType": { + "type": "string", + "description": "The aggregation type." + }, + "availabilities": { + "type": "array", + "items": { + "$ref": "#/definitions/Availability" + }, + "description": "List of availability." + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Whether regional MDM account enabled." + }, + "fillGapWithZero": { + "type": "boolean", + "description": "Whether gaps would be filled with zeros." + }, + "metricFilterPattern": { + "type": "string", + "description": "Pattern for the filter of the metric." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + }, + "description": "List of dimensions." + }, + "isInternal": { + "type": "boolean", + "description": "Whether the metric is internal." + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account." + }, + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace." + }, + "resourceIdDimensionNameOverride": { + "type": "string", + "description": "The resource Id dimension name override." + } + } + }, + "Dimension": { + "description": "Dimension of the metric.", + "properties": { + "name": { + "type": "string", + "description": "The name of the dimension." + }, + "displayName": { + "type": "string", + "description": "The display name of the dimension." + }, + "internalName": { + "type": "string", + "description": "The internal name of the dimension." + } + } + }, + "Availability": { + "description": "Availability of the metric.", + "properties": { + "timeGrain": { + "type": "string", + "description": "The time grain of the availability." + }, + "retention": { + "type": "string", + "description": "The retention of the availability." + }, + "blobDuration": { + "type": "string", + "description": "Duration of the availability blob." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateEndpoint.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateEndpoint.json new file mode 100644 index 000000000000..cd4c2100ed66 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateEndpoint.json @@ -0,0 +1,963 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}": { + "delete": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_Delete", + "description": "Deletes the specified private endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete private endpoint": { + "$ref": "./examples/PrivateEndpointDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_Get", + "description": "Gets the specified private endpoint by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting private endpoint resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get private endpoint": { + "$ref": "./examples/PrivateEndpointGet.json" + }, + "Get private endpoint with manual approval connection": { + "$ref": "./examples/PrivateEndpointGetForManualApproval.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_CreateOrUpdate", + "description": "Creates or updates an private endpoint in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "description": "Parameters supplied to the create or update private endpoint operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting private endpoint resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting private endpoint resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpoint" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create private endpoint": { + "$ref": "./examples/PrivateEndpointCreate.json" + }, + "Create private endpoint with manual approval connection": { + "$ref": "./examples/PrivateEndpointCreateForManualApproval.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints": { + "get": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_List", + "description": "Gets all private endpoints in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private endpoint resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private endpoints in resource group": { + "$ref": "./examples/PrivateEndpointList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateEndpoints": { + "get": { + "tags": [ + "PrivateEndpoints" + ], + "operationId": "PrivateEndpoints_ListBySubscription", + "description": "Gets all private endpoints in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private endpoint resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all private endpoints": { + "$ref": "./examples/PrivateEndpointListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes": { + "get": { + "operationId": "AvailablePrivateEndpointTypes_List", + "description": "Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AvailablePrivateEndpointTypesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available PrivateEndpoint types": { + "$ref": "./examples/AvailablePrivateEndpointTypesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/availablePrivateEndpointTypes": { + "get": { + "operationId": "AvailablePrivateEndpointTypes_ListByResourceGroup", + "description": "Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the resource types that can be linked to a Private Endpoint in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AvailablePrivateEndpointTypesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get available PrivateEndpoint types in the resource group": { + "$ref": "./examples/AvailablePrivateEndpointTypesResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups/{privateDnsZoneGroupName}": { + "delete": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_Delete", + "description": "Deletes the specified private dns zone group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "privateDnsZoneGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private dns zone group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete private dns zone group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_Get", + "description": "Gets the private dns zone group resource by specified private dns zone group name.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "privateDnsZoneGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private dns zone group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting privateDnsZoneGroup resource.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get private dns zone group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_CreateOrUpdate", + "description": "Creates or updates a private dns zone group in the specified private endpoint.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "privateDnsZoneGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private dns zone group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + }, + "description": "Parameters supplied to the create or update private dns zone group operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PrivateDnsZoneGroup resource.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting PrivateDnsZoneGroup resource.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create private dns zone group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateEndpoints/{privateEndpointName}/privateDnsZoneGroups": { + "get": { + "tags": [ + "PrivateDnsZoneGroups" + ], + "operationId": "PrivateDnsZoneGroups_List", + "description": "Gets all private dns zone groups in a private endpoint.", + "parameters": [ + { + "name": "privateEndpointName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private dns zone group resources.", + "schema": { + "$ref": "#/definitions/PrivateDnsZoneGroupListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private endpoints in resource group": { + "$ref": "./examples/PrivateEndpointDnsZoneGroupList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PrivateEndpoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointProperties", + "description": "Properties of the private endpoint." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Private endpoint resource." + }, + "PrivateEndpointProperties": { + "properties": { + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The ID of the subnet from which the private IP will be allocated." + }, + "networkInterfaces": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "An array of references to the network interfaces created for this private endpoint." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private endpoint resource." + }, + "privateLinkServiceConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkServiceConnection" + }, + "description": "A grouping of information about the connection to the remote resource." + }, + "manualPrivateLinkServiceConnections": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkServiceConnection" + }, + "description": "A grouping of information about the connection to the remote resource. Used when the network admin does not have access to approve connections to the remote resource." + }, + "customDnsConfigs": { + "type": "array", + "items": { + "$ref": "#/definitions/CustomDnsConfigPropertiesFormat" + }, + "description": "An array of custom dns configurations." + } + }, + "description": "Properties of the private endpoint." + }, + "CustomDnsConfigPropertiesFormat": { + "properties": { + "fqdn": { + "type": "string", + "description": "Fqdn that resolves to private endpoint ip address." + }, + "ipAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of private ip addresses of the private endpoint." + } + }, + "description": "Contains custom Dns resolution configuration from customer." + }, + "PrivateLinkServiceConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkServiceConnectionProperties", + "description": "Properties of the private link service connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "PrivateLinkServiceConnection resource." + }, + "PrivateLinkServiceConnectionProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private link service connection resource." + }, + "privateLinkServiceId": { + "type": "string", + "description": "The resource id of private link service." + }, + "groupIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The ID(s) of the group(s) obtained from the remote resource that this private endpoint should connect to." + }, + "requestMessage": { + "type": "string", + "description": "A message passed to the owner of the remote resource with this connection request. Restricted to 140 chars." + }, + "privateLinkServiceConnectionState": { + "$ref": "./privateLinkService.json#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of read-only information about the state of the connection to the remote resource." + } + }, + "description": "Properties of the PrivateLinkServiceConnection." + }, + "PrivateEndpointListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpoint" + }, + "description": "A list of private endpoint resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateEndpoints API service call." + }, + "PrivateDnsZoneGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateDnsZoneGroup" + }, + "description": "A list of private dns zone group resources in a private endpoint." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateDnsZoneGroups API service call." + }, + "AvailablePrivateEndpointTypesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailablePrivateEndpointType" + }, + "description": "An array of available privateEndpoint type." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of available PrivateEndpoint types." + }, + "AvailablePrivateEndpointType": { + "properties": { + "name": { + "type": "string", + "description": "The name of the service and resource." + }, + "id": { + "type": "string", + "description": "A unique identifier of the AvailablePrivateEndpoint Type resource." + }, + "type": { + "type": "string", + "description": "Resource type." + }, + "resourceName": { + "type": "string", + "description": "The name of the service and resource." + } + }, + "description": "The information of an AvailablePrivateEndpointType." + }, + "PrivateDnsZoneGroup": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateDnsZoneGroupPropertiesFormat", + "description": "Properties of the private dns zone group." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Private dns zone group resource." + }, + "PrivateDnsZoneGroupPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private dns zone group resource." + }, + "privateDnsZoneConfigs": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateDnsZoneConfig" + }, + "description": "A collection of private dns zone configurations of the private dns zone group." + } + }, + "description": "Properties of the private dns zone group." + }, + "PrivateDnsZoneConfig": { + "properties": { + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateDnsZonePropertiesFormat", + "description": "Properties of the private dns zone configuration." + } + }, + "description": "PrivateDnsZoneConfig resource." + }, + "PrivateDnsZonePropertiesFormat": { + "properties": { + "privateDnsZoneId": { + "type": "string", + "description": "The resource id of the private dns zone." + }, + "recordSets": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/RecordSet" + }, + "description": "A collection of information regarding a recordSet, holding information to identify private resources." + } + }, + "description": "Properties of the private dns zone configuration resource." + }, + "RecordSet": { + "properties": { + "recordType": { + "type": "string", + "description": "Resource record type." + }, + "recordSetName": { + "type": "string", + "description": "Recordset name." + }, + "fqdn": { + "type": "string", + "description": "Fqdn that resolves to private endpoint ip address." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the recordset." + }, + "ttl": { + "type": "integer", + "description": "Recordset time to live." + }, + "ipAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private ip address of the private endpoint." + } + }, + "description": "A collective group of information about the record set information." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateLinkService.json new file mode 100644 index 000000000000..cdaf84b39ac3 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateLinkService.json @@ -0,0 +1,1068 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}": { + "delete": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_Delete", + "description": "Deletes the specified private link service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete private link service": { + "$ref": "./examples/PrivateLinkServiceDelete.json" + } + } + }, + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_Get", + "description": "Gets the specified private link service by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PrivateLinkService resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkService" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get private link service": { + "$ref": "./examples/PrivateLinkServiceGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateLinkService" + ], + "operationId": "PrivateLinkServices_CreateOrUpdate", + "description": "Creates or updates an private link service in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateLinkService" + }, + "description": "Parameters supplied to the create or update private link service operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting privateLinkService resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkService" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting privateLinkService resource.", + "schema": { + "$ref": "#/definitions/PrivateLinkService" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create private link service": { + "$ref": "./examples/PrivateLinkServiceCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_List", + "description": "Gets all private link services in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of privateLinkService resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private link service in resource group": { + "$ref": "./examples/PrivateLinkServiceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/privateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListBySubscription", + "description": "Gets all private link service in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PrivateLinkService resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all private list service": { + "$ref": "./examples/PrivateLinkServiceListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections/{peConnectionName}": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_GetPrivateEndpointConnection", + "description": "Get the specific private end point connection by specific private link service in the resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "peConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private end point connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting private end point connection resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get private end point connection": { + "$ref": "./examples/PrivateLinkServiceGetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_UpdatePrivateEndpointConnection", + "description": "Approve or reject private end point connection for a private link service in a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "peConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private end point connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to approve or reject the private end point connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PrivateEndpointConnection resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "approve or reject private end point connection for a private link service": { + "$ref": "./examples/PrivateLinkServiceUpdatePrivateEndpointConnection.json" + } + } + }, + "delete": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_DeletePrivateEndpointConnection", + "description": "Delete private end point connection for a private link service in a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "name": "peConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private end point connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "delete private end point connection for a private link service": { + "$ref": "./examples/PrivateLinkServiceDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/privateLinkServices/{serviceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListPrivateEndpointConnections", + "description": "Gets all private end point connections for a specific private link service.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private link service." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of private end point connection resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List private link service in resource group": { + "$ref": "./examples/PrivateLinkServiceListPrivateEndpointConnection.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/checkPrivateLinkServiceVisibility": { + "post": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_CheckPrivateLinkServiceVisibility", + "description": "Checks whether the subscription is visible to private link service.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckPrivateLinkServiceVisibilityRequest" + }, + "description": "The request body of CheckPrivateLinkService API call." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the subscription is visible to private link service.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceVisibility" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check private link service visibility": { + "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/checkPrivateLinkServiceVisibility": { + "post": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_CheckPrivateLinkServiceVisibilityByResourceGroup", + "description": "Checks whether the subscription is visible to private link service in the specified resource group.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckPrivateLinkServiceVisibilityRequest" + }, + "description": "The request body of CheckPrivateLinkService API call." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns whether the subscription is visible to private link service.", + "schema": { + "$ref": "#/definitions/PrivateLinkServiceVisibility" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check private link service visibility": { + "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListAutoApprovedPrivateLinkServices", + "description": "Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AutoApprovedPrivateLinkServicesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of private link service id that can be linked to a private end point with auto approved": { + "$ref": "./examples/AutoApprovedPrivateLinkServicesGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/locations/{location}/autoApprovedPrivateLinkServices": { + "get": { + "tags": [ + "PrivateLinkServices" + ], + "operationId": "PrivateLinkServices_ListAutoApprovedPrivateLinkServicesByResourceGroup", + "description": "Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location of the domain name." + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all of the private link service ids that can be linked to a Private Endpoint with auto approved in this subscription in this region.", + "schema": { + "$ref": "#/definitions/AutoApprovedPrivateLinkServicesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of private link service id that can be linked to a private end point with auto approved": { + "$ref": "./examples/AutoApprovedPrivateLinkServicesResourceGroupGet.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PrivateLinkService": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkServiceProperties", + "description": "Properties of the private link service." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Private link service resource." + }, + "PrivateLinkServiceProperties": { + "properties": { + "loadBalancerFrontendIpConfigurations": { + "type": "array", + "items": { + "$ref": "./loadBalancer.json#/definitions/FrontendIPConfiguration" + }, + "description": "An array of references to the load balancer IP configurations." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkServiceIpConfiguration" + }, + "description": "An array of private link service IP configurations." + }, + "networkInterfaces": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + }, + "description": "An array of references to the network interfaces created for this private link service." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private link service resource." + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "An array of list about connections to the private endpoint." + }, + "visibility": { + "allOf": [ + { + "$ref": "#/definitions/ResourceSet" + } + ], + "description": "The visibility list of the private link service." + }, + "autoApproval": { + "allOf": [ + { + "$ref": "#/definitions/ResourceSet" + } + ], + "description": "The auto-approval list of the private link service." + }, + "fqdns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Fqdn." + }, + "alias": { + "readOnly": true, + "type": "string", + "description": "The alias of the private link service." + }, + "enableProxyProtocol": { + "type": "boolean", + "description": "Whether the private link service is enabled for proxy protocol or not." + } + }, + "description": "Properties of the private link service." + }, + "ResourceSet": { + "properties": { + "subscriptions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of subscriptions." + } + }, + "description": "The base resource set for visibility and auto-approval." + }, + "PrivateLinkServiceIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateLinkServiceIpConfigurationProperties", + "description": "Properties of the private link service ip configuration." + }, + "name": { + "type": "string", + "description": "The name of private link service ip configuration." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "The private link service ip configuration." + }, + "PrivateLinkServiceIpConfigurationProperties": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource." + }, + "primary": { + "type": "boolean", + "description": "Whether the ip configuration is primary or not." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private link service IP configuration resource." + }, + "privateIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "Whether the specific IP configuration is IPv4 or IPv6. Default is IPv4." + } + }, + "description": "Properties of private link service IP configuration." + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the private end point connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "PrivateEndpointConnection resource." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "readOnly": true, + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + }, + "linkIdentifier": { + "readOnly": true, + "type": "string", + "description": "The consumer link id." + } + }, + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "type": "string", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateLinkServiceListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkService" + }, + "description": "A list of PrivateLinkService resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateLinkService API service call." + }, + "PrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "A list of PrivateEndpointConnection resources for a specific private link service." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results.", + "readOnly": true + } + }, + "description": "Response for the ListPrivateEndpointConnection API service call." + }, + "CheckPrivateLinkServiceVisibilityRequest": { + "properties": { + "privateLinkServiceAlias": { + "type": "string", + "description": "The alias of the private link service." + } + }, + "description": "Request body of the CheckPrivateLinkServiceVisibility API service call." + }, + "PrivateLinkServiceVisibility": { + "properties": { + "visible": { + "type": "boolean", + "description": "Private Link Service Visibility (True/False)." + } + }, + "description": "Response for the CheckPrivateLinkServiceVisibility API service call." + }, + "AutoApprovedPrivateLinkServicesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AutoApprovedPrivateLinkService" + }, + "description": "An array of auto approved private link service." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "An array of private link service id that can be linked to a private end point with auto approved." + }, + "AutoApprovedPrivateLinkService": { + "properties": { + "privateLinkService": { + "type": "string", + "description": "The id of the private link service resource." + } + }, + "description": "The information of an AutoApprovedPrivateLinkService." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpAddress.json new file mode 100644 index 000000000000..6759277f77a5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpAddress.json @@ -0,0 +1,545 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses/{publicIpAddressName}": { + "delete": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_Delete", + "description": "Deletes the specified public IP address.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete public IP address": { + "$ref": "./examples/PublicIpAddressDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_Get", + "description": "Gets the specified public IP address in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get public IP address": { + "$ref": "./examples/PublicIpAddressGet.json" + } + } + }, + "put": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_CreateOrUpdate", + "description": "Creates or updates a static or dynamic public IP address.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublicIPAddress" + }, + "description": "Parameters supplied to the create or update public IP address operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create public IP address defaults": { + "$ref": "./examples/PublicIpAddressCreateDefaults.json" + }, + "Create public IP address allocation method": { + "$ref": "./examples/PublicIpAddressCreateCustomizedValues.json" + }, + "Create public IP address DNS": { + "$ref": "./examples/PublicIpAddressCreateDns.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_UpdateTags", + "description": "Updates public IP address tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP address." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update public IP address tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update public IP address tags": { + "$ref": "./examples/PublicIpAddressUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPAddresses": { + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_ListAll", + "description": "Gets all the public IP addresses in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all public IP addresses": { + "$ref": "./examples/PublicIpAddressListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPAddresses": { + "get": { + "tags": [ + "PublicIPAddresses" + ], + "operationId": "PublicIPAddresses_List", + "description": "Gets all public IP addresses in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group public IP addresses": { + "$ref": "./examples/PublicIpAddressList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PublicIPAddressSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a public IP address SKU.", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPAddressSkuName", + "modelAsString": true + } + } + }, + "description": "SKU of a public IP address." + }, + "PublicIPAddressPropertiesFormat": { + "properties": { + "publicIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The public IP address allocation method." + }, + "publicIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "The public IP address version." + }, + "ipConfiguration": { + "readOnly": true, + "$ref": "./networkInterface.json#/definitions/IPConfiguration", + "description": "The IP configuration associated with the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/PublicIPAddressDnsSettings", + "description": "The FQDN of the DNS record associated with the public IP address." + }, + "ddosSettings": { + "$ref": "#/definitions/DdosSettings", + "description": "The DDoS protection custom policy associated with the public IP address." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/IpTag" + }, + "description": "The list of tags associated with the public IP address." + }, + "ipAddress": { + "type": "string", + "description": "The IP address associated with the public IP address resource." + }, + "publicIPPrefix": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The Public IP Prefix this Public IP Address should be allocated from." + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the public IP address resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the public IP address resource." + } + }, + "description": "Public IP address properties." + }, + "PublicIPAddress": { + "properties": { + "sku": { + "$ref": "#/definitions/PublicIPAddressSku", + "description": "The public IP address SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PublicIPAddressPropertiesFormat", + "description": "Public IP address properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Public IP address resource." + }, + "PublicIPAddressListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicIPAddress" + }, + "description": "A list of public IP addresses that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPublicIpAddresses API service call." + }, + "PublicIPAddressDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The domain name label. The concatenation of the domain name label and the regionalized DNS zone make up the fully qualified domain name associated with the public IP address. If a domain name label is specified, an A DNS record is created for the public IP in the Microsoft Azure DNS system." + }, + "fqdn": { + "type": "string", + "description": "The Fully Qualified Domain Name of the A DNS record associated with the public IP. This is the concatenation of the domainNameLabel and the regionalized DNS zone." + }, + "reverseFqdn": { + "type": "string", + "description": "The reverse FQDN. A user-visible, fully qualified domain name that resolves to this public IP address. If the reverseFqdn is specified, then a PTR DNS record is created pointing from the IP address in the in-addr.arpa domain to the reverse FQDN." + } + }, + "description": "Contains FQDN of the DNS record associated with the public IP address." + }, + "DdosSettings": { + "properties": { + "ddosCustomPolicy": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The DDoS custom policy associated with the public IP." + }, + "protectionCoverage": { + "readOnly": false, + "type": "string", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "DdosSettingsProtectionCoverage", + "modelAsString": true + }, + "description": "The DDoS protection policy customizability of the public IP. Only standard coverage will have the ability to be customized." + }, + "protectedIP": { + "readOnly": false, + "type": "boolean", + "description": "Enables DDoS protection on the public IP." + } + }, + "description": "Contains the DDoS protection settings of the public IP." + }, + "IpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "The IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "The value of the IP tag associated with the public IP. Example: SQL." + } + }, + "description": "Contains the IpTag associated with the object." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpPrefix.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpPrefix.json new file mode 100644 index 000000000000..f4eac7e6aaeb --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpPrefix.json @@ -0,0 +1,485 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes/{publicIpPrefixName}": { + "delete": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_Delete", + "description": "Deletes the specified public IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the PublicIpPrefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete public IP prefix": { + "$ref": "./examples/PublicIpPrefixDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_Get", + "description": "Gets the specified public IP prefix in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get public IP prefix": { + "$ref": "./examples/PublicIpPrefixGet.json" + } + } + }, + "put": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_CreateOrUpdate", + "description": "Creates or updates a static or dynamic public IP prefix.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + }, + "description": "Parameters supplied to the create or update public IP prefix operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create public IP prefix defaults": { + "$ref": "./examples/PublicIpPrefixCreateDefaults.json" + }, + "Create public IP prefix allocation method": { + "$ref": "./examples/PublicIpPrefixCreateCustomizedValues.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_UpdateTags", + "description": "Updates public IP prefix tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "publicIpPrefixName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP prefix." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update public IP prefix tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting PublicIPPrefix resource.", + "schema": { + "$ref": "#/definitions/PublicIPPrefix" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update public IP prefix tags": { + "$ref": "./examples/PublicIpPrefixUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/publicIPPrefixes": { + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_ListAll", + "description": "Gets all the public IP prefixes in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPPrefix resources.", + "schema": { + "$ref": "#/definitions/PublicIPPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all public IP prefixes": { + "$ref": "./examples/PublicIpPrefixListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/publicIPPrefixes": { + "get": { + "tags": [ + "PublicIPPrefixes" + ], + "operationId": "PublicIPPrefixes_List", + "description": "Gets all public IP prefixes in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPPrefix resources.", + "schema": { + "$ref": "#/definitions/PublicIPPrefixListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group public IP prefixes": { + "$ref": "./examples/PublicIpPrefixList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "PublicIPPrefixSku": { + "properties": { + "name": { + "type": "string", + "description": "Name of a public IP prefix SKU.", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "PublicIPPrefixSkuName", + "modelAsString": true + } + } + }, + "description": "SKU of a public IP prefix." + }, + "PublicIPPrefixPropertiesFormat": { + "properties": { + "publicIPAddressVersion": { + "$ref": "./network.json#/definitions/IPVersion", + "description": "The public IP address version." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "./publicIpAddress.json#/definitions/IpTag" + }, + "description": "The list of tags associated with the public IP prefix." + }, + "prefixLength": { + "type": "integer", + "format": "int32", + "description": "The Length of the Public IP Prefix." + }, + "ipPrefix": { + "readOnly": true, + "type": "string", + "description": "The allocated Prefix." + }, + "publicIPAddresses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ReferencedPublicIpAddress" + }, + "description": "The list of all referenced PublicIPAddresses." + }, + "loadBalancerFrontendIpConfiguration": { + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to load balancer frontend IP configuration associated with the public IP prefix." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the public IP prefix resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the public IP prefix resource." + } + }, + "description": "Public IP prefix properties." + }, + "PublicIPPrefix": { + "properties": { + "sku": { + "$ref": "#/definitions/PublicIPPrefixSku", + "description": "The public IP prefix SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/PublicIPPrefixPropertiesFormat", + "description": "Public IP prefix properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of availability zones denoting the IP allocated for the resource needs to come from." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Public IP prefix resource." + }, + "PublicIPPrefixListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/PublicIPPrefix" + }, + "description": "A list of public IP prefixes that exists in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListPublicIpPrefixes API service call." + }, + "ReferencedPublicIpAddress": { + "properties": { + "id": { + "type": "string", + "description": "The PublicIPAddress Reference." + } + }, + "description": "Reference to a public IP address." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/routeFilter.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/routeFilter.json new file mode 100644 index 000000000000..6c559bb9cffe --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/routeFilter.json @@ -0,0 +1,822 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}": { + "delete": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Delete", + "x-ms-examples": { + "RouteFilterDelete": { + "$ref": "./examples/RouteFilterDelete.json" + } + }, + "description": "Deletes the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_Get", + "x-ms-examples": { + "RouteFilterGet": { + "$ref": "./examples/RouteFilterGet.json" + } + }, + "description": "Gets the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced express route bgp peering resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_CreateOrUpdate", + "x-ms-examples": { + "RouteFilterCreate": { + "$ref": "./examples/RouteFilterCreate.json" + } + }, + "description": "Creates or updates a route filter in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "routeFilterParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteFilter" + }, + "description": "Parameters supplied to the create or update route filter operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_UpdateTags", + "description": "Updates tags of a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update route filter tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter resource.", + "schema": { + "$ref": "#/definitions/RouteFilter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update route filter tags": { + "$ref": "./examples/RouteFilterUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters": { + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_ListByResourceGroup", + "x-ms-examples": { + "RouteFilterListByResourceGroup": { + "$ref": "./examples/RouteFilterListByResourceGroup.json" + } + }, + "description": "Gets all route filters in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter resources.", + "schema": { + "$ref": "#/definitions/RouteFilterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeFilters": { + "get": { + "tags": [ + "RouteFilters" + ], + "operationId": "RouteFilters_List", + "x-ms-examples": { + "RouteFilterList": { + "$ref": "./examples/RouteFilterList.json" + } + }, + "description": "Gets all route filters in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter resources.", + "schema": { + "$ref": "#/definitions/RouteFilterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules/{ruleName}": { + "delete": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Delete", + "x-ms-examples": { + "RouteFilterRuleDelete": { + "$ref": "./examples/RouteFilterRuleDelete.json" + } + }, + "description": "Deletes the specified rule from a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Accepted." + }, + "204": { + "description": "Rule was deleted or not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_Get", + "x-ms-examples": { + "RouteFilterRuleGet": { + "$ref": "./examples/RouteFilterRuleGet.json" + } + }, + "description": "Gets the specified rule from a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the rule." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_CreateOrUpdate", + "x-ms-examples": { + "RouteFilterRuleCreate": { + "$ref": "./examples/RouteFilterRuleCreate.json" + } + }, + "description": "Creates or updates a route in the specified route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "name": "ruleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter rule." + }, + { + "name": "routeFilterRuleParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Parameters supplied to the create or update route filter rule operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route Filter Rule resource.", + "schema": { + "$ref": "#/definitions/RouteFilterRule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeFilters/{routeFilterName}/routeFilterRules": { + "get": { + "tags": [ + "RouteFilterRules" + ], + "operationId": "RouteFilterRules_ListByRouteFilter", + "x-ms-examples": { + "RouteFilterRuleListByRouteFilter": { + "$ref": "./examples/RouteFilterRuleListByRouteFilter.json" + } + }, + "description": "Gets all RouteFilterRules in a route filter.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeFilterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route filter." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route Filter Rule resources.", + "schema": { + "$ref": "#/definitions/RouteFilterRuleListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "RouteFilterRulePropertiesFormat": { + "required": [ + "access", + "routeFilterRuleType", + "communities" + ], + "properties": { + "access": { + "$ref": "./network.json#/definitions/Access", + "description": "The access type of the rule." + }, + "routeFilterRuleType": { + "type": "string", + "description": "The rule type of the rule.", + "enum": [ + "Community" + ], + "x-ms-enum": { + "name": "RouteFilterRuleType", + "modelAsString": true + } + }, + "communities": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The collection for bgp community values to filter on. e.g. ['12076:5010','12076:5020']." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route filter rule resource." + } + }, + "description": "Route Filter Rule Resource." + }, + "RouteFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterRulePropertiesFormat", + "description": "Properties of the route filter rule." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Rule Resource." + }, + "PatchRouteFilterRule": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterRulePropertiesFormat", + "description": "Properties of the route filter rule." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Rule Resource." + }, + "RouteFilterPropertiesFormat": { + "properties": { + "rules": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "Collection of RouteFilterRules contained within a route filter." + }, + "peerings": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeering" + }, + "description": "A collection of references to express route circuit peerings." + }, + "ipv6Peerings": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./expressRouteCircuit.json#/definitions/ExpressRouteCircuitPeering" + }, + "description": "A collection of references to express route circuit ipv6 peerings." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route filter resource." + } + }, + "description": "Route Filter Resource." + }, + "RouteFilter": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterPropertiesFormat", + "description": "Properties of the route filter." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Route Filter Resource." + }, + "PatchRouteFilter": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteFilterPropertiesFormat", + "description": "Properties of the route filter." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route Filter Resource." + }, + "RouteFilterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilter" + }, + "description": "A list of route filters in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteFilters API service call." + }, + "RouteFilterRuleListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteFilterRule" + }, + "description": "A list of RouteFilterRules in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteFilterRules API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/routeTable.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/routeTable.json new file mode 100644 index 000000000000..016cf78edff2 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/routeTable.json @@ -0,0 +1,755 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}": { + "delete": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_Delete", + "description": "Deletes the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "200": { + "description": "Request successful. Operation to delete was accepted." + }, + "202": { + "description": "Accepted. If route table not found returned synchronously, otherwise if found returned asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete route table": { + "$ref": "./examples/RouteTableDelete.json" + } + } + }, + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_Get", + "description": "Gets the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get route table": { + "$ref": "./examples/RouteTableGet.json" + } + } + }, + "put": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_CreateOrUpdate", + "description": "Create or updates a route table in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RouteTable" + }, + "description": "Parameters supplied to the create or update route table operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create route table": { + "$ref": "./examples/RouteTableCreate.json" + }, + "Create route table with route": { + "$ref": "./examples/RouteTableCreateWithRoute.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_UpdateTags", + "description": "Updates a route table tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update route table tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting RouteTable resource.", + "schema": { + "$ref": "#/definitions/RouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update route table tags": { + "$ref": "./examples/RouteTableUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables": { + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_List", + "description": "Gets all route tables in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of RouteTable resources.", + "schema": { + "$ref": "#/definitions/RouteTableListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List route tables in resource group": { + "$ref": "./examples/RouteTableList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/routeTables": { + "get": { + "tags": [ + "RouteTables" + ], + "operationId": "RouteTables_ListAll", + "description": "Gets all route tables in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of RouteTable resources.", + "schema": { + "$ref": "#/definitions/RouteTableListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all route tables": { + "$ref": "./examples/RouteTableListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes/{routeName}": { + "delete": { + "tags": [ + "Routes" + ], + "operationId": "Routes_Delete", + "description": "Deletes the specified route from a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Accepted." + }, + "204": { + "description": "Route was deleted or not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete route": { + "$ref": "./examples/RouteTableRouteDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Routes" + ], + "operationId": "Routes_Get", + "description": "Gets the specified route from a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get route": { + "$ref": "./examples/RouteTableRouteGet.json" + } + } + }, + "put": { + "tags": [ + "Routes" + ], + "operationId": "Routes_CreateOrUpdate", + "description": "Creates or updates a route in the specified route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "name": "routeName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route." + }, + { + "name": "routeParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Route" + }, + "description": "Parameters supplied to the create or update route operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Route resource.", + "schema": { + "$ref": "#/definitions/Route" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create route": { + "$ref": "./examples/RouteTableRouteCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/routeTables/{routeTableName}/routes": { + "get": { + "tags": [ + "Routes" + ], + "operationId": "Routes_List", + "description": "Gets all routes in a route table.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the route table." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Route resources.", + "schema": { + "$ref": "#/definitions/RouteListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List routes": { + "$ref": "./examples/RouteTableRouteList.json" + } + } + } + } + }, + "definitions": { + "RoutePropertiesFormat": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "The destination CIDR to which the route applies." + }, + "nextHopType": { + "$ref": "#/definitions/RouteNextHopType", + "description": "The type of Azure hop the packet should be sent to." + }, + "nextHopIpAddress": { + "type": "string", + "description": "The IP address packets should be forwarded to. Next hop values are only allowed in routes where the next hop type is VirtualAppliance." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route resource." + } + }, + "required": [ + "nextHopType" + ], + "description": "Route resource." + }, + "Route": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoutePropertiesFormat", + "description": "Properties of the route." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Route resource." + }, + "RouteTablePropertiesFormat": { + "properties": { + "routes": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + }, + "description": "Collection of routes contained within a route table." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "disableBgpRoutePropagation": { + "type": "boolean", + "description": "Whether to disable the routes learned by BGP on that route table. True means disable." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the route table resource." + } + }, + "description": "Route Table resource." + }, + "RouteTable": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RouteTablePropertiesFormat", + "description": "Properties of the route table." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Route table resource." + }, + "RouteTableListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RouteTable" + }, + "description": "A list of route tables in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRouteTable API service call." + }, + "RouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Route" + }, + "description": "A list of routes in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListRoute API service call." + }, + "RouteNextHopType": { + "type": "string", + "description": "The type of Azure hop the packet should be sent to.", + "enum": [ + "VirtualNetworkGateway", + "VnetLocal", + "Internet", + "VirtualAppliance", + "None" + ], + "x-ms-enum": { + "name": "RouteNextHopType", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/securityPartnerProvider.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/securityPartnerProvider.json new file mode 100644 index 000000000000..237ad04f81aa --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/securityPartnerProvider.json @@ -0,0 +1,441 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders/{securityPartnerProviderName}": { + "delete": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_Delete", + "description": "Deletes the specified Security Partner Provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Security Partner Provider": { + "$ref": "./examples/SecurityPartnerProviderDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_Get", + "description": "Gets the specified Security Partner Provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Security Partner Provider": { + "$ref": "./examples/SecurityPartnerProviderGet.json" + } + } + }, + "put": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_CreateOrUpdate", + "description": "Creates or updates the specified Security Partner Provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + }, + "description": "Parameters supplied to the create or update Security Partner Provider operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Security Partner Provider": { + "$ref": "./examples/SecurityPartnerProviderPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_UpdateTags", + "description": "Updates tags of a Security Partner Provider resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "securityPartnerProviderName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Security Partner Provider." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update Security Partner Provider tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting SecurityPartnerProvider resource.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProvider" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Security Partner Provider Tags": { + "$ref": "./examples/SecurityPartnerProviderUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/securityPartnerProviders": { + "get": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_ListByResourceGroup", + "description": "Lists all Security Partner Providers in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of SecurityPartnerProvider resources.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Security Partner Providers for a given resource group": { + "$ref": "./examples/SecurityPartnerProviderListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/securityPartnerProviders": { + "get": { + "tags": [ + "SecurityPartnerProviders" + ], + "operationId": "SecurityPartnerProviders_List", + "description": "Gets all the Security Partner Providers in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of SecurityPartnerProvider resources.", + "schema": { + "$ref": "#/definitions/SecurityPartnerProviderListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all Security Partner Providers for a given subscription": { + "$ref": "./examples/SecurityPartnerProviderListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "SecurityPartnerProviderPropertiesFormat": { + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the Security Partner Provider resource." + }, + "securityProviderName": { + "description": "The security provider name.", + "$ref": "#/definitions/SecurityPartnerProvidersecurityProviderName" + }, + "connectionStatus": { + "readOnly": true, + "description": "The connection status with the Security Partner Provider.", + "$ref": "#/definitions/SecurityPartnerProviderConnectionStatus" + }, + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The virtualHub to which the Security Partner Provider belongs." + } + }, + "description": "Properties of the Security Partner Provider." + }, + "SecurityPartnerProvider": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecurityPartnerProviderPropertiesFormat", + "description": "Properties of the Security Partner Provider." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Security Partner Provider resource." + }, + "SecurityPartnerProviderListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityPartnerProvider" + }, + "description": "List of Security Partner Providers in a resource group." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListSecurityPartnerProviders API service call." + }, + "SecurityPartnerProvidersecurityProviderName": { + "type": "string", + "description": "The Security Providers.", + "enum": [ + "ZScaler", + "IBoss", + "Checkpoint" + ], + "x-ms-enum": { + "name": "SecurityProviderName", + "modelAsString": true + } + }, + "SecurityPartnerProviderConnectionStatus": { + "type": "string", + "description": "The current state of the connection with Security Partner Provider.", + "readOnly": true, + "enum": [ + "Unknown", + "PartiallyConnected", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "SecurityPartnerProviderConnectionStatus", + "modelAsString": true + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceCommunity.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceCommunity.json new file mode 100644 index 000000000000..525af7ae8bad --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceCommunity.json @@ -0,0 +1,158 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/bgpServiceCommunities": { + "get": { + "tags": [ + "BgpServiceCommunities" + ], + "operationId": "BgpServiceCommunities_List", + "x-ms-examples": { + "ServiceCommunityList": { + "$ref": "./examples/ServiceCommunityList.json" + } + }, + "description": "Gets all the available bgp service communities.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of BgpServiceCommunity resources.", + "schema": { + "$ref": "#/definitions/BgpServiceCommunityListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "BGPCommunity": { + "properties": { + "serviceSupportedRegion": { + "type": "string", + "description": "The region which the service support. e.g. For O365, region is Global." + }, + "communityName": { + "type": "string", + "description": "The name of the bgp community. e.g. Skype." + }, + "communityValue": { + "type": "string", + "description": "The value of the bgp community. For more information: https://docs.microsoft.com/en-us/azure/expressroute/expressroute-routing." + }, + "communityPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The prefixes that the bgp community contains." + }, + "isAuthorizedToUse": { + "type": "boolean", + "description": "Customer is authorized to use bgp community or not." + }, + "serviceGroup": { + "type": "string", + "description": "The service group of the bgp community contains." + } + }, + "description": "Contains bgp community information offered in Service Community resources." + }, + "BgpServiceCommunityPropertiesFormat": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the bgp community. e.g. Skype." + }, + "bgpCommunities": { + "type": "array", + "items": { + "$ref": "#/definitions/BGPCommunity" + }, + "description": "A list of bgp communities." + } + }, + "description": "Properties of Service Community." + }, + "BgpServiceCommunity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BgpServiceCommunityPropertiesFormat", + "description": "Properties of the BGP service community." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Service Community Properties." + }, + "BgpServiceCommunityListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpServiceCommunity" + }, + "description": "A list of service community resources." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListServiceCommunity API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceEndpointPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceEndpointPolicy.json new file mode 100644 index 000000000000..623bbddffcb5 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceEndpointPolicy.json @@ -0,0 +1,742 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}": { + "delete": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_Delete", + "description": "Deletes the specified service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_Get", + "description": "Gets the specified service Endpoint Policies in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get service endPoint Policy": { + "$ref": "./examples/ServiceEndpointPolicyGet.json" + } + } + }, + "put": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_CreateOrUpdate", + "description": "Creates or updates a service Endpoint Policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + }, + "description": "Parameters supplied to the create or update service endpoint policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyCreate.json" + }, + "Create service endpoint policy with definition": { + "$ref": "./examples/ServiceEndpointPolicyCreateWithDefinition.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_UpdateTags", + "description": "Updates tags of a service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update service endpoint policy tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicy resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update service endpoint policy tags": { + "$ref": "./examples/ServiceEndpointPolicyUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ServiceEndpointPolicies": { + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_List", + "description": "Gets all the service endpoint policies in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies": { + "get": { + "tags": [ + "ServiceEndpointPolicies" + ], + "operationId": "ServiceEndpointPolicies_ListByResourceGroup", + "description": "Gets all service endpoint Policies in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicy resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List resource group service endpoint policies": { + "$ref": "./examples/ServiceEndpointPolicyList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions/{serviceEndpointPolicyDefinitionName}": { + "delete": { + "tags": [ + "ServiceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_Delete", + "description": "Deletes the specified ServiceEndpoint policy definitions.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Service Endpoint Policy." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete service endpoint policy definitions from service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "serviceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_Get", + "description": "Get the specified service endpoint policy definitions from service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy name." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get service endpoint definition in service endpoint policy": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionGet.json" + } + } + }, + "put": { + "tags": [ + "serviceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_CreateOrUpdate", + "description": "Creates or updates a service endpoint policy definition in the specified service endpoint policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy." + }, + { + "name": "serviceEndpointPolicyDefinitionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy definition name." + }, + { + "name": "ServiceEndpointPolicyDefinitions", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "Parameters supplied to the create or update service endpoint policy operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ServiceEndpointPolicyDefinition resource.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create service endpoint policy definition": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/serviceEndpointPolicies/{serviceEndpointPolicyName}/serviceEndpointPolicyDefinitions": { + "get": { + "tags": [ + "ServiceEndpointPolicyDefinitions" + ], + "operationId": "ServiceEndpointPolicyDefinitions_ListByResourceGroup", + "description": "Gets all service endpoint policy definitions in a service end point policy.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "serviceEndpointPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the service endpoint policy name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of ServiceEndpointPolicyDefinition resources.", + "schema": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List service endpoint definitions in service end point policy": { + "$ref": "./examples/ServiceEndpointPolicyDefinitionList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServiceEndpointPolicyDefinitionPropertiesFormat": { + "properties": { + "description": { + "type": "string", + "description": "A description for this rule. Restricted to 140 chars." + }, + "service": { + "type": "string", + "description": "Service endpoint name." + }, + "serviceResources": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of service resources." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service endpoint policy definition resource." + } + }, + "description": "Service Endpoint policy definition resource." + }, + "ServiceEndpointPolicyDefinition": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceEndpointPolicyDefinitionPropertiesFormat", + "description": "Properties of the service endpoint policy definition." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Service Endpoint policy definitions." + }, + "ServiceEndpointPolicyDefinitionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "The service endpoint policy definition in a service endpoint policy." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListServiceEndpointPolicyDefinition API service call. Retrieves all service endpoint policy definition that belongs to a service endpoint policy." + }, + "ServiceEndpointPolicyPropertiesFormat": { + "properties": { + "serviceEndpointPolicyDefinitions": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicyDefinition" + }, + "description": "A collection of service endpoint policy definitions of the service endpoint policy." + }, + "subnets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./virtualNetwork.json#/definitions/Subnet" + }, + "description": "A collection of references to subnets." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "The resource GUID property of the service endpoint policy resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service endpoint policy resource." + } + }, + "description": "Service Endpoint Policy resource." + }, + "ServiceEndpointPolicy": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceEndpointPolicyPropertiesFormat", + "description": "Properties of the service end point policy." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Service End point policy resource." + }, + "ServiceEndpointPolicyListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPolicy" + }, + "description": "A list of ServiceEndpointPolicy resources." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListServiceEndpointPolicies API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceTags.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceTags.json new file mode 100644 index 000000000000..ac1b66147214 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/serviceTags.json @@ -0,0 +1,166 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/serviceTags": { + "get": { + "operationId": "ServiceTags_List", + "description": "Gets a list of service tag information resources.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location that will be used as a reference for version (not as a filter based on location, you will get the list of service tags with prefix details across all regions but limited to the cloud that your subscription belongs to)." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns a list of service tag information resources.", + "schema": { + "$ref": "#/definitions/ServiceTagsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get list of service tags": { + "$ref": "./examples/ServiceTagsList.json" + } + } + } + } + }, + "definitions": { + "ServiceTagsListResult": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the cloud." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The ID of the cloud." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The azure resource type." + }, + "changeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number." + }, + "cloud": { + "type": "string", + "readOnly": true, + "description": "The name of the cloud." + }, + "values": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceTagInformation" + }, + "readOnly": true, + "description": "The list of service tag information resources." + } + }, + "description": "Response for the ListServiceTags API service call." + }, + "ServiceTagInformation": { + "properties": { + "properties": { + "$ref": "#/definitions/ServiceTagInformationPropertiesFormat", + "readOnly": true, + "description": "Properties of the service tag information." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of service tag." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "The ID of service tag." + } + }, + "description": "The service tag information." + }, + "ServiceTagInformationPropertiesFormat": { + "properties": { + "changeNumber": { + "type": "string", + "readOnly": true, + "description": "The iteration number of service tag." + }, + "region": { + "type": "string", + "readOnly": true, + "description": "The region of service tag." + }, + "systemService": { + "type": "string", + "readOnly": true, + "description": "The name of system service." + }, + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of IP address prefixes." + } + }, + "description": "Properties of the service tag information." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/usage.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/usage.json new file mode 100644 index 000000000000..40ab24a9fdb6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/usage.json @@ -0,0 +1,160 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/locations/{location}/usages": { + "get": { + "tags": [ + "Usages" + ], + "operationId": "Usages_List", + "description": "List network usages for a subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location where resource usage is queried.", + "pattern": "^[-\\w\\._ ]+$" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Usage resources.", + "schema": { + "$ref": "#/definitions/UsagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List usages": { + "$ref": "./examples/UsageList.json" + }, + "List usages spaced location": { + "$ref": "./examples/UsageListSpacedLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "A string describing the resource name." + }, + "localizedValue": { + "type": "string", + "description": "A localized string describing the resource name." + } + }, + "description": "The usage names." + }, + "Usage": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Resource identifier." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "type": "integer", + "format": "int64", + "description": "The current value of the usage." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The limit of usage." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "The network resource usage." + }, + "UsagesListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list network resource usages." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "The list usages operation response." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetwork.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetwork.json new file mode 100644 index 000000000000..783bab0768f8 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetwork.json @@ -0,0 +1,1965 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}": { + "delete": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_Delete", + "description": "Deletes the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Delete virtual network": { + "$ref": "./examples/VirtualNetworkDelete.json" + } + } + }, + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_Get", + "description": "Gets the specified virtual network by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get virtual network": { + "$ref": "./examples/VirtualNetworkGet.json" + }, + "Get virtual network with a delegated subnet": { + "$ref": "./examples/VirtualNetworkGetWithSubnetDelegation.json" + }, + "Get virtual network with service association links": { + "$ref": "./examples/VirtualNetworkGetWithServiceAssociationLink.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_CreateOrUpdate", + "description": "Creates or updates a virtual network in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetwork" + }, + "description": "Parameters supplied to the create or update virtual network operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create virtual network": { + "$ref": "./examples/VirtualNetworkCreate.json" + }, + "Create virtual network with subnet": { + "$ref": "./examples/VirtualNetworkCreateSubnet.json" + }, + "Create virtual network with subnet containing address prefixes": { + "$ref": "./examples/VirtualNetworkCreateSubnetWithAddressPrefixes.json" + }, + "Create virtual network with Bgp Communities": { + "$ref": "./examples/VirtualNetworkCreateWithBgpCommunities.json" + }, + "Create virtual network with service endpoints": { + "$ref": "./examples/VirtualNetworkCreateServiceEndpoints.json" + }, + "Create virtual network with service endpoints and service endpoint policy": { + "$ref": "./examples/VirtualNetworkCreateServiceEndpointPolicy.json" + }, + "Create virtual network with delegated subnets": { + "$ref": "./examples/VirtualNetworkCreateSubnetWithDelegation.json" + } + } + }, + "patch": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_UpdateTags", + "description": "Updates a virtual network tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetwork resource.", + "schema": { + "$ref": "#/definitions/VirtualNetwork" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update virtual network tags": { + "$ref": "./examples/VirtualNetworkUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworks": { + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_ListAll", + "description": "Gets all virtual networks in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetwork resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all virtual networks": { + "$ref": "./examples/VirtualNetworkListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks": { + "get": { + "tags": [ + "VirtualNetworks" + ], + "operationId": "VirtualNetworks_List", + "description": "Gets all virtual networks in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetwork resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual networks in resource group": { + "$ref": "./examples/VirtualNetworkList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}": { + "delete": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_Delete", + "description": "Deletes the specified subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete subnet": { + "$ref": "./examples/SubnetDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_Get", + "description": "Gets the specified subnet by virtual network and resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get subnet": { + "$ref": "./examples/SubnetGet.json" + }, + "Get subnet with a delegation": { + "$ref": "./examples/SubnetGetWithDelegation.json" + } + } + }, + "put": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_CreateOrUpdate", + "description": "Creates or updates a subnet in the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "subnetParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Subnet" + }, + "description": "Parameters supplied to the create or update subnet operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting Subnet resource.", + "schema": { + "$ref": "#/definitions/Subnet" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Create subnet": { + "$ref": "./examples/SubnetCreate.json" + }, + "Create subnet with service endpoints": { + "$ref": "./examples/SubnetCreateServiceEndpoint.json" + }, + "Create subnet with a delegation": { + "$ref": "./examples/SubnetCreateWithDelegation.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/PrepareNetworkPolicies": { + "post": { + "operationId": "Subnets_PrepareNetworkPolicies", + "description": "Prepares a subnet by applying network intent policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "prepareNetworkPoliciesRequestParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrepareNetworkPoliciesRequest" + }, + "description": "Parameters supplied to prepare subnet by applying network intent policies." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Preparing subnet by applying network intent policies is successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prepare Network Policies": { + "$ref": "./examples/SubnetPrepareNetworkPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/UnprepareNetworkPolicies": { + "post": { + "operationId": "Subnets_UnprepareNetworkPolicies", + "description": "Unprepares a subnet by removing network intent policies.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "name": "unprepareNetworkPoliciesRequestParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UnprepareNetworkPoliciesRequest" + }, + "description": "Parameters supplied to unprepare subnet to remove network intent policies." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Unpreparing subnet by removing network intent policies is successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Unprepare Network Policies": { + "$ref": "./examples/SubnetUnprepareNetworkPolicies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ResourceNavigationLinks": { + "get": { + "operationId": "ResourceNavigationLinks_List", + "description": "Gets a list of resource navigation links for a subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of resource navigation links for the subnet.", + "schema": { + "$ref": "#/definitions/ResourceNavigationLinksListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Resource Navigation Links": { + "$ref": "./examples/VirtualNetworkGetResourceNavigationLinks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}/ServiceAssociationLinks": { + "get": { + "operationId": "ServiceAssociationLinks_List", + "description": "Gets a list of service association links for a subnet.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "subnetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the subnet." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of service association links for the subnet.", + "schema": { + "$ref": "#/definitions/ServiceAssociationLinksListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Service Association Links": { + "$ref": "./examples/VirtualNetworkGetServiceAssociationLinks.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets": { + "get": { + "tags": [ + "Subnets" + ], + "operationId": "Subnets_List", + "description": "Gets all subnets in a virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Subnet resources.", + "schema": { + "$ref": "#/definitions/SubnetListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List subnets": { + "$ref": "./examples/SubnetList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings/{virtualNetworkPeeringName}": { + "delete": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_Delete", + "description": "Deletes the specified virtual network peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete peering": { + "$ref": "./examples/VirtualNetworkPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_Get", + "description": "Gets the specified virtual network peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get peering": { + "$ref": "./examples/VirtualNetworkPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_CreateOrUpdate", + "description": "Creates or updates a peering in the specified virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "virtualNetworkPeeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "name": "VirtualNetworkPeeringParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "Parameters supplied to the create or update virtual network peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkPeering resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create peering": { + "$ref": "./examples/VirtualNetworkPeeringCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/virtualNetworkPeerings": { + "get": { + "tags": [ + "VirtualNetworkPeerings" + ], + "operationId": "VirtualNetworkPeerings_List", + "description": "Gets all virtual network peerings in a virtual network.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkPeering resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkPeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List peerings": { + "$ref": "./examples/VirtualNetworkPeeringList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/CheckIPAddressAvailability": { + "get": { + "operationId": "VirtualNetworks_CheckIPAddressAvailability", + "description": "Checks whether a private IP address is available for use.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "name": "ipAddress", + "in": "query", + "required": true, + "type": "string", + "description": "The private IP address to be verified." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Private IP address availability and list of other free addresses if the requested one is not available.", + "schema": { + "$ref": "#/definitions/IPAddressAvailabilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Check IP address availability": { + "$ref": "./examples/VirtualNetworkCheckIPAddressAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/usages": { + "get": { + "operationId": "VirtualNetworks_ListUsage", + "description": "Lists usage stats.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Usage stats for vnet.", + "schema": { + "$ref": "#/definitions/VirtualNetworkListUsageResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "VnetGetUsage": { + "$ref": "./examples/VirtualNetworkListUsage.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ServiceAssociationLinkPropertiesFormat": { + "properties": { + "linkedResourceType": { + "type": "string", + "description": "Resource type of the linked resource." + }, + "link": { + "type": "string", + "description": "Link to the external resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service association link resource." + }, + "allowDelete": { + "type": "boolean", + "description": "If true, the resource can be deleted." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + } + }, + "description": "Properties of ServiceAssociationLink." + }, + "ServiceAssociationLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceAssociationLinkPropertiesFormat", + "description": "Resource navigation link properties format." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ServiceAssociationLink resource." + }, + "ResourceNavigationLinkFormat": { + "properties": { + "linkedResourceType": { + "type": "string", + "description": "Resource type of the linked resource." + }, + "link": { + "type": "string", + "description": "Link to the external resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the resource navigation link resource." + } + }, + "description": "Properties of ResourceNavigationLink." + }, + "ResourceNavigationLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ResourceNavigationLinkFormat", + "description": "Resource navigation link properties format." + }, + "name": { + "type": "string", + "description": "Name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Resource navigation link identifier." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ResourceNavigationLink resource." + }, + "ServiceDelegationPropertiesFormat": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service to whom the subnet should be delegated (e.g. Microsoft.Sql/servers)." + }, + "actions": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The actions permitted to the service upon delegation." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service delegation resource." + } + }, + "description": "Properties of a service delegation." + }, + "Delegation": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ServiceDelegationPropertiesFormat", + "description": "Properties of the subnet." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a subnet. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Details the service to which the subnet is delegated." + }, + "SubnetPropertiesFormat": { + "properties": { + "addressPrefix": { + "type": "string", + "description": "The address prefix for the subnet." + }, + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of address prefixes for the subnet." + }, + "networkSecurityGroup": { + "$ref": "./networkSecurityGroup.json#/definitions/NetworkSecurityGroup", + "description": "The reference to the NetworkSecurityGroup resource." + }, + "routeTable": { + "$ref": "./routeTable.json#/definitions/RouteTable", + "description": "The reference to the RouteTable resource." + }, + "natGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Nat gateway associated with this subnet." + }, + "serviceEndpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceEndpointPropertiesFormat" + }, + "description": "An array of service endpoints." + }, + "serviceEndpointPolicies": { + "type": "array", + "items": { + "$ref": "./serviceEndpointPolicy.json#/definitions/ServiceEndpointPolicy" + }, + "description": "An array of service endpoint policies." + }, + "privateEndpoints": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./privateEndpoint.json#/definitions/PrivateEndpoint" + }, + "description": "An array of references to private endpoints." + }, + "ipConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/IPConfiguration" + }, + "description": "An array of references to the network interface IP configurations using subnet." + }, + "ipConfigurationProfiles": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkProfile.json#/definitions/IPConfigurationProfile" + }, + "description": "Array of IP configuration profiles which reference this subnet." + }, + "ipAllocations": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of IpAllocation which reference this subnet." + }, + "resourceNavigationLinks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceNavigationLink" + }, + "description": "An array of references to the external resources using subnet." + }, + "serviceAssociationLinks": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAssociationLink" + }, + "description": "An array of references to services injecting into this subnet." + }, + "delegations": { + "type": "array", + "items": { + "$ref": "#/definitions/Delegation" + }, + "description": "An array of references to the delegations on the subnet." + }, + "purpose": { + "type": "string", + "readOnly": true, + "description": "A read-only string identifying the intention of use for this subnet based on delegations and other user-defined properties." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the subnet resource." + }, + "privateEndpointNetworkPolicies": { + "type": "string", + "description": "Enable or Disable apply network policies on private end point in the subnet." + }, + "privateLinkServiceNetworkPolicies": { + "type": "string", + "description": "Enable or Disable apply network policies on private link service in the subnet." + } + }, + "description": "Properties of the subnet." + }, + "ServiceEndpointPropertiesFormat": { + "properties": { + "service": { + "type": "string", + "description": "The type of the endpoint service." + }, + "locations": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of locations." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the service endpoint resource." + } + }, + "description": "The service endpoint properties." + }, + "VirtualNetworkPeeringPropertiesFormat": { + "properties": { + "allowVirtualNetworkAccess": { + "type": "boolean", + "description": "Whether the VMs in the local virtual network space would be able to access the VMs in remote virtual network space." + }, + "allowForwardedTraffic": { + "type": "boolean", + "description": "Whether the forwarded traffic from the VMs in the local virtual network will be allowed/disallowed in remote virtual network." + }, + "allowGatewayTransit": { + "type": "boolean", + "description": "If gateway links can be used in remote virtual networking to link to this virtual network." + }, + "useRemoteGateways": { + "type": "boolean", + "description": "If remote gateways can be used on this virtual network. If the flag is set to true, and allowGatewayTransit on remote peering is also true, virtual network will use gateways of remote virtual network for transit. Only one peering can have this flag set to true. This flag cannot be set if virtual network already has a gateway." + }, + "remoteVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the remote virtual network. The remote virtual network can be in the same or different region (preview). See here to register for the preview and learn more (https://docs.microsoft.com/en-us/azure/virtual-network/virtual-network-create-peering)." + }, + "remoteAddressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The reference to the remote virtual network address space." + }, + "peeringState": { + "type": "string", + "description": "The status of the virtual network peering.", + "enum": [ + "Initiated", + "Connected", + "Disconnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkPeeringState", + "modelAsString": true + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network peering resource." + } + }, + "description": "Properties of the virtual network peering." + }, + "Subnet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SubnetPropertiesFormat", + "description": "Properties of the subnet." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Subnet in a virtual network resource." + }, + "VirtualNetworkPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPeeringPropertiesFormat", + "description": "Properties of the virtual network peering." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Peerings in a virtual network resource." + }, + "SubnetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "The subnets in a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSubnets API service callRetrieves all subnet that belongs to a virtual network." + }, + "ResourceNavigationLinksListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceNavigationLink" + }, + "description": "The resource navigation links in a subnet." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ResourceNavigationLinks_List operation." + }, + "ServiceAssociationLinksListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ServiceAssociationLink" + }, + "description": "The service association links in a subnet." + }, + "nextLink": { + "type": "string", + "readOnly": true, + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ServiceAssociationLinks_List operation." + }, + "VirtualNetworkPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "The peerings in a virtual network." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListSubnets API service call. Retrieves all subnets that belong to a virtual network." + }, + "VirtualNetworkPropertiesFormat": { + "properties": { + "addressSpace": { + "$ref": "#/definitions/AddressSpace", + "description": "The AddressSpace that contains an array of IP address ranges that can be used by subnets." + }, + "dhcpOptions": { + "$ref": "#/definitions/DhcpOptions", + "description": "The dhcpOptions that contains an array of DNS servers available to VMs deployed in the virtual network." + }, + "subnets": { + "type": "array", + "items": { + "$ref": "#/definitions/Subnet" + }, + "description": "A list of subnets in a Virtual Network." + }, + "virtualNetworkPeerings": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkPeering" + }, + "description": "A list of peerings in a Virtual Network." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resourceGuid property of the Virtual Network resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network resource." + }, + "enableDdosProtection": { + "type": "boolean", + "default": false, + "description": "Indicates if DDoS protection is enabled for all the protected resources in the virtual network. It requires a DDoS protection plan associated with the resource." + }, + "enableVmProtection": { + "type": "boolean", + "default": false, + "description": "Indicates if VM protection is enabled for all the subnets in the virtual network." + }, + "ddosProtectionPlan": { + "$ref": "./network.json#/definitions/SubResource", + "default": null, + "description": "The DDoS protection plan associated with the virtual network." + }, + "bgpCommunities": { + "$ref": "#/definitions/VirtualNetworkBgpCommunities", + "default": null, + "description": "Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET." + }, + "ipAllocations": { + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "Array of IpAllocation which reference this VNET." + } + }, + "description": "Properties of the virtual network." + }, + "VirtualNetwork": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkPropertiesFormat", + "description": "Properties of the virtual network." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Virtual Network resource." + }, + "VirtualNetworkListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetwork" + }, + "description": "A list of VirtualNetwork resources in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworks API service call." + }, + "AddressSpace": { + "properties": { + "addressPrefixes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of address blocks reserved for this virtual network in CIDR notation." + } + }, + "description": "AddressSpace contains an array of IP address ranges that can be used by subnets of the virtual network." + }, + "DhcpOptions": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of DNS servers IP addresses." + } + }, + "description": "DhcpOptions contains an array of DNS servers available to VMs deployed in the virtual network. Standard DHCP option for a subnet overrides VNET DHCP options." + }, + "VirtualNetworkBgpCommunities": { + "properties": { + "virtualNetworkCommunity": { + "type": "string", + "description": "The BGP community associated with the virtual network." + }, + "regionalCommunity": { + "type": "string", + "readOnly": true, + "description": "The BGP community associated with the region of the virtual network." + } + }, + "required": [ + "virtualNetworkCommunity" + ], + "description": "Bgp Communities sent over ExpressRoute with each route corresponding to a prefix in this VNET." + }, + "IPAddressAvailabilityResult": { + "properties": { + "available": { + "type": "boolean", + "description": "Private IP address availability." + }, + "availableIPAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Contains other available private IP addresses if the asked for address is taken." + } + }, + "description": "Response for CheckIPAddressAvailability API service call." + }, + "VirtualNetworkListUsageResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/VirtualNetworkUsage" + }, + "description": "VirtualNetwork usage stats." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the virtual networks GetUsage API service call." + }, + "VirtualNetworkUsage": { + "properties": { + "currentValue": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "Indicates number of IPs used from the Subnet." + }, + "id": { + "type": "string", + "readOnly": true, + "description": "Subnet identifier." + }, + "limit": { + "type": "number", + "format": "double", + "readOnly": true, + "description": "Indicates the size of the subnet." + }, + "name": { + "$ref": "#/definitions/VirtualNetworkUsageName", + "readOnly": true, + "description": "The name containing common and localized value for usage." + }, + "unit": { + "type": "string", + "readOnly": true, + "description": "Usage units. Returns 'Count'." + } + }, + "description": "Usage details for subnet." + }, + "VirtualNetworkUsageName": { + "properties": { + "localizedValue": { + "type": "string", + "readOnly": true, + "description": "Localized subnet size and usage string." + }, + "value": { + "type": "string", + "readOnly": true, + "description": "Subnet size and usage string." + } + }, + "description": "Usage strings container." + }, + "PrepareNetworkPoliciesRequest": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service for which subnet is being prepared for." + }, + "networkIntentPolicyConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkIntentPolicyConfiguration" + }, + "description": "A list of NetworkIntentPolicyConfiguration." + } + }, + "description": "Details of PrepareNetworkPolicies for Subnet." + }, + "UnprepareNetworkPoliciesRequest": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service for which subnet is being unprepared for." + } + }, + "description": "Details of UnprepareNetworkPolicies for Subnet." + }, + "NetworkIntentPolicyConfiguration": { + "properties": { + "networkIntentPolicyName": { + "type": "string", + "description": "The name of the Network Intent Policy for storing in target subscription." + }, + "sourceNetworkIntentPolicy": { + "$ref": "#/definitions/NetworkIntentPolicy", + "description": "Source network intent policy." + } + }, + "description": "Details of NetworkIntentPolicyConfiguration for PrepareNetworkPoliciesRequest." + }, + "NetworkIntentPolicy": { + "properties": { + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Network Intent Policy resource." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetworkGateway.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetworkGateway.json new file mode 100644 index 000000000000..6a6a29585858 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetworkGateway.json @@ -0,0 +1,3717 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}": { + "put": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_CreateOrUpdate", + "description": "Creates or updates a virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + }, + "description": "Parameters supplied to create or update virtual network gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Get", + "description": "Gets the specified virtual network gateway by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayGet.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Delete", + "description": "Deletes the specified virtual network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_UpdateTags", + "description": "Updates a virtual network gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGatewayTags": { + "$ref": "./examples/VirtualNetworkGatewayUpdateTags.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways": { + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_List", + "description": "Gets all virtual network gateways by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGateway resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewaysinResourceGroup": { + "$ref": "./examples/VirtualNetworkGatewayList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/connections": { + "get": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_ListConnections", + "description": "Gets all the connections in a virtual network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayListConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "VirtualNetworkGatewaysListConnections": { + "$ref": "./examples/VirtualNetworkGatewaysListConnections.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/reset": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Reset", + "description": "Resets the primary of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "gatewayVip", + "in": "query", + "required": false, + "type": "string", + "description": "Virtual network gateway vip address supplied to the begin reset of the active-active feature enabled gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation reset the primary of the virtual network gateway.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGateway": { + "$ref": "./examples/VirtualNetworkGatewayReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/resetvpnclientsharedkey": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_ResetVpnClientSharedKey", + "description": "Resets the VPN client shared key of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation reset the vpn client shared key of the virtual network gateway." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVpnClientSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayResetVpnClientSharedKey.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnclientpackage": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_Generatevpnclientpackage", + "description": "Generates VPN client package for P2S client of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientParameters" + }, + "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN client package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateVPNClientPackage": { + "$ref": "./examples/VirtualNetworkGatewayGenerateVpnClientPackage.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/generatevpnprofile": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GenerateVpnProfile", + "description": "Generates VPN profile for P2S client of the virtual network gateway in the specified resource group. Used for IKEV2 and radius based authentication.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientParameters" + }, + "description": "Parameters supplied to the generate virtual network gateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateVirtualNetworkGatewayVPNProfile": { + "$ref": "./examples/VirtualNetworkGatewayGenerateVpnProfile.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnprofilepackageurl": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnProfilePackageUrl", + "description": "Gets pre-generated VPN profile for P2S client of the virtual network gateway in the specified resource group. The profile needs to be generated first using generateVpnProfile.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "type": "string" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayVPNProfilePackageURL": { + "$ref": "./examples/VirtualNetworkGatewayGetVpnProfilePackageUrl.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getBgpPeerStatus": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetBgpPeerStatus", + "description": "The GetBgpPeerStatus operation retrieves the status of all BGP peers.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peer", + "in": "query", + "required": false, + "type": "string", + "description": "The IP address of the peer to retrieve the status of." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of BGP peer statuses.", + "schema": { + "$ref": "#/definitions/BgpPeerStatusListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayBGPPeerStatus": { + "$ref": "./examples/VirtualNetworkGatewayGetBGPPeerStatus.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/supportedvpndevices": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_SupportedVpnDevices", + "description": "Gets a xml format representation for supported vpn devices.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Xml format representation for supported vpn devices.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewaySupportedVPNDevices": { + "$ref": "./examples/VirtualNetworkGatewaySupportedVpnDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getLearnedRoutes": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetLearnedRoutes", + "description": "This operation retrieves a list of routes the virtual network gateway has learned, including routes learned from BGP peers.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of advertised BGP routes.", + "schema": { + "$ref": "#/definitions/GatewayRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayLearnedRoutes": { + "$ref": "./examples/VirtualNetworkGatewayLearnedRoutes.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getAdvertisedRoutes": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetAdvertisedRoutes", + "description": "This operation retrieves a list of routes the virtual network gateway is advertising to the specified peer.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "peer", + "in": "query", + "required": true, + "type": "string", + "description": "The IP address of the peer." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of learned BGP routes.", + "schema": { + "$ref": "#/definitions/GatewayRouteListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayAdvertisedRoutes": { + "$ref": "./examples/VirtualNetworkGatewayGetAdvertisedRoutes.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/setvpnclientipsecparameters": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_SetVpnclientIpsecParameters", + "description": "The Set VpnclientIpsecParameters operation sets the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "vpnclientIpsecParams", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + }, + "description": "Parameters supplied to the Begin Set vpnclient ipsec parameters of Virtual Network Gateway P2S client operation through Network resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation sets the specified vpnclient ipsec parameters for P2S client of the virtual network gateway.", + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Set VirtualNetworkGateway VpnClientIpsecParameters": { + "$ref": "./examples/VirtualNetworkGatewaySetVpnClientIpsecParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getvpnclientipsecparameters": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnclientIpsecParameters", + "description": "The Get VpnclientIpsecParameters operation retrieves information about the vpnclient ipsec policy for P2S client of virtual network gateway in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the set vpnclient ipsec parameters for P2S client of VirtualNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/VpnClientIPsecParameters" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Get VirtualNetworkGateway VpnClientIpsecParameters": { + "$ref": "./examples/VirtualNetworkGatewayGetVpnClientIpsecParameters.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/vpndeviceconfigurationscript": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_VpnDeviceConfigurationScript", + "description": "Gets a xml format representation for vpn device configuration script.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection for which the configuration script is generated." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnDeviceScriptParameters" + }, + "description": "Parameters supplied to the generate vpn device script operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Xml format representation for vpn device configuration script.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVPNDeviceConfigurationScript": { + "$ref": "./examples/VirtualNetworkGatewayVpnDeviceConfigurationScript.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/startPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_StartPacketCapture", + "description": "Starts packet capture on virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStartParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to start packet capture on gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture started on virtual network gateway.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Start packet capture on virtual network gateway without filter": { + "$ref": "./examples/VirtualNetworkGatewayStartPacketCapture.json" + }, + "Start packet capture on virtual network gateway with filter": { + "$ref": "./examples/VirtualNetworkGatewayStartPacketCaptureFilterData.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/stopPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_StopPacketCapture", + "description": "Stops packet capture on virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStopParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to stop packet capture on gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture stopped on virtual network gateway.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Stop packet capture on virtual network gateway": { + "$ref": "./examples/VirtualNetworkGatewayStopPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}": { + "put": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_CreateOrUpdate", + "description": "Creates or updates a virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + }, + "description": "Parameters supplied to the create or update virtual network gateway connection operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CreateVirtualNetworkGatewayConnection_S2S": { + "$ref": "./examples/VirtualNetworkGatewayConnectionCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_Get", + "description": "Gets the specified virtual network gateway connection by resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionGet.json" + } + } + }, + "delete": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_Delete", + "description": "Deletes the specified virtual network Gateway connection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteVirtualNetworkGatewayConnection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_UpdateTags", + "description": "Updates a virtual network gateway connection tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update virtual network gateway connection tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkGatewayConnection resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateVirtualNetworkGatewayConnectionTags": { + "$ref": "./examples/VirtualNetworkGatewayConnectionUpdateTags.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey": { + "put": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_SetSharedKey", + "description": "The Put VirtualNetworkGatewayConnectionSharedKey operation sets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + }, + "description": "Parameters supplied to the Begin Set Virtual Network Gateway connection Shared key operation throughNetwork resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request successful. The operation returns the resulting ConnectionSharedKey resource.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting ConnectionSharedKey resource.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SetVirtualNetworkGatewayConnectionSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayConnectionSetSharedKey.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_GetSharedKey", + "description": "The Get VirtualNetworkGatewayConnectionSharedKey operation retrieves information about the specified virtual network gateway connection shared key through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection shared key name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of VirtualNetworkGatewayConnection resources.", + "schema": { + "$ref": "#/definitions/ConnectionSharedKey" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayConnectionSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayConnectionGetSharedKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections": { + "get": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_List", + "description": "The List VirtualNetworkGatewayConnections operation retrieves all the virtual network gateways connections created.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation resets the virtual network gateway connection shared key.", + "schema": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVirtualNetworkGatewayConnectionsinResourceGroup": { + "$ref": "./examples/VirtualNetworkGatewayConnectionsList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/sharedkey/reset": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_ResetSharedKey", + "description": "The VirtualNetworkGatewayConnectionResetSharedKey operation resets the virtual network gateway connection shared key for passed virtual network gateway connection in the specified resource group through Network resource provider.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual network gateway connection reset shared key Name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionResetSharedKey" + }, + "description": "Parameters supplied to the begin reset virtual network gateway connection shared key operation through network resource provider." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation sets the virtual network gateway connection shared key.", + "schema": { + "$ref": "#/definitions/ConnectionResetSharedKey" + } + }, + "202": { + "description": "Request successful. The operation sets the virtual network gateway connection shared key." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVirtualNetworkGatewayConnectionSharedKey": { + "$ref": "./examples/VirtualNetworkGatewayConnectionResetSharedKey.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/startPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_StartPacketCapture", + "description": "Starts packet capture on virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway connection." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStartParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to start packet capture on gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture started on virtual network gateway connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Start packet capture on virtual network gateway connection without filter": { + "$ref": "./examples/VirtualNetworkGatewayConnectionStartPacketCapture.json" + }, + "Start packet capture on virtual network gateway connection with filter": { + "$ref": "./examples/VirtualNetworkGatewayConnectionStartPacketCaptureFilterData.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/connections/{virtualNetworkGatewayConnectionName}/stopPacketCapture": { + "post": { + "tags": [ + "VirtualNetworkGatewayConnections" + ], + "operationId": "VirtualNetworkGatewayConnections_StopPacketCapture", + "description": "Stops packet capture on virtual network gateway connection in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway Connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnPacketCaptureStopParameters" + }, + "description": "Virtual network gateway packet capture parameters supplied to stop packet capture on gateway connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "200": { + "description": "Request successful. The operation packet capture stopped on virtual network gateway connection.", + "schema": { + "type": "string" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Stop packet capture on virtual network gateway connection": { + "$ref": "./examples/VirtualNetworkGatewayConnectionStopPacketCapture.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways/{localNetworkGatewayName}": { + "put": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_CreateOrUpdate", + "description": "Creates or updates a local network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + }, + "description": "Parameters supplied to the create or update local network gateway operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Create successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "200": { + "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CreateLocalNetworkGateway": { + "$ref": "./examples/LocalNetworkGatewayCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_Get", + "description": "Gets the specified local network gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetLocalNetworkGateway": { + "$ref": "./examples/LocalNetworkGatewayGet.json" + } + } + }, + "delete": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_Delete", + "description": "Deletes the specified local network gateway.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "Delete successful." + }, + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DeleteLocalNetworkGateway": { + "$ref": "./examples/LocalNetworkGatewayDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "patch": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_UpdateTags", + "description": "Updates a local network gateway tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "localNetworkGatewayName", + "in": "path", + "required": true, + "minLength": 1, + "type": "string", + "description": "The name of the local network gateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update local network gateway tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting LocalNetworkGateway resource.", + "schema": { + "$ref": "#/definitions/LocalNetworkGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateLocalNetworkGatewayTags": { + "$ref": "./examples/LocalNetworkGatewayUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/localNetworkGateways": { + "get": { + "tags": [ + "LocalNetworkGateways" + ], + "operationId": "LocalNetworkGateways_List", + "description": "Gets all the local network gateways in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of LocalNetworkGateway resources.", + "schema": { + "$ref": "#/definitions/LocalNetworkGatewayListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListLocalNetworkGateways": { + "$ref": "./examples/LocalNetworkGatewayList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/getVpnClientConnectionHealth": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_GetVpnclientConnectionHealth", + "description": "Get VPN client connection health detail per P2S client connection of the virtual network gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "List of VPN client connection health details.", + "schema": { + "$ref": "#/definitions/VpnClientConnectionHealthDetailListResult" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GetVirtualNetworkGatewayVpnclientConnectionHealth": { + "$ref": "./examples/VirtualNetworkGatewayGetVpnclientConnectionHealth.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkGateways/{virtualNetworkGatewayName}/disconnectVirtualNetworkGatewayVpnConnections": { + "post": { + "tags": [ + "VirtualNetworkGateways" + ], + "operationId": "VirtualNetworkGateways_DisconnectVirtualNetworkGatewayVpnConnections", + "description": "Disconnect vpn connections of virtual network gateway in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualNetworkGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network gateway." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "./virtualWan.json#/definitions/P2SVpnConnectionRequest" + }, + "description": "The parameters are supplied to disconnect vpn connections." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation disconnects the requested vpn connections." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Disconnect VpnConnections from Virtual Network Gateway": { + "$ref": "./examples/VirtualNetworkGatewaysDisconnectP2sVpnConnections.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "VirtualNetworkGatewayIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the public IP resource." + }, + "privateIPAddress": { + "readOnly": true, + "type": "string", + "description": "Private IP Address for this gateway." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway IP configuration resource." + } + }, + "description": "Properties of VirtualNetworkGatewayIPConfiguration." + }, + "VirtualNetworkGatewayIPConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayIPConfigurationPropertiesFormat", + "description": "Properties of the virtual network gateway ip configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IP configuration for virtual network gateway." + }, + "VirtualNetworkGatewayPropertiesFormat": { + "properties": { + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayIPConfiguration" + }, + "description": "IP configurations for virtual network gateway." + }, + "gatewayType": { + "type": "string", + "description": "The type of this virtual network gateway.", + "enum": [ + "Vpn", + "ExpressRoute" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayType", + "modelAsString": true + } + }, + "vpnType": { + "type": "string", + "description": "The type of this virtual network gateway.", + "enum": [ + "PolicyBased", + "RouteBased" + ], + "x-ms-enum": { + "name": "VpnType", + "modelAsString": true + } + }, + "vpnGatewayGeneration": { + "type": "string", + "description": "The generation for this VirtualNetworkGateway. Must be None if gatewayType is not VPN.", + "enum": [ + "None", + "Generation1", + "Generation2" + ], + "x-ms-enum": { + "name": "VpnGatewayGeneration", + "modelAsString": true + } + }, + "enableBgp": { + "type": "boolean", + "description": "Whether BGP is enabled for this virtual network gateway or not." + }, + "enablePrivateIpAddress": { + "type": "boolean", + "description": "Whether private IP needs to be enabled on this gateway for connections or not." + }, + "activeActive": { + "type": "boolean", + "description": "ActiveActive flag." + }, + "gatewayDefaultSite": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to the LocalNetworkGateway resource which represents local network site having default routes. Assign Null value in case of removing existing default site setting." + }, + "sku": { + "$ref": "#/definitions/VirtualNetworkGatewaySku", + "description": "The reference to the VirtualNetworkGatewaySku resource which represents the SKU selected for Virtual network gateway." + }, + "vpnClientConfiguration": { + "$ref": "#/definitions/VpnClientConfiguration", + "description": "The reference to the VpnClientConfiguration resource which represents the P2S VpnClient configurations." + }, + "bgpSettings": { + "$ref": "#/definitions/BgpSettings", + "description": "Virtual network gateway's BGP speaker settings." + }, + "customRoutes": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents the custom routes address space specified by the customer for virtual network gateway and VpnClient." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the virtual network gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway resource." + }, + "enableDnsForwarding": { + "type": "boolean", + "description": "Whether dns forwarding is enabled or not." + }, + "inboundDnsForwardingEndpoint": { + "type": "string", + "readOnly": true, + "description": "The IP address allocated by the gateway to which dns requests can be sent." + } + }, + "description": "VirtualNetworkGateway properties." + }, + "VpnClientRootCertificatePropertiesFormat": { + "properties": { + "publicCertData": { + "type": "string", + "description": "The certificate public data." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN client root certificate resource." + } + }, + "required": [ + "publicCertData" + ], + "description": "Properties of SSL certificates of application gateway." + }, + "VpnClientRootCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnClientRootCertificatePropertiesFormat", + "description": "Properties of the vpn client root certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "properties" + ], + "description": "VPN client root certificate of virtual network gateway." + }, + "VpnClientRevokedCertificatePropertiesFormat": { + "properties": { + "thumbprint": { + "type": "string", + "description": "The revoked VPN client certificate thumbprint." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN client revoked certificate resource." + } + }, + "description": "Properties of the revoked VPN client certificate of virtual network gateway." + }, + "VpnClientRevokedCertificate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnClientRevokedCertificatePropertiesFormat", + "description": "Properties of the vpn client revoked certificate." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VPN client revoked certificate of virtual network gateway." + }, + "RadiusServer": { + "properties": { + "radiusServerAddress": { + "type": "string", + "description": "The address of this radius server." + }, + "radiusServerScore": { + "type": "integer", + "format": "int64", + "description": "The initial score assigned to this radius server." + }, + "radiusServerSecret": { + "type": "string", + "description": "The secret used for this radius server." + } + }, + "required": [ + "radiusServerAddress" + ], + "description": "Radius Server Settings." + }, + "VpnClientConfiguration": { + "properties": { + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents Address space for P2S VpnClient." + }, + "vpnClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientRootCertificate" + }, + "description": "VpnClientRootCertificate for virtual network gateway." + }, + "vpnClientRevokedCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientRevokedCertificate" + }, + "description": "VpnClientRevokedCertificate for Virtual network gateway." + }, + "vpnClientProtocols": { + "type": "array", + "items": { + "type": "string", + "description": "VPN client protocol enabled for the virtual network gateway.", + "enum": [ + "IkeV2", + "SSTP", + "OpenVPN" + ], + "x-ms-enum": { + "name": "VpnClientProtocol", + "modelAsString": true + } + }, + "description": "VpnClientProtocols for Virtual network gateway." + }, + "vpnClientIpsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "VpnClientIpsecPolicies for virtual network gateway P2S client." + }, + "radiusServerAddress": { + "type": "string", + "description": "The radius server address property of the VirtualNetworkGateway resource for vpn client connection." + }, + "radiusServerSecret": { + "type": "string", + "description": "The radius secret property of the VirtualNetworkGateway resource for vpn client connection." + }, + "radiusServers": { + "type": "array", + "items": { + "$ref": "#/definitions/RadiusServer" + }, + "description": "The radiusServers property for multiple radius server configuration." + }, + "aadTenant": { + "type": "string", + "description": "The AADTenant property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication." + }, + "aadAudience": { + "type": "string", + "description": "The AADAudience property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication." + }, + "aadIssuer": { + "type": "string", + "description": "The AADIssuer property of the VirtualNetworkGateway resource for vpn client connection used for AAD authentication." + } + }, + "description": "VpnClientConfiguration for P2S client." + }, + "VirtualNetworkGatewaySku": { + "properties": { + "name": { + "type": "string", + "description": "Gateway SKU name.", + "enum": [ + "Basic", + "HighPerformance", + "Standard", + "UltraPerformance", + "VpnGw1", + "VpnGw2", + "VpnGw3", + "VpnGw4", + "VpnGw5", + "VpnGw1AZ", + "VpnGw2AZ", + "VpnGw3AZ", + "VpnGw4AZ", + "VpnGw5AZ", + "ErGw1AZ", + "ErGw2AZ", + "ErGw3AZ" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewaySkuName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Gateway SKU tier.", + "enum": [ + "Basic", + "HighPerformance", + "Standard", + "UltraPerformance", + "VpnGw1", + "VpnGw2", + "VpnGw3", + "VpnGw4", + "VpnGw5", + "VpnGw1AZ", + "VpnGw2AZ", + "VpnGw3AZ", + "VpnGw4AZ", + "VpnGw5AZ", + "ErGw1AZ", + "ErGw2AZ", + "ErGw3AZ" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewaySkuTier", + "modelAsString": true + } + }, + "capacity": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The capacity." + } + }, + "description": "VirtualNetworkGatewaySku details." + }, + "BgpSettings": { + "properties": { + "asn": { + "type": "integer", + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "The BGP speaker's ASN." + }, + "bgpPeeringAddress": { + "type": "string", + "description": "The BGP peering address and BGP identifier of this BGP speaker." + }, + "peerWeight": { + "type": "integer", + "format": "int32", + "description": "The weight added to routes learned from this BGP speaker." + }, + "bgpPeeringAddresses": { + "type": "array", + "items": { + "$ref": "#/definitions/IPConfigurationBgpPeeringAddress" + }, + "description": "BGP peering address with IP configuration ID for virtual network gateway." + } + }, + "description": "BGP settings details." + }, + "BgpPeerStatus": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The virtual network gateway's local address." + }, + "neighbor": { + "type": "string", + "readOnly": true, + "description": "The remote BGP peer." + }, + "asn": { + "type": "integer", + "format": "int64", + "readOnly": true, + "minimum": 0, + "maximum": 4294967295, + "description": "The autonomous system number of the remote BGP peer." + }, + "state": { + "type": "string", + "readOnly": true, + "description": "The BGP peer state.", + "enum": [ + "Unknown", + "Stopped", + "Idle", + "Connecting", + "Connected" + ], + "x-ms-enum": { + "name": "BgpPeerState", + "modelAsString": true + } + }, + "connectedDuration": { + "type": "string", + "readOnly": true, + "description": "For how long the peering has been up." + }, + "routesReceived": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of routes learned from this peer." + }, + "messagesSent": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of BGP messages sent." + }, + "messagesReceived": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The number of BGP messages received." + } + }, + "description": "BGP peer status details." + }, + "GatewayRoute": { + "properties": { + "localAddress": { + "type": "string", + "readOnly": true, + "description": "The gateway's local address." + }, + "network": { + "type": "string", + "readOnly": true, + "description": "The route's network prefix." + }, + "nextHop": { + "type": "string", + "readOnly": true, + "description": "The route's next hop." + }, + "sourcePeer": { + "type": "string", + "readOnly": true, + "description": "The peer this route was learned from." + }, + "origin": { + "type": "string", + "readOnly": true, + "description": "The source this route was learned from." + }, + "asPath": { + "type": "string", + "readOnly": true, + "description": "The route's AS path sequence." + }, + "weight": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "The route's weight." + } + }, + "description": "Gateway routing details." + }, + "VirtualNetworkGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayPropertiesFormat", + "description": "Properties of the virtual network gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "VpnClientParameters": { + "properties": { + "processorArchitecture": { + "type": "string", + "description": "VPN client Processor Architecture.", + "enum": [ + "Amd64", + "X86" + ], + "x-ms-enum": { + "name": "ProcessorArchitecture", + "modelAsString": true + } + }, + "authenticationMethod": { + "$ref": "./network.json#/definitions/AuthenticationMethod", + "description": "VPN client authentication method." + }, + "radiusServerAuthCertificate": { + "type": "string", + "description": "The public certificate data for the radius server authentication certificate as a Base-64 encoded string. Required only if external radius authentication has been configured with EAPTLS authentication." + }, + "clientRootCertificates": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of client root certificates public certificate data encoded as Base-64 strings. Optional parameter for external radius based authentication with EAPTLS." + } + }, + "description": "Vpn Client Parameters for package generation." + }, + "VirtualNetworkGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGateway" + }, + "description": "A list of VirtualNetworkGateway resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworkGateways API service call." + }, + "BgpPeerStatusListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpPeerStatus" + }, + "description": "List of BGP peers." + } + }, + "description": "Response for list BGP peer status API service call." + }, + "GatewayRouteListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GatewayRoute" + }, + "description": "List of gateway routes." + } + }, + "description": "List of virtual network gateway routes." + }, + "TunnelConnectionHealth": { + "properties": { + "tunnel": { + "readOnly": true, + "type": "string", + "description": "Tunnel name." + }, + "connectionStatus": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionStatus", + "description": "Virtual Network Gateway connection status." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The Ingress Bytes Transferred in this connection." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The Egress Bytes Transferred in this connection." + }, + "lastConnectionEstablishedUtcTime": { + "readOnly": true, + "type": "string", + "description": "The time at which connection was established in Utc format." + } + }, + "description": "VirtualNetworkGatewayConnection properties." + }, + "VirtualNetworkGatewayConnectionPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "virtualNetworkGateway1": { + "$ref": "#/definitions/VirtualNetworkGateway", + "description": "The reference to virtual network gateway resource." + }, + "virtualNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkGateway", + "description": "The reference to virtual network gateway resource." + }, + "localNetworkGateway2": { + "$ref": "#/definitions/LocalNetworkGateway", + "description": "The reference to local network gateway resource." + }, + "connectionType": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionType", + "description": "Gateway connection type." + }, + "connectionProtocol": { + "$ref": "#/definitions/ConnectionProtocol", + "description": "Connection protocol used for this connection." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "The routing weight." + }, + "dpdTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The dead peer detection timeout of this connection in seconds." + }, + "sharedKey": { + "type": "string", + "description": "The IPSec shared key." + }, + "connectionStatus": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionStatus", + "description": "Virtual Network Gateway connection status." + }, + "tunnelConnectionStatus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TunnelConnectionHealth" + }, + "description": "Collection of all tunnels' connection health status." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The egress bytes transferred in this connection." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The ingress bytes transferred in this connection." + }, + "peer": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to peerings resource." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "useLocalAzureIpAddress": { + "type": "boolean", + "description": "Use private local Azure IP for the connection." + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "trafficSelectorPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/TrafficSelectorPolicy" + }, + "description": "The Traffic Selector Policies to be considered by this connection." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the virtual network gateway connection resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway connection resource." + }, + "expressRouteGatewayBypass": { + "type": "boolean", + "description": "Bypass ExpressRoute Gateway for data forwarding." + } + }, + "required": [ + "virtualNetworkGateway1", + "connectionType" + ], + "description": "VirtualNetworkGatewayConnection properties." + }, + "VirtualNetworkGatewayConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionPropertiesFormat", + "description": "Properties of the virtual network gateway connection." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "VirtualNetworkGatewayConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnection" + }, + "description": "A list of VirtualNetworkGatewayConnection resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the ListVirtualNetworkGatewayConnections API service call." + }, + "ConnectionResetSharedKey": { + "properties": { + "keyLength": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 128, + "description": "The virtual network connection reset shared key length, should between 1 and 128." + } + }, + "required": [ + "keyLength" + ], + "description": "The virtual network connection reset shared key." + }, + "ConnectionSharedKey": { + "properties": { + "value": { + "type": "string", + "description": "The virtual network connection shared key value." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "required": [ + "value" + ], + "description": "Response for GetConnectionSharedKey API service call." + }, + "IpsecPolicy": { + "properties": { + "saLifeTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for a site to site VPN tunnel." + }, + "saDataSizeKilobytes": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for a site to site VPN tunnel." + }, + "ipsecEncryption": { + "$ref": "#/definitions/IpsecEncryption", + "description": "The IPSec encryption algorithm (IKE phase 1)." + }, + "ipsecIntegrity": { + "$ref": "#/definitions/IpsecIntegrity", + "description": "The IPSec integrity algorithm (IKE phase 1)." + }, + "ikeEncryption": { + "$ref": "#/definitions/IkeEncryption", + "description": "The IKE encryption algorithm (IKE phase 2)." + }, + "ikeIntegrity": { + "$ref": "#/definitions/IkeIntegrity", + "description": "The IKE integrity algorithm (IKE phase 2)." + }, + "dhGroup": { + "$ref": "#/definitions/DhGroup", + "description": "The DH Group used in IKE Phase 1 for initial SA." + }, + "pfsGroup": { + "$ref": "#/definitions/PfsGroup", + "description": "The Pfs Group used in IKE Phase 2 for new child SA." + } + }, + "required": [ + "saLifeTimeSeconds", + "saDataSizeKilobytes", + "ipsecEncryption", + "ipsecIntegrity", + "ikeEncryption", + "ikeIntegrity", + "dhGroup", + "pfsGroup" + ], + "description": "An IPSec Policy configuration for a virtual network gateway connection." + }, + "TrafficSelectorPolicy": { + "properties": { + "localAddressRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A collection of local address spaces in CIDR format." + }, + "remoteAddressRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A collection of remote address spaces in CIDR format." + } + }, + "required": [ + "localAddressRanges", + "remoteAddressRanges" + ], + "description": "An traffic selector policy for a virtual network gateway connection." + }, + "ConnectionProtocol": { + "type": "string", + "description": "Gateway connection protocol.", + "enum": [ + "IKEv2", + "IKEv1" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionProtocol", + "modelAsString": true + } + }, + "VpnClientIPsecParameters": { + "properties": { + "saLifeTimeSeconds": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) lifetime in seconds for P2S client." + }, + "saDataSizeKilobytes": { + "type": "integer", + "format": "int32", + "description": "The IPSec Security Association (also called Quick Mode or Phase 2 SA) payload size in KB for P2S client.." + }, + "ipsecEncryption": { + "$ref": "#/definitions/IpsecEncryption", + "description": "The IPSec encryption algorithm (IKE phase 1)." + }, + "ipsecIntegrity": { + "$ref": "#/definitions/IpsecIntegrity", + "description": "The IPSec integrity algorithm (IKE phase 1)." + }, + "ikeEncryption": { + "$ref": "#/definitions/IkeEncryption", + "description": "The IKE encryption algorithm (IKE phase 2)." + }, + "ikeIntegrity": { + "$ref": "#/definitions/IkeIntegrity", + "description": "The IKE integrity algorithm (IKE phase 2)." + }, + "dhGroup": { + "$ref": "#/definitions/DhGroup", + "description": "The DH Group used in IKE Phase 1 for initial SA." + }, + "pfsGroup": { + "$ref": "#/definitions/PfsGroup", + "description": "The Pfs Group used in IKE Phase 2 for new child SA." + } + }, + "required": [ + "saLifeTimeSeconds", + "saDataSizeKilobytes", + "ipsecEncryption", + "ipsecIntegrity", + "ikeEncryption", + "ikeIntegrity", + "dhGroup", + "pfsGroup" + ], + "description": "An IPSec parameters for a virtual network gateway P2S connection." + }, + "LocalNetworkGatewayPropertiesFormat": { + "properties": { + "localNetworkAddressSpace": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "Local network site address space." + }, + "gatewayIpAddress": { + "type": "string", + "description": "IP address of local network gateway." + }, + "fqdn": { + "type": "string", + "description": "FQDN of local network gateway." + }, + "bgpSettings": { + "$ref": "#/definitions/BgpSettings", + "description": "Local network gateway's BGP speaker settings." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the local network gateway resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the local network gateway resource." + } + }, + "description": "LocalNetworkGateway properties." + }, + "LocalNetworkGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LocalNetworkGatewayPropertiesFormat", + "description": "Properties of the local network gateway." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "LocalNetworkGatewayListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LocalNetworkGateway" + }, + "description": "A list of local network gateways that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListLocalNetworkGateways API service call." + }, + "VirtualNetworkConnectionGatewayReference": { + "properties": { + "id": { + "type": "string", + "description": "The ID of VirtualNetworkGateway or LocalNetworkGateway resource." + } + }, + "required": [ + "id" + ], + "description": "A reference to VirtualNetworkGateway or LocalNetworkGateway resource." + }, + "VirtualNetworkGatewayConnectionListEntityPropertiesFormat": { + "properties": { + "authorizationKey": { + "type": "string", + "description": "The authorizationKey." + }, + "virtualNetworkGateway1": { + "$ref": "#/definitions/VirtualNetworkConnectionGatewayReference", + "description": "The reference to virtual network gateway resource." + }, + "virtualNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkConnectionGatewayReference", + "description": "The reference to virtual network gateway resource." + }, + "localNetworkGateway2": { + "$ref": "#/definitions/VirtualNetworkConnectionGatewayReference", + "description": "The reference to local network gateway resource." + }, + "connectionType": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionType", + "description": "Gateway connection type." + }, + "connectionProtocol": { + "$ref": "#/definitions/ConnectionProtocol", + "description": "Connection protocol used for this connection." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "The routing weight." + }, + "sharedKey": { + "type": "string", + "description": "The IPSec shared key." + }, + "connectionStatus": { + "readOnly": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionStatus", + "description": "Virtual Network Gateway connection status." + }, + "tunnelConnectionStatus": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TunnelConnectionHealth" + }, + "description": "Collection of all tunnels' connection health status." + }, + "egressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The egress bytes transferred in this connection." + }, + "ingressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The ingress bytes transferred in this connection." + }, + "peer": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The reference to peerings resource." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "trafficSelectorPolicies": { + "type": "array", + "items": { + "$ref": "#/definitions/TrafficSelectorPolicy" + }, + "description": "The Traffic Selector Policies to be considered by this connection." + }, + "resourceGuid": { + "readOnly": true, + "type": "string", + "description": "The resource GUID property of the virtual network gateway connection resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network gateway connection resource." + }, + "expressRouteGatewayBypass": { + "type": "boolean", + "description": "Bypass ExpressRoute Gateway for data forwarding." + } + }, + "required": [ + "virtualNetworkGateway1", + "connectionType" + ], + "description": "VirtualNetworkGatewayConnection properties." + }, + "VirtualNetworkGatewayConnectionListEntity": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListEntityPropertiesFormat", + "description": "Properties of the virtual network gateway connection." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "required": [ + "properties" + ], + "description": "A common class for general resource information." + }, + "VirtualNetworkGatewayListConnectionsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkGatewayConnectionListEntity" + }, + "description": "A list of VirtualNetworkGatewayConnection resources that exists in a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for the VirtualNetworkGatewayListConnections API service call." + }, + "VpnDeviceScriptParameters": { + "properties": { + "vendor": { + "type": "string", + "description": "The vendor for the vpn device." + }, + "deviceFamily": { + "type": "string", + "description": "The device family for the vpn device." + }, + "firmwareVersion": { + "type": "string", + "description": "The firmware version for the vpn device." + } + }, + "description": "Vpn device configuration script generation parameters." + }, + "DhGroup": { + "type": "string", + "description": "The DH Groups used in IKE Phase 1 for initial SA.", + "enum": [ + "None", + "DHGroup1", + "DHGroup2", + "DHGroup14", + "DHGroup2048", + "ECP256", + "ECP384", + "DHGroup24" + ], + "x-ms-enum": { + "name": "DhGroup", + "modelAsString": true + } + }, + "IkeEncryption": { + "type": "string", + "description": "The IKE encryption algorithm (IKE phase 2).", + "enum": [ + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeEncryption", + "modelAsString": true + } + }, + "IkeIntegrity": { + "type": "string", + "description": "The IKE integrity algorithm (IKE phase 2).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "SHA384", + "GCMAES256", + "GCMAES128" + ], + "x-ms-enum": { + "name": "IkeIntegrity", + "modelAsString": true + } + }, + "IpsecEncryption": { + "type": "string", + "description": "The IPSec encryption algorithm (IKE phase 1).", + "enum": [ + "None", + "DES", + "DES3", + "AES128", + "AES192", + "AES256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecEncryption", + "modelAsString": true + } + }, + "IpsecIntegrity": { + "type": "string", + "description": "The IPSec integrity algorithm (IKE phase 1).", + "enum": [ + "MD5", + "SHA1", + "SHA256", + "GCMAES128", + "GCMAES192", + "GCMAES256" + ], + "x-ms-enum": { + "name": "IpsecIntegrity", + "modelAsString": true + } + }, + "PfsGroup": { + "type": "string", + "description": "The Pfs Groups used in IKE Phase 2 for new child SA.", + "enum": [ + "None", + "PFS1", + "PFS2", + "PFS2048", + "ECP256", + "ECP384", + "PFS24", + "PFS14", + "PFSMM" + ], + "x-ms-enum": { + "name": "PfsGroup", + "modelAsString": true + } + }, + "VirtualNetworkGatewayConnectionStatus": { + "type": "string", + "description": "Virtual Network Gateway connection status.", + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionStatus", + "modelAsString": true + } + }, + "VirtualNetworkGatewayConnectionType": { + "type": "string", + "description": "Gateway connection type.", + "enum": [ + "IPsec", + "Vnet2Vnet", + "ExpressRoute", + "VPNClient" + ], + "x-ms-enum": { + "name": "VirtualNetworkGatewayConnectionType", + "modelAsString": true + } + }, + "VpnClientConnectionHealthDetailListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnClientConnectionHealthDetail" + }, + "description": "List of vpn client connection health." + } + }, + "description": "List of virtual network gateway vpn client connection health." + }, + "VpnClientConnectionHealthDetail": { + "properties": { + "vpnConnectionId": { + "type": "string", + "readOnly": true, + "description": "The vpn client Id." + }, + "vpnConnectionDuration": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The duration time of a connected vpn client." + }, + "vpnConnectionTime": { + "type": "string", + "readOnly": true, + "description": "The start time of a connected vpn client." + }, + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "The public Ip of a connected vpn client." + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "The assigned private Ip of a connected vpn client." + }, + "vpnUserName": { + "type": "string", + "readOnly": true, + "description": "The user name of a connected vpn client." + }, + "maxBandwidth": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The max band width." + }, + "egressPacketsTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The egress packets per second." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The egress bytes per second." + }, + "ingressPacketsTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The ingress packets per second." + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The ingress bytes per second." + }, + "maxPacketsPerSecond": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The max packets transferred per second." + } + }, + "description": "VPN client connection health detail." + }, + "VpnPacketCaptureStopParameters": { + "properties": { + "sasUrl": { + "type": "string", + "description": "SAS url for packet capture on virtual network gateway." + } + }, + "description": "Stop packet capture parameters." + }, + "VpnPacketCaptureStartParameters": { + "properties": { + "filterData": { + "type": "string", + "description": "Start Packet capture parameters." + } + }, + "description": "Start packet capture parameters on virtual network gateway." + }, + "IPConfigurationBgpPeeringAddress": { + "properties": { + "ipconfigurationId": { + "type": "string", + "description": "The ID of IP configuration which belongs to gateway." + }, + "defaultBgpIpAddresses": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of default BGP peering addresses which belong to IP configuration." + }, + "customBgpIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of custom BGP peering addresses which belong to IP configuration." + }, + "tunnelIpAddresses": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of tunnel public IP addresses which belong to IP configuration." + } + }, + "description": "Properties of IPConfigurationBgpPeeringAddress." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetworkTap.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetworkTap.json new file mode 100644 index 000000000000..fcbba0c35aa6 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualNetworkTap.json @@ -0,0 +1,426 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps/{tapName}": { + "delete": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_Delete", + "description": "Deletes the specified virtual network tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network tap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted. Sets 'Deleting' provisioningState until the operation completes. Returns an operation URI that can be queried to find the current state of the operation." + }, + "204": { + "description": "Request successful. Resource does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Delete Virtual Network Tap resource": { + "$ref": "./examples/VirtualNetworkTapDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_Get", + "description": "Gets information about the specified virtual network tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of virtual network tap." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Virtual Network Tap": { + "$ref": "./examples/VirtualNetworkTapGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_CreateOrUpdate", + "description": "Creates or updates a Virtual Network Tap.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual network tap." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + }, + "description": "Parameters supplied to the create or update virtual network tap operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Create Virtual Network Tap": { + "$ref": "./examples/VirtualNetworkTapCreate.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualNetworkTap" + ], + "operationId": "VirtualNetworkTaps_UpdateTags", + "description": "Updates an VirtualNetworkTap tags.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "tapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the tap." + }, + { + "name": "tapParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VirtualNetworkTap tags." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting VirtualNetworkTap resource.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTap" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update virtual network tap tags": { + "$ref": "./examples/VirtualNetworkTapUpdateTags.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualNetworkTaps": { + "get": { + "tags": [ + "VirtualNetworkTaps" + ], + "operationId": "VirtualNetworkTaps_ListAll", + "description": "Gets all the VirtualNetworkTaps in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Virtual Network Tap resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTapListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List all virtual network taps": { + "$ref": "./examples/VirtualNetworkTapListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualNetworkTaps": { + "get": { + "tags": [ + "VirtualNetworkTaps" + ], + "operationId": "VirtualNetworkTaps_ListByResourceGroup", + "description": "Gets all the VirtualNetworkTaps in a subscription.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of Virtual Network Tap resources.", + "schema": { + "$ref": "#/definitions/VirtualNetworkTapListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual network taps in resource group": { + "$ref": "./examples/VirtualNetworkTapList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualNetworkTap": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualNetworkTapPropertiesFormat", + "description": "Virtual Network Tap Properties." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "Virtual Network Tap resource." + }, + "VirtualNetworkTapPropertiesFormat": { + "description": "Virtual Network Tap properties.", + "properties": { + "networkInterfaceTapConfigurations": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceTapConfiguration", + "description": "The reference to the Network Interface." + }, + "description": "Specifies the list of resource IDs for the network interface IP configuration that needs to be tapped." + }, + "resourceGuid": { + "type": "string", + "readOnly": true, + "description": "The resource GUID property of the virtual network tap resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual network tap resource." + }, + "destinationNetworkInterfaceIPConfiguration": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "description": "The reference to the private IP Address of the collector nic that will receive the tap." + }, + "destinationLoadBalancerFrontEndIPConfiguration": { + "$ref": "./loadBalancer.json#/definitions/FrontendIPConfiguration", + "description": "The reference to the private IP address on the internal Load Balancer that will receive the tap." + }, + "destinationPort": { + "type": "integer", + "description": "The VXLAN destination port that will receive the tapped traffic." + } + } + }, + "VirtualNetworkTapListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualNetworkTap" + }, + "description": "A list of VirtualNetworkTaps in a resource group." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of results." + } + }, + "description": "Response for ListVirtualNetworkTap API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualRouter.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualRouter.json new file mode 100644 index 000000000000..eb8b8964ec83 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualRouter.json @@ -0,0 +1,698 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}": { + "delete": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_Delete", + "description": "Deletes the specified Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete VirtualRouter": { + "$ref": "./examples/VirtualRouterDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_Get", + "description": "Gets the specified Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Virtual Router resource.", + "schema": { + "$ref": "#/definitions/VirtualRouter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get VirtualRouter": { + "$ref": "./examples/VirtualRouterGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_CreateOrUpdate", + "description": "Creates or updates the specified Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualRouter" + }, + "description": "Parameters supplied to the create or update Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting Virtual Router resource.", + "schema": { + "$ref": "#/definitions/VirtualRouter" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting Virtual Router resource.", + "schema": { + "$ref": "#/definitions/VirtualRouter" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create VirtualRouter": { + "$ref": "./examples/VirtualRouterPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters": { + "get": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_ListByResourceGroup", + "description": "Lists all Virtual Routers in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Virtual Router resources.", + "schema": { + "$ref": "#/definitions/VirtualRouterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all Virtual Router for a given resource group": { + "$ref": "./examples/VirtualRouterListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualRouters": { + "get": { + "tags": [ + "VirtualRouters" + ], + "operationId": "VirtualRouters_List", + "description": "Gets all the Virtual Routers in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Virtual Router resources.", + "schema": { + "$ref": "#/definitions/VirtualRouterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all Virtual Routers for a given subscription": { + "$ref": "./examples/VirtualRouterListBySubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings/{peeringName}": { + "delete": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_Delete", + "description": "Deletes the specified peering from a Virtual Router.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Request successful. Resource with the specified name does not exist." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Delete VirtualRouterPeering": { + "$ref": "./examples/VirtualRouterPeeringDelete.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_Get", + "description": "Gets the specified Virtual Router Peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router Peering." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a Virtual Router Peering resource.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Get Virtual Router Peering": { + "$ref": "./examples/VirtualRouterPeeringGet.json" + } + } + }, + "put": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_CreateOrUpdate", + "description": "Creates or updates the specified Virtual Router Peering.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "name": "peeringName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router Peering." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + }, + "description": "Parameters supplied to the create or update Virtual Router Peering operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "201": { + "description": "Request received successfully. The operation returns the resulting Virtual Router Peering resource.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + } + }, + "200": { + "description": "Request successful. The operation returns the resulting Virtual Router Peering resource.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeering" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "Create Virtual Router Peering": { + "$ref": "./examples/VirtualRouterPeeringPut.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualRouters/{virtualRouterName}/peerings": { + "get": { + "tags": [ + "VirtualRouterPeerings" + ], + "operationId": "VirtualRouterPeerings_List", + "description": "Lists all Virtual Router Peerings in a Virtual Router resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualRouterName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Virtual Router." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The operation returns a list of Virtual Router Peering resources.", + "schema": { + "$ref": "#/definitions/VirtualRouterPeeringListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-examples": { + "List all Virtual Router Peerings for a given Virtual Router": { + "$ref": "./examples/VirtualRouterPeeringList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "VirtualRouter": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualRouterPropertiesFormat", + "description": "Properties of the Virtual Router." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualRouter Resource." + }, + "VirtualRouterPropertiesFormat": { + "properties": { + "virtualRouterAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "VirtualRouter ASN." + }, + "virtualRouterIps": { + "type": "array", + "readOnly": false, + "description": "VirtualRouter IPs.", + "items": { + "type": "string" + } + }, + "hostedSubnet": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The Subnet on which VirtualRouter is hosted." + }, + "hostedGateway": { + "readOnly": false, + "$ref": "./network.json#/definitions/SubResource", + "description": "The Gateway on which VirtualRouter is hosted." + }, + "peerings": { + "type": "array", + "readOnly": true, + "description": "List of references to VirtualRouterPeerings.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Virtual Router definition." + }, + "VirtualRouterPeering": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualRouterPeeringProperties", + "description": "The properties of the Virtual Router Peering." + }, + "name": { + "type": "string", + "description": "Name of the virtual router peering that is unique within a virtual router." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Peering type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Virtual Router Peering resource." + }, + "VirtualRouterPeeringProperties": { + "properties": { + "peerAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Peer ASN." + }, + "peerIp": { + "type": "string", + "readOnly": false, + "description": "Peer IP." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + } + }, + "description": "Properties of the rule group." + }, + "VirtualRouterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualRouter" + }, + "description": "List of Virtual Routers." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListVirtualRouters API service call." + }, + "VirtualRouterPeeringListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualRouterPeering" + }, + "description": "List of VirtualRouterPeerings in a VirtualRouter." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "Response for ListVirtualRouterPeerings API service call." + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualWan.json new file mode 100644 index 000000000000..59268c93c1b1 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualWan.json @@ -0,0 +1,6647 @@ +{ + "swagger": "2.0", + "info": { + "title": "VirtualWANAsAServiceManagementClient", + "description": "REST API for Azure VirtualWAN As a Service.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{VirtualWANName}": { + "get": { + "operationId": "VirtualWans_Get", + "x-ms-examples": { + "VirtualWANGet": { + "$ref": "./examples/VirtualWANGet.json" + } + }, + "description": "Retrieves the details of a VirtualWAN.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN retrieved.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualWans_CreateOrUpdate", + "x-ms-examples": { + "VirtualWANCreate": { + "$ref": "./examples/VirtualWANPut.json" + } + }, + "description": "Creates a VirtualWAN resource if it doesn't exist else updates the existing VirtualWAN.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "WANParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualWAN" + }, + "description": "Parameters supplied to create or update VirtualWAN." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN created or updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting VirtualWAN resource.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualWANs" + ], + "operationId": "VirtualWans_UpdateTags", + "x-ms-examples": { + "VirtualWANUpdate": { + "$ref": "./examples/VirtualWANUpdateTags.json" + } + }, + "description": "Updates a VirtualWAN tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "WANParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to Update VirtualWAN tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualWAN updated.", + "schema": { + "$ref": "#/definitions/VirtualWAN" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VirtualWans_Delete", + "x-ms-examples": { + "VirtualWANDelete": { + "$ref": "./examples/VirtualWANDelete.json" + } + }, + "description": "Deletes a VirtualWAN.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "name": "VirtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualWAN deleted." + }, + "202": { + "description": "Request received successfully. VirtualWAN deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualWANs exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans": { + "get": { + "operationId": "VirtualWans_ListByResourceGroup", + "x-ms-examples": { + "VirtualWANListByResourceGroup": { + "$ref": "./examples/VirtualWANListByResourceGroup.json" + } + }, + "description": "Lists all the VirtualWANs in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualWan." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualWANs in the resource group.", + "schema": { + "$ref": "#/definitions/ListVirtualWANsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualWans": { + "get": { + "operationId": "VirtualWans_List", + "x-ms-examples": { + "VirtualWANList": { + "$ref": "./examples/VirtualWANList.json" + } + }, + "description": "Lists all the VirtualWANs in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualWANs in the subscription.", + "schema": { + "$ref": "#/definitions/ListVirtualWANsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}": { + "get": { + "operationId": "VpnSites_Get", + "x-ms-examples": { + "VpnSiteGet": { + "$ref": "./examples/VpnSiteGet.json" + } + }, + "description": "Retrieves the details of a VPN site.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite retrieved.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnSites_CreateOrUpdate", + "x-ms-examples": { + "VpnSiteCreate": { + "$ref": "./examples/VpnSitePut.json" + } + }, + "description": "Creates a VpnSite resource if it doesn't exist else updates the existing VpnSite.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnSiteParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnSite" + }, + "description": "Parameters supplied to create or update VpnSite." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite created or updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VpnSite created or updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VpnSites" + ], + "operationId": "VpnSites_UpdateTags", + "x-ms-examples": { + "VpnSiteUpdate": { + "$ref": "./examples/VpnSiteUpdateTags.json" + } + }, + "description": "Updates VpnSite tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnSiteParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VpnSite tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSite updated.", + "schema": { + "$ref": "#/definitions/VpnSite" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VpnSites_Delete", + "x-ms-examples": { + "VpnSiteDelete": { + "$ref": "./examples/VpnSiteDelete.json" + } + }, + "description": "Deletes a VpnSite.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VpnSite deleted." + }, + "202": { + "description": "Request received successfully. VpnSite deletion is in progress." + }, + "204": { + "description": "No VpnSites exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites": { + "get": { + "operationId": "VpnSites_ListByResourceGroup", + "x-ms-examples": { + "VpnSiteListByResourceGroup": { + "$ref": "./examples/VpnSiteListByResourceGroup.json" + } + }, + "description": "Lists all the vpnSites in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnSites in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnSitesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks/{vpnSiteLinkName}": { + "get": { + "operationId": "VpnSiteLinks_Get", + "x-ms-examples": { + "VpnSiteGet": { + "$ref": "./examples/VpnSiteLinkGet.json" + } + }, + "description": "Retrieves the details of a VPN site link.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite." + }, + { + "name": "vpnSiteLinkName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSiteLink being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnSiteLink retrieved.", + "schema": { + "$ref": "#/definitions/VpnSiteLink" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnSites/{vpnSiteName}/vpnSiteLinks": { + "get": { + "operationId": "VpnSiteLinks_ListByVpnSite", + "x-ms-examples": { + "VpnSiteLinkListByVpnSite": { + "$ref": "./examples/VpnSiteLinkListByVpnSite.json" + } + }, + "description": "Lists all the vpnSiteLinks in a resource group for a vpn site.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnSite." + }, + { + "name": "vpnSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnSite." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnSites in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnSiteLinksResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnSites": { + "get": { + "operationId": "VpnSites_List", + "x-ms-examples": { + "VpnSiteList": { + "$ref": "./examples/VpnSiteList.json" + } + }, + "description": "Lists all the VpnSites in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnSites in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnSitesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnConfiguration": { + "post": { + "operationId": "VpnSitesConfiguration_Download", + "x-ms-examples": { + "VpnSitesConfigurationDownload": { + "$ref": "./examples/VpnSitesConfigurationDownload.json" + } + }, + "description": "Gives the sas-url to download the configurations for vpn-sites in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN for which configuration of all vpn-sites is needed." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetVpnSitesConfigurationRequest" + }, + "description": "Parameters supplied to download vpn-sites configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Follow the location header for sas-url to output blob." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously. Follow the location header for sas-url to output blob." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/supportedSecurityProviders": { + "get": { + "operationId": "SupportedSecurityProviders", + "x-ms-examples": { + "supportedSecurityProviders": { + "$ref": "./examples/VirtualWanSupportedSecurityProviders.json" + } + }, + "description": "Gives the supported security providers for the virtual wan.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN for which supported security providers are needed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the object containing supported security providers.", + "schema": { + "$ref": "#/definitions/VirtualWanSecurityProviders" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations/{vpnServerConfigurationName}": { + "get": { + "operationId": "VpnServerConfigurations_Get", + "x-ms-examples": { + "VpnServerConfigurationGet": { + "$ref": "./examples/VpnServerConfigurationGet.json" + } + }, + "description": "Retrieves the details of a VpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being retrieved." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration retrieved.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnServerConfigurations_CreateOrUpdate", + "x-ms-examples": { + "VpnServerConfigurationCreate": { + "$ref": "./examples/VpnServerConfigurationPut.json" + } + }, + "description": "Creates a VpnServerConfiguration resource if it doesn't exist else updates the existing VpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being created or updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnServerConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + }, + "description": "Parameters supplied to create or update VpnServerConfiguration." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VpnServerConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VpnServerConfigurations" + ], + "operationId": "VpnServerConfigurations_UpdateTags", + "x-ms-examples": { + "VpnServerConfigurationUpdate": { + "$ref": "./examples/VpnServerConfigurationUpdateTags.json" + } + }, + "description": "Updates VpnServerConfiguration tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being updated." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnServerConfigurationParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VpnServerConfiguration tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VpnServerConfiguration updated.", + "schema": { + "$ref": "#/definitions/VpnServerConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VpnServerConfigurations_Delete", + "x-ms-examples": { + "VpnServerConfigurationDelete": { + "$ref": "./examples/VpnServerConfigurationDelete.json" + } + }, + "description": "Deletes a VpnServerConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "name": "vpnServerConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VpnServerConfiguration being deleted." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VpnServerConfiguration deleted." + }, + "202": { + "description": "Request received successfully. VpnServerConfiguration deletion is in progress." + }, + "204": { + "description": "No VpnServerConfigurations exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnServerConfigurations": { + "get": { + "operationId": "VpnServerConfigurations_ListByResourceGroup", + "x-ms-examples": { + "VpnServerConfigurationListByResourceGroup": { + "$ref": "./examples/VpnServerConfigurationListByResourceGroup.json" + } + }, + "description": "Lists all the vpnServerConfigurations in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnServerConfiguration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the vpnServerConfigurations in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnServerConfigurationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnServerConfigurations": { + "get": { + "operationId": "VpnServerConfigurations_List", + "x-ms-examples": { + "VpnServerConfigurationList": { + "$ref": "./examples/VpnServerConfigurationList.json" + } + }, + "description": "Lists all the VpnServerConfigurations in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnServerConfigurations in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnServerConfigurationsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}": { + "get": { + "operationId": "VirtualHubs_Get", + "x-ms-examples": { + "VirtualHubGet": { + "$ref": "./examples/VirtualHubGet.json" + } + }, + "description": "Retrieves the details of a VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub retrieved.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualHubs_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubPut": { + "$ref": "./examples/VirtualHubPut.json" + } + }, + "description": "Creates a VirtualHub resource if it doesn't exist else updates the existing VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHub" + }, + "description": "Parameters supplied to create or update VirtualHub." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualHub created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VirtualWANs" + ], + "operationId": "VirtualHubs_UpdateTags", + "x-ms-examples": { + "VirtualHubUpdate": { + "$ref": "./examples/VirtualHubUpdateTags.json" + } + }, + "description": "Updates VirtualHub tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update VirtualHub tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHub updated.", + "schema": { + "$ref": "#/definitions/VirtualHub" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VirtualHubs_Delete", + "x-ms-examples": { + "VirtualHubDelete": { + "$ref": "./examples/VirtualHubDelete.json" + } + }, + "description": "Deletes a VirtualHub.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHub deleted." + }, + "202": { + "description": "Request received successfully. VirtualHub deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubs exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs": { + "get": { + "operationId": "VirtualHubs_ListByResourceGroup", + "x-ms-examples": { + "VirtualHubListByResourceGroup": { + "$ref": "./examples/VirtualHubListByResourceGroup.json" + } + }, + "description": "Lists all the VirtualHubs in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubs in the resource group.", + "schema": { + "$ref": "#/definitions/ListVirtualHubsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/virtualHubs": { + "get": { + "operationId": "VirtualHubs_List", + "x-ms-examples": { + "VirtualHubList": { + "$ref": "./examples/VirtualHubList.json" + } + }, + "description": "Lists all the VirtualHubs in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubs in the subscription.", + "schema": { + "$ref": "#/definitions/ListVirtualHubsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections/{connectionName}": { + "put": { + "operationId": "HubVirtualNetworkConnections_CreateOrUpdate", + "x-ms-examples": { + "HubVirtualNetworkConnectionPut": { + "$ref": "./examples/HubVirtualNetworkConnectionPut.json" + } + }, + "description": "Creates a hub virtual network connection if it doesn't exist else updates the existing one.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the HubVirtualNetworkConnection." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the HubVirtualNetworkConnection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "hubVirtualNetworkConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + }, + "description": "Parameters supplied to create or update a hub virtual network connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the hub virtual network connection created or updated.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "201": { + "description": "Request successful. Returns the details of the hub virtual network connection retrieved.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "HubVirtualNetworkConnections_Delete", + "x-ms-examples": { + "HubVirtualNetworkConnectionDelete": { + "$ref": "./examples/HubVirtualNetworkConnectionDelete.json" + } + }, + "description": "Deletes a HubVirtualNetworkConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the HubVirtualNetworkConnection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. HubVirtualNetworkConnection deleted." + }, + "202": { + "description": "Request received successfully. HubVirtualNetworkConnection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No HubVirtualNetworkConnection exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + }, + "get": { + "operationId": "HubVirtualNetworkConnections_Get", + "x-ms-examples": { + "HubVirtualNetworkConnectionGet": { + "$ref": "./examples/HubVirtualNetworkConnectionGet.json" + } + }, + "description": "Retrieves the details of a HubVirtualNetworkConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the HubVirtualNetworkConnection retrieved.", + "schema": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubVirtualNetworkConnections": { + "get": { + "operationId": "HubVirtualNetworkConnections_List", + "x-ms-examples": { + "HubVirtualNetworkConnectionList": { + "$ref": "./examples/HubVirtualNetworkConnectionList.json" + } + }, + "description": "Retrieves the details of all HubVirtualNetworkConnections.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the HubVirtualNetworkConnections for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListHubVirtualNetworkConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}": { + "get": { + "operationId": "VpnGateways_Get", + "x-ms-examples": { + "VpnGatewayGet": { + "$ref": "./examples/VpnGatewayGet.json" + } + }, + "description": "Retrieves the details of a virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnGateways_CreateOrUpdate", + "x-ms-examples": { + "VpnGatewayPut": { + "$ref": "./examples/VpnGatewayPut.json" + } + }, + "description": "Creates a virtual wan vpn gateway if it doesn't exist else updates the existing gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "vpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnGateway" + }, + "description": "Parameters supplied to create or Update a virtual wan vpn gateway." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan vpn Gateway created or updated.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "201": { + "description": "Request successful. Returns the details of the virtual wan vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_UpdateTags", + "x-ms-examples": { + "VpnGatewayUpdate": { + "$ref": "./examples/VpnGatewayUpdateTags.json" + } + }, + "description": "Updates virtual wan vpn gateway tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "vpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan vpn gateway tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "VpnGateways_Delete", + "x-ms-examples": { + "VpnGatewayDelete": { + "$ref": "./examples/VpnGatewayDelete.json" + } + }, + "description": "Deletes a virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Vpn Gateway deleted." + }, + "202": { + "description": "Request received successfully. Vpn Gateway deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No vpn gateways exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/reset": { + "post": { + "tags": [ + "VpnGateways" + ], + "operationId": "VpnGateways_Reset", + "description": "Resets the primary of the vpn gateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation reset the primary of the VpnGateway.", + "schema": { + "$ref": "#/definitions/VpnGateway" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ResetVpnGateway": { + "$ref": "./examples/VpnGatewayReset.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways": { + "get": { + "operationId": "VpnGateways_ListByResourceGroup", + "x-ms-examples": { + "VpnGatewayListByResourceGroup": { + "$ref": "./examples/VpnGatewayListByResourceGroup.json" + } + }, + "description": "Lists all the VpnGateways in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnGateways in the resource group.", + "schema": { + "$ref": "#/definitions/ListVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/vpnGateways": { + "get": { + "operationId": "VpnGateways_List", + "x-ms-examples": { + "VpnGatewayListBySubscription": { + "$ref": "./examples/VpnGatewayList.json" + } + }, + "description": "Lists all the VpnGateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VpnGateways in the subscription.", + "schema": { + "$ref": "#/definitions/ListVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}": { + "get": { + "operationId": "VpnConnections_Get", + "x-ms-examples": { + "VpnConnectionGet": { + "$ref": "./examples/VpnConnectionGet.json" + } + }, + "description": "Retrieves the details of a vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VpnConnections_CreateOrUpdate", + "x-ms-examples": { + "VpnConnectionPut": { + "$ref": "./examples/VpnConnectionPut.json" + } + }, + "description": "Creates a vpn connection to a scalable vpn gateway if it doesn't exist else updates the existing connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "VpnConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VpnConnection" + }, + "description": "Parameters supplied to create or Update a VPN Connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection created or updated.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "201": { + "description": "Request successful. Returns the details of the vpn connection created or updated.", + "schema": { + "$ref": "#/definitions/VpnConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VpnConnections_Delete", + "x-ms-examples": { + "VpnConnectionDelete": { + "$ref": "./examples/VpnConnectionDelete.json" + } + }, + "description": "Deletes a vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Vpn Connection deleted." + }, + "202": { + "description": "Request received successfully. Vpn Connection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No vpn connections exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections/{linkConnectionName}": { + "get": { + "operationId": "VpnSiteLinkConnections_Get", + "x-ms-examples": { + "VpnSiteLinkConnectionGet": { + "$ref": "./examples/VpnSiteLinkConnectionGet.json" + } + }, + "description": "Retrieves the details of a vpn site link connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "name": "linkConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the vpn connection.", + "schema": { + "$ref": "#/definitions/VpnSiteLinkConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections": { + "get": { + "operationId": "VpnConnections_ListByVpnGateway", + "x-ms-examples": { + "VpnConnectionList": { + "$ref": "./examples/VpnConnectionList.json" + } + }, + "description": "Retrieves all vpn connections for a particular virtual wan vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.", + "schema": { + "$ref": "#/definitions/ListVpnConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/vpnGateways/{gatewayName}/vpnConnections/{connectionName}/vpnLinkConnections": { + "get": { + "operationId": "VpnLinkConnections_ListByVpnConnection", + "x-ms-examples": { + "VpnSiteLinkConnectionList": { + "$ref": "./examples/VpnSiteLinkConnectionList.json" + } + }, + "description": "Retrieves all vpn site link connections for a particular virtual wan vpn gateway vpn connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the vpn connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns all Vpn connections for a virtual wan vpn gateway.", + "schema": { + "$ref": "#/definitions/ListVpnSiteLinkConnectionsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}": { + "get": { + "operationId": "P2sVpnGateways_Get", + "x-ms-examples": { + "P2SVpnGatewayGet": { + "$ref": "./examples/P2SVpnGatewayGet.json" + } + }, + "description": "Retrieves the details of a virtual wan p2s vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "P2sVpnGateways_CreateOrUpdate", + "x-ms-examples": { + "P2SVpnGatewayPut": { + "$ref": "./examples/P2SVpnGatewayPut.json" + } + }, + "description": "Creates a virtual wan p2s vpn gateway if it doesn't exist else updates the existing gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "p2SVpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "Parameters supplied to create or Update a virtual wan p2s vpn gateway." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn Gateway created or updated.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "201": { + "description": "Request successful. Returns the details of the virtual wan p2s vpn gateway retrieved.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "patch": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_UpdateTags", + "x-ms-examples": { + "P2SVpnGatewayUpdate": { + "$ref": "./examples/P2SVpnGatewayUpdateTags.json" + } + }, + "description": "Updates virtual wan p2s vpn gateway tags.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "p2SVpnGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "./network.json#/definitions/TagsObject" + }, + "description": "Parameters supplied to update a virtual wan p2s vpn gateway tags." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the updated gateway.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "P2sVpnGateways_Delete", + "x-ms-examples": { + "P2SVpnGatewayDelete": { + "$ref": "./examples/P2SVpnGatewayDelete.json" + } + }, + "description": "Deletes a virtual wan p2s vpn gateway.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. P2SVpnGateway deleted." + }, + "202": { + "description": "Request received successfully. P2SVpnGateway deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No p2s vpn gateways exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways": { + "get": { + "operationId": "P2sVpnGateways_ListByResourceGroup", + "x-ms-examples": { + "P2SVpnGatewayListByResourceGroup": { + "$ref": "./examples/P2SVpnGatewayListByResourceGroup.json" + } + }, + "description": "Lists all the P2SVpnGateways in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the P2SVpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the P2SVpnGateways in the resource group.", + "schema": { + "$ref": "#/definitions/ListP2SVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/p2svpnGateways": { + "get": { + "operationId": "P2sVpnGateways_List", + "x-ms-examples": { + "P2SVpnGatewayListBySubscription": { + "$ref": "./examples/P2SVpnGatewayList.json" + } + }, + "description": "Lists all the P2SVpnGateways in a subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the P2SVpnGateways in the subscription.", + "schema": { + "$ref": "#/definitions/ListP2SVpnGatewaysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/generatevpnprofile": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_GenerateVpnProfile", + "description": "Generates VPN profile for P2S client of the P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnGateway." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnProfileParameters" + }, + "description": "Parameters supplied to the generate P2SVpnGateway VPN client package operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "$ref": "#/definitions/VpnProfileResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "GenerateP2SVpnGatewayVPNProfile": { + "$ref": "./examples/P2SVpnGatewayGenerateVpnProfile.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealth": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_GetP2sVpnConnectionHealth", + "description": "Gets the connection health of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnGateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "P2S Vpn Gateway with P2S connection health details.", + "schema": { + "$ref": "#/definitions/P2SVpnGateway" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "P2SVpnGatewayGetConnectionHealth": { + "$ref": "./examples/P2SVpnGatewayGetConnectionHealth.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{gatewayName}/getP2sVpnConnectionHealthDetailed": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_GetP2sVpnConnectionHealthDetailed", + "description": "Gets the sas url to get the connection health detail of P2S clients of the virtual wan P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "gatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2SVpnGateway." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnConnectionHealthRequest" + }, + "description": "Request parameters supplied to get p2s vpn connections detailed health." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "P2S connections detailed health report.", + "schema": { + "$ref": "#/definitions/P2SVpnConnectionHealth" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "P2SVpnGatewayGetConnectionHealthDetailed": { + "$ref": "./examples/P2SVpnGatewayGetConnectionHealthDetailed.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/vpnServerConfigurations": { + "post": { + "operationId": "VpnServerConfigurationsAssociatedWithVirtualWan_List", + "x-ms-examples": { + "GetVirtualWanVpnServerConfigurations": { + "$ref": "./examples/GetVirtualWanVpnServerConfigurations.json" + } + }, + "description": "Gives the list of VpnServerConfigurations associated with Virtual Wan in a resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN whose associated VpnServerConfigurations is needed." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of associated VpnServerConfigurations list.", + "schema": { + "$ref": "#/definitions/VpnServerConfigurationsResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously. Follow the location header for list of associated VpnServerConfigurations list." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualWans/{virtualWANName}/GenerateVpnProfile": { + "post": { + "operationId": "generatevirtualwanvpnserverconfigurationvpnprofile", + "x-ms-examples": { + "GenerateVirtualWanVpnServerConfigurationVpnProfile": { + "$ref": "./examples/GenerateVirtualWanVpnServerConfigurationVpnProfile.json" + } + }, + "description": "Generates a unique VPN profile for P2S clients for VirtualWan and associated VpnServerConfiguration combination in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name." + }, + { + "name": "virtualWANName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualWAN whose associated VpnServerConfigurations is needed." + }, + { + "name": "vpnClientParams", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualWanVpnProfileParameters" + }, + "description": "Parameters supplied to the generate VirtualWan VPN profile generation operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "VPN profile package URL.", + "schema": { + "$ref": "#/definitions/VpnProfileResponse" + } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables/{routeTableName}": { + "get": { + "operationId": "VirtualHubRouteTableV2s_Get", + "x-ms-examples": { + "VirtualHubVirtualHubRouteTableV2Get": { + "$ref": "./examples/VirtualHubRouteTableV2Get.json" + } + }, + "description": "Retrieves the details of a VirtualHubRouteTableV2.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubRouteTableV2." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHubRouteTableV2." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHubRouteTableV2 retrieved.", + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + } + }, + "put": { + "operationId": "VirtualHubRouteTableV2s_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubRouteTableV2Put": { + "$ref": "./examples/VirtualHubRouteTableV2Put.json" + } + }, + "description": "Creates a VirtualHubRouteTableV2 resource if it doesn't exist else updates the existing VirtualHubRouteTableV2.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHubRouteTableV2." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "virtualHubRouteTableV2Parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + }, + "description": "Parameters supplied to create or update VirtualHubRouteTableV2." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the VirtualHubRouteTableV2 created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the VirtualHubRouteTableV2 created or updated.", + "schema": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualHubRouteTableV2s_Delete", + "x-ms-examples": { + "VirtualHubRouteTableV2Delete": { + "$ref": "./examples/VirtualHubRouteTableV2Delete.json" + } + }, + "description": "Deletes a VirtualHubRouteTableV2.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubRouteTableV2." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHubRouteTableV2." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHubRouteTableV2 deleted." + }, + "202": { + "description": "Request received successfully. VirtualHubRouteTableV2 deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubRouteTableV2s exist by the name provided." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/Error" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/routeTables": { + "get": { + "operationId": "VirtualHubRouteTableV2s_List", + "x-ms-examples": { + "VirtualHubRouteTableV2List": { + "$ref": "./examples/VirtualHubRouteTableV2List.json" + } + }, + "description": "Retrieves the details of all VirtualHubRouteTableV2s.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubRouteTableV2s for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListVirtualHubRouteTableV2sResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/p2svpnGateways/{p2sVpnGatewayName}/disconnectP2sVpnConnections": { + "post": { + "tags": [ + "P2SVpnGateways" + ], + "operationId": "P2sVpnGateways_DisconnectP2sVpnConnections", + "description": "Disconnect P2S vpn connections of the virtual wan P2SVpnGateway in the specified resource group.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "p2sVpnGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the P2S Vpn Gateway." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/P2SVpnConnectionRequest" + }, + "description": "The parameters are supplied to disconnect p2s vpn connections." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation disconnects the requested vpn connections." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Disconnect VpnConnections from P2sVpn Gateway": { + "$ref": "./examples/P2sVpnGatewaysDisconnectP2sVpnConnections.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/expressRouteGateways": { + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_ListBySubscription", + "x-ms-examples": { + "ExpressRouteGatewayListBySubscription": { + "$ref": "./examples/ExpressRouteGatewayListBySubscription.json" + } + }, + "description": "Lists ExpressRoute gateways under a given subscription.", + "parameters": [ + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteGatewayList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways": { + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_ListByResourceGroup", + "x-ms-examples": { + "ExpressRouteGatewayListByResourceGroup": { + "$ref": "./examples/ExpressRouteGatewayListByResourceGroup.json" + } + }, + "description": "Lists ExpressRoute gateways in a given resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteGatewayList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}": { + "put": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_CreateOrUpdate", + "x-ms-examples": { + "ExpressRouteGatewayCreate": { + "$ref": "./examples/ExpressRouteGatewayCreate.json" + } + }, + "description": "Creates or updates a ExpressRoute gateway in a specified resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "putExpressRouteGatewayParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + }, + "description": "Parameters required in an ExpressRoute gateway PUT operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the resulting ExpressRoute gateway resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "201": { + "description": "Create successful. The operation returns the resulting ExpressRoute gateway resource.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_Get", + "x-ms-examples": { + "ExpressRouteGatewayGet": { + "$ref": "./examples/ExpressRouteGatewayGet.json" + } + }, + "description": "Fetches the details of a ExpressRoute gateway in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Operation succeeded. The operation returns the ExpressRoute gateway.", + "schema": { + "$ref": "#/definitions/ExpressRouteGateway" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ExpressRouteGateways" + ], + "operationId": "ExpressRouteGateways_Delete", + "x-ms-examples": { + "ExpressRouteGatewayDelete": { + "$ref": "./examples/ExpressRouteGatewayDelete.json" + } + }, + "description": "Deletes the specified ExpressRoute gateway in a resource group. An ExpressRoute gateway resource can only be deleted when there are no connection subresources.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections/{connectionName}": { + "put": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_CreateOrUpdate", + "x-ms-examples": { + "ExpressRouteConnectionCreate": { + "$ref": "./examples/ExpressRouteConnectionCreate.json" + } + }, + "description": "Creates a connection between an ExpressRoute gateway and an ExpressRoute circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection subresource." + }, + { + "name": "putExpressRouteConnectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + }, + "description": "Parameters required in an ExpressRouteConnection PUT operation." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Update successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "201": { + "description": "Create successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_Get", + "x-ms-examples": { + "ExpressRouteConnectionGet": { + "$ref": "./examples/ExpressRouteConnectionGet.json" + } + }, + "description": "Gets the specified ExpressRouteConnection.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the ExpressRouteConnection.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_Delete", + "x-ms-examples": { + "ExpressRouteConnectionDelete": { + "$ref": "./examples/ExpressRouteConnectionDelete.json" + } + }, + "description": "Deletes a connection to a ExpressRoute circuit.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection subresource." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Delete successful." + }, + "202": { + "description": "Accepted, and the operation will continue asynchronously." + }, + "204": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/expressRouteGateways/{expressRouteGatewayName}/expressRouteConnections": { + "get": { + "tags": [ + "ExpressRouteConnections" + ], + "operationId": "ExpressRouteConnections_List", + "x-ms-examples": { + "ExpressRouteConnectionList": { + "$ref": "./examples/ExpressRouteConnectionList.json" + } + }, + "description": "Lists ExpressRouteConnections.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "expressRouteGatewayName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ExpressRoute gateway." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful.", + "schema": { + "$ref": "#/definitions/ExpressRouteConnectionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections/{connectionName}": { + "get": { + "operationId": "VirtualHubBgpConnection_Get", + "x-ms-examples": { + "VirtualHubVirtualHubRouteTableV2Get": { + "$ref": "./examples/VirtualHubBgpConnectionGet.json" + } + }, + "description": "Retrieves the details of a Virtual Hub Bgp Connection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the Bgp Connection retrieved.", + "schema": { + "$ref": "#/definitions/BgpConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualHubBgpConnection_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubRouteTableV2Put": { + "$ref": "./examples/VirtualHubBgpConnectionPut.json" + } + }, + "description": "Creates a VirtualHubBgpConnection resource if it doesn't exist else updates the existing VirtualHubBgpConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BgpConnection" + }, + "description": "Parameters of Bgp connection." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the BgpConnection created or updated.", + "schema": { + "$ref": "#/definitions/BgpConnection" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the BgpConnection created or updated.", + "schema": { + "$ref": "#/definitions/BgpConnection" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualHubBgpConnection_Delete", + "x-ms-examples": { + "VirtualHubRouteTableV2Delete": { + "$ref": "./examples/VirtualHubBgpConnectionDelete.json" + } + }, + "description": "Deletes a VirtualHubBgpConnection.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubBgpConnection." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the connection." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHubBgpConnection deleted." + }, + "202": { + "description": "Request received successfully. VirtualHubBgpConnection deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubBgpConnection exist by the name provided." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/bgpConnections": { + "get": { + "operationId": "VirtualHubBgpConnections_List", + "x-ms-examples": { + "VirtualHubRouteTableV2List": { + "$ref": "./examples/VirtualHubBgpConnectionList.json" + } + }, + "description": "Retrieves the details of all VirtualHubBgpConnections.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubBgpConnections for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListVirtualHubBgpConnectionResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations/{ipConfigName}": { + "get": { + "operationId": "VirtualHubIpConfiguration_Get", + "x-ms-examples": { + "VirtualHubVirtualHubRouteTableV2Get": { + "$ref": "./examples/VirtualHubIpConfigurationGet.json" + } + }, + "description": "Retrieves the details of a Virtual Hub Ip configuration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "ipConfigName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipconfig." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the Bgp Connection retrieved.", + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "VirtualHubIpConfiguration_CreateOrUpdate", + "x-ms-examples": { + "VirtualHubIpConfigurationPut": { + "$ref": "./examples/VirtualHubIpConfigurationPut.json" + } + }, + "description": "Creates a VirtualHubIpConfiguration resource if it doesn't exist else updates the existing VirtualHubIpConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "ipConfigName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipconfig." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + }, + "description": "Hub Ip Configuration parameters." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the IpConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the IpConfiguration created or updated.", + "schema": { + "$ref": "#/definitions/HubIpConfiguration" + } + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "delete": { + "operationId": "VirtualHubIpConfiguration_Delete", + "x-ms-examples": { + "VirtualHubIpConfigurationDelete": { + "$ref": "./examples/VirtualHubIpConfigurationDelete.json" + } + }, + "description": "Deletes a VirtualHubIpConfiguration.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHubBgpConnection." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "ipConfigName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ipconfig." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. VirtualHubIpConfiguration deleted." + }, + "202": { + "description": "Request received successfully. VirtualHubIpConfiguration deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No VirtualHubIpConfiguration exist by the name provided." + }, + "default": { + "description": "Error.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/ipConfigurations": { + "get": { + "operationId": "VirtualHubIpConfiguration_List", + "x-ms-examples": { + "VirtualHubRouteTableV2List": { + "$ref": "./examples/VirtualHubIpConfigurationList.json" + } + }, + "description": "Retrieves the details of all VirtualHubIpConfigurations.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the VirtualHubIpConfigurations for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListVirtualHubIpConfigurationResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables/{routeTableName}": { + "put": { + "operationId": "HubRouteTables_CreateOrUpdate", + "x-ms-examples": { + "RouteTablePut": { + "$ref": "./examples/HubRouteTablePut.json" + } + }, + "description": "Creates a RouteTable resource if it doesn't exist else updates the existing RouteTable.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteTable." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "routeTableParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HubRouteTable" + }, + "description": "Parameters supplied to create or update RouteTable." + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RouteTable created or updated.", + "schema": { + "$ref": "#/definitions/HubRouteTable" + } + }, + "201": { + "description": "Request received successfully. Returns the details of the RouteTable created or updated.", + "schema": { + "$ref": "#/definitions/HubRouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + }, + "get": { + "operationId": "HubRouteTables_Get", + "x-ms-examples": { + "RouteTableGet": { + "$ref": "./examples/HubRouteTableGet.json" + } + }, + "description": "Retrieves the details of a RouteTable.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteTable." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of the RouteTable retrieved.", + "schema": { + "$ref": "#/definitions/HubRouteTable" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "HubRouteTables_Delete", + "x-ms-examples": { + "RouteTableDelete": { + "$ref": "./examples/HubRouteTableDelete.json" + } + }, + "description": "Deletes a RouteTable.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the RouteTable." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "name": "routeTableName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the RouteTable." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. RouteTable deleted." + }, + "202": { + "description": "Request received successfully. RouteTable deletion is in progress; follow the Location header to poll for final outcome." + }, + "204": { + "description": "No RouteTables exist by the name provided." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/hubRouteTables": { + "get": { + "operationId": "HubRouteTables_List", + "x-ms-examples": { + "RouteTableList": { + "$ref": "./examples/HubRouteTableList.json" + } + }, + "description": "Retrieves the details of all RouteTables.", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. Returns the details of all the RouteTables for the VirtualHub.", + "schema": { + "$ref": "#/definitions/ListHubRouteTablesResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/virtualHubs/{virtualHubName}/effectiveRoutes": { + "post": { + "operationId": "VirtualHubs_GetEffectiveVirtualHubRoutes", + "x-ms-examples": { + "Effective Routes for the Virtual Hub": { + "$ref": "./examples/EffectiveRoutesListForVirtualHub.json" + }, + "Effective Routes for a Route Table resource": { + "$ref": "./examples/EffectiveRoutesListForRouteTable.json" + }, + "Effective Routes for a Connection resource": { + "$ref": "./examples/EffectiveRoutesListForConnection.json" + } + }, + "description": "Gets the effective routes configured for the Virtual Hub resource or the specified resource .", + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The resource group name of the VirtualHub." + }, + { + "name": "virtualHubName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VirtualHub." + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + }, + { + "name": "effectiveRoutesParameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/EffectiveRoutesParameters" + }, + "description": "Parameters supplied to get the effective routes for a specific resource." + } + ], + "responses": { + "200": { + "description": "Request successful. Follow the location header for the effective routes list." + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "VirtualWanProperties": { + "properties": { + "disableVpnEncryption": { + "type": "boolean", + "description": "Vpn encryption to be disabled or not." + }, + "virtualHubs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of VirtualHubs in the VirtualWAN." + }, + "vpnSites": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "List of VpnSites in the VirtualWAN." + }, + "allowBranchToBranchTraffic": { + "type": "boolean", + "description": "True if branch to branch traffic is allowed." + }, + "allowVnetToVnetTraffic": { + "type": "boolean", + "description": "True if Vnet to Vnet traffic is allowed." + }, + "office365LocalBreakoutCategory": { + "description": "The office local breakout category.", + "$ref": "#/definitions/OfficeTrafficCategory" + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual WAN resource." + }, + "type": { + "type": "string", + "description": "The type of the VirtualWAN." + } + }, + "description": "Parameters for VirtualWAN." + }, + "VirtualWAN": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualWanProperties", + "description": "Properties of the virtual WAN." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualWAN Resource." + }, + "ListVirtualWANsResult": { + "description": "Result of the request to list VirtualWANs. It contains a list of VirtualWANs and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualWAN" + }, + "description": "List of VirtualWANs." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteProperties": { + "properties": { + "virtualWan": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualWAN to which the vpnSite belongs." + }, + "deviceProperties": { + "description": "The device properties.", + "$ref": "#/definitions/DeviceProperties" + }, + "ipAddress": { + "type": "string", + "description": "The ip-address for the vpn-site." + }, + "siteKey": { + "type": "string", + "description": "The key for vpn-site that can be used for connections." + }, + "addressSpace": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The AddressSpace that contains an array of IP address ranges." + }, + "bgpProperties": { + "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", + "description": "The set of bgp properties." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN site resource." + }, + "isSecuritySite": { + "type": "boolean", + "description": "IsSecuritySite flag." + }, + "vpnSiteLinks": { + "type": "array", + "description": "List of all vpn site links.", + "items": { + "$ref": "#/definitions/VpnSiteLink" + } + } + }, + "description": "Parameters for VpnSite." + }, + "VpnSite": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteProperties", + "description": "Properties of the VPN site." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnSite Resource." + }, + "ListVpnSitesResult": { + "description": "Result of the request to list VpnSites. It contains a list of VpnSites and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSite" + }, + "description": "List of VpnSites." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteLinkProperties": { + "properties": { + "linkProperties": { + "description": "The link provider properties.", + "$ref": "#/definitions/VpnLinkProviderProperties" + }, + "ipAddress": { + "type": "string", + "description": "The ip-address for the vpn-site-link." + }, + "fqdn": { + "type": "string", + "description": "FQDN of vpn-site-link." + }, + "bgpProperties": { + "$ref": "#/definitions/VpnLinkBgpSettings", + "description": "The set of bgp properties." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN site link resource." + } + }, + "description": "Parameters for VpnSite." + }, + "VpnSiteLink": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteLinkProperties", + "description": "Properties of the VPN site link." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnSiteLink Resource." + }, + "ListVpnSiteLinksResult": { + "description": "Result of the request to list VpnSiteLinks. It contains a list of VpnSiteLinks and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSiteLink" + }, + "description": "List of VpnSitesLinks." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "GetVpnSitesConfigurationRequest": { + "properties": { + "vpnSites": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of resource-ids of the vpn-sites for which config is to be downloaded." + }, + "outputBlobSasUrl": { + "type": "string", + "description": "The sas-url to download the configurations for vpn-sites." + } + }, + "required": [ + "outputBlobSasUrl" + ], + "description": "List of Vpn-Sites." + }, + "VirtualHubProperties": { + "properties": { + "virtualWan": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualWAN to which the VirtualHub belongs." + }, + "vpnGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VpnGateway associated with this VirtualHub." + }, + "p2SVpnGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The P2SVpnGateway associated with this VirtualHub." + }, + "expressRouteGateway": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The expressRouteGateway associated with this VirtualHub." + }, + "azureFirewall": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The azureFirewall associated with this VirtualHub." + }, + "securityPartnerProvider": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The securityPartnerProvider associated with this VirtualHub." + }, + "addressPrefix": { + "type": "string", + "description": "Address-prefix for this VirtualHub." + }, + "routeTable": { + "$ref": "#/definitions/VirtualHubRouteTable", + "description": "The routeTable associated with this virtual hub." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the virtual hub resource." + }, + "securityProviderName": { + "type": "string", + "description": "The Security Provider name." + }, + "virtualHubRouteTableV2s": { + "type": "array", + "description": "List of all virtual hub route table v2s associated with this VirtualHub.", + "items": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + } + }, + "sku": { + "type": "string", + "description": "The sku of this VirtualHub." + }, + "routingState": { + "$ref": "#/definitions/RoutingState", + "description": "The routing state." + }, + "bgpConnections": { + "type": "array", + "readOnly": true, + "description": "List of references to Bgp Connections.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "ipConfigurations": { + "type": "array", + "readOnly": true, + "description": "List of references to IpConfigurations.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "virtualRouterAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "VirtualRouter ASN." + }, + "virtualRouterIps": { + "type": "array", + "readOnly": false, + "description": "VirtualRouter IPs.", + "items": { + "type": "string" + } + } + }, + "description": "Parameters for VirtualHub." + }, + "RoutingState": { + "type": "string", + "description": "The current routing state of the VirtualHub.", + "readOnly": true, + "enum": [ + "None", + "Provisioned", + "Provisioning", + "Failed" + ], + "x-ms-enum": { + "name": "RoutingState", + "modelAsString": true + } + }, + "BgpConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/BgpConnectionProperties", + "description": "The properties of the Bgp connections." + }, + "name": { + "type": "string", + "description": "Name of the connection." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Connection type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "Virtual Appliance Site resource." + }, + "BgpConnectionProperties": { + "properties": { + "peerAsn": { + "type": "integer", + "readOnly": false, + "format": "int64", + "minimum": 0, + "maximum": 4294967295, + "description": "Peer ASN." + }, + "peerIp": { + "type": "string", + "readOnly": false, + "description": "Peer IP." + }, + "provisioningState": { + "description": "The provisioning state of the resource.", + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState" + }, + "connectionState": { + "type": "string", + "description": "The current state of the VirtualHub to Peer.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "HubBgpConnectionStatus", + "modelAsString": true + } + } + }, + "description": "Properties of the bgp connection." + }, + "HubIpConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubIPConfigurationPropertiesFormat", + "description": "The properties of the Virtual Hub IPConfigurations." + }, + "name": { + "type": "string", + "description": "Name of the Ip Configuration." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Ipconfiguration type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "IpConfigurations." + }, + "HubIPConfigurationPropertiesFormat": { + "properties": { + "privateIPAddress": { + "type": "string", + "description": "The private IP address of the IP configuration." + }, + "privateIPAllocationMethod": { + "$ref": "./network.json#/definitions/IPAllocationMethod", + "description": "The private IP address allocation method." + }, + "subnet": { + "$ref": "./virtualNetwork.json#/definitions/Subnet", + "description": "The reference to the subnet resource." + }, + "publicIPAddress": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress", + "description": "The reference to the public IP resource." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the IP configuration resource." + } + }, + "description": "Properties of IP configuration." + }, + "VirtualHubRouteTable": { + "properties": { + "routes": { + "type": "array", + "description": "List of all routes.", + "items": { + "$ref": "#/definitions/VirtualHubRoute" + } + } + }, + "description": "VirtualHub route table." + }, + "VirtualHubRoute": { + "properties": { + "addressPrefixes": { + "type": "array", + "description": "List of all addressPrefixes.", + "items": { + "type": "string" + } + }, + "nextHopIpAddress": { + "type": "string", + "description": "NextHop ip address." + } + }, + "description": "VirtualHub route." + }, + "VirtualHub": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualHubProperties", + "description": "Properties of the virtual hub." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VirtualHub Resource." + }, + "ListVirtualHubsResult": { + "description": "Result of the request to list VirtualHubs. It contains a list of VirtualHubs and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHub" + }, + "description": "List of VirtualHubs." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnGatewayProperties": { + "properties": { + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualHub to which the gateway belongs." + }, + "connections": { + "type": "array", + "description": "List of all vpn connections to the gateway.", + "items": { + "$ref": "#/definitions/VpnConnection" + } + }, + "bgpSettings": { + "$ref": "./virtualNetworkGateway.json#/definitions/BgpSettings", + "description": "Local network gateway's BGP speaker settings." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN gateway resource." + }, + "vpnGatewayScaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit for this vpn gateway." + } + }, + "description": "Parameters for VpnGateway." + }, + "VpnGateway": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnGatewayProperties", + "description": "Properties of the VPN gateway." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnGateway Resource." + }, + "ListVpnGatewaysResult": { + "description": "Result of the request to list VpnGateways. It contains a list of VpnGateways and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnGateway" + }, + "description": "List of VpnGateways." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnConnectionProperties": { + "properties": { + "remoteVpnSite": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Id of the connected vpn site." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "Routing weight for vpn connection." + }, + "dpdTimeoutSeconds": { + "type": "integer", + "format": "int32", + "description": "The dead peer detection timeout for a vpn connection in seconds." + }, + "connectionStatus": { + "description": "The connection status.", + "$ref": "#/definitions/VpnConnectionStatus" + }, + "vpnConnectionProtocolType": { + "description": "Connection protocol used for this connection.", + "$ref": "./virtualNetworkGateway.json#/definitions/ConnectionProtocol" + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Ingress bytes transferred." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Egress bytes transferred." + }, + "connectionBandwidth": { + "type": "integer", + "format": "int32", + "description": "Expected bandwidth in MBPS." + }, + "sharedKey": { + "type": "string", + "description": "SharedKey for the vpn connection." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "enableRateLimiting": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "useLocalAzureIpAddress": { + "type": "boolean", + "description": "Use local azure ip to initiate connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN connection resource." + }, + "vpnLinkConnections": { + "type": "array", + "description": "List of all vpn site link connections to the gateway.", + "items": { + "$ref": "#/definitions/VpnSiteLinkConnection" + } + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + } + }, + "description": "Parameters for VpnConnection." + }, + "VpnConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnConnectionProperties", + "description": "Properties of the VPN connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnConnection Resource." + }, + "ListVpnConnectionsResult": { + "description": "Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnConnection" + }, + "description": "List of Vpn Connections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteLinkConnectionProperties": { + "properties": { + "vpnSiteLink": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Id of the connected vpn site link." + }, + "routingWeight": { + "type": "integer", + "format": "int32", + "description": "Routing weight for vpn connection." + }, + "connectionStatus": { + "description": "The connection status.", + "$ref": "#/definitions/VpnConnectionStatus" + }, + "vpnConnectionProtocolType": { + "description": "Connection protocol used for this connection.", + "$ref": "./virtualNetworkGateway.json#/definitions/ConnectionProtocol" + }, + "ingressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Ingress bytes transferred." + }, + "egressBytesTransferred": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Egress bytes transferred." + }, + "connectionBandwidth": { + "type": "integer", + "format": "int32", + "description": "Expected bandwidth in MBPS." + }, + "sharedKey": { + "type": "string", + "description": "SharedKey for the vpn connection." + }, + "enableBgp": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "usePolicyBasedTrafficSelectors": { + "type": "boolean", + "description": "Enable policy-based traffic selectors." + }, + "ipsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "The IPSec Policies to be considered by this connection." + }, + "enableRateLimiting": { + "type": "boolean", + "description": "EnableBgp flag." + }, + "useLocalAzureIpAddress": { + "type": "boolean", + "description": "Use local azure ip to initiate connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the VPN site link connection resource." + } + }, + "description": "Parameters for VpnConnection." + }, + "VpnSiteLinkConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnSiteLinkConnectionProperties", + "description": "Properties of the VPN site link connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VpnSiteLinkConnection Resource." + }, + "ListVpnSiteLinkConnectionsResult": { + "description": "Result of the request to list all vpn connections to a virtual wan vpn gateway. It contains a list of Vpn Connections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnSiteLinkConnection" + }, + "description": "List of VpnSiteLinkConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "HubVirtualNetworkConnectionProperties": { + "properties": { + "remoteVirtualNetwork": { + "$ref": "./network.json#/definitions/SubResource", + "description": "Reference to the remote virtual network." + }, + "allowHubToRemoteVnetTransit": { + "type": "boolean", + "description": "Deprecated: VirtualHub to RemoteVnet transit to enabled or not." + }, + "allowRemoteVnetToUseHubVnetGateways": { + "type": "boolean", + "description": "Deprecated: Allow RemoteVnet to use Virtual Hub's gateways." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the hub virtual network connection resource." + } + }, + "description": "Parameters for HubVirtualNetworkConnection." + }, + "HubVirtualNetworkConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubVirtualNetworkConnectionProperties", + "description": "Properties of the hub virtual network connection." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "HubVirtualNetworkConnection Resource." + }, + "ListHubVirtualNetworkConnectionsResult": { + "description": "List of HubVirtualNetworkConnections and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubVirtualNetworkConnection" + }, + "description": "List of HubVirtualNetworkConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "HubRouteTableProperties": { + "properties": { + "routes": { + "type": "array", + "description": "List of all routes.", + "items": { + "$ref": "#/definitions/HubRoute" + } + }, + "labels": { + "type": "array", + "description": "List of labels associated with this route table.", + "items": { + "type": "string" + } + }, + "associatedConnections": { + "type": "array", + "description": "List of all connections associated with this route table.", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "propagatingConnections": { + "type": "array", + "description": "List of all connections that advertise to this route table.", + "readOnly": true, + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the RouteTable resource." + } + }, + "description": "Parameters for RouteTable." + }, + "HubRouteTable": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/HubRouteTableProperties", + "description": "Properties of the RouteTable resource." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "RouteTable resource in a virtual hub." + }, + "HubRoute": { + "required": [ + "name", + "destinationType", + "destinations", + "nextHopType", + "nextHop" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the Route that is unique within a RouteTable. This name can be used to access this route." + }, + "destinationType": { + "type": "string", + "description": "The type of destinations (eg: CIDR, ResourceId, Service)." + }, + "destinations": { + "type": "array", + "description": "List of all destinations.", + "items": { + "type": "string" + } + }, + "nextHopType": { + "type": "string", + "description": "The type of next hop (eg: ResourceId)." + }, + "nextHop": { + "type": "string", + "description": "NextHop resource ID." + } + }, + "description": "RouteTable route." + }, + "ListHubRouteTablesResult": { + "description": "List of RouteTables and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubRouteTable" + }, + "description": "List of RouteTables." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnSiteId": { + "properties": { + "vpnSite": { + "type": "string", + "readOnly": true, + "description": "The resource-uri of the vpn-site for which config is to be fetched." + } + }, + "description": "VpnSite Resource." + }, + "DeviceProperties": { + "properties": { + "deviceVendor": { + "type": "string", + "description": "Name of the device Vendor." + }, + "deviceModel": { + "type": "string", + "description": "Model of the device." + }, + "linkSpeedInMbps": { + "type": "integer", + "format": "int32", + "description": "Link speed." + } + }, + "description": "List of properties of the device." + }, + "VirtualWanSecurityProviders": { + "properties": { + "supportedProviders": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualWanSecurityProvider" + }, + "description": "List of VirtualWAN security providers." + } + }, + "description": "Collection of SecurityProviders." + }, + "VirtualWanSecurityProvider": { + "properties": { + "name": { + "type": "string", + "description": "Name of the security provider." + }, + "url": { + "type": "string", + "description": "Url of the security provider." + }, + "type": { + "$ref": "#/definitions/VirtualWanSecurityProviderType", + "description": "Name of the security provider." + } + }, + "description": "Collection of SecurityProviders." + }, + "VpnConnectionStatus": { + "type": "string", + "description": "The current state of the vpn connection.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "VpnConnectionStatus", + "modelAsString": true + } + }, + "TunnelConnectionStatus": { + "type": "string", + "description": "The current state of the tunnel.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "TunnelConnectionStatus", + "modelAsString": true + } + }, + "HubVirtualNetworkConnectionStatus": { + "type": "string", + "description": "The current state of the VirtualHub to vnet connection.", + "readOnly": true, + "enum": [ + "Unknown", + "Connecting", + "Connected", + "NotConnected" + ], + "x-ms-enum": { + "name": "HubVirtualNetworkConnectionStatus", + "modelAsString": true + } + }, + "OfficeTrafficCategory": { + "type": "string", + "description": "The office traffic category.", + "readOnly": true, + "enum": [ + "Optimize", + "OptimizeAndAllow", + "All", + "None" + ], + "x-ms-enum": { + "name": "OfficeTrafficCategory", + "modelAsString": true + } + }, + "VirtualWanSecurityProviderType": { + "type": "string", + "description": "The virtual wan security provider type.", + "readOnly": true, + "enum": [ + "External", + "Native" + ], + "x-ms-enum": { + "name": "VirtualWanSecurityProviderType", + "modelAsString": true + } + }, + "VpnServerConfigVpnClientRootCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "publicCertData": { + "type": "string", + "description": "The certificate public data." + } + }, + "description": "Properties of VPN client root certificate of VpnServerConfiguration." + }, + "VpnServerConfigRadiusServerRootCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "publicCertData": { + "type": "string", + "description": "The certificate public data." + } + }, + "description": "Properties of Radius Server root certificate of VpnServerConfiguration." + }, + "VpnServerConfigVpnClientRevokedCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "thumbprint": { + "type": "string", + "description": "The revoked VPN client certificate thumbprint." + } + }, + "description": "Properties of the revoked VPN client certificate of VpnServerConfiguration." + }, + "VpnServerConfigRadiusClientRootCertificate": { + "properties": { + "name": { + "type": "string", + "description": "The certificate name." + }, + "thumbprint": { + "type": "string", + "description": "The Radius client root certificate thumbprint." + } + }, + "description": "Properties of the Radius client root certificate of VpnServerConfiguration." + }, + "AadAuthenticationParameters": { + "properties": { + "aadTenant": { + "type": "string", + "description": "AAD Vpn authentication parameter AAD tenant." + }, + "aadAudience": { + "type": "string", + "description": "AAD Vpn authentication parameter AAD audience." + }, + "aadIssuer": { + "type": "string", + "description": "AAD Vpn authentication parameter AAD issuer." + } + }, + "description": "AAD Vpn authentication type related parameters." + }, + "VpnServerConfigurationProperties": { + "properties": { + "name": { + "type": "string", + "description": "The name of the VpnServerConfiguration that is unique within a resource group." + }, + "vpnProtocols": { + "type": "array", + "items": { + "type": "string", + "description": "VPN protocol enabled for the VpnServerConfiguration.", + "enum": [ + "IkeV2", + "OpenVPN" + ], + "x-ms-enum": { + "name": "VpnGatewayTunnelingProtocol", + "modelAsString": true + } + }, + "description": "VPN protocols for the VpnServerConfiguration." + }, + "vpnAuthenticationTypes": { + "type": "array", + "items": { + "type": "string", + "description": "VPN authentication types enabled for the VpnServerConfiguration.", + "enum": [ + "Certificate", + "Radius", + "AAD" + ], + "x-ms-enum": { + "name": "VpnAuthenticationType", + "modelAsString": true + } + }, + "description": "VPN authentication types for the VpnServerConfiguration." + }, + "vpnClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigVpnClientRootCertificate" + }, + "description": "VPN client root certificate of VpnServerConfiguration." + }, + "vpnClientRevokedCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigVpnClientRevokedCertificate" + }, + "description": "VPN client revoked certificate of VpnServerConfiguration." + }, + "radiusServerRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigRadiusServerRootCertificate" + }, + "description": "Radius Server root certificate of VpnServerConfiguration." + }, + "radiusClientRootCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfigRadiusClientRootCertificate" + }, + "description": "Radius client root certificate of VpnServerConfiguration." + }, + "vpnClientIpsecPolicies": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/IpsecPolicy" + }, + "description": "VpnClientIpsecPolicies for VpnServerConfiguration." + }, + "radiusServerAddress": { + "type": "string", + "description": "The radius server address property of the VpnServerConfiguration resource for point to site client connection." + }, + "radiusServerSecret": { + "type": "string", + "description": "The radius secret property of the VpnServerConfiguration resource for point to site client connection." + }, + "radiusServers": { + "type": "array", + "items": { + "$ref": "./virtualNetworkGateway.json#/definitions/RadiusServer" + }, + "description": "Multiple Radius Server configuration for VpnServerConfiguration." + }, + "aadAuthenticationParameters": { + "$ref": "#/definitions/AadAuthenticationParameters", + "description": "The set of aad vpn authentication parameters." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the VpnServerConfiguration resource. Possible values are: 'Updating', 'Deleting', and 'Failed'." + }, + "p2SVpnGateways": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "List of references to P2SVpnGateways." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "description": "Parameters for VpnServerConfiguration." + }, + "VpnServerConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VpnServerConfigurationProperties", + "description": "Properties of the P2SVpnServer configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "VpnServerConfiguration Resource." + }, + "ListVpnServerConfigurationsResult": { + "description": "Result of the request to list all VpnServerConfigurations. It contains a list of VpnServerConfigurations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VpnServerConfiguration" + }, + "description": "List of VpnServerConfigurations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "VpnClientConnectionHealth": { + "properties": { + "totalIngressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "Total of the Ingress Bytes Transferred in this P2S Vpn connection." + }, + "totalEgressBytesTransferred": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "Total of the Egress Bytes Transferred in this connection." + }, + "vpnClientConnectionsCount": { + "type": "integer", + "format": "int32", + "description": "The total of p2s vpn clients connected at this time to this P2SVpnGateway." + }, + "allocatedIpAddresses": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of allocated ip addresses to the connected p2s vpn clients." + } + }, + "description": "VpnClientConnectionHealth properties." + }, + "P2SVpnGatewayProperties": { + "properties": { + "virtualHub": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VirtualHub to which the gateway belongs." + }, + "p2SConnectionConfigurations": { + "type": "array", + "description": "List of all p2s connection configurations of the gateway.", + "items": { + "$ref": "#/definitions/P2SConnectionConfiguration" + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the P2S VPN gateway resource." + }, + "vpnGatewayScaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit for this p2s vpn gateway." + }, + "vpnServerConfiguration": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The VpnServerConfiguration to which the p2sVpnGateway is attached to." + }, + "vpnClientConnectionHealth": { + "readOnly": true, + "$ref": "#/definitions/VpnClientConnectionHealth", + "description": "All P2S VPN clients' connection health status." + }, + "customDnsServers": { + "type": "array", + "description": "List of all customer specified DNS servers IP addresses.", + "items": { + "type": "string" + } + } + }, + "description": "Parameters for P2SVpnGateway." + }, + "P2SVpnGateway": { + "required": [ + "location" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SVpnGatewayProperties", + "description": "Properties of the P2SVpnGateway." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "P2SVpnGateway Resource." + }, + "ListP2SVpnGatewaysResult": { + "description": "Result of the request to list P2SVpnGateways. It contains a list of P2SVpnGateways and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/P2SVpnGateway" + }, + "description": "List of P2SVpnGateways." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "P2SVpnProfileParameters": { + "properties": { + "authenticationMethod": { + "$ref": "./network.json#/definitions/AuthenticationMethod", + "description": "VPN client authentication method." + } + }, + "description": "Vpn Client Parameters for package generation." + }, + "VpnProfileResponse": { + "properties": { + "profileUrl": { + "type": "string", + "description": "URL to the VPN profile." + } + }, + "description": "Vpn Profile Response for package generation." + }, + "VpnLinkBgpSettings": { + "properties": { + "asn": { + "type": "integer", + "format": "int64", + "description": "The BGP speaker's ASN." + }, + "bgpPeeringAddress": { + "type": "string", + "description": "The BGP peering address and BGP identifier of this BGP speaker." + } + }, + "description": "BGP settings details for a link." + }, + "VpnLinkProviderProperties": { + "properties": { + "linkProviderName": { + "type": "string", + "description": "Name of the link provider." + }, + "linkSpeedInMbps": { + "type": "integer", + "format": "int32", + "description": "Link speed." + } + }, + "description": "List of properties of a link provider." + }, + "VpnServerConfigurationsResponse": { + "properties": { + "vpnServerConfigurationResourceIds": { + "type": "array", + "items": { + "type": "string", + "description": "VpnServerConfiguration partial resource uri." + }, + "description": "List of VpnServerConfigurations associated with VirtualWan." + } + }, + "description": "VpnServerConfigurations list associated with VirtualWan Response." + }, + "VirtualWanVpnProfileParameters": { + "properties": { + "vpnServerConfigurationResourceId": { + "type": "string", + "description": "VpnServerConfiguration partial resource uri with which VirtualWan is associated to." + }, + "authenticationMethod": { + "$ref": "./network.json#/definitions/AuthenticationMethod", + "description": "VPN client authentication method." + } + }, + "description": "Virtual Wan Vpn profile parameters Vpn profile generation." + }, + "P2SVpnConnectionHealthRequest": { + "properties": { + "vpnUserNamesFilter": { + "type": "array", + "items": { + "type": "string", + "description": "P2S vpn user name." + }, + "description": "The list of p2s vpn user names whose p2s vpn connection detailed health to retrieve for." + }, + "outputBlobSasUrl": { + "type": "string", + "description": "The sas-url to download the P2S Vpn connection health detail." + } + }, + "description": "List of P2S Vpn connection health request." + }, + "P2SVpnConnectionHealth": { + "properties": { + "sasUrl": { + "type": "string", + "description": "Returned sas url of the blob to which the p2s vpn connection detailed health will be written." + } + }, + "description": "P2S Vpn connection detailed health written to sas url." + }, + "P2SConnectionConfigurationProperties": { + "properties": { + "vpnClientAddressPool": { + "$ref": "./virtualNetwork.json#/definitions/AddressSpace", + "description": "The reference to the address space resource which represents Address space for P2S VpnClient." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the P2SConnectionConfiguration resource." + } + }, + "description": "Parameters for P2SConnectionConfiguration." + }, + "P2SConnectionConfiguration": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/P2SConnectionConfigurationProperties", + "description": "Properties of the P2S connection configuration." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "P2SConnectionConfiguration Resource." + }, + "VirtualHubRouteTableV2Properties": { + "properties": { + "routes": { + "type": "array", + "description": "List of all routes.", + "items": { + "$ref": "#/definitions/VirtualHubRouteV2" + } + }, + "attachedConnections": { + "type": "array", + "description": "List of all connections attached to this route table v2.", + "items": { + "type": "string" + } + }, + "provisioningState": { + "$ref": "./network.json#/definitions/ProvisioningState", + "readOnly": true, + "description": "The provisioning state of the virtual hub route table v2 resource." + } + }, + "description": "Parameters for VirtualHubRouteTableV2." + }, + "VirtualHubRouteTableV2": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualHubRouteTableV2Properties", + "description": "Properties of the virtual hub route table v2." + }, + "name": { + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "VirtualHubRouteTableV2 Resource." + }, + "VirtualHubRouteV2": { + "properties": { + "destinationType": { + "type": "string", + "description": "The type of destinations." + }, + "destinations": { + "type": "array", + "description": "List of all destinations.", + "items": { + "type": "string" + } + }, + "nextHopType": { + "type": "string", + "description": "The type of next hops." + }, + "nextHops": { + "type": "array", + "description": "NextHops ip address.", + "items": { + "type": "string" + } + } + }, + "description": "VirtualHubRouteTableV2 route." + }, + "ListVirtualHubRouteTableV2sResult": { + "description": "List of VirtualHubRouteTableV2s and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHubRouteTableV2" + }, + "description": "List of VirtualHubRouteTableV2s." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "P2SVpnConnectionRequest": { + "description": "List of p2s vpn connections to be disconnected.", + "properties": { + "vpnConnectionIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of p2s vpn connection Ids." + } + } + }, + "VirtualHubId": { + "properties": { + "id": { + "type": "string", + "description": "The resource URI for the Virtual Hub where the ExpressRoute gateway is or will be deployed. The Virtual Hub resource and the ExpressRoute gateway resource reside in the same subscription." + } + }, + "description": "Virtual Hub identifier." + }, + "ExpressRouteCircuitPeeringId": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the ExpressRoute circuit peering." + } + }, + "description": "ExpressRoute circuit peering identifier." + }, + "ExpressRouteConnectionId": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The ID of the ExpressRouteConnection." + } + }, + "description": "The ID of the ExpressRouteConnection." + }, + "ExpressRouteGatewayProperties": { + "required": [ + "virtualHub" + ], + "properties": { + "autoScaleConfiguration": { + "properties": { + "bounds": { + "properties": { + "min": { + "type": "integer", + "description": "Minimum number of scale units deployed for ExpressRoute gateway." + }, + "max": { + "type": "integer", + "description": "Maximum number of scale units deployed for ExpressRoute gateway." + } + }, + "description": "Minimum and maximum number of scale units to deploy." + } + }, + "description": "Configuration for auto scaling." + }, + "expressRouteConnections": { + "type": "array", + "readOnly": true, + "description": "List of ExpressRoute connections to the ExpressRoute gateway.", + "items": { + "$ref": "#/definitions/ExpressRouteConnection" + } + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route gateway resource." + }, + "virtualHub": { + "$ref": "#/definitions/VirtualHubId", + "description": "The Virtual Hub where the ExpressRoute gateway is or will be deployed." + } + }, + "description": "ExpressRoute gateway resource properties." + }, + "ExpressRouteGateway": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteGatewayProperties", + "description": "Properties of the express route gateway." + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ], + "description": "ExpressRoute gateway resource." + }, + "ExpressRouteGatewayList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteGateway" + }, + "description": "List of ExpressRoute gateways." + } + }, + "description": "List of ExpressRoute gateways." + }, + "ExpressRouteConnectionProperties": { + "required": [ + "expressRouteCircuitPeering" + ], + "properties": { + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the express route connection resource." + }, + "expressRouteCircuitPeering": { + "$ref": "#/definitions/ExpressRouteCircuitPeeringId", + "description": "The ExpressRoute circuit peering." + }, + "authorizationKey": { + "type": "string", + "description": "Authorization key to establish the connection." + }, + "routingWeight": { + "type": "integer", + "description": "The routing weight associated to the connection." + }, + "enableInternetSecurity": { + "type": "boolean", + "description": "Enable internet security." + }, + "routingConfiguration": { + "$ref": "#/definitions/RoutingConfiguration", + "description": "The Routing Configuration indicating the associated and propagated route tables on this connection." + } + }, + "description": "Properties of the ExpressRouteConnection subresource." + }, + "ExpressRouteConnection": { + "required": [ + "name" + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExpressRouteConnectionProperties", + "description": "Properties of the express route connection." + }, + "name": { + "type": "string", + "description": "The name of the resource." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/SubResource" + } + ], + "description": "ExpressRouteConnection resource." + }, + "ExpressRouteConnectionList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ExpressRouteConnection" + }, + "description": "The list of ExpressRoute connections." + } + }, + "description": "ExpressRouteConnection list." + }, + "ListVirtualHubBgpConnectionResults": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/BgpConnection" + }, + "description": "The list of VirtualHubBgpConnections." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "VirtualHubBgpConnections list." + }, + "ListVirtualHubIpConfigurationResults": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/HubIpConfiguration" + }, + "description": "The list of VirtualHubIpConfigurations." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of results." + } + }, + "description": "VirtualHubIpConfigurations list." + }, + "RoutingConfiguration": { + "description": "Routing Configuration indicating the associated and propagated route tables for this connection.", + "properties": { + "associatedRouteTable": { + "$ref": "./network.json#/definitions/SubResource", + "description": "The resource id RouteTable associated with this RoutingConfiguration." + }, + "propagatedRouteTables": { + "$ref": "#/definitions/PropagatedRouteTable", + "description": "The list of RouteTables to advertise the routes to." + }, + "vnetRoutes": { + "$ref": "#/definitions/VnetRoute", + "description": "List of routes that control routing from VirtualHub into a virtual network connection." + } + } + }, + "PropagatedRouteTable": { + "description": "The list of RouteTables to advertise the routes to.", + "properties": { + "labels": { + "type": "array", + "description": "The list of labels.", + "items": { + "type": "string" + } + }, + "ids": { + "type": "array", + "description": "The list of resource ids of all the RouteTables.", + "items": { + "$ref": "./network.json#/definitions/SubResource" + } + } + } + }, + "VnetRoute": { + "description": "List of routes that control routing from VirtualHub into a virtual network connection.", + "properties": { + "staticRoutes": { + "type": "array", + "description": "List of all Static Routes.", + "items": { + "$ref": "#/definitions/StaticRoute" + } + } + } + }, + "StaticRoute": { + "description": "List of all Static Routes.", + "properties": { + "name": { + "type": "string", + "description": "The name of the StaticRoute that is unique within a VnetRoute." + }, + "addressPrefixes": { + "type": "array", + "description": "List of all address prefixes.", + "items": { + "type": "string" + } + }, + "nextHopIpAddress": { + "type": "string", + "description": "The ip address of the next hop." + } + } + }, + "VirtualHubEffectiveRouteEffectiveRouteList": { + "description": "EffectiveRoutes List.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualHubEffectiveRoute" + }, + "description": "The list of effective routes configured on the virtual hub or the specified resource." + } + } + }, + "VirtualHubEffectiveRoute": { + "description": "The effective route configured on the virtual hub or specified resource.", + "properties": { + "addressPrefixes": { + "description": "The list of address prefixes.", + "type": "array", + "items": { + "type": "string" + } + }, + "nextHops": { + "description": "The list of next hops.", + "type": "array", + "items": { + "type": "string" + } + }, + "nextHopType": { + "description": "The type of the next hop.", + "type": "string" + }, + "asPath": { + "description": "The ASPath of this route.", + "type": "string" + }, + "routeOrigin": { + "description": "The origin of this route.", + "type": "string" + } + } + }, + "EffectiveRoutesParameters": { + "description": "The parameters specifying the resource whose effective routes are being requested.", + "properties": { + "resourceId": { + "$ref": "./network.json#/definitions/Resource", + "description": "The resource whose effective routes are being requested." + }, + "virtualWanResourceType": { + "type": "string", + "description": "The type of the specified resource like RouteTable, ExpressRouteConnection, HubVirtualNetworkConnection, VpnConnection and P2SConnection." + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json new file mode 100644 index 000000000000..89562aa3062c --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json @@ -0,0 +1,374 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetVMNetworkInterfaces", + "description": "Gets information about all network interfaces in a virtual machine in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set vm network interfaces": { + "$ref": "./examples/VmssVmNetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/networkInterfaces": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetNetworkInterfaces", + "description": "Gets all network interfaces in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of NetworkInterface resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set network interfaces": { + "$ref": "./examples/VmssNetworkInterfaceList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetNetworkInterface", + "description": "Get the specified network interface in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterface resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterface" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get virtual machine scale set network interface": { + "$ref": "./examples/VmssNetworkInterfaceGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_ListVirtualMachineScaleSetIpConfigurations", + "description": "Get the specified network interface ip configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the list of resulting NetworkInterfaceIPConfigurations resources.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List virtual machine scale set network interface ip configurations": { + "$ref": "./examples/VmssNetworkInterfaceIpConfigList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipConfigurations/{ipConfigurationName}": { + "get": { + "tags": [ + "NetworkInterfaces" + ], + "operationId": "NetworkInterfaces_GetVirtualMachineScaleSetIpConfiguration", + "description": "Get the specified network interface ip configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the ip configuration." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting NetworkInterfaceIPConfiguration resource.", + "schema": { + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get virtual machine scale set network interface": { + "$ref": "./examples/VmssNetworkInterfaceIpConfigGet.json" + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/vmssPublicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/vmssPublicIpAddress.json new file mode 100644 index 000000000000..d100152e7711 --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/vmssPublicIpAddress.json @@ -0,0 +1,241 @@ +{ + "swagger": "2.0", + "info": { + "title": "NetworkManagementClient", + "description": "The Microsoft Azure Network management API provides a RESTful set of web services that interact with Microsoft Azure Networks service to manage your network resources. The API has entities that capture the relationship between an end user and the Microsoft Azure Networks service.", + "version": "2018-10-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetPublicIPAddresses", + "description": "Gets information about all public IP addresses on a virtual machine scale set level.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPInterface resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVMSSPublicIP": { + "$ref": "./examples/VmssPublicIpListAll.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses": { + "get": { + "operationId": "PublicIPAddresses_ListVirtualMachineScaleSetVMPublicIPAddresses", + "description": "Gets information about all public IP addresses in a virtual machine IP configuration in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The network interface name." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The IP configuration name." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Request successful. The operation returns a list of PublicIPAddress resources.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddressListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ListVMSSVMPublicIP": { + "$ref": "./examples/VmssVmPublicIpList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines/{virtualmachineIndex}/networkInterfaces/{networkInterfaceName}/ipconfigurations/{ipConfigurationName}/publicipaddresses/{publicIpAddressName}": { + "get": { + "operationId": "PublicIPAddresses_GetVirtualMachineScaleSetPublicIPAddress", + "description": "Get the specified public IP address in a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set." + }, + { + "name": "virtualmachineIndex", + "in": "path", + "required": true, + "type": "string", + "description": "The virtual machine index." + }, + { + "name": "networkInterfaceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the network interface." + }, + { + "name": "ipConfigurationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the IP configuration." + }, + { + "name": "publicIpAddressName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the public IP Address." + }, + { + "$ref": "./network.json#/parameters/ApiVersionVmssParameter" + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "Expands referenced resources." + } + ], + "x-ms-examples": { + "GetVMSSPublicIP": { + "$ref": "./examples/VmssPublicIpGet.json" + } + }, + "responses": { + "200": { + "description": "Request successful. The operation returns the resulting PublicIPAddress resource.", + "schema": { + "$ref": "./publicIpAddress.json#/definitions/PublicIPAddress" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + } + } + } +} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json new file mode 100644 index 000000000000..111927abcdca --- /dev/null +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json @@ -0,0 +1,743 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-05-01", + "title": "WebApplicationFirewallManagement", + "description": "APIs to manage web application firewall rules." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Lists all of the protection policies within a resource group.", + "operationId": "WebApplicationFirewallPolicies_List", + "x-ms-examples": { + "Lists all WAF policies in a resource group": { + "$ref": "./examples/WafListPolicies.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Gets all the WAF policies in a subscription.", + "operationId": "WebApplicationFirewallPolicies_ListAll", + "x-ms-examples": { + "Lists all WAF policies in a subscription": { + "$ref": "./examples/WafListAllPolicies.json" + } + }, + "parameters": [ + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}": { + "get": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Retrieve protection policy with specified name within a resource group.", + "operationId": "WebApplicationFirewallPolicies_Get", + "x-ms-examples": { + "Gets a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyGet.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Creates or update policy with specified rule set name within a resource group.", + "operationId": "WebApplicationFirewallPolicies_CreateOrUpdate", + "x-ms-examples": { + "Creates or updates a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyCreateOrUpdate.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "description": "Policy to be created.", + "in": "body", + "name": "parameters", + "required": true, + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "201": { + "description": "Created. The request has been fulfilled and a new protection policy has been created.", + "schema": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "WebApplicationFirewallPolicies" + ], + "description": "Deletes Policy.", + "operationId": "WebApplicationFirewallPolicies_Delete", + "x-ms-examples": { + "Deletes a WAF policy within a resource group": { + "$ref": "./examples/WafPolicyDelete.json" + } + }, + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "policyName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 128, + "description": "The name of the policy." + }, + { + "$ref": "./network.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "./network.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." + }, + "204": { + "description": "No Content. The request has been accepted but the policy was not found." + }, + "200": { + "description": "Delete successful." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "./network.json#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "WebApplicationFirewallPolicy": { + "description": "Defines web application firewall policy.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WebApplicationFirewallPolicyPropertiesFormat", + "description": "Properties of the web application firewall policy." + }, + "etag": { + "readOnly": true, + "type": "string", + "description": "A unique read-only string that changes whenever the resource is updated." + } + }, + "allOf": [ + { + "$ref": "./network.json#/definitions/Resource" + } + ] + }, + "WebApplicationFirewallPolicyPropertiesFormat": { + "description": "Defines web application firewall policy properties.", + "required": [ + "managedRules" + ], + "properties": { + "policySettings": { + "description": "The PolicySettings for policy.", + "$ref": "#/definitions/PolicySettings" + }, + "customRules": { + "description": "The custom rules inside the policy.", + "type": "array", + "items": { + "$ref": "#/definitions/WebApplicationFirewallCustomRule" + } + }, + "applicationGateways": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./applicationGateway.json#/definitions/ApplicationGateway" + }, + "description": "A collection of references to application gateways." + }, + "provisioningState": { + "readOnly": true, + "$ref": "./network.json#/definitions/ProvisioningState", + "description": "The provisioning state of the web application firewall policy resource." + }, + "resourceState": { + "title": "Resource status of the policy.", + "readOnly": true, + "type": "string", + "description": "Resource status of the policy.", + "enum": [ + "Creating", + "Enabling", + "Enabled", + "Disabling", + "Disabled", + "Deleting" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallPolicyResourceState", + "modelAsString": true + } + }, + "managedRules": { + "description": "Describes the managedRules structure.", + "$ref": "#/definitions/ManagedRulesDefinition" + }, + "httpListeners": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A collection of references to application gateway http listeners." + }, + "pathBasedRules": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "./network.json#/definitions/SubResource" + }, + "description": "A collection of references to application gateway path rules." + } + } + }, + "WebApplicationFirewallPolicyListResult": { + "description": "Result of the request to list WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/WebApplicationFirewallPolicy" + }, + "description": "List of WebApplicationFirewallPolicies within a resource group." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." + } + } + }, + "ManagedRulesDefinition": { + "description": "Allow to exclude some variable satisfy the condition for the WAF check.", + "required": [ + "managedRuleSets" + ], + "properties": { + "exclusions": { + "type": "array", + "items": { + "$ref": "#/definitions/OwaspCrsExclusionEntry" + }, + "description": "The Exclusions that are applied on the policy." + }, + "managedRuleSets": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleSet" + }, + "description": "The managed rule sets that are associated with the policy." + } + } + }, + "PolicySettings": { + "description": "Defines contents of a web application firewall global configuration.", + "properties": { + "state": { + "description": "The state of the policy.", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallEnabledState", + "modelAsString": true + } + }, + "mode": { + "description": "The mode of the policy.", + "type": "string", + "enum": [ + "Prevention", + "Detection" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallMode", + "modelAsString": true + } + }, + "requestBodyCheck": { + "type": "boolean", + "description": "Whether to allow WAF to check request Body." + }, + "maxRequestBodySizeInKb": { + "type": "integer", + "format": "int32", + "maximum": 128, + "exclusiveMaximum": false, + "minimum": 8, + "exclusiveMinimum": false, + "description": "Maximum request body size in Kb for WAF." + }, + "fileUploadLimitInMb": { + "type": "integer", + "format": "int32", + "minimum": 0, + "exclusiveMinimum": false, + "description": "Maximum file upload size in Mb for WAF." + } + } + }, + "WebApplicationFirewallCustomRule": { + "description": "Defines contents of a web application rule.", + "required": [ + "priority", + "ruleType", + "matchConditions", + "action" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the resource that is unique within a policy. This name can be used to access the resource.", + "maxLength": 128 + }, + "etag": { + "type": "string", + "readOnly": true, + "description": "A unique read-only string that changes whenever the resource is updated." + }, + "priority": { + "description": "Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.", + "type": "integer" + }, + "ruleType": { + "description": "The rule type.", + "type": "string", + "enum": [ + "MatchRule", + "Invalid" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallRuleType", + "modelAsString": true + } + }, + "matchConditions": { + "description": "List of match conditions.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchCondition" + } + }, + "action": { + "description": "Type of Actions.", + "type": "string", + "enum": [ + "Allow", + "Block", + "Log" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallAction", + "modelAsString": true + } + } + } + }, + "Transform": { + "description": "Transforms applied before matching.", + "type": "string", + "enum": [ + "Lowercase", + "Trim", + "UrlDecode", + "UrlEncode", + "RemoveNulls", + "HtmlEntityDecode" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallTransform", + "modelAsString": true + } + }, + "MatchVariable": { + "description": "Define match variables.", + "required": [ + "variableName" + ], + "properties": { + "variableName": { + "description": "Match Variable.", + "type": "string", + "enum": [ + "RemoteAddr", + "RequestMethod", + "QueryString", + "PostArgs", + "RequestUri", + "RequestHeaders", + "RequestBody", + "RequestCookies" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallMatchVariable", + "modelAsString": true + } + }, + "selector": { + "description": "The selector of match variable.", + "type": "string" + } + } + }, + "MatchCondition": { + "description": "Define match conditions.", + "required": [ + "matchVariables", + "operator", + "matchValues" + ], + "properties": { + "matchVariables": { + "description": "List of match variables.", + "type": "array", + "items": { + "$ref": "#/definitions/MatchVariable" + } + }, + "operator": { + "description": "The operator to be matched.", + "type": "string", + "enum": [ + "IPMatch", + "Equal", + "Contains", + "LessThan", + "GreaterThan", + "LessThanOrEqual", + "GreaterThanOrEqual", + "BeginsWith", + "EndsWith", + "Regex", + "GeoMatch" + ], + "x-ms-enum": { + "name": "WebApplicationFirewallOperator", + "modelAsString": true + } + }, + "negationConditon": { + "description": "Whether this is negate condition or not.", + "type": "boolean" + }, + "matchValues": { + "description": "Match value.", + "type": "array", + "items": { + "type": "string" + } + }, + "transforms": { + "description": "List of transforms.", + "type": "array", + "items": { + "$ref": "#/definitions/Transform" + } + } + } + }, + "ManagedRuleSet": { + "type": "object", + "description": "Defines a managed rule set.", + "required": [ + "ruleSetType", + "ruleSetVersion" + ], + "properties": { + "ruleSetType": { + "description": "Defines the rule set type to use.", + "type": "string" + }, + "ruleSetVersion": { + "description": "Defines the version of the rule set to use.", + "type": "string" + }, + "ruleGroupOverrides": { + "description": "Defines the rule group overrides to apply to the rule set.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleGroupOverride" + } + } + } + }, + "ManagedRuleGroupOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleGroupName" + ], + "properties": { + "ruleGroupName": { + "description": "The managed rule group to override.", + "type": "string" + }, + "rules": { + "description": "List of rules that will be disabled. If none specified, all rules in the group will be disabled.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedRuleOverride" + } + } + } + }, + "ManagedRuleOverride": { + "description": "Defines a managed rule group override setting.", + "required": [ + "ruleId" + ], + "properties": { + "ruleId": { + "description": "Identifier for the managed rule.", + "type": "string" + }, + "state": { + "description": "The state of the managed rule. Defaults to Disabled if not specified.", + "type": "string", + "enum": [ + "Disabled" + ], + "x-ms-enum": { + "name": "ManagedRuleEnabledState", + "modelAsString": true + } + } + } + }, + "OwaspCrsExclusionEntry": { + "required": [ + "matchVariable", + "selectorMatchOperator", + "selector" + ], + "description": "Allow to exclude some variable satisfy the condition for the WAF check.", + "properties": { + "matchVariable": { + "type": "string", + "enum": [ + "RequestHeaderNames", + "RequestCookieNames", + "RequestArgNames" + ], + "description": "The variable to be excluded.", + "x-ms-enum": { + "name": "OwaspCrsExclusionEntryMatchVariable", + "modelAsString": true + } + }, + "selectorMatchOperator": { + "type": "string", + "enum": [ + "Equals", + "Contains", + "StartsWith", + "EndsWith", + "EqualsAny" + ], + "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.", + "x-ms-enum": { + "name": "OwaspCrsExclusionEntrySelectorMatchOperator", + "modelAsString": true + } + }, + "selector": { + "type": "string", + "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." + } + } + } + } +} diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index 45312080b20f..9db19ff5ac47 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -28,15 +28,67 @@ These are the global settings for the Network API. title: NetworkManagementClient description: Network Client openapi-type: arm -tag: package-2020-04 +tag: package-2020-05 ``` +### Tag: package-2020-05 + +These settings apply only when `--tag=package-2020-05` is specified on the command line. + +```yaml $(tag) == 'package-2020-05' +input-file: + - Microsoft.Network/stable/2020-05-01/applicationGateway.json + - Microsoft.Network/stable/2020-05-01/applicationSecurityGroup.json + - Microsoft.Network/stable/2020-05-01/availableDelegations.json + - Microsoft.Network/stable/2020-05-01/availableServiceAliases.json + - Microsoft.Network/stable/2020-05-01/azureFirewall.json + - Microsoft.Network/stable/2020-05-01/azureFirewallFqdnTag.json + - Microsoft.Network/stable/2020-05-01/bastionHost.json + - Microsoft.Network/stable/2020-05-01/checkDnsAvailability.json + - Microsoft.Network/stable/2020-05-01/ddosCustomPolicy.json + - Microsoft.Network/stable/2020-05-01/ddosProtectionPlan.json + - Microsoft.Network/stable/2020-05-01/endpointService.json + - Microsoft.Network/stable/2020-05-01/expressRouteCircuit.json + - Microsoft.Network/stable/2020-05-01/expressRouteCrossConnection.json + - Microsoft.Network/stable/2020-05-01/expressRoutePort.json + - Microsoft.Network/stable/2020-05-01/firewallPolicy.json + - Microsoft.Network/stable/2020-05-01/ipAllocation.json + - Microsoft.Network/stable/2020-05-01/ipGroups.json + - Microsoft.Network/stable/2020-05-01/loadBalancer.json + - Microsoft.Network/stable/2020-05-01/natGateway.json + - Microsoft.Network/stable/2020-05-01/network.json + - Microsoft.Network/stable/2020-05-01/networkInterface.json + - Microsoft.Network/stable/2020-05-01/networkProfile.json + - Microsoft.Network/stable/2020-05-01/networkSecurityGroup.json + - Microsoft.Network/stable/2020-05-01/networkVirtualAppliance.json + - Microsoft.Network/stable/2020-05-01/networkWatcher.json + - Microsoft.Network/stable/2020-05-01/operation.json + - Microsoft.Network/stable/2020-05-01/privateEndpoint.json + - Microsoft.Network/stable/2020-05-01/privateLinkService.json + - Microsoft.Network/stable/2020-05-01/publicIpAddress.json + - Microsoft.Network/stable/2020-05-01/publicIpPrefix.json + - Microsoft.Network/stable/2020-05-01/routeFilter.json + - Microsoft.Network/stable/2020-05-01/routeTable.json + - Microsoft.Network/stable/2020-05-01/securityPartnerProvider.json + - Microsoft.Network/stable/2020-05-01/serviceCommunity.json + - Microsoft.Network/stable/2020-05-01/serviceEndpointPolicy.json + - Microsoft.Network/stable/2020-05-01/serviceTags.json + - Microsoft.Network/stable/2020-05-01/usage.json + - Microsoft.Network/stable/2020-05-01/virtualNetwork.json + - Microsoft.Network/stable/2020-05-01/virtualNetworkGateway.json + - Microsoft.Network/stable/2020-05-01/virtualNetworkTap.json + - Microsoft.Network/stable/2020-05-01/virtualRouter.json + - Microsoft.Network/stable/2020-05-01/virtualWan.json + - Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json + - Microsoft.Network/stable/2020-05-01/vmssPublicIpAddress.json + - Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json +``` ### Tag: package-2020-04 These settings apply only when `--tag=package-2020-04` is specified on the command line. -```yaml $(tag) == 'package-2020-04' +``` yaml $(tag) == 'package-2020-04' input-file: - Microsoft.Network/stable/2020-04-01/applicationGateway.json - Microsoft.Network/stable/2020-04-01/applicationSecurityGroup.json @@ -84,6 +136,7 @@ input-file: - Microsoft.Network/stable/2020-04-01/vmssPublicIpAddress.json - Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json ``` + ### Tag: package-2020-03 These settings apply only when `--tag=package-2020-03` is specified on the command line. From c9bbb209db39792761a4d88ea5f8e0e2566cfdaa Mon Sep 17 00:00:00 2001 From: rakeshakkera <52220364+rakeshakkera@users.noreply.github.com> Date: Tue, 9 Jun 2020 18:35:45 -0700 Subject: [PATCH 119/318] Azure Spot Standalone VMs support 'Delete' eviction policy (#9743) --- .../Microsoft.Compute/stable/2019-12-01/compute.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json index 8cc4586990f8..4e9f646b5399 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-12-01/compute.json @@ -8456,7 +8456,7 @@ }, "evictionPolicy": { "$ref": "#/definitions/evictionPolicy", - "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

For Azure Spot virtual machines, the only supported value is 'Deallocate' and the minimum api-version is 2019-03-01.

For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.

For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." }, "billingProfile": { "$ref": "#/definitions/BillingProfile", @@ -9754,7 +9754,7 @@ }, "evictionPolicy": { "$ref": "#/definitions/evictionPolicy", - "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

For Azure Spot virtual machines, the only supported value is 'Deallocate' and the minimum api-version is 2019-03-01.

For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.

For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." }, "billingProfile": { "$ref": "#/definitions/BillingProfile", From b4fbfef50cc5b7b9fc90019356a5d459aa06c423 Mon Sep 17 00:00:00 2001 From: vidyadharijami <57709079+vidyadharijami@users.noreply.github.com> Date: Wed, 10 Jun 2020 07:19:10 +0530 Subject: [PATCH 120/318] Support for Proximity placement group and Availability zone as input for VMWare to Azure and Hyper-V to Azure replications in Site Recovery Service (#9688) * Adding Proximity placement group and Availability zone for V2A and H2A * Fix after running prettier --- .../stable/2018-07-10/service.json | 52 +++++++++++++++++++ 1 file changed, 52 insertions(+) diff --git a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-07-10/service.json b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-07-10/service.json index 522c8ff4f166..7f53155a6a2e 100644 --- a/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-07-10/service.json +++ b/specification/recoveryservicessiterecovery/resource-manager/Microsoft.RecoveryServices/stable/2018-07-10/service.json @@ -10211,6 +10211,14 @@ "useManagedDisks": { "description": "A value indicating whether managed disks should be used during failover.", "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The proximity placement group ARM Id.", + "type": "string" } }, "x-ms-discriminator-value": "HyperVReplicaAzure" @@ -10476,6 +10484,14 @@ "description": "The recovery availability set Id.", "type": "string" }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, "useManagedDisks": { "description": "A value indicating whether managed disks should be used during failover.", "type": "string" @@ -10550,6 +10566,14 @@ "additionalProperties": { "type": "string" } + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" } }, "x-ms-discriminator-value": "HyperVReplicaAzure" @@ -11402,6 +11426,14 @@ "diskEncryptionSetId": { "description": "The DiskEncryptionSet ARM ID.", "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The proximity placement group ARM Id.", + "type": "string" } }, "x-ms-discriminator-value": "InMageAzureV2" @@ -11829,6 +11861,10 @@ "description": "The selected recovery azure network Id.", "type": "string" }, + "selectedTfoAzureNetworkId": { + "description": "The test failover virtual network.", + "type": "string" + }, "selectedSourceNicId": { "description": "The selected source nic Id which will be used as the primary nic during failover.", "type": "string" @@ -11860,6 +11896,14 @@ "description": "The recovery availability set Id.", "type": "string" }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, "useManagedDisks": { "description": "A value indicating whether managed disks should be used during failover.", "type": "string" @@ -11966,6 +12010,14 @@ "useManagedDisks": { "description": "A value indicating whether managed disks should be used during failover.", "type": "string" + }, + "targetProximityPlacementGroupId": { + "description": "The target proximity placement group Id.", + "type": "string" + }, + "targetAvailabilityZone": { + "description": "The target availability zone.", + "type": "string" } }, "x-ms-discriminator-value": "InMageAzureV2" From eb5c8788040400a15b4917442643dfce6af08f98 Mon Sep 17 00:00:00 2001 From: Meha Kaushik Date: Tue, 9 Jun 2020 19:31:13 -0700 Subject: [PATCH 121/318] Update Go and Java Readme (#9793) * Adding notebooks in 1212 and 0301 * updating java readme * fixing issue in go readme * fixing issue in java readme Co-authored-by: Meha Kaushik --- .../cosmos-db/resource-manager/readme.go.md | 10 ++++++++++ .../cosmos-db/resource-manager/readme.java.md | 14 ++++++++++++++ 2 files changed, 24 insertions(+) diff --git a/specification/cosmos-db/resource-manager/readme.go.md b/specification/cosmos-db/resource-manager/readme.go.md index e77d1f0a2b99..09594aa19120 100644 --- a/specification/cosmos-db/resource-manager/readme.go.md +++ b/specification/cosmos-db/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-04 - tag: package-2020-03 - tag: package-2019-12 - tag: package-2019-08 @@ -20,6 +21,15 @@ batch: - tag: package-2015-04 ``` +### Tag: package-2020-04 and go + +These settings apply only when `--tag=package-2020-04 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-04' && $(go) +output-folder: $(go-sdk-folder)/services/cosmos-db/mgmt/2020-04-01/$(namespace) +``` + ### Tag: package-2020-03 and go These settings apply only when `--tag=package-2020-03 --go` is specified on the command line. diff --git a/specification/cosmos-db/resource-manager/readme.java.md b/specification/cosmos-db/resource-manager/readme.java.md index 29cd5f533fdc..f54ed71714a6 100644 --- a/specification/cosmos-db/resource-manager/readme.java.md +++ b/specification/cosmos-db/resource-manager/readme.java.md @@ -17,6 +17,7 @@ service-name: CosmosDB ``` yaml $(java) && $(multiapi) batch: + - tag: package-2020-04 - tag: package-2020-03 - tag: package-2019-12 - tag: package-2019-08 @@ -24,6 +25,19 @@ batch: - tag: package-2015-04 ``` +### Tag: package-2020-04 and java + +These settings apply only when `--tag=package-2020-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.cosmosdb.v2020_04_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/cosmos/mgmt-v2020_04_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2020-03 and java These settings apply only when `--tag=package-2020-03 --java` is specified on the command line. From 074f6dbd7a896c1455d7912c130536a6ec468500 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Wed, 10 Jun 2020 11:13:03 +0800 Subject: [PATCH 122/318] Add new api-version (#9760) --- specification/keyvault/resource-manager/readme.go.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/keyvault/resource-manager/readme.go.md b/specification/keyvault/resource-manager/readme.go.md index cd3e71257c40..18186ff695aa 100644 --- a/specification/keyvault/resource-manager/readme.go.md +++ b/specification/keyvault/resource-manager/readme.go.md @@ -13,11 +13,21 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2019-09 - tag: package-2018-02 - tag: package-2016-10 - tag: package-2015-06 ``` +### Tag: package-2019-09 and go + +These settings apply only when `--tag=package-2019-09 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-09' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-09-01/$(namespace) +``` + ### Tag: package-2018-02 and go These settings apply only when `--tag=package-2018-02 --go` is specified on the command line. From 421c92a2e6bb4a887833262ed9e3e2089bcd8aef Mon Sep 17 00:00:00 2001 From: Chen Lahav Date: Wed, 10 Jun 2020 06:52:21 +0300 Subject: [PATCH 123/318] [Microsoft.Security] avoiding URL encoding for resource ID parameters (#9788) Co-authored-by: Chen Lahav --- .../security/resource-manager/common/v1/types.json | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/specification/security/resource-manager/common/v1/types.json b/specification/security/resource-manager/common/v1/types.json index 1dd01005fbcc..48bec7b159a3 100644 --- a/specification/security/resource-manager/common/v1/types.json +++ b/specification/security/resource-manager/common/v1/types.json @@ -303,7 +303,8 @@ "required": true, "type": "string", "description": "The identifier of the resource.", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true }, "Scope": { "name": "scope", @@ -311,7 +312,8 @@ "required": true, "type": "string", "description": "Scope of the query, can be subscription (/subscriptions/0b06d9ea-afe6-4779-bd59-30e5c2d9d13f) or management group (/providers/Microsoft.Management/managementGroups/mgName).", - "x-ms-parameter-location": "method" + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true }, "ODataFilter": { "name": "$filter", From b39019f3130301e7e669fab9aa9544bb60d3fabf Mon Sep 17 00:00:00 2001 From: brpanask <64860651+brpanask@users.noreply.github.com> Date: Wed, 10 Jun 2020 01:42:17 -0400 Subject: [PATCH 124/318] Updated StorageCache Examples (#9791) --- .../examples/Caches_CreateOrUpdate.json | 14 +++++++------- .../stable/2020-03-01/examples/Caches_Get.json | 8 ++++---- .../stable/2020-03-01/examples/Caches_List.json | 16 ++++++++-------- .../examples/Caches_ListByResourceGroup.json | 16 ++++++++-------- .../2020-03-01/examples/Caches_Update.json | 10 +++++----- 5 files changed, 32 insertions(+), 32 deletions(-) diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_CreateOrUpdate.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_CreateOrUpdate.json index 8749b6b5c3e7..5673dedad5c4 100644 --- a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_CreateOrUpdate.json +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_CreateOrUpdate.json @@ -6,7 +6,7 @@ "api-version": "2020-03-01", "cache": { "tags": { - "Dept": "Initech" + "Dept": "ContosoAds" }, "location": "westus", "properties": { @@ -22,7 +22,7 @@ "201": { "body": { "tags": { - "Dept": "Initech" + "Dept": "ContosoAds" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", "location": "westus", @@ -38,7 +38,7 @@ "192.168.1.1", "192.168.1.2" ], - "provisioningState": "Booting", + "provisioningState": "Succeeded", "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", "upgradeStatus": { "currentFirmwareVersion": "5.3.23", @@ -59,7 +59,7 @@ "200": { "body": { "tags": { - "Dept": "Initech" + "Dept": "ContosoAds" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", "location": "westus", @@ -75,14 +75,14 @@ "192.168.1.1", "192.168.1.2" ], - "provisioningState": "Booting", + "provisioningState": "Updating", "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", "upgradeStatus": { - "currentFirmwareVersion": "AvereOS V5.1.1.2", + "currentFirmwareVersion": "V5.1.12", "firmwareUpdateStatus": "available", "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", - "pendingFirmwareVersion": "AvereOS V5.1.1.32" + "pendingFirmwareVersion": "V5.1.15" }, "networkSettings": { "mtu": 1500 diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Get.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Get.json index 39e20ed9a4cd..51ff1db2e017 100644 --- a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Get.json +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Get.json @@ -9,7 +9,7 @@ "200": { "body": { "tags": { - "Dept": "Initech" + "Dept": "ContosoAds" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", "location": "westus", @@ -25,14 +25,14 @@ "192.168.1.1", "192.168.1.2" ], - "provisioningState": "Booting", + "provisioningState": "Succeeded", "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", "upgradeStatus": { - "currentFirmwareVersion": "AvereOS V5.1.1.2", + "currentFirmwareVersion": "V5.1.12", "firmwareUpdateStatus": "available", "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", - "pendingFirmwareVersion": "AvereOS V5.1.1.32" + "pendingFirmwareVersion": "V5.1.15" }, "networkSettings": { "mtu": 1500 diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_List.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_List.json index e4274e6b3a9f..30094bbfd392 100644 --- a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_List.json +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_List.json @@ -9,7 +9,7 @@ "value": [ { "tags": { - "Dept": "Initech" + "Dept": "ContosoAds" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", "location": "westus", @@ -25,14 +25,14 @@ "192.168.1.1", "192.168.1.2" ], - "provisioningState": "Booting", + "provisioningState": "Succeeded", "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", "upgradeStatus": { - "currentFirmwareVersion": "AvereOS V5.1.1.2", + "currentFirmwareVersion": "V5.1.12", "firmwareUpdateStatus": "available", "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", - "pendingFirmwareVersion": "AvereOS V5.1.1.32" + "pendingFirmwareVersion": "V5.1.15" }, "networkSettings": { "mtu": 1500 @@ -44,7 +44,7 @@ }, { "tags": { - "Dept": "Intertrode" + "Dept": "ContosoAds" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc2", "location": "westus", @@ -60,14 +60,14 @@ "192.168.1.1", "192.168.1.2" ], - "provisioningState": "Configuring", + "provisioningState": "Updating", "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub2", "upgradeStatus": { - "currentFirmwareVersion": "AvereOS V5.1.1.2", + "currentFirmwareVersion": "V5.1.12", "firmwareUpdateStatus": "available", "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", - "pendingFirmwareVersion": "AvereOS V5.1.1.32" + "pendingFirmwareVersion": "V5.1.15" }, "networkSettings": { "mtu": 1500 diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_ListByResourceGroup.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_ListByResourceGroup.json index 258735a01725..015a5719b0a4 100644 --- a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_ListByResourceGroup.json +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_ListByResourceGroup.json @@ -10,7 +10,7 @@ "value": [ { "tags": { - "Dept": "Initech" + "Dept": "ContosoAds" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", "location": "westus", @@ -26,14 +26,14 @@ "192.168.1.1", "192.168.1.2" ], - "provisioningState": "Booting", + "provisioningState": "Succeeded", "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", "upgradeStatus": { - "currentFirmwareVersion": "AvereOS V5.1.1.2", + "currentFirmwareVersion": "V5.1.12", "firmwareUpdateStatus": "available", "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", - "pendingFirmwareVersion": "AvereOS V5.1.1.32" + "pendingFirmwareVersion": "V5.1.15" }, "networkSettings": { "mtu": 1500 @@ -45,7 +45,7 @@ }, { "tags": { - "Dept": "Intertrode" + "Dept": "ContosoAds" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc2", "location": "westus", @@ -61,14 +61,14 @@ "192.168.1.1", "192.168.1.2" ], - "provisioningState": "Booting", + "provisioningState": "Updating", "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub2", "upgradeStatus": { - "currentFirmwareVersion": "AvereOS V5.1.1.2", + "currentFirmwareVersion": "V5.1.12", "firmwareUpdateStatus": "available", "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", - "pendingFirmwareVersion": "AvereOS V5.1.1.32" + "pendingFirmwareVersion": "V5.1.15" }, "networkSettings": { "mtu": 1500 diff --git a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Update.json b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Update.json index b5fdb34b4458..61fac4750c6d 100644 --- a/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Update.json +++ b/specification/storagecache/resource-manager/Microsoft.StorageCache/stable/2020-03-01/examples/Caches_Update.json @@ -6,7 +6,7 @@ "api-version": "2020-03-01", "cache": { "tags": { - "Dept": "Initech" + "Dept": "ContosoAds" }, "location": "westus", "properties": { @@ -22,7 +22,7 @@ "200": { "body": { "tags": { - "Dept": "Initech" + "Dept": "ContosoAds" }, "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.StorageCache/caches/sc1", "location": "westus", @@ -38,14 +38,14 @@ "192.168.1.1", "192.168.1.2" ], - "provisioningState": "Booting", + "provisioningState": "Updating", "subnet": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/scgroup/providers/Microsoft.Network/virtualNetworks/scvnet/subnets/sub1", "upgradeStatus": { - "currentFirmwareVersion": "AvereOS V5.1.1.2", + "currentFirmwareVersion": "V5.1.12", "firmwareUpdateStatus": "available", "firmwareUpdateDeadline": "2019-04-21T18:25:43.511Z", "lastFirmwareUpdate": "2019-01-21T18:25:43.511Z", - "pendingFirmwareVersion": "AvereOS V5.1.1.32" + "pendingFirmwareVersion": "V5.1.15" }, "networkSettings": { "mtu": 1500 From ff7203b3e0f4cc0dd273068a92d120737fc34613 Mon Sep 17 00:00:00 2001 From: dhruvsawhney Date: Wed, 10 Jun 2020 04:31:30 -0700 Subject: [PATCH 125/318] Updates to LoadBalancer swagger (#9794) * updates to 04-01/loadBalancer.json * updates to 05-01/loadBalancer.json * updates to remove LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json * Fix PrettierCheck * remove LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json from both dirs Co-authored-by: Dhruv Sawhney --- ...endAddressesPutWithNICIPConfiguration.json | 91 ------------------- .../stable/2020-04-01/loadBalancer.json | 8 +- ...endAddressesPutWithNICIPConfiguration.json | 91 ------------------- .../stable/2020-05-01/loadBalancer.json | 8 +- 4 files changed, 6 insertions(+), 192 deletions(-) delete mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json delete mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json deleted file mode 100644 index a4adbda522a1..000000000000 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json +++ /dev/null @@ -1,91 +0,0 @@ -{ - "parameters": { - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "loadBalancerName": "lb", - "backendAddressPoolName": "backend", - "api-version": "2020-04-01", - "parameters": { - "properties": { - "loadBalancerBackendAddresses": [ - { - "name": "address1", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig1" - } - } - }, - { - "name": "address2", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig2" - } - } - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "name": "backend", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", - "etag": "W/\"00000000-0000-0000-0000-000000000000\"", - "type": "Microsoft.Network/loadBalancers/backendAddressPools", - "properties": { - "provisioningState": "Succeeded", - "loadBalancerBackendAddresses": [ - { - "name": "address1", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig1" - } - } - }, - { - "name": "address2", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig2" - } - } - } - ] - } - } - }, - "201": { - "body": { - "name": "backend", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", - "etag": "W/\"00000000-0000-0000-0000-000000000000\"", - "type": "Microsoft.Network/loadBalancers/backendAddressPools", - "properties": { - "provisioningState": "Succeeded", - "loadBalancerBackendAddresses": [ - { - "name": "address1", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig1" - } - } - }, - { - "name": "address2", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig2" - } - } - } - ] - } - } - } - } -} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/loadBalancer.json index 1fc7d526fa52..01905101e2e3 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/loadBalancer.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/loadBalancer.json @@ -549,9 +549,6 @@ "x-ms-examples": { "Update load balancer backend pool with backend addresses containing virtual network and IP address.": { "$ref": "./examples/LBBackendAddressPoolWithBackendAddressesPut.json" - }, - "Update load balancer backend pool with backend addresses containing virtual network and IP address defined in network interfaces.": { - "$ref": "./examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json" } }, "x-ms-long-running-operation": true, @@ -1495,7 +1492,7 @@ "LoadBalancerBackendAddressPropertiesFormat": { "properties": { "virtualNetwork": { - "$ref": "./virtualNetwork.json#/definitions/VirtualNetwork", + "$ref": "./network.json#/definitions/SubResource", "description": "Reference to an existing virtual network." }, "ipAddress": { @@ -1504,7 +1501,8 @@ "x-ms-azure-resource": false }, "networkInterfaceIPConfiguration": { - "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", "description": "Reference to IP address defined in network interfaces." } }, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json deleted file mode 100644 index eadf70581c3e..000000000000 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json +++ /dev/null @@ -1,91 +0,0 @@ -{ - "parameters": { - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "loadBalancerName": "lb", - "backendAddressPoolName": "backend", - "api-version": "2020-05-01", - "parameters": { - "properties": { - "loadBalancerBackendAddresses": [ - { - "name": "address1", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig1" - } - } - }, - { - "name": "address2", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig2" - } - } - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "name": "backend", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", - "etag": "W/\"00000000-0000-0000-0000-000000000000\"", - "type": "Microsoft.Network/loadBalancers/backendAddressPools", - "properties": { - "provisioningState": "Succeeded", - "loadBalancerBackendAddresses": [ - { - "name": "address1", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig1" - } - } - }, - { - "name": "address2", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig2" - } - } - } - ] - } - } - }, - "201": { - "body": { - "name": "backend", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/loadBalancers/lb/backendAddressPools/backend", - "etag": "W/\"00000000-0000-0000-0000-000000000000\"", - "type": "Microsoft.Network/loadBalancers/backendAddressPools", - "properties": { - "provisioningState": "Succeeded", - "loadBalancerBackendAddresses": [ - { - "name": "address1", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig1" - } - } - }, - { - "name": "address2", - "properties": { - "networkInterfaceIPConfiguration": { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/networkInterfaces/vnetlb/ipConfigurations/ipconfig2" - } - } - } - ] - } - } - } - } -} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json index 20ae268b140c..956b50a92d18 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json @@ -549,9 +549,6 @@ "x-ms-examples": { "Update load balancer backend pool with backend addresses containing virtual network and IP address.": { "$ref": "./examples/LBBackendAddressPoolWithBackendAddressesPut.json" - }, - "Update load balancer backend pool with backend addresses containing virtual network and IP address defined in network interfaces.": { - "$ref": "./examples/LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json" } }, "x-ms-long-running-operation": true, @@ -1495,7 +1492,7 @@ "LoadBalancerBackendAddressPropertiesFormat": { "properties": { "virtualNetwork": { - "$ref": "./virtualNetwork.json#/definitions/VirtualNetwork", + "$ref": "./network.json#/definitions/SubResource", "description": "Reference to an existing virtual network." }, "ipAddress": { @@ -1504,7 +1501,8 @@ "x-ms-azure-resource": false }, "networkInterfaceIPConfiguration": { - "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration", + "readOnly": true, + "$ref": "./network.json#/definitions/SubResource", "description": "Reference to IP address defined in network interfaces." } }, From 873a13e78197ef6cc2c3eb1c6022b04eda84fb41 Mon Sep 17 00:00:00 2001 From: shobhitmishra Date: Wed, 10 Jun 2020 19:51:01 -0700 Subject: [PATCH 126/318] [Hub Generated] Review request for Microsoft.BotService to add version stable/2020-06-02 (#9696) --- custom-words.txt | 4 + .../stable/2020-06-02/botservice.json | 2561 +++++++++++++++++ .../examples/CheckNameAvailability.json | 17 + .../stable/2020-06-02/examples/CreateBot.json | 105 + .../stable/2020-06-02/examples/DeleteBot.json | 12 + .../2020-06-02/examples/DeleteChannel.json | 13 + .../2020-06-02/examples/DeleteConnection.json | 13 + .../DeleteDirectLineSpeechChannel.json | 13 + .../examples/DirectlineRegenerateKeys.json | 36 + .../2020-06-02/examples/GetAlexaChannel.json | 25 + .../stable/2020-06-02/examples/GetBot.json | 45 + .../2020-06-02/examples/GetChannel.json | 24 + .../2020-06-02/examples/GetConnection.json | 36 + .../examples/GetDirectLineSpeechChannel.json | 26 + .../2020-06-02/examples/GetLineChannel.json | 30 + .../2020-06-02/examples/GetOperations.json | 53 + .../examples/ListBotsByResourceGroup.json | 48 + .../examples/ListBotsBySubscription.json | 47 + .../2020-06-02/examples/ListChannel.json | 27 + .../examples/ListChannelsByBotService.json | 46 + .../examples/ListConnectionsByBotService.json | 35 + .../examples/ListServiceProviders.json | 33 + .../2020-06-02/examples/PutAlexaChannel.json | 49 + .../2020-06-02/examples/PutChannel.json | 48 + .../2020-06-02/examples/PutConnection.json | 81 + .../examples/PutDirectLineSpeechChannel.json | 45 + .../2020-06-02/examples/PutLineChannel.json | 63 + .../examples/UpdateAlexaChannel.json | 49 + .../stable/2020-06-02/examples/UpdateBot.json | 107 + .../2020-06-02/examples/UpdateChannel.json | 48 + .../2020-06-02/examples/UpdateConnection.json | 81 + .../UpdateDirectLineSpeechChannel.json | 45 + .../examples/UpdateLineChannel.json | 63 + .../examples/WebChatRegenerateKeys.json | 35 + .../botservice/resource-manager/readme.md | 28 +- 35 files changed, 3982 insertions(+), 9 deletions(-) create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/botservice.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/CheckNameAvailability.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/CreateBot.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteBot.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteConnection.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteDirectLineSpeechChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DirectlineRegenerateKeys.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetAlexaChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetBot.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetConnection.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetDirectLineSpeechChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetLineChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetOperations.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsByResourceGroup.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsBySubscription.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListChannelsByBotService.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListConnectionsByBotService.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListServiceProviders.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutAlexaChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutConnection.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutDirectLineSpeechChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutLineChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateAlexaChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateBot.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateConnection.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateDirectLineSpeechChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateLineChannel.json create mode 100644 specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/WebChatRegenerateKeys.json diff --git a/custom-words.txt b/custom-words.txt index 626e14de791b..f2b1de52262c 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1785,6 +1785,10 @@ userprincipalname sessionstate sessionhosts hostpool +Alexa +regeneratekeys +Directline +Keyschannel azureADMetrics sparkr ambari diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/botservice.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/botservice.json new file mode 100644 index 000000000000..4253a275b423 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/botservice.json @@ -0,0 +1,2561 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Bot Service", + "description": "Azure Bot Service is a platform for creating smart conversational agents.", + "version": "2020-06-02" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}": { + "put": { + "tags": [ + "Bot" + ], + "description": "Creates a Bot Service. Bot Service is a resource group wide resource type.", + "operationId": "Bots_Create", + "x-ms-examples": { + "Create Bot": { + "$ref": "./examples/CreateBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Bot" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "Bot" + ], + "description": "Updates a Bot Service", + "operationId": "Bots_Update", + "x-ms-examples": { + "Update Bot": { + "$ref": "./examples/UpdateBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/Bot" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "201": { + "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "Bot" + ], + "description": "Deletes a Bot Service from the resource group. ", + "operationId": "Bots_Delete", + "x-ms-examples": { + "Delete Bot": { + "$ref": "./examples/DeleteBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "Bot" + ], + "description": "Returns a BotService specified by the parameters.", + "operationId": "Bots_Get", + "x-ms-examples": { + "Get Bot": { + "$ref": "./examples/GetBot.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/Bot" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices": { + "get": { + "tags": [ + "Bot" + ], + "description": "Returns all the resources of a particular type belonging to a resource group", + "operationId": "Bots_ListByResourceGroup", + "x-ms-examples": { + "List Bots by Resource Group": { + "$ref": "./examples/ListBotsByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/BotResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/botServices": { + "get": { + "tags": [ + "Bot" + ], + "description": "Returns all the resources of a particular type belonging to a subscription.", + "operationId": "Bots_List", + "x-ms-examples": { + "List Bots by Subscription": { + "$ref": "./examples/ListBotsBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/BotResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}": { + "put": { + "tags": [ + "Channel" + ], + "description": "Creates a Channel registration for a Bot Service", + "operationId": "Channels_Create", + "x-ms-examples": { + "Create Bot": { + "$ref": "./examples/PutChannel.json" + }, + "Create Alexa Bot": { + "$ref": "./examples/PutAlexaChannel.json" + }, + "Create Line Bot": { + "$ref": "./examples/PutLineChannel.json" + }, + "Create DirectLine Speech Bot": { + "$ref": "./examples/PutDirectLineSpeechChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/channelNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BotChannel" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "Channel" + ], + "description": "Updates a Channel registration for a Bot Service", + "operationId": "Channels_Update", + "x-ms-examples": { + "Update Bot": { + "$ref": "./examples/UpdateChannel.json" + }, + "Update Alexa": { + "$ref": "./examples/UpdateAlexaChannel.json" + }, + "Update Line": { + "$ref": "./examples/UpdateLineChannel.json" + }, + "Update DirectLine Speech": { + "$ref": "./examples/UpdateDirectLineSpeechChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/channelNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "x-ms-client-flatten": true, + "schema": { + "$ref": "#/definitions/BotChannel" + }, + "description": "The parameters to provide for the created bot." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "201": { + "description": "If resource is updated successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "Channel" + ], + "description": "Deletes a Channel registration from a Bot Service", + "operationId": "Channels_Delete", + "x-ms-examples": { + "Delete Bot": { + "$ref": "./examples/DeleteChannel.json" + }, + "Delete DirectLine Speech Bot": { + "$ref": "./examples/DeleteDirectLineSpeechChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "channelName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "Channel" + ], + "description": "Returns a BotService Channel registration specified by the parameters.", + "operationId": "Channels_Get", + "x-ms-examples": { + "Get Bot": { + "$ref": "./examples/GetChannel.json" + }, + "Get Alexa Bot": { + "$ref": "./examples/GetAlexaChannel.json" + }, + "Get Line Bot": { + "$ref": "./examples/GetLineChannel.json" + }, + "Get DirectLine Speech Bot": { + "$ref": "./examples/GetDirectLineSpeechChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "name": "channelName", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/listChannelWithKeys": { + "post": { + "tags": [ + "Channel" + ], + "description": "Lists a Channel registration for a Bot Service including secrets", + "operationId": "Channels_ListWithKeys", + "x-ms-examples": { + "List Channel": { + "$ref": "./examples/ListChannel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/channelNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is retrieved successfully, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels": { + "get": { + "tags": [ + "Channel" + ], + "description": "Returns all the Channel registrations of a particular BotService resource", + "operationId": "Channels_ListByResourceGroup", + "x-ms-examples": { + "List Bots by Resource Group": { + "$ref": "./examples/ListChannelsByBotService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/ChannelResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/channels/{channelName}/regeneratekeys": { + "post": { + "tags": [ + "Channel" + ], + "description": "Regenerates secret keys and returns them for the DirectLine Channel of a particular BotService resource", + "operationId": "DirectLine_RegenerateKeys", + "x-ms-examples": { + "Regenerate Keys for DirectLine Channel Site": { + "$ref": "./examples/DirectlineRegenerateKeys.json" + }, + "Regenerate Keys for WebChat Channel Site": { + "$ref": "./examples/WebChatRegenerateKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/regenerateKeyschannelNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SiteInfo" + }, + "description": "The parameters to provide for the created bot." + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/BotChannel" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.BotService/checkNameAvailability": { + "post": { + "tags": [ + "Bot" + ], + "description": "Check whether a bot name is available.", + "operationId": "Bots_GetCheckNameAvailability", + "x-ms-examples": { + "check Name Availability": { + "$ref": "./examples/CheckNameAvailability.json" + } + }, + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityRequestBody" + }, + "description": "The request body parameters to provide for the check name availability request" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses. If a resource provider does not support paging, it should return the same body but leave nextLink empty for future compatibility.\nFor a detailed explanation of each field in the response body, please refer to the request body description in the PUT resource section. ", + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityResponseBody" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/providers/Microsoft.BotService/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all the available BotService operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "Get Operations": { + "$ref": "./examples/GetOperations.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/OperationEntityListResult" + } + } + }, + "deprecated": false, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.BotService/listAuthServiceProviders": { + "post": { + "tags": [ + "ListServiceProviders" + ], + "description": "Lists the available Service Providers for creating Connection Settings", + "operationId": "BotConnection_ListServiceProviders", + "x-ms-examples": { + "List Auth Service Providers": { + "$ref": "./examples/ListServiceProviders.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is retrieved successfully, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/ServiceProviderResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}/listWithSecrets": { + "post": { + "tags": [ + "BotConnection" + ], + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/GetConnection.json" + } + }, + "description": "Get a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_ListWithSecrets", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/Connections/{connectionName}": { + "put": { + "tags": [ + "BotConnection" + ], + "description": "Register a new Auth Connection for a Bot Service", + "operationId": "BotConnection_Create", + "x-ms-examples": { + "Create Connection Setting": { + "$ref": "./examples/PutConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSetting" + }, + "description": "The parameters to provide for creating the Connection Setting." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "patch": { + "tags": [ + "BotConnection" + ], + "description": "Updates a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_Update", + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/UpdateConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ConnectionSetting" + }, + "description": "The parameters to provide for updating the Connection Setting." + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "If resource is created successfully or already existed, the service should return 200 (OK).", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "201": { + "description": "If resource is created successfully, the service should return 201 (Created). Execution to continue asynchronously.", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "get": { + "tags": [ + "BotConnection" + ], + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/GetConnection.json" + } + }, + "description": "Get a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_Get", + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. ", + "schema": { + "$ref": "#/definitions/ConnectionSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group *or* resource does not exist, 404 (NotFound) should be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + }, + "delete": { + "tags": [ + "BotConnection" + ], + "description": "Deletes a Connection Setting registration for a Bot Service", + "operationId": "BotConnection_Delete", + "x-ms-examples": { + "Update Connection Setting": { + "$ref": "./examples/DeleteConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/connectionNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "A 200 (OK) should be returned if the object exists and was deleted successfully;" + }, + "204": { + "description": "a 204 (NoContent) should be used if the resource does not exist and the request is well formed." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.BotService/botServices/{resourceName}/connections": { + "get": { + "tags": [ + "BotConnection" + ], + "description": "Returns all the Connection Settings registered to a particular BotService resource", + "operationId": "BotConnection_ListByBotService", + "x-ms-examples": { + "List Connection Settings": { + "$ref": "./examples/ListConnectionsByBotService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/resourceNameParameter" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The resource provider should return 200 (OK) to indicate that the operation completed successfully. For other errors (e.g. internal errors) use the appropriate HTTP error code.\nThe nextLink field is expected to point to the URL the client should use to fetch the next page (per server side paging). This matches the OData guidelines for paged responses here. If a resource provider does not support paging, it should return the same body (JSON object with “value” property) but omit nextLink entirely (or set to null, *not* empty string) for future compatibility.\nThe nextLink should be implemented using following query parameters:\n· skipToken: opaque token that allows the resource provider to skip resources already enumerated. This value is defined and returned by the RP after first request via nextLink.\n· top: the optional client query parameter which defines the maximum number of records to be returned by the server.\nImplementation details:\n· NextLink may include all the query parameters (specifically OData $filter) used by the client in the first query. \n· Server may return less records than requested with nextLink. Returning zero records with NextLink is an acceptable response. \nClients must fetch records until the nextLink is not returned back / null. Clients should never rely on number of returned records to determinate if pagination is completed.", + "schema": { + "$ref": "#/definitions/ConnectionSettingResponseList" + } + }, + "default": { + "description": "Error response describing why the operation failed. If the resource group does not exist, 404 (NotFound) will be returned.", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Resource": { + "description": "Azure resource", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Specifies the resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Specifies the name of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "type": { + "description": "Specifies the type of the resource.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Gets or sets the SKU of the resource." + }, + "kind": { + "$ref": "#/definitions/Kind", + "description": "Required. Gets or sets the Kind of the resource." + }, + "etag": { + "type": "string", + "description": "Entity Tag" + } + } + }, + "Sku": { + "properties": { + "name": { + "$ref": "#/definitions/SkuName", + "description": "The sku name" + }, + "tier": { + "readOnly": true, + "type": "string", + "description": "Gets the sku tier. This is based on the SKU name.", + "enum": [ + "Free", + "Standard" + ], + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + }, + "required": [ + "name" + ], + "description": "The SKU of the cognitive services account." + }, + "SkuName": { + "type": "string", + "description": "The name of SKU.", + "enum": [ + "F0", + "S1" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "Kind": { + "type": "string", + "description": "Indicates the type of bot service", + "enum": [ + "sdk", + "designer", + "bot", + "function" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "Bot": { + "type": "object", + "description": "Bot resource definition", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BotProperties", + "description": "The set of properties specific to bot resource" + } + } + }, + "BotProperties": { + "properties": { + "displayName": { + "type": "string", + "description": "The Name of the bot" + }, + "description": { + "type": "string", + "description": "The description of the bot" + }, + "iconUrl": { + "type": "string", + "description": "The Icon Url of the bot" + }, + "endpoint": { + "type": "string", + "description": "The bot's endpoint" + }, + "endpointVersion": { + "type": "string", + "readOnly": true, + "description": "The bot's endpoint version" + }, + "msaAppId": { + "type": "string", + "description": "Microsoft App Id for the bot" + }, + "configuredChannels": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Collection of channels for which the bot is configured" + }, + "enabledChannels": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "Collection of channels for which the bot is enabled" + }, + "developerAppInsightKey": { + "type": "string", + "description": "The Application Insights key" + }, + "developerAppInsightsApiKey": { + "type": "string", + "description": "The Application Insights Api Key" + }, + "developerAppInsightsApplicationId": { + "type": "string", + "description": "The Application Insights App Id" + }, + "luisAppIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of LUIS App Ids" + }, + "luisKey": { + "type": "string", + "description": "The LUIS Key" + } + }, + "description": "The parameters to provide for the Bot.", + "required": [ + "displayName", + "endpoint", + "msaAppId" + ] + }, + "BotResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Bot" + }, + "description": "Gets the list of bot service results and their properties." + } + }, + "description": "The list of bot service operation response." + }, + "BotChannel": { + "type": "object", + "description": "Bot channel resource definition", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/Channel", + "description": "The set of properties specific to bot channel resource" + } + } + }, + "Channel": { + "type": "object", + "description": "Channel definition", + "discriminator": "channelName", + "properties": { + "channelName": { + "type": "string", + "description": "The channel name" + } + }, + "required": [ + "channelName" + ] + }, + "AlexaChannel": { + "type": "object", + "x-ms-discriminator-value": "AlexaChannel", + "description": "Alexa channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AlexaChannelProperties", + "description": "The set of properties specific to Alexa channel resource" + } + } + }, + "AlexaChannelProperties": { + "properties": { + "alexaSkillId": { + "type": "string", + "description": "The Alexa skill Id" + }, + "urlFragment": { + "type": "string", + "readOnly": true, + "description": "Url fragment used in part of the Uri configured in Alexa" + }, + "serviceEndpointUri": { + "type": "string", + "readOnly": true, + "description": "Full Uri used to configured the skill in Alexa" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Alexa channel.", + "required": [ + "alexaSkillId", + "isEnabled" + ] + }, + "FacebookChannel": { + "type": "object", + "description": "Facebook channel definition", + "x-ms-discriminator-value": "FacebookChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FacebookChannelProperties", + "description": "The set of properties specific to bot facebook channel" + } + } + }, + "FacebookChannelProperties": { + "properties": { + "verifyToken": { + "x-ms-secret": true, + "type": "string", + "readOnly": true, + "description": "Verify token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "pages": { + "type": "array", + "items": { + "$ref": "#/definitions/FacebookPage" + }, + "description": "The list of Facebook pages" + }, + "appId": { + "type": "string", + "description": "Facebook application id" + }, + "appSecret": { + "x-ms-secret": true, + "type": "string", + "description": "Facebook application secret. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "callbackUrl": { + "type": "string", + "readOnly": true, + "description": "Callback Url" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Facebook channel.", + "required": [ + "appId", + "appSecret", + "isEnabled" + ] + }, + "FacebookPage": { + "properties": { + "id": { + "type": "string", + "description": "Page id" + }, + "accessToken": { + "x-ms-secret": true, + "type": "string", + "description": "Facebook application access token. Value only returned through POST to the action Channel List API, otherwise empty." + } + }, + "description": "A Facebook page for Facebook channel registration", + "required": [ + "id", + "accessToken" + ] + }, + "EmailChannel": { + "type": "object", + "description": "Email channel definition", + "x-ms-discriminator-value": "EmailChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/EmailChannelProperties", + "description": "The set of properties specific to email channel resource" + } + } + }, + "EmailChannelProperties": { + "properties": { + "emailAddress": { + "type": "string", + "description": "The email address" + }, + "password": { + "type": "string", + "description": "The password for the email address. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Email channel.", + "required": [ + "emailAddress", + "password", + "isEnabled" + ] + }, + "MsTeamsChannel": { + "type": "object", + "x-ms-discriminator-value": "MsTeamsChannel", + "description": "Microsoft Teams channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MsTeamsChannelProperties", + "description": "The set of properties specific to Microsoft Teams channel resource" + } + } + }, + "MsTeamsChannelProperties": { + "properties": { + "enableCalling": { + "type": "boolean", + "description": "Enable calling for Microsoft Teams channel" + }, + "callingWebHook": { + "type": "string", + "description": "Webhook for Microsoft Teams channel calls" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Microsoft Teams channel.", + "required": [ + "isEnabled" + ] + }, + "SkypeChannel": { + "type": "object", + "description": "Skype channel definition", + "x-ms-discriminator-value": "SkypeChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SkypeChannelProperties", + "description": "The set of properties specific to Skype channel resource" + } + } + }, + "SkypeChannelProperties": { + "properties": { + "enableMessaging": { + "type": "boolean", + "description": "Enable messaging for Skype channel" + }, + "enableMediaCards": { + "type": "boolean", + "description": "Enable media cards for Skype channel" + }, + "enableVideo": { + "type": "boolean", + "description": "Enable video for Skype channel" + }, + "enableCalling": { + "type": "boolean", + "description": "Enable calling for Skype channel" + }, + "enableScreenSharing": { + "type": "boolean", + "description": "Enable screen sharing for Skype channel" + }, + "enableGroups": { + "type": "boolean", + "description": "Enable groups for Skype channel" + }, + "groupsMode": { + "type": "string", + "description": "Group mode for Skype channel" + }, + "callingWebHook": { + "type": "string", + "description": "Calling web hook for Skype channel" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Microsoft Teams channel.", + "required": [ + "isEnabled" + ] + }, + "KikChannel": { + "type": "object", + "x-ms-discriminator-value": "KikChannel", + "description": "Kik channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/KikChannelProperties", + "description": "The set of properties specific to Kik channel resource" + } + } + }, + "KikChannelProperties": { + "properties": { + "userName": { + "type": "string", + "description": "The Kik user name" + }, + "apiKey": { + "type": "string", + "description": "Kik API key. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Kik channel.", + "required": [ + "userName", + "apiKey", + "isEnabled" + ] + }, + "WebChatChannel": { + "type": "object", + "x-ms-discriminator-value": "WebChatChannel", + "description": "Web Chat channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WebChatChannelProperties", + "description": "The set of properties specific to Web Chat channel resource" + } + } + }, + "WebChatChannelProperties": { + "properties": { + "webChatEmbedCode": { + "type": "string", + "x-ms-mutability": [ + "read" + ], + "readOnly": true, + "description": "Web chat control embed code" + }, + "sites": { + "type": "array", + "items": { + "$ref": "#/definitions/WebChatSite" + }, + "description": "The list of Web Chat sites" + } + }, + "description": "The parameters to provide for the Web Chat channel." + }, + "DirectLineChannel": { + "type": "object", + "x-ms-discriminator-value": "DirectLineChannel", + "description": "Direct Line channel definition", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DirectLineChannelProperties", + "description": "The set of properties specific to Direct Line channel resource" + } + } + }, + "DirectLineChannelProperties": { + "properties": { + "sites": { + "type": "array", + "items": { + "$ref": "#/definitions/DirectLineSite" + }, + "description": "The list of Direct Line sites" + } + }, + "description": "The parameters to provide for the Direct Line channel." + }, + "TelegramChannel": { + "type": "object", + "description": "Telegram channel definition", + "x-ms-discriminator-value": "TelegramChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TelegramChannelProperties", + "description": "The set of properties specific to Telegram channel resource" + } + } + }, + "TelegramChannelProperties": { + "properties": { + "accessToken": { + "x-ms-secret": true, + "type": "string", + "description": "The Telegram access token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Telegram channel.", + "required": [ + "accessToken", + "isEnabled" + ] + }, + "SmsChannel": { + "type": "object", + "description": "Sms channel definition", + "x-ms-discriminator-value": "SmsChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SmsChannelProperties", + "description": "The set of properties specific to Sms channel resource" + } + } + }, + "SmsChannelProperties": { + "properties": { + "phone": { + "type": "string", + "description": "The Sms phone" + }, + "accountSID": { + "type": "string", + "description": "The Sms account SID. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "authToken": { + "x-ms-secret": true, + "type": "string", + "description": "The Sms auth token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot" + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Sms channel.", + "required": [ + "phone", + "accountSID", + "authToken", + "isEnabled" + ] + }, + "SlackChannel": { + "type": "object", + "description": "Slack channel definition", + "x-ms-discriminator-value": "SlackChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SlackChannelProperties", + "description": "The set of properties specific to Slack channel resource" + } + } + }, + "SlackChannelProperties": { + "properties": { + "clientId": { + "type": "string", + "description": "The Slack client id" + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string", + "description": "The Slack client secret. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "verificationToken": { + "x-ms-secret": true, + "type": "string", + "description": "The Slack verification token. Value only returned through POST to the action Channel List API, otherwise empty." + }, + "landingPageUrl": { + "type": "string", + "description": "The Slack landing page Url" + }, + "redirectAction": { + "type": "string", + "description": "The Slack redirect action", + "readOnly": true + }, + "lastSubmissionId": { + "type": "string", + "description": "The Sms auth token", + "readOnly": true + }, + "registerBeforeOAuthFlow": { + "type": "boolean", + "description": "Whether to register the settings before OAuth validation is performed. Recommended to True.", + "readOnly": true + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot", + "readOnly": true + }, + "signingSecret": { + "x-ms-secret": true, + "type": "string", + "description": "The Slack signing secret." + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled for the bot" + } + }, + "description": "The parameters to provide for the Slack channel.", + "required": [ + "clientId", + "clientSecret", + "verificationToken", + "isEnabled" + ] + }, + "LineChannel": { + "type": "object", + "description": "Line channel definition", + "x-ms-discriminator-value": "LineChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/LineChannelProperties", + "description": "The set of properties specific to line channel resource" + } + } + }, + "LineChannelProperties": { + "properties": { + "lineRegistrations": { + "type": "array", + "description": "The list of line channel registrations", + "items": { + "$ref": "#/definitions/LineRegistration" + } + }, + "callbackUrl": { + "type": "string", + "description": "Callback Url to enter in line registration.", + "readOnly": true + }, + "isValidated": { + "type": "boolean", + "description": "Whether this channel is validated for the bot", + "readOnly": true + } + }, + "description": "The parameters to provide for the Line channel.", + "required": [ + "lineRegistrations" + ] + }, + "LineRegistration": { + "properties": { + "generatedId": { + "x-ms-mutability": [ + "read" + ], + "type": "string", + "description": "Id generated for the line channel registration", + "readOnly": true + }, + "channelSecret": { + "x-ms-secret": true, + "type": "string", + "description": "Secret for the line channel registration" + }, + "channelAccessToken": { + "x-ms-secret": true, + "type": "string", + "description": "Access token for the line channel registration" + } + }, + "description": "The properties corresponding to a line channel registration" + }, + "DirectLineSpeechChannel": { + "type": "object", + "description": "DirectLine Speech channel definition", + "x-ms-discriminator-value": "DirectLineSpeechChannel", + "allOf": [ + { + "$ref": "#/definitions/Channel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DirectLineSpeechChannelProperties", + "description": "The set of properties specific to DirectLine Speech channel resource" + } + } + }, + "DirectLineSpeechChannelProperties": { + "properties": { + "cognitiveServicesSubscriptionId": { + "type": "string", + "description": "The cognitive service subscription ID to use with this channel registration." + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this channel is enabled or not." + }, + "customVoiceDeploymentId": { + "type": "string", + "description": "Custom speech model id (optional)." + }, + "customSpeechModelId": { + "type": "string", + "description": "Custom voice deployment id (optional)." + }, + "isDefaultBotForCogSvcAccount": { + "type": "boolean", + "description": "Make this a default bot for chosen cognitive service account." + } + }, + "description": "The parameters to provide for the DirectLine Speech channel.", + "required": [ + "cognitiveServicesSubscriptionId" + ] + }, + "ChannelResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service channel resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/BotChannel" + }, + "description": "Gets the list of bot service channel results and their properties." + } + }, + "description": "The list of bot service channel operation response." + }, + "WebChatSite": { + "properties": { + "siteId": { + "type": "string", + "description": "Site Id", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "siteName": { + "type": "string", + "description": "Site name" + }, + "key": { + "type": "string", + "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "key2": { + "type": "string", + "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "x-ms-mutability": [ + "read" + ], + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this site is enabled for DirectLine channel" + }, + "enablePreview": { + "type": "boolean", + "description": "Whether this site is enabled for preview versions of Webchat" + } + }, + "required": [ + "siteName", + "isEnabled", + "enablePreview" + ], + "description": "A site for the Webchat channel" + }, + "DirectLineSite": { + "properties": { + "siteId": { + "x-ms-mutability": [ + "read" + ], + "type": "string", + "description": "Site Id", + "readOnly": true + }, + "siteName": { + "type": "string", + "description": "Site name" + }, + "key": { + "x-ms-mutability": [ + "read" + ], + "type": "string", + "description": "Primary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "readOnly": true + }, + "key2": { + "x-ms-mutability": [ + "read" + ], + "type": "string", + "description": "Secondary key. Value only returned through POST to the action Channel List API, otherwise empty.", + "readOnly": true + }, + "isEnabled": { + "type": "boolean", + "description": "Whether this site is enabled for DirectLine channel." + }, + "isV1Enabled": { + "type": "boolean", + "description": "Whether this site is enabled for Bot Framework V1 protocol." + }, + "isV3Enabled": { + "type": "boolean", + "description": "Whether this site is enabled for Bot Framework V1 protocol." + }, + "isSecureSiteEnabled": { + "type": "boolean", + "description": "Whether this site is enabled for authentication with Bot Framework." + }, + "trustedOrigins": { + "type": "array", + "description": "List of Trusted Origin URLs for this site. This field is applicable only if isSecureSiteEnabled is True.", + "items": { + "type": "string" + } + } + }, + "description": "A site for the Direct Line channel", + "required": [ + "isV1Enabled", + "isV3Enabled", + "isEnabled", + "siteName" + ] + }, + "SiteInfo": { + "properties": { + "siteName": { + "type": "string", + "description": "The site name" + }, + "key": { + "type": "string", + "description": "Determines which key is to be regenerated", + "enum": [ + "key1", + "key2" + ], + "x-ms-enum": { + "name": "key", + "modelAsString": false + } + } + }, + "description": "Site information for WebChat or DirectLine Channels to identify which site to regenerate keys for.", + "type": "object", + "required": [ + "siteName", + "key" + ] + }, + "ConnectionItemName": { + "properties": { + "name": { + "type": "string", + "description": "Connection Item name that has been added in the API", + "readOnly": true + } + }, + "description": "The display name of a connection Item Setting registered with the Bot" + }, + "ConnectionSettingParameter": { + "properties": { + "key": { + "type": "string", + "description": "Key for the Connection Setting Parameter." + }, + "value": { + "type": "string", + "description": "Value associated with the Connection Setting Parameter." + } + }, + "description": "Extra Parameter in a Connection Setting Properties to indicate service provider specific properties" + }, + "ConnectionSettingProperties": { + "properties": { + "clientId": { + "type": "string", + "description": "Client Id associated with the Connection Setting." + }, + "settingId": { + "type": "string", + "description": "Setting Id set by the service for the Connection Setting.", + "readOnly": true + }, + "clientSecret": { + "x-ms-secret": true, + "type": "string", + "description": "Client Secret associated with the Connection Setting" + }, + "scopes": { + "type": "string", + "description": "Scopes associated with the Connection Setting" + }, + "serviceProviderId": { + "type": "string", + "description": "Service Provider Id associated with the Connection Setting" + }, + "serviceProviderDisplayName": { + "type": "string", + "description": "Service Provider Display Name associated with the Connection Setting" + }, + "parameters": { + "type": "array", + "description": "Service Provider Parameters associated with the Connection Setting", + "items": { + "$ref": "#/definitions/ConnectionSettingParameter" + } + } + }, + "description": "Properties for a Connection Setting Item" + }, + "ConnectionSetting": { + "type": "object", + "description": "Bot channel resource definition", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConnectionSettingProperties", + "description": "The set of properties specific to bot channel resource" + } + } + }, + "ConnectionSettingResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service connection setting resources.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ConnectionSetting" + }, + "description": "Gets the list of bot service connection settings and their properties." + } + }, + "description": "The list of bot service connection settings response." + }, + "ServiceProviderResponseList": { + "properties": { + "nextLink": { + "description": "The link used to get the next page of bot service providers.", + "type": "string" + }, + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ServiceProvider" + }, + "description": "Gets the list of bot service providers and their properties." + } + }, + "description": "The list of bot service providers response." + }, + "ServiceProviderParameter": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Service Provider", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Type of the Service Provider", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Service Provider", + "readOnly": true + }, + "description": { + "type": "string", + "description": "Description of the Service Provider", + "readOnly": true + }, + "helpUrl": { + "type": "string", + "description": "Help Url for the Service Provider", + "readOnly": true + }, + "default": { + "type": "string", + "description": "Default Name for the Service Provider", + "readOnly": true + } + }, + "description": "Extra Parameters specific to each Service Provider" + }, + "ServiceProviderProperties": { + "properties": { + "id": { + "type": "string", + "description": "Id for Service Provider", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "Display Name of the Service Provider", + "readOnly": true + }, + "serviceProviderName": { + "type": "string", + "description": "Display Name of the Service Provider", + "readOnly": true + }, + "devPortalUrl": { + "type": "string", + "description": "Display Name of the Service Provider", + "readOnly": true + }, + "iconUrl": { + "type": "string", + "description": "Display Name of the Service Provider", + "readOnly": true + }, + "parameters": { + "description": "The list of parameters for the Service Provider", + "type": "array", + "items": { + "$ref": "#/definitions/ServiceProviderParameter" + } + } + }, + "description": "The Object used to describe a Service Provider supported by Bot Service" + }, + "ServiceProvider": { + "type": "object", + "description": "Service Provider Definition", + "properties": { + "properties": { + "$ref": "#/definitions/ServiceProviderProperties", + "description": "The Properties of a Service Provider Object" + } + } + }, + "Error": { + "properties": { + "error": { + "$ref": "#/definitions/ErrorBody", + "description": "The error body." + } + }, + "description": "Bot Service error object." + }, + "ErrorBody": { + "properties": { + "code": { + "type": "string", + "description": "error code" + }, + "message": { + "type": "string", + "description": "error message" + } + }, + "description": "Bot Service error body.", + "required": [ + "code", + "message" + ] + }, + "OperationEntityListResult": { + "description": "The list of bot service operation response.", + "type": "object", + "properties": { + "nextLink": { + "description": "The link used to get the next page of operations.", + "type": "string" + }, + "value": { + "description": "The list of operations.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationEntity" + } + } + } + }, + "OperationEntity": { + "description": "The operations supported by Bot Service Management.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplayInfo", + "description": "The operation supported by Bot Service Management." + }, + "origin": { + "description": "The origin of the operation.", + "type": "string" + }, + "properties": { + "description": "Additional properties.", + "type": "object" + } + } + }, + "OperationDisplayInfo": { + "description": "The operation supported by Bot Service Management.", + "type": "object", + "properties": { + "description": { + "description": "The description of the operation.", + "type": "string" + }, + "operation": { + "description": "The action that users can perform, based on their permission level.", + "type": "string" + }, + "provider": { + "description": "Service provider: Microsoft Bot Service.", + "type": "string" + }, + "resource": { + "description": "Resource on which the operation is performed.", + "type": "string" + } + } + }, + "CheckNameAvailabilityRequestBody": { + "description": "The request body for a request to Bot Service Management to check availability of a bot name.", + "type": "object", + "properties": { + "name": { + "description": "the name of the bot for which availability needs to be checked.", + "type": "string" + }, + "type": { + "description": "the type of the bot for which availability needs to be checked", + "type": "string" + } + } + }, + "CheckNameAvailabilityResponseBody": { + "description": "The response body returned for a request to Bot Service Management to check availability of a bot name.", + "type": "object", + "properties": { + "valid": { + "description": "indicates if the bot name is valid.", + "type": "boolean" + }, + "message": { + "description": "additional message from the bot management api showing why a bot name is not available", + "type": "string" + } + } + } + }, + "parameters": { + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource group in the user subscription." + }, + "resourceNameParameter": { + "name": "resourceName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][a-zA-Z0-9_.-]*$", + "description": "The name of the Bot resource." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request." + }, + "connectionNameParameter": { + "name": "connectionName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "maxLength": 64, + "minLength": 2, + "pattern": "^[a-zA-Z0-9][\\sa-zA-Z0-9_.-]*$", + "description": "The name of the Bot Service Connection Setting resource." + }, + "channelNameParameter": { + "name": "channelName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "AlexaChannel", + "FacebookChannel", + "EmailChannel", + "KikChannel", + "TelegramChannel", + "SlackChannel", + "MsTeamsChannel", + "SkypeChannel", + "WebChatChannel", + "DirectLineChannel", + "SmsChannel", + "LineChannel", + "DirectLineSpeechChannel" + ], + "x-ms-enum": { + "name": "channelName", + "modelAsString": false, + "values": [ + { + "value": "AlexaChannel" + }, + { + "value": "FacebookChannel" + }, + { + "value": "EmailChannel" + }, + { + "value": "KikChannel" + }, + { + "value": "TelegramChannel" + }, + { + "value": "SlackChannel" + }, + { + "value": "MsTeamsChannel" + }, + { + "value": "SkypeChannel" + }, + { + "value": "WebChatChannel" + }, + { + "value": "DirectLineChannel" + }, + { + "value": "SmsChannel" + }, + { + "value": "LineChannel" + }, + { + "value": "DirectLineSpeechChannel" + } + ] + }, + "description": "The name of the Channel resource." + }, + "regenerateKeyschannelNameParameter": { + "name": "channelName", + "x-ms-parameter-location": "method", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "WebChatChannel", + "DirectLineChannel" + ], + "x-ms-enum": { + "name": "regenerateKeysChannelName", + "modelAsString": false, + "values": [ + { + "value": "WebChatChannel" + }, + { + "value": "DirectLineChannel" + } + ] + }, + "description": "The name of the Channel resource for which keys are to be regenerated." + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/CheckNameAvailability.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/CheckNameAvailability.json new file mode 100644 index 000000000000..fbadcd8aaf56 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/CheckNameAvailability.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-06-02", + "parameters": { + "name": "testbotname", + "type": "string" + } + }, + "responses": { + "200": { + "body": { + "valid": true, + "message": "custom message from server" + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/CreateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/CreateBot.json new file mode 100644 index 000000000000..6b7d08874ae4 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/CreateBot.json @@ -0,0 +1,105 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "parameters": { + "location": "West US", + "sku": { + "name": "S1" + }, + "etag": "etag1", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "kind": "sdk", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApiKey": "appinsightsapikey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "luisKey": "luiskey", + "msaAppId": "exampleappid" + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplebotname", + "type": "Microsoft.BotService/botServices", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname", + "kind": "sdk", + "etag": "etag1", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + }, + "201": { + "body": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplebotname", + "type": "Microsoft.BotService/botServices", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname", + "kind": "sdk", + "properties": { + "description": "The description of the bot", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteBot.json new file mode 100644 index 000000000000..4c9e878a278b --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteBot.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteChannel.json new file mode 100644 index 000000000000..70bda60a10ba --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteChannel.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "EmailChannel" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteConnection.json new file mode 100644 index 000000000000..85962b406899 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteConnection.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "connectionName": "sampleConnection" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteDirectLineSpeechChannel.json new file mode 100644 index 000000000000..9a66ed0c328c --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DeleteDirectLineSpeechChannel.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "DirectLineSpeechChannel" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DirectlineRegenerateKeys.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DirectlineRegenerateKeys.json new file mode 100644 index 000000000000..c740ef5e1fe5 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/DirectlineRegenerateKeys.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "DirectLineChannel", + "parameters": { + "siteName": "testSiteName", + "key": "key1" + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "DirectLineChannel", + "properties": { + "sites": [ + { + "siteId": "abcd", + "siteName": "Default Site", + "key": "key1", + "key2": "key2", + "isEnabled": true, + "isV1Enabled": true, + "isV3Enabled": true + } + ] + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetAlexaChannel.json new file mode 100644 index 000000000000..1faa62ff3a8c --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetAlexaChannel.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "AlexaChannel" + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "AlexaChannel", + "properties": { + "alexaSkillId": "alexa skill id", + "urlFragment": "XUrlFragmentX", + "serviceEndpointUri": "https://domain/XUrlFragmentX/botId", + "isEnabled": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetBot.json new file mode 100644 index 000000000000..31641dd9d2cc --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetBot.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname" + }, + "responses": { + "200": { + "body": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplebotname", + "type": "Microsoft.BotService/botServices", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname", + "kind": "sdk", + "etag": "etag1", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetChannel.json new file mode 100644 index 000000000000..821aad9640a5 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetChannel.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "EmailChannel" + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties": { + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetConnection.json new file mode 100644 index 000000000000..27a0f0755e51 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetConnection.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "connectionName": "sampleConnection" + }, + "responses": { + "200": { + "body": { + "location": "global", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/Connections/sampleConnection", + "etag": "etag1", + "name": "sampleConnection", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetDirectLineSpeechChannel.json new file mode 100644 index 000000000000..c90035e66679 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetDirectLineSpeechChannel.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "DirectLineSpeechChannel" + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "DirectLineSpeechChannel", + "properties": { + "cognitiveServicesSubscriptionId": "Cognitive services subscription ID", + "customVoiceDeploymentId": "Custom voice deployment ID", + "customSpeechModelId": "Custom speech model ID", + "isDefaultBotForCogSvcAccount": true, + "isEnabled": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetLineChannel.json new file mode 100644 index 000000000000..8a4d5c01a48e --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetLineChannel.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "LineChannel" + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "LineChannel", + "properties": { + "lineRegistrations": [ + { + "generatedId": "id", + "channelSecret": "channelSecret", + "channelAccessToken": "channelAccessToken" + } + ], + "callbackUrl": "http://callbackUrl", + "isValidated": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetOperations.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetOperations.json new file mode 100644 index 000000000000..a7718e8c505f --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/GetOperations.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-06-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.BotService/botService/read", + "display": { + "provider": "Microsoft Bot Service", + "resource": "Bot Service", + "operation": "Read Bot Service", + "description": "Read Bot Service" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.BotService/botService/write", + "display": { + "provider": "Microsoft Bot Service", + "resource": "Bot Service", + "operation": "Write Bot Service", + "description": "Writes Bot Service" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.BotService/botService/delete", + "display": { + "provider": "Microsoft Bot Service", + "resource": "Bot Service", + "operation": "Delete Bot Service", + "description": "Deletes Bot Service" + }, + "origin": "user,system" + }, + { + "name": "Microsoft.BotService/botService/botName/read", + "display": { + "provider": "Microsoft Bot Service", + "resource": "Bot Service name availability", + "operation": "Check bot name availability", + "description": "Check bot name availability" + }, + "origin": "user,system" + } + ] + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsByResourceGroup.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsByResourceGroup.json new file mode 100644 index 000000000000..f07d46d3e9ce --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplebotname", + "type": "Microsoft.BotService/botServices", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices", + "etag": "etag1", + "kind": "sdk", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + ] + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsBySubscription.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsBySubscription.json new file mode 100644 index 000000000000..3fbd09d5d306 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListBotsBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "api-version": "2020-06-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplebotname", + "type": "Microsoft.BotService/botServices", + "id": "/subscriptions/subscription-id/providers/Microsoft.BotService/botServices", + "kind": "sdk", + "etag": "etag1", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + ] + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListChannel.json new file mode 100644 index 000000000000..c3cd570b9c5b --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListChannel.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "EmailChannel", + "parameters": { + "location": "global" + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties": { + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListChannelsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListChannelsByBotService.json new file mode 100644 index 000000000000..bb98a06944df --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListChannelsByBotService.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "resourceName": "samplebotname", + "api-version": "2020-06-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties": { + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + }, + { + "location": "global", + "properties": { + "channelName": "FacebookChannel", + "properties": { + "verifyToken": "othertoken", + "appId": "id", + "appSecret": "secret", + "callbackUrl": "appid", + "isEnabled": true, + "pages": [ + { + "accessToken": "token", + "id": "id" + } + ] + } + } + } + ] + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListConnectionsByBotService.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListConnectionsByBotService.json new file mode 100644 index 000000000000..e6cec3c217af --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListConnectionsByBotService.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleConnection", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListServiceProviders.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListServiceProviders.json new file mode 100644 index 000000000000..8b4b78ba6e67 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/ListServiceProviders.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "api-version": "2020-06-02" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "id": "sampleServiceProviderId", + "displayName": "sample service provider display name", + "serviceProviderName": "sampleServiceProvider", + "devPortalUrl": "sampleDevPortalUrl", + "iconUrl": "sampleIconUrl", + "parameters": [ + { + "name": "sampleParameterName", + "type": "sampleParameterType", + "displayName": "sampleDisplayName", + "description": "sampleDescription", + "helpUrl": "sampleHelpUrl", + "default": "sampleDefaultValue" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutAlexaChannel.json new file mode 100644 index 000000000000..04773f770a0b --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutAlexaChannel.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "AlexaChannel", + "parameters": { + "location": "global", + "properties": { + "channelName": "AlexaChannel", + "properties": { + "alexaSkillId": "XAlexaSkillIdX", + "isEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "AlexaChannel", + "properties": { + "alexaSkillId": "alexa skill id", + "urlFragment": "XUrlFragmentX", + "serviceEndpointUri": "https://domain/XUrlFragmentX/botId", + "isEnabled": true + } + } + } + }, + "201": { + "body": { + "location": "global", + "properties": { + "channelName": "AlexaChannel", + "properties": { + "alexaSkillId": "alexa skill id", + "urlFragment": "XUrlFragmentX", + "serviceEndpointUri": "https://domain/XUrlFragmentX/botId", + "isEnabled": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutChannel.json new file mode 100644 index 000000000000..f2020bfa0016 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutChannel.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "EmailChannel", + "parameters": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties": { + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties": { + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + }, + "201": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties": { + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutConnection.json new file mode 100644 index 000000000000..879da201f980 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutConnection.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "connectionName": "sampleConnection", + "parameters": { + "location": "West US", + "etag": "etag1", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection", + "etag": "etag1", + "name": "sampleConnection", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + }, + "201": { + "body": { + "location": "global", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection", + "etag": "etag1", + "name": "sampleConnection", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutDirectLineSpeechChannel.json new file mode 100644 index 000000000000..b3c964d86eeb --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutDirectLineSpeechChannel.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "DirectLineSpeechChannel", + "parameters": { + "location": "global", + "properties": { + "channelName": "DirectLineSpeechChannel", + "properties": { + "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX", + "isEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "DirectLineSpeechChannel", + "properties": { + "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX", + "isEnabled": true + } + } + } + }, + "201": { + "body": { + "location": "global", + "properties": { + "channelName": "DirectLineSpeechChannel", + "properties": { + "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX", + "isEnabled": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutLineChannel.json new file mode 100644 index 000000000000..9d58ac32cd06 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/PutLineChannel.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "LineChannel", + "parameters": { + "location": "global", + "properties": { + "channelName": "LineChannel", + "properties": { + "lineRegistrations": [ + { + "channelSecret": "channelSecret", + "channelAccessToken": "channelAccessToken" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "LineChannel", + "properties": { + "lineRegistrations": [ + { + "generatedId": "id", + "channelSecret": "channelSecret", + "channelAccessToken": "channelAccessToken" + } + ], + "callbackUrl": "http://callbackUrl", + "isValidated": true + } + } + } + }, + "201": { + "body": { + "location": "global", + "properties": { + "channelName": "LineChannel", + "properties": { + "lineRegistrations": [ + { + "generatedId": "id", + "channelSecret": "channelSecret", + "channelAccessToken": "channelAccessToken" + } + ], + "callbackUrl": "http://callbackUrl", + "isValidated": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateAlexaChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateAlexaChannel.json new file mode 100644 index 000000000000..280fbb879f85 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateAlexaChannel.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "AlexaChannel", + "parameters": { + "location": "global", + "properties": { + "channelName": "AlexaChannel", + "properties": { + "alexaSkillId": "XAlexaSkillIdX", + "isEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "AlexaChannel", + "properties": { + "alexaSkillId": "XAlexaSkillIdX", + "urlFragment": "XUrlFragmentX", + "serviceEndpointUri": "https://domain/XUrlFragmentX/botId", + "isEnabled": true + } + } + } + }, + "201": { + "body": { + "location": "global", + "properties": { + "channelName": "AlexaChannel", + "properties": { + "alexaSkillId": "XAlexaSkillIdX", + "urlFragment": "XUrlFragmentX", + "serviceEndpointUri": "https://domain/XUrlFragmentX/botId", + "isEnabled": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateBot.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateBot.json new file mode 100644 index 000000000000..1d2c7b728468 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateBot.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "parameters": { + "location": "West US", + "sku": { + "name": "S1" + }, + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "etag": "etag1", + "kind": "sdk", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApiKey": "appinsightsapikey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "luisKey": "luiskey", + "msaAppId": "msaappid" + } + } + }, + "responses": { + "200": { + "body": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "etag": "etag1", + "name": "samplebotname", + "type": "Microsoft.BotService/botServices", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname", + "kind": "sdk", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + }, + "201": { + "body": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "name": "samplebotname", + "type": "Microsoft.BotService/botServices", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname", + "kind": "sdk", + "etag": "etag1", + "properties": { + "description": "The description of the bot", + "developerAppInsightKey": "appinsightskey", + "developerAppInsightsApplicationId": "appinsightsappid", + "displayName": "The Name of the bot", + "endpoint": "http://mybot.coffee", + "endpointVersion": "version", + "iconUrl": "http://myicon", + "luisAppIds": [ + "luisappid1", + "luisappid2" + ], + "msaAppId": "msaappid", + "configuredChannels": [ + "facebook", + "groupme" + ], + "enabledChannels": [ + "facebook" + ] + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateChannel.json new file mode 100644 index 000000000000..f2020bfa0016 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateChannel.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "EmailChannel", + "parameters": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties": { + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties": { + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + }, + "201": { + "body": { + "location": "global", + "properties": { + "channelName": "EmailChannel", + "properties": { + "emailAddress": "a@b.com", + "password": "pwd", + "isEnabled": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateConnection.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateConnection.json new file mode 100644 index 000000000000..14fba951e914 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateConnection.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "connectionName": "sampleConnection", + "parameters": { + "location": "global", + "etag": "etag1", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection", + "name": "sampleConnection", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + }, + "201": { + "body": { + "location": "global", + "etag": "etag1", + "id": "/subscriptions/subscription-id/resourceGroups/OneResourceGroupName/providers/Microsoft.BotService/botServices/samplebotname/connections/sampleConnection", + "name": "sampleConnection", + "properties": { + "clientId": "sampleclientid", + "clientSecret": "samplesecret", + "scopes": "samplescope", + "serviceProviderId": "serviceproviderid", + "serviceProviderDisplayName": "serviceProviderDisplayName", + "parameters": [ + { + "key": "key1", + "value": "value1" + }, + { + "key": "key2", + "value": "value2" + } + ] + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateDirectLineSpeechChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateDirectLineSpeechChannel.json new file mode 100644 index 000000000000..b3c964d86eeb --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateDirectLineSpeechChannel.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "DirectLineSpeechChannel", + "parameters": { + "location": "global", + "properties": { + "channelName": "DirectLineSpeechChannel", + "properties": { + "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX", + "isEnabled": true + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "DirectLineSpeechChannel", + "properties": { + "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX", + "isEnabled": true + } + } + } + }, + "201": { + "body": { + "location": "global", + "properties": { + "channelName": "DirectLineSpeechChannel", + "properties": { + "cognitiveServicesSubscriptionId": "XcognitiveServicesSubscriptionIdX", + "isEnabled": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateLineChannel.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateLineChannel.json new file mode 100644 index 000000000000..9d58ac32cd06 --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/UpdateLineChannel.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "LineChannel", + "parameters": { + "location": "global", + "properties": { + "channelName": "LineChannel", + "properties": { + "lineRegistrations": [ + { + "channelSecret": "channelSecret", + "channelAccessToken": "channelAccessToken" + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "LineChannel", + "properties": { + "lineRegistrations": [ + { + "generatedId": "id", + "channelSecret": "channelSecret", + "channelAccessToken": "channelAccessToken" + } + ], + "callbackUrl": "http://callbackUrl", + "isValidated": true + } + } + } + }, + "201": { + "body": { + "location": "global", + "properties": { + "channelName": "LineChannel", + "properties": { + "lineRegistrations": [ + { + "generatedId": "id", + "channelSecret": "channelSecret", + "channelAccessToken": "channelAccessToken" + } + ], + "callbackUrl": "http://callbackUrl", + "isValidated": true + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/WebChatRegenerateKeys.json b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/WebChatRegenerateKeys.json new file mode 100644 index 000000000000..e13716da4bbd --- /dev/null +++ b/specification/botservice/resource-manager/Microsoft.BotService/stable/2020-06-02/examples/WebChatRegenerateKeys.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subscription-id", + "resourceGroupName": "OneResourceGroupName", + "api-version": "2020-06-02", + "resourceName": "samplebotname", + "channelName": "WebChatChannel", + "parameters": { + "siteName": "testSiteName", + "key": "key1" + } + }, + "responses": { + "200": { + "body": { + "location": "global", + "properties": { + "channelName": "WebChatChannel", + "properties": { + "sites": [ + { + "siteId": "abcd", + "siteName": "Default Site", + "key": "key1", + "key2": "key2", + "isEnabled": true, + "enablePreview": true + } + ] + } + } + } + } + } +} diff --git a/specification/botservice/resource-manager/readme.md b/specification/botservice/resource-manager/readme.md index 4e13dd4c54a1..16c01f946217 100644 --- a/specification/botservice/resource-manager/readme.md +++ b/specification/botservice/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for BotService. - - --- + ## Getting Started + To build the SDK for BotService, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,20 +15,29 @@ To build the SDK for BotService, simply [Install AutoRest](https://aka.ms/autore To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the BotService API. ``` yaml openapi-type: arm -tag: package-2018-07-12 +tag: package-2020-06-02 ``` + +### Tag: package-2020-06-02 + +These settings apply only when `--tag=package-2020-06-02` is specified on the command line. + +```yaml $(tag) == 'package-2020-06-02' +input-file: + - Microsoft.BotService/stable/2020-06-02/botservice.json +``` ### Tag: package-2018-07-12 These settings apply only when `--tag=package-2018-07-12` is specified on the command line. @@ -72,7 +81,9 @@ directive: from: botservice.json reason: The path as-is is quite descriptive. ``` + --- + # Code Generation ## Swagger to SDK @@ -113,7 +124,7 @@ See configuration in [readme.java.md](./readme.java.md) See readme.python.md file. -## Multi-API/Profile support for AutoRest v3 generators +## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -130,11 +141,10 @@ input-file: ``` -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. +If there are files that should not be in the `all-api-versions` set, +uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - From aebc8487fff154cd3e53556e779395d3212158a0 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Thu, 11 Jun 2020 05:24:23 +0200 Subject: [PATCH 127/318] enable t2 comute generation (#9753) --- specification/compute/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 46f7bb57354b..06d1324050ed 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -685,6 +685,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python after_scripts: - python ./scripts/multiapi_init_gen.py azure-mgmt-compute + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-js - repo: azure-sdk-for-go From e691ceee865ab60d1f2dca5b35488aeb784da221 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Thu, 11 Jun 2020 05:25:16 +0200 Subject: [PATCH 128/318] enable t2 generation (#9750) --- specification/keyvault/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/keyvault/resource-manager/readme.md b/specification/keyvault/resource-manager/readme.md index 298f828af207..72863b21ce95 100644 --- a/specification/keyvault/resource-manager/readme.md +++ b/specification/keyvault/resource-manager/readme.md @@ -105,6 +105,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python after_scripts: - python ./scripts/multiapi_init_gen.py azure-mgmt-keyvault + - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java - repo: azure-sdk-for-go - repo: azure-sdk-for-node From 8d6c63018b175e04819654c04236ed32bc441e09 Mon Sep 17 00:00:00 2001 From: chunyu3 Date: Thu, 11 Jun 2020 13:36:50 +0800 Subject: [PATCH 129/318] add trenton md file for resources RP (#9707) --- .../resource-manager/readme.trenton.md | 50 +++++++++++++++++++ 1 file changed, 50 insertions(+) create mode 100644 specification/resources/resource-manager/readme.trenton.md diff --git a/specification/resources/resource-manager/readme.trenton.md b/specification/resources/resource-manager/readme.trenton.md new file mode 100644 index 000000000000..03432508ba66 --- /dev/null +++ b/specification/resources/resource-manager/readme.trenton.md @@ -0,0 +1,50 @@ + +## trenton + +These settings apply only when `--trenton` is specified on the command line. + + +``` yaml $(trenton) +batch: + - package-features: true + - package-policy: true + - package-managedapplications: true +``` + +```yaml $(trenton) && $(package-policy) +trenton: + cli-name: policy + package-name: policy +output-folder: $(trenton-output-folder)/policy +clear-output-folder: true +``` + +```yaml $(trenton) && $(package-features) +trenton: + cli-name: features + package-name: features +output-folder: $(trenton-output-folder)/features +clear-output-folder: true +``` + +```yaml $(trenton) && $(package-managedapplications) +trenton: + cli-name: managedApplications + package-name: managedapplications +output-folder: $(trenton-output-folder)/managedapplications +clear-output-folder: true + +overrides: + - where: + resource: "Applications" + property: "/parameters" + set: + - GoVariableName: "appParameters" + - Gen: "newgen" +``` \ No newline at end of file From edbb9cc14033a8ec1b8f97232589ea9d7524e7ac Mon Sep 17 00:00:00 2001 From: chunyu3 Date: Thu, 11 Jun 2020 13:38:09 +0800 Subject: [PATCH 130/318] add readme.trenton.md for datashare (#9782) --- .../resource-manager/readme.trenton.md | 25 +++++++++++++++++++ 1 file changed, 25 insertions(+) create mode 100644 specification/datashare/resource-manager/readme.trenton.md diff --git a/specification/datashare/resource-manager/readme.trenton.md b/specification/datashare/resource-manager/readme.trenton.md new file mode 100644 index 000000000000..a4e0699566a8 --- /dev/null +++ b/specification/datashare/resource-manager/readme.trenton.md @@ -0,0 +1,25 @@ +## overrides + +These settings apply only when `--trenton` is specified on the command line. +``` yaml $(trenton) +overrides: + - where: + resource: "*" + set: + - NeedSeparated: false + - where: + resource: "Accounts" + set: + - CombineCreateUpdate: false +``` +## trenton + +These settings apply only when `--trenton` is specified on the command line. + +``` yaml $(trenton) +trenton: + cli-name: dataShare + package-name: datashare +clear-output-folder: true +output-folder: $(trenton-output-folder)/datashare +``` From 92e846e0135bce5f13b37330562714ecb9eaa058 Mon Sep 17 00:00:00 2001 From: zhaomuzhi Date: Thu, 11 Jun 2020 00:07:43 -0700 Subject: [PATCH 131/318] [Ready For Review] Add APIs for preparing Azure Notebook to newer version (#9716) * Add Identity to createWorkpace example * move missing apis to version 2020-04-01 --- .../2020-04-01/examples/createWorkspace.json | 20 +++- .../2020-04-01/examples/getWorkspace.json | 10 +- .../examples/listWorkspaceKeys.json | 4 + .../examples/workspacePrepareNotebook.json | 21 ++++ .../2020-04-01/machineLearningServices.json | 95 +++++++++++++++++++ 5 files changed, 147 insertions(+), 3 deletions(-) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/workspacePrepareNotebook.json diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/createWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/createWorkspace.json index bea2168be906..456af90f383a 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/createWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/createWorkspace.json @@ -80,7 +80,15 @@ "status": "Approved" } } - ] + ], + "notebookInfo": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } } } }, @@ -123,7 +131,15 @@ "status": "Approved" } } - ] + ], + "notebookInfo": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } } } }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/getWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/getWorkspace.json index 99c934fbcd42..8e49baeddff5 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/getWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/getWorkspace.json @@ -66,7 +66,15 @@ "status": "Approved" } } - ] + ], + "notebookInfo": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/listWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/listWorkspaceKeys.json index 52b699fbae08..2b2077543b66 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/listWorkspaceKeys.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/listWorkspaceKeys.json @@ -24,6 +24,10 @@ "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t" } ] + }, + "notebookAccessKeys": { + "primaryAccessKey": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw", + "secondaryAccessKey": "0KARRQoQHSUq1yViPWg7YFernOS" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/workspacePrepareNotebook.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/workspacePrepareNotebook.json new file mode 100644 index 000000000000..93bc71201231 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/workspacePrepareNotebook.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-04-01" + }, + "responses": { + "200": { + "body": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } + }, + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json index f51a3a500861..2ce9a0fb59f7 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json @@ -300,6 +300,54 @@ } } }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook": { + "post": { + "tags": [ + "ProxyOperations" + ], + "operationId": "Notebooks_Prepare", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/workspacePrepareNotebook.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotebookResourceInfo" + } + }, + "202": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { "get": { "tags": [ @@ -1368,6 +1416,45 @@ } } }, + "NotebookListCredentialsResult": { + "type": "object", + "properties": { + "primaryAccessKey": { + "type": "string" + }, + "secondaryAccessKey": { + "type": "string" + } + } + }, + "NotebookResourceInfo": { + "type": "object", + "properties": { + "fqdn": { + "type": "string" + }, + "resourceId": { + "type": "string", + "description": "the data plane resourceId that used to initialize notebook component" + }, + "notebookPreparationError": { + "$ref": "#/definitions/NotebookPreparationError", + "description": "The error that occurs when preparing notebook." + } + } + }, + "NotebookPreparationError": { + "type": "object", + "properties": { + "errorMessage": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" + } + } + }, "OperationListResult": { "description": "An array of operations supported by the resource provider.", "properties": { @@ -1500,6 +1587,11 @@ "$ref": "#/definitions/SharedPrivateLinkResource" }, "description": "The list of shared private link resources in this workspace." + }, + "notebookInfo": { + "readOnly": true, + "$ref": "#/definitions/NotebookResourceInfo", + "description": "The notebook info of Azure ML workspace." } } }, @@ -2050,6 +2142,9 @@ "containerRegistryCredentials": { "readOnly": true, "$ref": "#/definitions/RegistryListCredentialsResult" + }, + "notebookAccessKeys": { + "$ref": "#/definitions/NotebookListCredentialsResult" } } }, From 0e036368f94bdebbc21e1c70331473bea945a777 Mon Sep 17 00:00:00 2001 From: bganapa Date: Thu, 11 Jun 2020 06:43:17 -0700 Subject: [PATCH 132/318] Adding required attributes to location and properties (#9777) * Adding required attributes to location and properties * Prettier fixes --- .../stable/2017-06-01/Registration.json | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json index 62f2bd69c0b0..1216c20372ad 100644 --- a/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json +++ b/specification/azurestack/resource-manager/Microsoft.AzureStack/stable/2017-06-01/Registration.json @@ -348,7 +348,11 @@ "read" ] } - } + }, + "required": [ + "properties", + "location" + ] }, "RegistrationParameterProperties": { "description": "Properties of the Azure Stack registration resource", From 487e7cbf59e893825e34c5abc6aa7a2856b85cb7 Mon Sep 17 00:00:00 2001 From: Vitaliy Fedonkin Date: Thu, 11 Jun 2020 18:26:17 -0700 Subject: [PATCH 133/318] ApiManagement - fix quota patch contracts (#9642) * ApiManagement - fix quota patch contracts * ApiManagement - fix quota patch contracts prettier fix Co-authored-by: vfedonkin --- .../stable/2019-12-01/apimquotas.json | 4 ++-- .../stable/2019-12-01/definitions.json | 10 ++++++++++ .../examples/ApiManagementUpdateQuotaCounterKey.json | 6 ++++-- ...piManagementUpdateQuotaCounterKeyByQuotaPeriod.json | 6 ++++-- 4 files changed, 20 insertions(+), 6 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/apimquotas.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/apimquotas.json index 2aa6ffd5883d..e03d8fcd17d6 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/apimquotas.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/apimquotas.json @@ -108,7 +108,7 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/QuotaCounterValueContractProperties" + "$ref": "./definitions.json#/definitions/QuotaCounterValueUpdateContract" }, "description": "The value of the quota counter to be applied to all quota counter periods." }, @@ -212,7 +212,7 @@ "in": "body", "required": true, "schema": { - "$ref": "./definitions.json#/definitions/QuotaCounterValueContractProperties" + "$ref": "./definitions.json#/definitions/QuotaCounterValueUpdateContract" }, "description": "The value of the Quota counter to be applied on the specified period." }, diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json index 490ae700e22e..83499631fc01 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json @@ -3847,6 +3847,16 @@ }, "description": "Quota counter value details." }, + "QuotaCounterValueUpdateContract": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/QuotaCounterValueContractProperties", + "description": "Quota counter value details." + } + }, + "description": "Quota counter value details." + }, "RecipientEmailCollection": { "properties": { "value": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementUpdateQuotaCounterKey.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementUpdateQuotaCounterKey.json index e912200c09ab..d1e94ce2d3d5 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementUpdateQuotaCounterKey.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementUpdateQuotaCounterKey.json @@ -6,8 +6,10 @@ "subscriptionId": "subid", "quotaCounterKey": "ba", "parameters": { - "callsCount": 0, - "kbTransferred": 2.5630078125 + "properties": { + "callsCount": 0, + "kbTransferred": 2.5630078125 + } } }, "responses": { diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json index 5e43c0fb4956..257bd852272a 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/examples/ApiManagementUpdateQuotaCounterKeyByQuotaPeriod.json @@ -7,8 +7,10 @@ "quotaCounterKey": "ba", "quotaPeriodKey": "0_P3Y6M4DT12H30M5S", "parameters": { - "callsCount": 0, - "kbTransferred": 0 + "properties": { + "callsCount": 0, + "kbTransferred": 0 + } } }, "responses": { From 91e1643ff03fa757a87cda50d4434ece5223e587 Mon Sep 17 00:00:00 2001 From: Abyssknight <501835725@qq.com> Date: Fri, 12 Jun 2020 09:54:43 +0800 Subject: [PATCH 134/318] change vmware package version from 0.3.0 to 0.1.0 (#9820) Co-authored-by: Shixun Guan --- specification/vmware/resource-manager/readme.csharp.md | 4 ++-- specification/vmware/resource-manager/readme.python.md | 4 ++-- specification/vmware/resource-manager/readme.typescript.md | 4 ++-- 3 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/vmware/resource-manager/readme.csharp.md b/specification/vmware/resource-manager/readme.csharp.md index 77d4211ccfba..0285a875be62 100644 --- a/specification/vmware/resource-manager/readme.csharp.md +++ b/specification/vmware/resource-manager/readme.csharp.md @@ -5,11 +5,11 @@ Please also specify `--csharp-sdks-folder= Date: Thu, 11 Jun 2020 18:58:33 -0700 Subject: [PATCH 135/318] Add logArtifactLink property in RunGetLogResult. (#9558) --- .../preview/2019-06-01-preview/containerregistry_build.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json index 933aa70dc501..2174cc1e0e84 100644 --- a/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json +++ b/specification/containerregistry/resource-manager/Microsoft.ContainerRegistry/preview/2019-06-01-preview/containerregistry_build.json @@ -1904,6 +1904,10 @@ "logLink": { "description": "The link to logs for a run on a azure container registry.", "type": "string" + }, + "logArtifactLink": { + "description": "The link to logs in registry for a run on a azure container registry.", + "type": "string" } } }, From 76179115d5096285932e74d75f7a964a13063952 Mon Sep 17 00:00:00 2001 From: Milan Brkic Date: Fri, 12 Jun 2020 05:18:11 +0200 Subject: [PATCH 136/318] Managed Instance failover swagger (#8911) * Failover managed instance API docs * fix parameters * typo fix * fix version * changes in readme.md * Removed unused parameters and rearranged little bit * fixes Co-authored-by: Milan Brkic --- .../FailoverManagedInstance.json | 113 ++++++++++++++++++ .../examples/FailoverManagedInstance.json | 13 ++ specification/sql/resource-manager/readme.md | 4 + 3 files changed, 130 insertions(+) create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/FailoverManagedInstance.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json new file mode 100644 index 000000000000..47b4874ad9c2 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json @@ -0,0 +1,113 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-06-01-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/failover": { + "post": { + "tags": [ + "ManagedInstances" + ], + "description": "Failovers a managed instance.", + "operationId": "ManagedInstances_Failover", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "replicaType", + "in": "query", + "description": "The type of replica to be failed over.", + "required": false, + "type": "string", + "enum": [ + "Primary", + "ReadableSecondary" + ], + "x-ms-enum": { + "name": "ReplicaType", + "modelAsString": true + } + } + ], + "responses": { + "200": { + "description": "Successfully completed managed instance failover." + }, + "202": { + "description": "Managed instance failover is in progress." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 ManagementServiceFeatureDisabled - User attempted to use a feature which is disabled.\n\n * 400 ManagedInstanceFailoverThrottled - There was a recent failover on the managed instance.\n\n * 400 ManagedInstanceFailoverNotSupportedOnSKU - This type of customer initiated failover is not supported on the given SKU.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 409 ManagedInstanceNotInStateToFailover - The managed instance is currently in a state such that failover cannot be issued." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Failover a managed instance.": { + "$ref": "./examples/FailoverManagedInstance.json" + } + } + } + } + }, + "definitions": {}, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "responses": {} +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/FailoverManagedInstance.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/FailoverManagedInstance.json new file mode 100644 index 000000000000..f5c660c2233a --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/FailoverManagedInstance.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "managedInstanceName": "testinstance", + "replicaType": "Primary", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index b67d56d4dc40..2af3444b6aca 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -140,6 +140,7 @@ input-file: - Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json - Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json - Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json +- Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json # Needed when there is more than one input file override-info: @@ -241,6 +242,7 @@ input-file: - Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json - Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json - Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json +- Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json # Needed when there is more than one input file override-info: @@ -331,6 +333,7 @@ input-file: - Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json - Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json - Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json +- Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json # Needed when there is more than one input file override-info: @@ -497,6 +500,7 @@ input-file: - ./Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json - ./Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json - ./Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json + - ./Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json # Needed when there is more than one input file override-info: From b17d7cca4756ef2702fc3c64d626c8615ea2dc30 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Fri, 12 Jun 2020 13:06:16 +0800 Subject: [PATCH 137/318] New api-version 2020-05 and 2020-04 (#9824) --- specification/network/resource-manager/readme.go.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/specification/network/resource-manager/readme.go.md b/specification/network/resource-manager/readme.go.md index a1304cfb2ee8..c8c9e609a2d7 100644 --- a/specification/network/resource-manager/readme.go.md +++ b/specification/network/resource-manager/readme.go.md @@ -13,6 +13,8 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-05 + - tag: package-2020-04 - tag: package-2020-03 - tag: package-2019-12 - tag: package-2019-11 @@ -45,6 +47,15 @@ batch: - tag: package-2015-05-preview ``` +### Tag: package-2020-05 and go + +These settings apply only when `--tag=package-2020-05 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-05' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-05-01/$(namespace) +``` + ### Tag: package-2020-04 and go These settings apply only when `--tag=package-2020-04 --go` is specified on the command line. From c7041d768b279437a917a1ea8cd935bf1d599309 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Fri, 12 Jun 2020 13:08:02 +0800 Subject: [PATCH 138/318] Add new api-version for go SDK (#9825) --- .../vmware/resource-manager/readme.go.md | 26 +++++++++++++++++++ .../vmware/resource-manager/readme.md | 5 ++++ 2 files changed, 31 insertions(+) create mode 100644 specification/vmware/resource-manager/readme.go.md diff --git a/specification/vmware/resource-manager/readme.go.md b/specification/vmware/resource-manager/readme.go.md new file mode 100644 index 000000000000..d172ca3a98a7 --- /dev/null +++ b/specification/vmware/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: vmware + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-2019-08-09-preview +``` + +### Tag: package-2019-08-09-preview and go + +These settings apply only when `--tag=package-2019-08-09-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-08-09-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2019-08-09-preview/$(namespace) +``` diff --git a/specification/vmware/resource-manager/readme.md b/specification/vmware/resource-manager/readme.md index a2a404bfe4b6..94e25f8fd487 100644 --- a/specification/vmware/resource-manager/readme.md +++ b/specification/vmware/resource-manager/readme.md @@ -56,6 +56,7 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-python - repo: azure-sdk-for-net + - repo: azure-sdk-for-go ``` ## TypeScript @@ -70,6 +71,10 @@ See configuration in [readme.python.md](./readme.python.md) See configuration in [readme.csharp.md](./readme.csharp.md) +## Go + +See configuration in [readme.go.md](./readme.go.md) + ## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. From c7eba4d81cd6b0d7e5e3c953bd37b77fde36f6f3 Mon Sep 17 00:00:00 2001 From: MyronFanQiu <49134743+MyronFanQiu@users.noreply.github.com> Date: Fri, 12 Jun 2020 13:08:14 +0800 Subject: [PATCH 139/318] fix network python sdk (#9822) --- .../network/resource-manager/readme.python.md | 15 +++++++++++++++ 1 file changed, 15 insertions(+) diff --git a/specification/network/resource-manager/readme.python.md b/specification/network/resource-manager/readme.python.md index b76eb2ba5ee4..454c5a571d86 100644 --- a/specification/network/resource-manager/readme.python.md +++ b/specification/network/resource-manager/readme.python.md @@ -27,6 +27,7 @@ Generate all API versions currently shipped for this package ```yaml $(multiapi) && !$(track2) batch: + - tag: package-2020-05 - tag: package-2020-04 - tag: package-2020-03 - tag: package-2019-12 @@ -60,6 +61,7 @@ batch: ```yaml $(multiapi) && $(track2) clear-output-folder: true batch: + - tag: package-2020-05 - tag: package-2020-04 - tag: package-2020-03 - tag: package-2019-12 @@ -97,6 +99,19 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2020-05 and python + +These settings apply only when `--tag=package-2020-05 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-05' +namespace: azure.mgmt.network.v2020_05_01 +output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2020_05_01 +python: + namespace: azure.mgmt.network.v2020_05_01 + output-folder: $(python-sdks-folder)/network/azure-mgmt-network/azure/mgmt/network/v2020_05_01 +``` + ### Tag: package-2020-04 and python These settings apply only when `--tag=package-2020-04 --python` is specified on the command line. From bca618ccc14955f39d0bdd24fbb4ed7b28193103 Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Fri, 12 Jun 2020 14:19:14 +0800 Subject: [PATCH 140/318] add track2 config (#9823) * add track2 config * format fix --- .../compute/resource-manager/readme.python.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/specification/compute/resource-manager/readme.python.md b/specification/compute/resource-manager/readme.python.md index 07382513e166..e0a44c76fbe6 100644 --- a/specification/compute/resource-manager/readme.python.md +++ b/specification/compute/resource-manager/readme.python.md @@ -36,6 +36,23 @@ azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION package-name: azure-mgmt-compute no-namespace-folders: true + +directive: + # dynamically add a DummyOrchestrationServiceName value to the enum + - from: compute.json + where: $..enum + transform: >- + if( $.length === 1 && $[0] === "AutomaticRepairs") { + $.push('DummyOrchestrationServiceName'); + } + return $; + + - from: source-file-python + where: $ + transform: >- + return $. + replace(/, 'DummyOrchestrationServiceName'/g,''). + replace(/dummy_orchestration_service_name = "DummyOrchestrationServiceName"/g,''); ``` ### Python multi-api From 68bd022064b159631ee8eccfa5cbce3314618476 Mon Sep 17 00:00:00 2001 From: Anand Kishore <60298805+ankisho@users.noreply.github.com> Date: Fri, 12 Jun 2020 14:58:17 +0530 Subject: [PATCH 141/318] Added Microsoft.Confluent swagger (#9789) --- .../preview/2020-03-01-preview/confluent.json | 697 ++++++++++++++++++ .../examples/OrganizationOperations_List.json | 41 ++ .../examples/Organization_Create.json | 91 +++ .../examples/Organization_Delete.json | 13 + .../examples/Organization_Get.json | 40 + .../Organization_ListByResourceGroup.json | 44 ++ .../Organization_ListBySubscription.json | 43 ++ .../examples/Organization_Update.json | 46 ++ .../confluent/resource-manager/readme.md | 40 + 9 files changed, 1055 insertions(+) create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json create mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json create mode 100644 specification/confluent/resource-manager/readme.md diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json new file mode 100644 index 000000000000..5265c290155d --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json @@ -0,0 +1,697 @@ +{ + "swagger": "2.0", + "info": { + "title": "Microsoft.Confluent", + "version": "2020-03-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Confluent/operations": { + "get": { + "tags": [ + "Organization" + ], + "summary": "List all operations provided by Microsoft.Confluent.", + "operationId": "OrganizationOperations_List", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OrganizationOperations_List": { + "$ref": "./examples/OrganizationOperations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Confluent/organizations": { + "get": { + "tags": [ + "Organization" + ], + "summary": "List all organizations under the specified subscription.", + "operationId": "Organization_ListBySubscription", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResourceListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Organization_ListBySubscription": { + "$ref": "./examples/Organization_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations": { + "get": { + "tags": [ + "Organization" + ], + "summary": "List all Organizations under the specified resource group.", + "operationId": "Organization_ListByResourceGroup", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResourceListResult" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Organization_ListByResourceGroup": { + "$ref": "./examples/Organization_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}": { + "get": { + "tags": [ + "Organization" + ], + "summary": "Get the properties of a specific Organization resource.", + "operationId": "Organization_Get", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/OrganizationResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Organization_Get": { + "$ref": "./examples/Organization_Get.json" + } + } + }, + "put": { + "tags": [ + "Organization" + ], + "summary": "Create Organization resource", + "operationId": "Organization_Create", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/OrganizationResourceNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Organization resource model", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "Organization_Create": { + "$ref": "./examples/Organization_Create.json" + } + } + }, + "patch": { + "tags": [ + "Organization" + ], + "summary": "Update Organization resource", + "operationId": "Organization_Update", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/OrganizationResourceNameParameter" + }, + { + "in": "body", + "name": "body", + "description": "Updated Organization resource", + "schema": { + "$ref": "#/definitions/OrganizationResourceUpdate" + } + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-examples": { + "Confluent_Update": { + "$ref": "./examples/Organization_Update.json" + } + } + }, + "delete": { + "tags": [ + "Organization" + ], + "summary": "Delete Organization resource", + "operationId": "Organization_Delete", + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/OrganizationResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "The specified confluent resource does not exist in the subscription." + }, + "default": { + "description": "Default error response.", + "schema": { + "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Confluent_Delete": { + "$ref": "./examples/Organization_Delete.json" + } + } + } + } + }, + "definitions": { + "OperationDisplay": { + "description": "The object that represents the operation.", + "type": "object", + "properties": { + "provider": { + "description": "Service provider: Microsoft.Confluent", + "type": "string" + }, + "resource": { + "description": "Type on which the operation is performed, e.g., 'clusters'.", + "type": "string" + }, + "operation": { + "description": "Operation type, e.g., read, write, delete, etc.", + "type": "string" + }, + "description": { + "description": "Description of the operation, e.g., 'Write confluent'.", + "type": "string" + } + } + }, + "OperationResult": { + "description": "An Confluent REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "$ref": "#/definitions/OperationDisplay" + } + } + }, + "OperationListResult": { + "description": "Result of GET request to list Confluent operations.", + "type": "object", + "properties": { + "value": { + "description": "List of Confluent operations supported by the Microsoft.Confluent provider.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationResult" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string" + } + } + }, + "ErrorResponseBody": { + "description": "Response body of Error", + "title": "ErrorResponseBody", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Error target", + "type": "string", + "readOnly": true + }, + "details": { + "description": "Error detail", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + } + }, + "ResourceProviderDefaultErrorResponse": { + "type": "object", + "description": "Default error response for resource provider", + "title": "ResourceProviderDefaultErrorResponse", + "properties": { + "error": { + "description": "Response body of Error", + "readOnly": true, + "$ref": "#/definitions/ErrorResponseBody" + } + } + }, + "ProvisioningState": { + "enum": [ + "Accepted", + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "description": "Provision states for confluent RP", + "title": "ProvisioningState", + "x-ms-enum": { + "name": "ProvisionState", + "modelAsString": true + } + }, + "OfferDetail": { + "description": "Confluent Offer detail", + "type": "object", + "properties": { + "publisherId": { + "description": "Publisher Id", + "maxLength": 50, + "type": "string" + }, + "id": { + "description": "Offer Id", + "maxLength": 50, + "type": "string" + }, + "planId": { + "description": "Offer Plan Id", + "maxLength": 50, + "type": "string" + }, + "planName": { + "description": "Offer Plan Name", + "maxLength": 50, + "type": "string" + }, + "termUnit": { + "description": "Offer Plan Term unit", + "maxLength": 25, + "type": "string" + } + } + }, + "UserDetail": { + "description": "Subscriber detail", + "type": "object", + "properties": { + "firstName": { + "description": "First name", + "maxLength": 50, + "type": "string" + }, + "lastName": { + "description": "Last name", + "maxLength": 50, + "type": "string" + }, + "emailAddress": { + "description": "Email address. Validation Pattern: ^\\w+@[a-zA-Z_]+?\\.[a-zA-Z]{2,3}$", + "pattern": "^\\w+@[a-zA-Z_]+?\\.[a-zA-Z]{2,3}$", + "type": "string" + }, + "phoneNumber": { + "description": "Phone number. Validation Pattern: ^(\\+\\d{1,2}\\s)?\\(?\\d{3}\\)?[\\s.-]?\\d{3}[\\s.-]?\\d{4}$", + "pattern": "^(\\+\\d{1,2}\\s)?\\(?\\d{3}\\)?[\\s.-]?\\d{3}[\\s.-]?\\d{4}$", + "type": "string" + } + } + }, + "OrganizationResourceProperties": { + "description": "Organization resource property", + "type": "object", + "properties": { + "createdTime": { + "format": "date-time", + "description": "The creation time of the resource.", + "type": "string", + "readOnly": true + }, + "provisioningState": { + "description": "Provision states for confluent RP", + "$ref": "#/definitions/ProvisioningState" + }, + "organizationId": { + "description": "Id of the Confluent organization.", + "type": "string", + "readOnly": true + }, + "ssoUrl": { + "description": "SSO url for the Confluent organization.", + "type": "string", + "readOnly": true + }, + "offerDetail": { + "description": "Confluent offer detail", + "allOf": [ + { + "$ref": "#/definitions/OfferDetail" + } + ] + }, + "userDetail": { + "description": "Subscriber detail", + "allOf": [ + { + "$ref": "#/definitions/UserDetail" + } + ] + } + } + }, + "OrganizationResource": { + "description": "Organization resource.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "The ARM id of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "x-ms-client-flatten": true, + "description": "Organization resource properties", + "allOf": [ + { + "$ref": "#/definitions/OrganizationResourceProperties" + } + ] + }, + "tags": { + "type": "object", + "description": "Organization resource tags", + "additionalProperties": { + "type": "string" + } + }, + "location": { + "description": "Location of Organization resource", + "type": "string" + } + } + }, + "OrganizationResourceListResult": { + "description": "The response of a list operation.", + "type": "object", + "properties": { + "value": { + "description": "Result of a list operation.", + "type": "array", + "items": { + "$ref": "#/definitions/OrganizationResource" + } + }, + "nextLink": { + "description": "Link to the next set of results, if any.", + "type": "string" + } + } + }, + "OrganizationResourceUpdate": { + "description": "Organization Resource update", + "type": "object", + "properties": { + "tags": { + "description": "ARM resource tags", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string", + "enum": [ + "2020-03-01-preview" + ] + }, + "SubscriptionIdParameter": { + "in": "path", + "name": "subscriptionId", + "description": "Microsoft Azure subscription id", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "in": "path", + "name": "resourceGroupName", + "description": "Resource group name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "OrganizationResourceNameParameter": { + "in": "path", + "name": "organizationName", + "description": "Organization resource name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json new file mode 100644 index 000000000000..cf08589e54db --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-03-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Confluent/organizations/Read", + "display": { + "provider": "Microsoft.Confluent", + "resource": "organizations", + "operation": "Get/List organization resources", + "description": "Read organization" + } + }, + { + "name": "Microsoft.Confluent/organizations/Write", + "display": { + "provider": "Microsoft.Confluent", + "resource": "organizations", + "operation": "Create/Update organization resources", + "description": "Write organization" + } + }, + { + "name": "Microsoft.Confluent/organizations/Delete", + "display": { + "provider": "Microsoft.Confluent", + "resource": "organizations", + "operation": "Delete organization resources", + "description": "Delete organization" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json new file mode 100644 index 000000000000..59c760932d81 --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json @@ -0,0 +1,91 @@ +{ + "parameters": { + "api-version": "2020-03-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "organizationName": "myOrganization", + "body": { + "properties": { + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com", + "phoneNumber": "+91 1111111111" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", + "name": "myOrganization", + "type": "Microsoft.Confluent/organizations", + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Succeeded", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com", + "phoneNumber": "+91 1111111111" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", + "name": "myOrganization", + "type": "Microsoft.Confluent/organizations", + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Accepted", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com", + "phoneNumber": "+91 1111111111" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json new file mode 100644 index 000000000000..9621d3e6929b --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-03-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "organizationName": "myOrganization" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json new file mode 100644 index 000000000000..5b1aab813d2e --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-03-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "organizationName": "myOrganization" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", + "name": "myOrganization", + "type": "Microsoft.Confluent/organizations", + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Accepted", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com", + "phoneNumber": "+91 1111111111" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json new file mode 100644 index 000000000000..6d80f1581538 --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-03-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganizations", + "name": "myOrganizations", + "type": "Microsoft.Confluent/organizations", + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Accepted", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com", + "phoneNumber": "+91 1111111111" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json new file mode 100644 index 000000000000..f605aee4a999 --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-03-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganizations", + "name": "myOrganizations", + "type": "Microsoft.Confluent/organizations", + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Accepted", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com", + "phoneNumber": "+91 1111111111" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json new file mode 100644 index 000000000000..dce805cf8eac --- /dev/null +++ b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-03-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "organizationName": "myOrganization", + "body": { + "tags": { + "env": "dev", + "client": "dev-client" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", + "name": "myOrganization", + "type": "Microsoft.Confluent/organizations", + "properties": { + "createdTime": "2020-05-09T14:28:47.284Z", + "provisioningState": "Succeeded", + "organizationId": "string", + "ssoUrl": "string", + "offerDetail": { + "publisherId": "string", + "id": "string", + "planId": "string", + "planName": "string", + "termUnit": "string" + }, + "userDetail": { + "firstName": "string", + "lastName": "string", + "emailAddress": "contoso@microsoft.com", + "phoneNumber": "+91 1111111111" + } + }, + "tags": { + "Environment": "Dev" + }, + "location": "West US" + } + } + } +} diff --git a/specification/confluent/resource-manager/readme.md b/specification/confluent/resource-manager/readme.md new file mode 100644 index 000000000000..687ff7737205 --- /dev/null +++ b/specification/confluent/resource-manager/readme.md @@ -0,0 +1,40 @@ +# Confluent + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for ContainerInstance. + + + +--- +## Getting Started +To build the SDK for ContainerInstance, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + + + +### Basic Information +These are the global settings for the Confluent API. + +``` yaml +title: Microsoft Confluent Client +openapi-type: arm +tag: package-2020-03-preview +``` + +### Tag: package-2020-03-preview + +These settings apply only when `--tag=package-2020-03-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-03-preview' +input-file: +- Microsoft.Confluent/preview/2020-03-01-preview/confluent.json +``` From 4314c1c9432b3e16c84d334cde4511caca1fa6ec Mon Sep 17 00:00:00 2001 From: srilatha inavolu Date: Fri, 12 Jun 2020 03:32:38 -0700 Subject: [PATCH 142/318] [Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 (#9670) * Adding GTM reservation transactions API * update * updating examples * updating examples * adding scope parameter * updating examples * prettifying * updates * Adding missing property in examples * updates * prettify examples * Removing LegacyReservationTransactionsListResult * Removing updates to ReservationTransactions at BillingAccount scope * updates * updating example * removing extra property --- .../stable/2019-10-01/consumption.json | 241 +++++++++++++++++- ...ionTransactionsListByBillingProfileId.json | 43 ++++ ...onTransactionsListByEnrollmentNumber.json} | 4 +- 3 files changed, 279 insertions(+), 9 deletions(-) create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationTransactionsListByBillingProfileId.json rename specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/{ReservationTransactionsListByBillingAccountId.json => ReservationTransactionsListByEnrollmentNumber.json} (95%) diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json index cd3415b062d5..214e42d27d1a 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json @@ -1129,8 +1129,8 @@ "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" }, "x-ms-examples": { - "ReservationTransaction": { - "$ref": "./examples/ReservationTransactionsListByBillingAccountId.json" + "ReservationTransactionsByEnrollmentNumber": { + "$ref": "./examples/ReservationTransactionsListByEnrollmentNumber.json" } }, "parameters": [ @@ -1167,6 +1167,58 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/providers/Microsoft.Consumption/reservationTransactions": { + "get": { + "tags": [ + "ReservationTransactions" + ], + "operationId": "ReservationTransactions_ListByBillingProfile", + "description": "List of transactions for reserved instances on billing account scope", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/consumption/" + }, + "x-ms-examples": { + "ReservationTransactionsByBillingProfileId": { + "$ref": "./examples/ReservationTransactionsListByBillingProfileId.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "Filter reservation transactions by date range. The properties/EventDate for start date and end date. The filter supports 'le' and 'ge' ", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountIdParameter" + }, + { + "$ref": "#/parameters/billingProfileIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ModernReservationTransactionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.Consumption/pricesheets/default": { "get": { "tags": [ @@ -3327,8 +3379,156 @@ } } }, - "ReservationTransactionProperties": { - "default": "The properties of the reservation transaction.", + "ModernReservationTransactionProperties": { + "description": "The properties of a modern reservation transaction.", + "properties": { + "amount": { + "description": "The charge of the transaction.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "armSkuName": { + "description": "This is the ARM Sku name. It can be used to join with the serviceType field in additional info in usage records.", + "type": "string", + "readOnly": true + }, + "billingFrequency": { + "description": "The billing frequency, which can be either one-time or recurring.", + "type": "string", + "readOnly": true + }, + "billingProfileId": { + "description": "Billing profile Id.", + "type": "string", + "readOnly": true + }, + "billingProfileName": { + "description": "Billing profile name.", + "type": "string", + "readOnly": true + }, + "currency": { + "description": "The ISO currency in which the transaction is charged, for example, USD.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of the transaction.", + "type": "string", + "readOnly": true + }, + "eventDate": { + "description": "The date of the transaction", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "eventType": { + "description": "The type of the transaction (Purchase, Cancel, etc.)", + "type": "string", + "readOnly": true + }, + "invoice": { + "description": "Invoice Number", + "type": "string", + "readOnly": true + }, + "invoiceId": { + "description": "Invoice Id as on the invoice where the specific transaction appears.", + "type": "string", + "readOnly": true + }, + "invoiceSectionId": { + "description": "Invoice Section Id", + "type": "string", + "readOnly": true + }, + "invoiceSectionName": { + "description": "Invoice Section Name.", + "type": "string", + "readOnly": true + }, + "purchasingSubscriptionGuid": { + "description": "The subscription guid that makes the transaction.", + "type": "string", + "format": "uuid", + "readOnly": true + }, + "purchasingSubscriptionName": { + "description": "The subscription name that makes the transaction.", + "type": "string", + "readOnly": true + }, + "quantity": { + "description": "The quantity of the transaction.", + "type": "number", + "format": "decimal", + "readOnly": true + }, + "region": { + "description": "The region of the transaction.", + "type": "string", + "readOnly": true + }, + "reservationOrderId": { + "description": "The reservation order ID is the identifier for a reservation purchase. Each reservation order ID represents a single purchase transaction. A reservation order contains reservations. The reservation order specifies the VM size and region for the reservations.", + "type": "string", + "readOnly": true + }, + "reservationOrderName": { + "description": "The name of the reservation order.", + "type": "string", + "readOnly": true + }, + "term": { + "description": "This is the term of the transaction.", + "type": "string", + "readOnly": true + } + } + }, + "ModernReservationTransaction": { + "description": "Modern Reservation transaction resource.", + "type": "object", + "x-ms-discriminator-value": "Modern", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ModernReservationTransactionProperties", + "title": "Reservation Transaction properties" + } + }, + "required": [ + "properties" + ] + }, + "LegacyReservationTransaction": { + "description": "Legacy Reservation transaction resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ReservationTransaction" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LegacyReservationTransactionProperties", + "title": "Reservation Transaction properties" + } + }, + "required": [ + "properties" + ] + }, + "LegacyReservationTransactionProperties": { + "description": "The properties of a legacy reservation transaction.", "properties": { "eventDate": { "description": "The date of the transaction", @@ -3447,16 +3647,16 @@ "properties": { "properties": { "x-ms-client-flatten": true, - "$ref": "#/definitions/ReservationTransactionProperties", + "$ref": "#/definitions/LegacyReservationTransactionProperties", "title": "Reservation Transaction properties" } } }, "ReservationTransactionsListResult": { - "description": "Result of listing reservation transactions", + "description": "Result of listing reservation recommendations.", "properties": { "value": { - "description": "The list of reservation transactions.", + "description": "The list of reservation recommendations.", "type": "array", "readOnly": true, "items": { @@ -3470,6 +3670,24 @@ } } }, + "ModernReservationTransactionsListResult": { + "description": "Result of listing reservation recommendations.", + "properties": { + "value": { + "description": "The list of reservation recommendations.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ModernReservationTransaction" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, "TagsResult": { "description": "A resource listing all tags.", "type": "object", @@ -4739,6 +4957,15 @@ "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true }, + "scopeReservationTransactionsParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with reservation transactions operations. This includes '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount/Enrollment scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, "apiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationTransactionsListByBillingProfileId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationTransactionsListByBillingProfileId.json new file mode 100644 index 000000000000..76bb8670823f --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationTransactionsListByBillingProfileId.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "$filter": "properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30", + "billingAccountId": "fcebaabc-fced-4284-a83d-79f83dee183c:45796ba8-988f-45ad-bea9-7b71fc6c7513_2018-09-30", + "billingProfileId": "Z76D-SGAF-BG7-TGB" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/fcebaabc-fced-4284-a83d-79f83dee183c:45796ba8-988f-45ad-bea9-7b71fc6c7513_2018-09-30/billingProfiles/Z76D-SGAF-BG7-TGB/providers/Microsoft.Consumption/reservationTransactions", + "name": "a838a8c3-a408-49e1-ac90-42cb95bff9b2", + "type": "Microsoft.Consumption/reservationTransactions", + "properties": { + "eventDate": "2020-04-25T21:21:38Z", + "reservationOrderId": "a838a8c3-a408-49e1-ac90-42cb95bff9b2", + "description": "Reserved VM Instance, Standard_B1ls, US East, 3 Years", + "eventType": "Purchase", + "quantity": 1, + "amount": 1.44, + "currency": "USD", + "reservationOrderName": "VM_RI_03-25-2020_14-18", + "armSkuName": "Standard_B1ls", + "billingFrequency": "Recurring", + "billingProfileId": "/providers/Microsoft.Billing/billingAccounts/fcebaabc-fced-4284-a83d-79f83dee183c:45796ba8-988f-45ad-bea9-7b71fc6c7513_2018-09-30/billingProfiles/Z76D-SGAF-BG7-TGB", + "billingProfileName": "IT Department*", + "invoice": "T000456437", + "invoiceId": "/providers/Microsoft.Billing/billingAccounts/fcebaabc-fced-4284-a83d-79f83dee183c:45796ba8-988f-45ad-bea9-7b71fc6c7513_2018-09-30/billingProfiles/Z76D-SGAF-BG7-TGB/invoices/T000456437", + "invoiceSectionId": "/providers/Microsoft.Billing/billingAccounts/fcebaabc-fced-4284-a83d-79f83dee183c:45796ba8-988f-45ad-bea9-7b71fc6c7513_2018-09-30/invoiceSections/QBTB-EYAK-PJA-TGB", + "invoiceSectionName": "IT Department", + "purchasingSubscriptionGuid": "d924ad15-4a3d-4047-971d-c8b1b300a97b", + "purchasingSubscriptionName": "contoso", + "region": "eastus", + "term": "P3Y" + } + } + ] + } + } + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationTransactionsListByBillingAccountId.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationTransactionsListByEnrollmentNumber.json similarity index 95% rename from specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationTransactionsListByBillingAccountId.json rename to specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationTransactionsListByEnrollmentNumber.json index 7770a224b060..9e2cd5457ab2 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationTransactionsListByBillingAccountId.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationTransactionsListByEnrollmentNumber.json @@ -1,8 +1,8 @@ { "parameters": { "api-version": "2019-10-01", - "billingAccountId": "123456", - "$filter": "properties/eventDate ge 2019-09-09 AND properties/eventDate le 2019-09-10" + "$filter": "properties/eventDate+ge+2020-05-20+AND+properties/eventDate+le+2020-05-30", + "billingAccountId": "123456" }, "responses": { "200": { From 02ed4afdecf6bc81898212b338df52c33d6e9213 Mon Sep 17 00:00:00 2001 From: Weidong Xu Date: Sun, 14 Jun 2020 11:06:58 +0800 Subject: [PATCH 143/318] add ApiVersion to sample spec (#9798) --- .../stable/YYYY-MM-DD/YourServiceName.json | 3 +++ 1 file changed, 3 insertions(+) diff --git a/documentation/samplefiles/Microsoft.YourServiceName/stable/YYYY-MM-DD/YourServiceName.json b/documentation/samplefiles/Microsoft.YourServiceName/stable/YYYY-MM-DD/YourServiceName.json index 43165d3ad9ca..c7f0e40bc3f5 100644 --- a/documentation/samplefiles/Microsoft.YourServiceName/stable/YYYY-MM-DD/YourServiceName.json +++ b/documentation/samplefiles/Microsoft.YourServiceName/stable/YYYY-MM-DD/YourServiceName.json @@ -43,6 +43,9 @@ }, { "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { From 1bfe97c075732de80de8fd2dcd446ba1518b8f8d Mon Sep 17 00:00:00 2001 From: Arik Olsh <47111029+arolshan@users.noreply.github.com> Date: Sun, 14 Jun 2020 16:14:53 +0300 Subject: [PATCH 144/318] add descriptions for data ingestion (#9836) --- .../2020-03-01-preview/Workspaces.json | 28 ++++++++++++++++++- 1 file changed, 27 insertions(+), 1 deletion(-) diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/Workspaces.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/Workspaces.json index 1328a4d68255..73ddf561508e 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/Workspaces.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/Workspaces.json @@ -419,7 +419,33 @@ ], "x-ms-enum": { "name": "DataIngestionStatus", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "RespectQuota", + "description": "Ingestion enabled following daily cap quota reset, or subscription enablement." + }, + { + "value": "ForceOn", + "description": "Ingestion started following service setting change." + }, + { + "value": "ForceOff", + "description": "Ingestion stopped following service setting change." + }, + { + "value": "OverQuota", + "description": "Reached daily cap quota, ingestion stopped." + }, + { + "value": "SubscriptionSuspended", + "description": "Ingestion stopped following suspended subscription." + }, + { + "value": "ApproachingQuota", + "description": "80% of daily cap quota reached." + } + ] } } } From b864383672a78ea3ead440a14eb3b626129e53c2 Mon Sep 17 00:00:00 2001 From: Alexander Kaplan Date: Sun, 14 Jun 2020 18:29:37 -0700 Subject: [PATCH 145/318] Approved 2020-06 API version to support Live Metrics token generation. (#9808) * Approved 2020-06 version. * Spellcheck fixes. * PR feedback * Prettier fixes. --- custom-words.txt | 3 + .../examples/LiveTokenGet.json | 13 ++ .../examples/Operations_List.json | 23 ++ .../2020-06-02-preview/livetoken_API.json | 219 ++++++++++++++++++ .../resource-manager/readme.md | 35 ++- .../resource-manager/readme.python.md | 1 + 6 files changed, 292 insertions(+), 2 deletions(-) create mode 100644 specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/examples/LiveTokenGet.json create mode 100644 specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/examples/Operations_List.json create mode 100644 specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json diff --git a/custom-words.txt b/custom-words.txt index f2b1de52262c..d1f32e855593 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -585,6 +585,7 @@ GC'd GCMAES gdpr genderless +generatelivetoken generateverificationcode generatevpnclientpackage generatevpnprofile @@ -1167,6 +1168,7 @@ qloguniform qnamaker qnas qnormal +Qssw querylogs querypool querystring @@ -1753,6 +1755,7 @@ XBing Xeon Xero XSMB +XVCJ Yucatec Ywhk YYMMDD diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/examples/LiveTokenGet.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/examples/LiveTokenGet.json new file mode 100644 index 000000000000..abf2f0593a87 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/examples/LiveTokenGet.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "resourceUri": "subscriptions/df602c9c-7aa0-407d-a6fb-eb20c8bd1192/resourceGroups/FabrikamFiberApp/providers/microsoft.insights/components/CustomAvailabilityTest/providers/microsoft.insights/generatelivetoken", + "api-version": "2020-06-02-preview" + }, + "responses": { + "200": { + "body": { + "liveToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + } + } + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/examples/Operations_List.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/examples/Operations_List.json new file mode 100644 index 000000000000..fdfbf1775678 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/examples/Operations_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-06-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "microsoft.insights/generatelivetoken", + "display": { + "provider": "Microsoft Container Instance", + "resource": "generatelivetoken", + "operation": "Gets an access token for live metrics stream data", + "description": "Gets an access token for live metrics stream data" + }, + "origin": "User" + } + ] + } + } + } +} diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json new file mode 100644 index 000000000000..ecb4fd85d389 --- /dev/null +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json @@ -0,0 +1,219 @@ +{ + "swagger": "2.0", + "info": { + "title": "ApplicationInsightsManagementClient", + "x-ms-code-generation-settings": { + "name": "ApplicationInsightsManagementClient" + }, + "version": "2020-06-02-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/microsoft.insights/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "List available operations.", + "description": "List the available operations supported by the Microsoft.EventGrid resource provider.", + "operationId": "Operations_List", + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationsListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 Bad Request.\n\n * 500 Internal Server Error." + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/{resourceUri}/providers/microsoft.insights/generatelivetoken": { + "post": { + "tags": [ + "LiveToken" + ], + "operationId": "LiveToken_Get", + "description": "**Gets an access token for live metrics stream data.**", + "parameters": [ + { + "$ref": "#/parameters/ResourceUriParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful response containing the live metrics stream token.", + "schema": { + "$ref": "#/definitions/LiveTokenResponse" + }, + "examples": { + "application/json": { + "liveToken": "eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJzdWIiOiIxMjM0NTY3ODkwIiwibmFtZSI6IkpvaG4gRG9lIiwiaWF0IjoxNTE2MjM5MDIyfQ.SflKxwRJSMeKKF2QT4fwpMeJf36POk6yJV_adQssw5c" + } + } + } + }, + "x-ms-examples": { + "Get live token for resource": { + "$ref": "./examples/LiveTokenGet.json" + } + } + } + } + }, + "definitions": { + "ErrorResponse": { + "description": "Describes the format of an error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + }, + "LiveTokenResponse": { + "type": "object", + "properties": { + "liveToken": { + "type": "string", + "description": "JWT token for accessing live metrics stream data.", + "readOnly": true + } + }, + "description": "The response to a live token query." + }, + "OperationsListResult": { + "description": "Result of the List Operations operation", + "type": "object", + "properties": { + "value": { + "description": "A collection of operations", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "description": "Represents an operation returned by the GetOperations request", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationInfo", + "description": "Display name of the operation" + }, + "origin": { + "description": "Origin of the operation", + "type": "string" + }, + "properties": { + "description": "Properties of the operation", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "OperationInfo": { + "description": "Information about an operation", + "type": "object", + "properties": { + "provider": { + "description": "Name of the provider", + "type": "string" + }, + "resource": { + "description": "Name of the resource type", + "type": "string" + }, + "operation": { + "description": "Name of the operation", + "type": "string" + }, + "description": { + "description": "Description of the operation", + "type": "string" + } + } + } + }, + "parameters": { + "ResourceUriParameter": { + "name": "resourceUri", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier of the resource.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/applicationinsights/resource-manager/readme.md b/specification/applicationinsights/resource-manager/readme.md index b01e064aecde..3e00e6366502 100644 --- a/specification/applicationinsights/resource-manager/readme.md +++ b/specification/applicationinsights/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the ApplicationInsights API. title: ApplicationInsightsManagementClient description: Composite Swagger for Application Insights Management Client openapi-type: arm -tag: package-preview-2020-02 +tag: package-preview-2020-06 ``` ## Suppression @@ -238,6 +238,37 @@ directive: reason: There are a bug in this rule. "ExportConfigurations_Create" is a valid operation id. ``` +### Tag: package-preview-2020-06-only + +These settings apply only when `--tag=package-preview-2020-06-only` is specified on the command line. + +```yaml $(tag) == 'package-preview-2020-06-only' +input-file: + - Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json +``` + +### Tag: package-preview-2020-06 + +These settings apply only when `--tag=package-preview-2020-06` is specified on the command line. + +```yaml $(tag) == 'package-preview-2020-06' +input-file: + - Microsoft.Insights/stable/2015-05-01/aiOperations_API.json + - Microsoft.Insights/stable/2015-05-01/componentAnnotations_API.json + - Microsoft.Insights/stable/2015-05-01/componentApiKeys_API.json + - Microsoft.Insights/stable/2015-05-01/componentContinuousExport_API.json + - Microsoft.Insights/stable/2015-05-01/componentFeaturesAndPricing_API.json + - Microsoft.Insights/stable/2015-05-01/componentProactiveDetection_API.json + - Microsoft.Insights/stable/2015-05-01/componentWorkItemConfigs_API.json + - Microsoft.Insights/stable/2015-05-01/favorites_API.json + - Microsoft.Insights/stable/2015-05-01/webTestLocations_API.json + - Microsoft.Insights/stable/2015-05-01/webTests_API.json + - Microsoft.Insights/stable/2015-05-01/analyticsItems_API.json + - Microsoft.Insights/stable/2015-05-01/workbooks_API.json + - Microsoft.Insights/preview/2018-05-01-preview/components_API.json + - Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json + - Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json +``` ### Tag: package-preview-2020-02 @@ -479,7 +510,7 @@ input-file: - $(this-folder)/Microsoft.Insights/preview/2019-09-01-preview/QueryPacks_API.json - $(this-folder)/Microsoft.Insights/preview/2020-02-02-preview/components_API.json - $(this-folder)/Microsoft.Insights/preview/2020-03-01-preview/componentLinkedStorageAccounts_API.json - + - $(this-folder)/Microsoft.Insights/preview/2020-06-02-preview/livetoken_API.json ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/applicationinsights/resource-manager/readme.python.md b/specification/applicationinsights/resource-manager/readme.python.md index 97df9d6f8c3b..b7462eaaf2d0 100644 --- a/specification/applicationinsights/resource-manager/readme.python.md +++ b/specification/applicationinsights/resource-manager/readme.python.md @@ -25,6 +25,7 @@ batch: - tag: package-2019-10-17-preview - tag: package-2020-02-02-preview - tag: package-2020-03-01-preview + - tag: package-preview-2020-06-only ``` ### Tag: package-2015-05 and python From f5f041d73e773d6ad4952b78bd2ee851c22b8c1f Mon Sep 17 00:00:00 2001 From: Chuang <54572251+xccc-msft@users.noreply.github.com> Date: Mon, 15 Jun 2020 09:32:14 +0800 Subject: [PATCH 146/318] Network: rename operation for java generator (#9826) * Network: rename operation for java generator * add package-2020-05 --- .../network/resource-manager/readme.java.md | 24 +++++++++++++++++++ 1 file changed, 24 insertions(+) diff --git a/specification/network/resource-manager/readme.java.md b/specification/network/resource-manager/readme.java.md index 2c46f72efaf5..d2df4bb20159 100644 --- a/specification/network/resource-manager/readme.java.md +++ b/specification/network/resource-manager/readme.java.md @@ -10,12 +10,23 @@ namespace: com.microsoft.azure.management.network license-header: MICROSOFT_MIT_NO_CODEGEN payload-flattening-threshold: 1 output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-network +directive: + - rename-operation: + from: VirtualHubBgpConnection_Get + to: VirtualHubBgpConnections_Get + - rename-operation: + from: VirtualHubBgpConnection_CreateOrUpdate + to: VirtualHubBgpConnections_CreateOrUpdate + - rename-operation: + from: VirtualHubBgpConnection_Delete + to: VirtualHubBgpConnections_Delete ``` ### Java multi-api ``` yaml $(java) && $(multiapi) batch: + - tag: package-2020-05 - tag: package-2020-04 - tag: package-2020-03 - tag: package-2019-09 @@ -26,6 +37,19 @@ batch: - tag: package-2019-02 ``` +### Tag: package-2020-05 and java + +These settings apply only when `--tag=package-2020-05 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-05' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.network.v2020_05_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/network/mgmt-v2020_05_01 + regenerate-manager: true + generate-interface: true +``` + ### Tag: package-2020-04 and java These settings apply only when `--tag=package-2020-04 --java` is specified on the command line. From 0a3871d13e5fd2a11be1c29ca41a577589307ac9 Mon Sep 17 00:00:00 2001 From: chunyu3 Date: Mon, 15 Jun 2020 17:03:30 +0800 Subject: [PATCH 147/318] update readme.trenton.md for alertsmanagement (#9600) --- .../alertsmanagement/resource-manager/readme.trenton.md | 7 ++++++- 1 file changed, 6 insertions(+), 1 deletion(-) diff --git a/specification/alertsmanagement/resource-manager/readme.trenton.md b/specification/alertsmanagement/resource-manager/readme.trenton.md index 06e42501cc61..4a374c2f42fd 100644 --- a/specification/alertsmanagement/resource-manager/readme.trenton.md +++ b/specification/alertsmanagement/resource-manager/readme.trenton.md @@ -6,7 +6,7 @@ overrides: - where: resource: "*" set: - - NeedSeparated: false + - NeedSeparated: true - where: resource: "ActionRules" property: "properties" @@ -18,6 +18,10 @@ overrides: property: "properties" set: - GoFieldName: "PatchProperties" + - where: + property: "status" + set: + - Hidden: false - where: property: "type" set: @@ -33,6 +37,7 @@ overrides: set: - EnumValues/0/GoEnumMemberName: "ScopeTypeResourceGroup" - EnumValues/1/GoEnumMemberName: "ScopeTypeResource" + - EnumValues/2/GoEnumMemberName: "ScopeTypeSubscription" ``` ## trenton From 68d642b16e39c29068ed47992e4bbba227100e9d Mon Sep 17 00:00:00 2001 From: chunyu3 Date: Mon, 15 Jun 2020 20:20:51 +0800 Subject: [PATCH 148/318] add readme.trenton.md for RP Databoxedge (#9837) --- .../resource-manager/readme.trenton.md | 77 +++++++++++++++++++ 1 file changed, 77 insertions(+) create mode 100644 specification/databoxedge/resource-manager/readme.trenton.md diff --git a/specification/databoxedge/resource-manager/readme.trenton.md b/specification/databoxedge/resource-manager/readme.trenton.md new file mode 100644 index 000000000000..25f9a09eebb2 --- /dev/null +++ b/specification/databoxedge/resource-manager/readme.trenton.md @@ -0,0 +1,77 @@ + +## trenton + +These settings apply only when `--trenton` is specified on the command line. + +``` yaml $(trenton) +trenton: + cli-name: databoxedge + package-name: databoxedge +clear-output-folder: true +output-folder: $(trenton-output-folder)/databoxedge +``` +## overrides + +These settings apply only when `--trenton` is specified on the command line. +``` yaml $(trenton) +overrides: + - where: + resource: "BandwidthSchedules" + method: "CreateOrUpdate" + set: + - BodyPosition: 2 + - where: + resource: "Containers" + method: "CreateOrUpdate" + set: + - BodyPosition: 3 + - where: + resource: "Devices" + method: "CreateOrUpdate" + set: + - BodyPosition: 1 + - where: + resource: "Devices" + method: "Update" + set: + - BodyPosition: 1 + - where: + resource: "Orders" + method: "CreateOrUpdate" + set: + - BodyPosition: 1 + - where: + resource: "Roles" + method: "CreateOrUpdate" + set: + - BodyPosition: 2 + - where: + resource: "Shares" + method: "CreateOrUpdate" + set: + - BodyPosition: 2 + - where: + resource: "StorageAccountCredentials" + method: "CreateOrUpdate" + set: + - BodyPosition: 2 + - where: + resource: "StorageAccounts" + method: "CreateOrUpdate" + set: + - BodyPosition: 2 + - where: + resource: "Triggers" + method: "CreateOrUpdate" + set: + - BodyPosition: 2 + - where: + resource: "Users" + method: "CreateOrUpdate" + set: + - BodyPosition: 2 + - where: + property: "SSLStatus" + set: + - GoFieldName: "SslStatus" +``` \ No newline at end of file From ac46e15587ef004c2730c1a1023147c5acbbfd62 Mon Sep 17 00:00:00 2001 From: shurd Date: Mon, 15 Jun 2020 08:57:49 -0400 Subject: [PATCH 149/318] Cosmos DB remove 404 response on databaseAccounts GET (#9746) * removing documented 404 to prevent swallowing exception in CLI when account does not exist * removing 404 response code from examples Co-authored-by: Sam Hurd --- .../Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json | 3 --- .../stable/2020-03-01/examples/CosmosDBDatabaseAccountGet.json | 3 +-- .../Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json | 3 --- .../stable/2020-04-01/examples/CosmosDBDatabaseAccountGet.json | 3 +-- 4 files changed, 2 insertions(+), 10 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json index 7dbbfb12e702..e648003dc480 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/cosmos-db.json @@ -63,9 +63,6 @@ "schema": { "$ref": "#/definitions/DatabaseAccountGetResults" } - }, - "404": { - "description": "Not Found. The account name is available and valid." } } }, diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBDatabaseAccountGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBDatabaseAccountGet.json index 4f54871fce78..f9f8b1e7a0c0 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBDatabaseAccountGet.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-03-01/examples/CosmosDBDatabaseAccountGet.json @@ -77,7 +77,6 @@ ] } } - }, - "404": {} + } } } diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json index fac9062ba082..6e73ccd40325 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json @@ -63,9 +63,6 @@ "schema": { "$ref": "#/definitions/DatabaseAccountGetResults" } - }, - "404": { - "description": "Not Found. The account name is available and valid." } } }, diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBDatabaseAccountGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBDatabaseAccountGet.json index 5acc11878245..a9060dbe546d 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBDatabaseAccountGet.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/stable/2020-04-01/examples/CosmosDBDatabaseAccountGet.json @@ -80,7 +80,6 @@ "enableAnalyticalStorage": true } } - }, - "404": {} + } } } From c9aad889e94387d174e3ed3a2404b69e657c1165 Mon Sep 17 00:00:00 2001 From: Denis Stankovski Date: Mon, 15 Jun 2020 16:18:37 -0700 Subject: [PATCH 150/318] Updated APNS related documentation for 2017-04-01 version (#8664) * Updated APNS related documentation for 2017-04-01 version * Additional changes * Addressed code review feedback * Added default gcmEndpoint value --- .../stable/2017-04-01/notificationhubs.json | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json index b80cda4121ea..e1cde5770fdf 100644 --- a/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json +++ b/specification/notificationhubs/resource-manager/Microsoft.NotificationHubs/stable/2017-04-01/notificationhubs.json @@ -1898,38 +1898,38 @@ "properties": { "apnsCertificate": { "type": "string", - "description": "The APNS certificate." + "description": "The APNS certificate. Specify if using Certificate Authentication Mode." }, "certificateKey": { "type": "string", - "description": "The certificate key." + "description": "The APNS certificate password if it exists." }, "endpoint": { "type": "string", - "description": "The endpoint of this credential." + "description": "The APNS endpoint of this credential. If using Certificate Authentication Mode and Sandbox specify 'gateway.sandbox.push.apple.com'. If using Certificate Authentication Mode and Production specify 'gateway.push.apple.com'. If using Token Authentication Mode and Sandbox specify 'https://api.development.push.apple.com:443/3/device'. If using Token Authentication Mode and Production specify 'https://api.push.apple.com:443/3/device'." }, "thumbprint": { "type": "string", - "description": "The APNS certificate Thumbprint" + "description": "The APNS certificate thumbprint. Specify if using Certificate Authentication Mode." }, "keyId": { "type": "string", - "description": "A 10-character key identifier (kid) key, obtained from your developer account" + "description": "A 10-character key identifier (kid) key, obtained from your developer account. Specify if using Token Authentication Mode." }, "appName": { "type": "string", - "description": "The name of the application" + "description": "The name of the application or BundleId. Specify if using Token Authentication Mode." }, "appId": { "type": "string", - "description": "The issuer (iss) registered claim key, whose value is your 10-character Team ID, obtained from your developer account" + "description": "The issuer (iss) registered claim key. The value is a 10-character TeamId, obtained from your developer account. Specify if using Token Authentication Mode." }, "token": { "type": "string", - "description": "Provider Authentication Token, obtained through your developer account" + "description": "Provider Authentication Token, obtained through your developer account. Specify if using Token Authentication Mode." } }, - "description": "Description of a NotificationHub ApnsCredential." + "description": "Description of a NotificationHub ApnsCredential. Note that there is no explicit switch between Certificate and Token Authentication Modes. The mode is determined based on the properties passed in." }, "ApnsCredential": { "properties": { @@ -1972,7 +1972,7 @@ "properties": { "gcmEndpoint": { "type": "string", - "description": "The GCM endpoint." + "description": "The FCM legacy endpoint. Default value is 'https://fcm.googleapis.com/fcm/send'" }, "googleApiKey": { "type": "string", From 937be0b5c85d73dca2e53346197b29012c48292d Mon Sep 17 00:00:00 2001 From: Vishnu Priya Ananthu Sundaram Date: Mon, 15 Jun 2020 16:23:00 -0700 Subject: [PATCH 151/318] Cumulative commit message: (#9031) commit 9e551f0eab4057d4c2f54c333c7aa2a1a564c125 Author: bganapa Date: Tue Nov 12 11:44:22 2019 -0800 Reset to Stackadmin2 (#7766) --- .../deployment/readme.azsautogen.md | 57 +++++++++++++++++++ .../resource-manager/deployment/readme.md | 1 - 2 files changed, 57 insertions(+), 1 deletion(-) create mode 100644 specification/azsadmin/resource-manager/deployment/readme.azsautogen.md diff --git a/specification/azsadmin/resource-manager/deployment/readme.azsautogen.md b/specification/azsadmin/resource-manager/deployment/readme.azsautogen.md new file mode 100644 index 000000000000..210d18e38387 --- /dev/null +++ b/specification/azsadmin/resource-manager/deployment/readme.azsautogen.md @@ -0,0 +1,57 @@ +# Deployment Admin + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Deployment Admin. + +--- +## Getting Started +To build the SDK for Deployment Admin, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` +--- + +## Configuration + +### Basic Information +These are the global settings for the Deployment Resource Provider API. + +``` yaml +title: DeploymentAdminClient +description: Deployment Admin Client +openapi-type: arm +tag: package-2019-01-01 +``` + +``` yaml +input-file: + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/Deployment.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlan.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ActionPlanOperation.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/FileContainer.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductDeployment.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json + - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json +``` + +--- +# Code Generation + +## 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 + namespace: Microsoft.AzureStack.Management.Deployment.Admin + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/Generated + clear-output-folder: true +``` diff --git a/specification/azsadmin/resource-manager/deployment/readme.md b/specification/azsadmin/resource-manager/deployment/readme.md index 0fd649383551..3976fe43cc0f 100644 --- a/specification/azsadmin/resource-manager/deployment/readme.md +++ b/specification/azsadmin/resource-manager/deployment/readme.md @@ -76,7 +76,6 @@ input-file: - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductDeployment.json - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductPackage.json - $(this-folder)/Microsoft.Deployment.Admin/preview/2019-01-01/ProductSecret.json - ``` If there are files that should not be in the `all-api-versions` set, From 493838af21a2db789e00864fea8c4b894a5785a1 Mon Sep 17 00:00:00 2001 From: Sakthi Vetrivel Date: Mon, 15 Jun 2020 17:09:31 -0700 Subject: [PATCH 152/318] Updating summaries and description (#9681) Updating summaries and description to fix formatting and repeated information in auto-generated docs. --- .../stable/2020-04-30/redhatopenshift.json | 20 +++++++++---------- 1 file changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/stable/2020-04-30/redhatopenshift.json b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/stable/2020-04-30/redhatopenshift.json index 2baad1416737..9b9900008676 100644 --- a/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/stable/2020-04-30/redhatopenshift.json +++ b/specification/redhatopenshift/resource-manager/Microsoft.RedHatOpenShift/stable/2020-04-30/redhatopenshift.json @@ -1,8 +1,8 @@ { "swagger": "2.0", "info": { - "title": "Azure Red Hat OpenShift Client", - "description": "Rest API for Azure Red Hat OpenShift", + "title": "Azure Red Hat OpenShift 4 Client", + "description": "Rest API for Azure Red Hat OpenShift 4", "version": "2020-04-30" }, "host": "management.azure.com", @@ -22,7 +22,7 @@ "Operations" ], "summary": "Lists all of the available RP operations.", - "description": "Lists all of the available RP operations. The operation returns the RP operations.", + "description": "The operation returns the RP operations.", "operationId": "Operations_List", "parameters": [ { @@ -59,7 +59,7 @@ "OpenShiftClusters" ], "summary": "Lists OpenShift clusters in the specified subscription.", - "description": "Lists OpenShift clusters in the specified subscription. The operation returns properties of each OpenShift cluster.", + "description": "The operation returns properties of each OpenShift cluster.", "operationId": "OpenShiftClusters_List", "parameters": [ { @@ -99,7 +99,7 @@ "OpenShiftClusters" ], "summary": "Lists OpenShift clusters in the specified subscription and resource group.", - "description": "Lists OpenShift clusters in the specified subscription and resource group. The operation returns properties of each OpenShift cluster.", + "description": "The operation returns properties of each OpenShift cluster.", "operationId": "OpenShiftClusters_ListByResourceGroup", "parameters": [ { @@ -142,7 +142,7 @@ "OpenShiftClusters" ], "summary": "Gets a OpenShift cluster with the specified subscription, resource group and resource name.", - "description": "Gets a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.", + "description": "The operation returns properties of a OpenShift cluster.", "operationId": "OpenShiftClusters_Get", "parameters": [ { @@ -187,7 +187,7 @@ "OpenShiftClusters" ], "summary": "Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.", - "description": "Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.", + "description": "The operation returns properties of a OpenShift cluster.", "operationId": "OpenShiftClusters_CreateOrUpdate", "parameters": [ { @@ -248,7 +248,7 @@ "OpenShiftClusters" ], "summary": "Deletes a OpenShift cluster with the specified subscription, resource group and resource name.", - "description": "Deletes a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns nothing.", + "description": "The operation returns nothing.", "operationId": "OpenShiftClusters_Delete", "parameters": [ { @@ -294,7 +294,7 @@ "OpenShiftClusters" ], "summary": "Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name.", - "description": "Creates or updates a OpenShift cluster with the specified subscription, resource group and resource name. The operation returns properties of a OpenShift cluster.", + "description": "The operation returns properties of a OpenShift cluster.", "operationId": "OpenShiftClusters_Update", "parameters": [ { @@ -357,7 +357,7 @@ "OpenShiftClusters" ], "summary": "Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name.", - "description": "Lists credentials of an OpenShift cluster with the specified subscription, resource group and resource name. The operation returns the credentials.", + "description": "The operation returns the credentials.", "operationId": "OpenShiftClusters_ListCredentials", "parameters": [ { From 0a31d5ae086d32b254132bb7420b3219833c89ba Mon Sep 17 00:00:00 2001 From: Shangwei Sun <63389531+sunsw1994@users.noreply.github.com> Date: Tue, 16 Jun 2020 00:25:20 +0000 Subject: [PATCH 153/318] [Synapse]-Add autorest configuration file for track1 go dateplane-sdk (#9811) * Add autorest configuration for go SDK * update readme.md for autorest * remove vnet from generate batch --- specification/synapse/data-plane/readme.go.md | 51 +++++++++++++++++++ specification/synapse/data-plane/readme.md | 5 ++ 2 files changed, 56 insertions(+) create mode 100644 specification/synapse/data-plane/readme.go.md diff --git a/specification/synapse/data-plane/readme.go.md b/specification/synapse/data-plane/readme.go.md new file mode 100644 index 000000000000..3b24071d4596 --- /dev/null +++ b/specification/synapse/data-plane/readme.go.md @@ -0,0 +1,51 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true +``` + +### Go multi-api + +``` yaml $(go) && $(multiapi) +batch: + - tag: package-spark-2019-11-01-preview + - tag: package-artifacts-2019-06-01-preview + - tag: package-access-control-2020-02-01-preview +``` + +### Tag: package-spark-2019-11-01-preview and go + +These settings apply only when `--tag=package-spark-2019-11-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-spark-2019-11-01-preview' && $(go) +go: + namespace: spark +output-folder: $(go-sdk-folder)/services/preview/synapse/2019-11-01-preview/$(namespace) +``` + +### Tag: package-artifacts-2019-06-01-preview and go + +These settings apply only when `--tag=package-artifacts-2019-06-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-artifacts-2019-06-01-preview' && $(go) +go: + namespace: artifacts +output-folder: $(go-sdk-folder)/services/preview/synapse/2019-06-01-preview/$(namespace) +``` + +### Tag: package-access-control-2020-02-01-preview and go + +These settings apply only when `--tag=package-access-control-2020-02-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-access-control-2020-02-01-preview' && $(go) +go: + namespace: accesscontrol +output-folder: $(go-sdk-folder)/services/preview/synapse/2020-02-01-preview/$(namespace) +``` \ No newline at end of file diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md index 27db372758be..90987da109b6 100644 --- a/specification/synapse/data-plane/readme.md +++ b/specification/synapse/data-plane/readme.md @@ -131,6 +131,11 @@ batch: ## TypeScript See configuration in [readme.typescript.md](./readme.typescript.md) + +## Go + +See configuration in [readme.go.md](./readme.go.md) + ## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. From 7dd04f70789e293d5931948fa313cf08530fe6c6 Mon Sep 17 00:00:00 2001 From: Jacob Freck Date: Mon, 15 Jun 2020 17:25:47 -0700 Subject: [PATCH 154/318] fix typo (#9664) --- .../Microsoft.Batch/stable/2020-05-01/BatchManagement.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/BatchManagement.json b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/BatchManagement.json index 1dfb09e8472b..7aa629b9cb38 100644 --- a/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/BatchManagement.json +++ b/specification/batch/resource-manager/Microsoft.Batch/stable/2020-05-01/BatchManagement.json @@ -2382,7 +2382,7 @@ } } }, - "description": "The identity of the Batch account, if configured. This is only used when the user specifies 'Azure.KeyVault' as their Batch account encryption configuration.", + "description": "The identity of the Batch account, if configured. This is only used when the user specifies 'Microsoft.KeyVault' as their Batch account encryption configuration.", "required": [ "type" ] From da2056aac6e25068648fa7cc096a216695c0e0fd Mon Sep 17 00:00:00 2001 From: Cameron Taggart Date: Mon, 15 Jun 2020 20:56:22 -0600 Subject: [PATCH 155/318] adjust csharp SDK generation for Microsoft.AVS (#9773) * adjust csharp generation for Microsoft.AVS * renamed namespace to "Avs" & client is "AvsClient" --- specification/vmware/resource-manager/readme.csharp.md | 7 +++---- 1 file changed, 3 insertions(+), 4 deletions(-) diff --git a/specification/vmware/resource-manager/readme.csharp.md b/specification/vmware/resource-manager/readme.csharp.md index 0285a875be62..97f5c0aea663 100644 --- a/specification/vmware/resource-manager/readme.csharp.md +++ b/specification/vmware/resource-manager/readme.csharp.md @@ -5,11 +5,10 @@ Please also specify `--csharp-sdks-folder= Date: Tue, 16 Jun 2020 06:07:39 +0200 Subject: [PATCH 156/318] network test (#9740) * network test * dependencies * sorted out more examples * more * sorted out more operations * sorted out more tests * sorted out more * more sorted * updates * a few updates * updates * updates * updates * some tests are disabled --- .../network/resource-manager/readme.cli.md | 681 ++++++++++++++++++ 1 file changed, 681 insertions(+) create mode 100644 specification/network/resource-manager/readme.cli.md diff --git a/specification/network/resource-manager/readme.cli.md b/specification/network/resource-manager/readme.cli.md new file mode 100644 index 000000000000..ca430ac46cee --- /dev/null +++ b/specification/network/resource-manager/readme.cli.md @@ -0,0 +1,681 @@ +## CLI + +These settings apply only when `--cli` is specified on the command line. + +``` yaml $(cli) +cli: + cli-name: network + package-name: azure-mgmt-network + namespace: azure.mgmt.network + test-scenario: + - split: publicipaddresses + - name: /PublicIPAddresses/put/Create public IP address DNS + - name: /PublicIPAddresses/put/Create public IP address allocation method + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /PublicIPAddresses/get/GetVMSSPublicIP + - name: /PublicIPAddresses/get/ListVMSSVMPublicIP + - name: /PublicIPAddresses/get/ListVMSSPublicIP + - name: /PublicIPAddresses/get/Get public IP address + - name: /PublicIPAddresses/get/List resource group public IP addresses + - name: /PublicIPAddresses/get/List all public IP addresses + - name: /PublicIPAddresses/patch/Update public IP address tags + - name: /PublicIPAddresses/delete/Delete public IP address + - split: virtualnetworks + - name: /VirtualNetworks/put/Create virtual network with service endpoints and service endpoint policy + - name: /VirtualNetworks/put/Create virtual network with subnet containing address prefixes + - name: /VirtualNetworks/put/Create virtual network with Bgp Communities + - name: /VirtualNetworks/put/Create virtual network + - name: /VirtualNetworks/put/Create virtual network with service endpoints + - name: /VirtualNetworks/put/Create virtual network with subnet + - name: /VirtualNetworks/put/Create virtual network with delegated subnets + - name: /VirtualNetworks/get/Check IP address availability + - name: /VirtualNetworks/get/VnetGetUsage + - name: /VirtualNetworks/get/Get virtual network + - name: /VirtualNetworks/get/Get virtual network with service association links + - name: /VirtualNetworks/get/Get virtual network with a delegated subnet + - name: /VirtualNetworks/get/List virtual networks in resource group + - name: /VirtualNetworks/get/List all virtual networks + - name: /VirtualNetworks/patch/Update virtual network tags + - name: /VirtualNetworks/delete/Delete virtual network + - split: subnets + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /Subnets/put/Create subnet with service endpoints + - name: /Subnets/put/Create subnet with a delegation + - name: /Subnets/get/Get subnet with a delegation + - name: /Subnets/get/Get subnet + - name: /Subnets/get/List subnets + - name: /Subnets/post/Unprepare Network Policies + comment: "Azure Error: UnauthorizedOperation" + disabled: true + - name: /Subnets/post/Prepare Network Policies + comment: "Azure Error: UnauthorizedOperation" + disabled: true + - name: /Subnets/delete/Delete subnet + - split: loadbalancers + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /LoadBalancers/put/Create load balancer with Frontend IP in Zone 1 + - name: /LoadBalancers/put/Create load balancer with outbound rules + - name: /LoadBalancers/put/Create load balancer with Standard SKU + - name: /LoadBalancers/put/Create load balancer + - name: /LoadBalancers/put/Create load balancer with inbound nat pool + - name: /LoadBalancers/get/Get load balancer + - name: /LoadBalancers/get/List load balancers in resource group + - name: /LoadBalancers/get/List all load balancers + - name: /LoadBalancers/patch/Update load balancer tags + - name: /LoadBalancers/delete/Delete load balancer + - split: networkinterfaces + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /NetworkInterfaces/put/Create network interface + - name: /NetworkInterfaces/get/Get virtual machine scale set network interface + - name: /NetworkInterfaces/get/List virtual machine scale set network interface ip configurations + - name: /NetworkInterfaces/get/Get virtual machine scale set network interface + - name: /NetworkInterfaces/get/List virtual machine scale set vm network interfaces + - name: /NetworkInterfaces/get/List virtual machine scale set network interfaces + - name: /NetworkInterfaces/get/Get network interface + - name: /NetworkInterfaces/get/List network interfaces in resource group + - name: /NetworkInterfaces/get/List all network interfaces + - name: /NetworkInterfaces/post/List network interface effective network security groups + - name: /NetworkInterfaces/post/Show network interface effective route tables + - name: /NetworkInterfaces/patch/Update network interface tags + - name: /NetworkInterfaces/delete/Delete network interface + - split: routetables + - name: /RouteTables/put/Create route table with route + - name: /RouteTables/put/Create route table + - name: /RouteTables/get/Get route table + - name: /RouteTables/get/List route tables in resource group + - name: /RouteTables/get/List all route tables + - name: /RouteTables/patch/Update route table tags + - name: /RouteTables/delete/Delete route table + - split: routes + - name: /RouteTables/put/Create route table + - name: /Routes/put/Create route + - name: /Routes/get/Get route + - name: /Routes/get/List routes + - name: /Routes/delete/Delete route + - split: routefilters + - name: /RouteFilters/put/RouteFilterCreate + - name: /RouteFilters/get/RouteFilterGet + - name: /RouteFilters/get/RouteFilterListByResourceGroup + - name: /RouteFilters/get/RouteFilterList + - name: /RouteFilters/patch/Update route filter tags + - name: /RouteFilters/delete/RouteFilterDelete + - split: routefilterrules + - name: /RouteFilters/put/RouteFilterCreate + - name: /RouteFilterRules/put/RouteFilterRuleCreate + - name: /RouteFilterRules/get/RouteFilterRuleGet + - name: /RouteFilterRules/get/RouteFilterRuleListByRouteFilter + - name: /RouteFilterRules/delete/RouteFilterRuleDelete + - split: virtualwans + - name: /VirtualWans/put/VirtualWANCreate + - name: /VirtualWans/get/VirtualWANGet + - name: /VirtualWans/get/VirtualWANListByResourceGroup + - name: /VirtualWans/get/VirtualWANList + - name: /VirtualWans/patch/VirtualWANUpdate + - name: /VirtualWans/delete/VirtualWANDelete + - split: virtualhubs + - name: /VirtualWans/put/VirtualWANCreate + - name: /VirtualHubs/put/VirtualHubPut + - name: /VirtualHubs/get/VirtualHubGet + - name: /VirtualHubs/get/VirtualHubListByResourceGroup + - name: /VirtualHubs/get/VirtualHubList + - name: /VirtualHubs/patch/VirtualHubUpdate + - name: /VirtualHubs/delete/VirtualHubDelete + - split: virtualhubroutetablev2s + - name: /VirtualWans/put/VirtualWANCreate + - name: /VirtualHubs/put/VirtualHubPut + - name: /VirtualHubRouteTableV2s/put/VirtualHubRouteTableV2Put + - name: /VirtualHubRouteTableV2s/get/VirtualHubVirtualHubRouteTableV2Get + - name: /VirtualHubRouteTableV2s/get/VirtualHubRouteTableV2List + - name: /VirtualHubRouteTableV2s/delete/VirtualHubRouteTableV2Delete + - split: vpnsites + - name: /VirtualWans/put/VirtualWANCreate + - name: /VpnSites/put/VpnSiteCreate + - name: /VpnSites/get/VpnSiteGet + - name: /VpnSites/get/VpnSiteListByResourceGroup + - name: /VpnSites/get/VpnSiteList + - name: /VpnSites/patch/VpnSiteUpdate + - name: /VpnSites/delete/VpnSiteDelete + - split: ipgroups + - name: /IpGroups/put/CreateOrUpdate_IpGroups + - name: /IpGroups/get/Get_IpGroups + - name: /IpGroups/get/ListByResourceGroup_IpGroups + - name: /IpGroups/get/List_IpGroups + - name: /IpGroups/patch/Update_IpGroups + comment: The requested resource does not support http method 'PATCH'. + disabled: true + - name: /IpGroups/delete/Delete_IpGroups + - split: bastionhosts + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /BastionHosts/put/Create Bastion Host + - name: /BastionHosts/get/Get Bastion Host + - name: /BastionHosts/get/List all Bastion Hosts for a given resource group + - name: /BastionHosts/get/List all Bastion Hosts for a given subscription + - name: /BastionHosts/delete/Delete Bastion Host + - split: inboundnatrules + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /LoadBalancers/put/Create load balancer + - name: /InboundNatRules/put/InboundNatRuleCreate + - name: /InboundNatRules/get/InboundNatRuleGet + - name: /InboundNatRules/get/InboundNatRuleList + - name: /InboundNatRules/delete/InboundNatRuleDelete + - split: networksecuritygroups + - name: /NetworkSecurityGroups/put/Create network security group + - name: /NetworkSecurityGroups/put/Create network security group with rule + - name: /NetworkSecurityGroups/get/Get network security group + - name: /NetworkSecurityGroups/get/List network security groups in resource group + - name: /NetworkSecurityGroups/get/List all network security groups + - name: /NetworkSecurityGroups/patch/Update network security group tags + - name: /NetworkSecurityGroups/delete/Delete network security group + - split: securityrules + - name: /NetworkSecurityGroups/put/Create network security group + - name: /SecurityRules/put/Create security rule + - name: /SecurityRules/get/List network security rules in network security group + - name: /SecurityRules/get/Get network security rule in network security group + - name: /SecurityRules/delete/Delete network security rule from network security group + - split: ipallocations + - name: /VirtualNetworks/put/Create virtual network + - name: /IpAllocations/put/Create IpAllocation + comment: "Azure Error: HypernetIpAllocationSubscriptionNotOnboardHypernet" + - name: /IpAllocations/get/Get IpAllocation + - name: /IpAllocations/get/List IpAllocations in resource group + - name: /IpAllocations/get/List all IpAllocations + - name: /IpAllocations/patch/Update virtual network tags + - name: /IpAllocations/delete/Delete IpAllocation + - split: publicipprefixes + - name: /PublicIPPrefixes/put/Create public IP prefix defaults + - name: /PublicIPPrefixes/put/Create public IP prefix allocation method + - name: /PublicIPPrefixes/get/Get public IP prefix + - name: /PublicIPPrefixes/get/List resource group public IP prefixes + - name: /PublicIPPrefixes/get/List all public IP prefixes + - name: /PublicIPPrefixes/patch/Update public IP prefix tags + - name: /PublicIPPrefixes/delete/Delete public IP prefix + - split: firewallpolicies + - name: /FirewallPolicies/put/Create FirewallPolicy + - name: /FirewallPolicyRuleGroups/put/Create FirewallPolicyRuleGroup + - name: /FirewallPolicyRuleGroups/put/Create FirewallPolicyRuleGroup With IpGroups + - name: /FirewallPolicyRuleGroups/get/Get FirewallPolicyRuleGroup With IpGroups + - name: /FirewallPolicyRuleGroups/get/Get FirewallPolicyRuleGroup + - name: /FirewallPolicyRuleGroups/get/List all FirewallPolicyRuleGroups for a given FirewallPolicy + - name: /FirewallPolicyRuleGroups/get/List all FirewallPolicyRuleGroups with IpGroups for a given FirewallPolicy + - name: /FirewallPolicies/get/Get FirewallPolicy + - name: /FirewallPolicies/get/List all Firewall Policies for a given resource group + - name: /FirewallPolicies/get/List all Firewall Policies for a given subscription + - name: /FirewallPolicyRuleGroups/delete/Delete FirewallPolicyRuleGroup + - name: /FirewallPolicies/delete/Delete Firewall Policy + - split: virtualrouters + - name: /VirtualRouters/put/Create VirtualRouter + - name: /VirtualRouters/get/Get VirtualRouter + - name: /VirtualRouters/get/List all Virtual Router for a given resource group + - name: /VirtualRouters/get/List all Virtual Routers for a given subscription + - name: /VirtualRouters/delete/Delete VirtualRouter + - split: azurefirewalls + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /AzureFirewalls/put/Create Azure Firewall With IpGroups + - name: /AzureFirewalls/put/Create Azure Firewall With Additional Properties + - name: /AzureFirewalls/put/Create Azure Firewall in virtual Hub + - name: /AzureFirewalls/put/Create Azure Firewall With management subnet + - name: /AzureFirewalls/put/Create Azure Firewall With Zones + - name: /AzureFirewalls/put/Create Azure Firewall + - name: /AzureFirewalls/get/Get Azure Firewall + - name: /AzureFirewalls/get/Get Azure Firewall With Zones + - name: /AzureFirewalls/get/Get Azure Firewall With management subnet + - name: /AzureFirewalls/get/Get Azure Firewall With Additional Properties + - name: /AzureFirewalls/get/Get Azure Firewall With IpGroups + - name: /AzureFirewalls/get/List all Azure Firewalls for a given resource group + - name: /AzureFirewalls/get/List all Azure Firewalls for a given subscription + - name: /AzureFirewalls/patch/Update Azure Firewall Tags + - name: /AzureFirewalls/delete/Delete Azure Firewall + - split: vpngateways + - name: /VpnGateways/put/VpnGatewayPut + - name: /VpnGateways/get/VpnGatewayGet + - name: /VpnGateways/get/VpnGatewayListByResourceGroup + - name: /VpnGateways/get/VpnGatewayListBySubscription + - name: /VpnGateways/post/ResetVpnGateway + - name: /VpnGateways/patch/VpnGatewayUpdate + - name: /VpnGateways/delete/VpnGatewayDelete + - split: natgateways + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /PublicIPPrefixes/put/Create public IP prefix defaults + - name: /NatGateways/put/Create nat gateway + - name: /NatGateways/get/Get nat gateway + - name: /NatGateways/get/List nat gateways in resource group + - name: /NatGateways/get/List all nat gateways + - name: /NatGateways/patch/Update nat gateway tags + - name: /NatGateways/delete/Delete nat gateway + - split: virtualnetworktaps + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /NetworkInterfaces/put/Create network interface + - name: /VirtualNetworkTaps/put/Create Virtual Network Tap + - name: /VirtualNetworkTaps/get/Get Virtual Network Tap + - name: /VirtualNetworkTaps/get/List virtual network taps in resource group + - name: /VirtualNetworkTaps/get/List all virtual network taps + - name: /VirtualNetworkTaps/patch/Update virtual network tap tags + - name: /VirtualNetworkTaps/delete/Delete Virtual Network Tap resource + - split: networkinterfacetapconfigurations + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /NetworkInterfaces/put/Create network interface + - name: /VirtualNetworkTaps/put/Create Virtual Network Tap + - name: /NetworkInterfaceTapConfigurations/put/Create Network Interface Tap Configurations + - name: /NetworkInterfaceTapConfigurations/get/Get Network Interface Tap Configurations + - name: /NetworkInterfaceTapConfigurations/get/List virtual network tap configurations + - name: /NetworkInterfaceTapConfigurations/delete/Delete tap configuration + - split: virtualnetworkgateways + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /VirtualNetworkGateways/put/UpdateVirtualNetworkGateway + - name: /VirtualNetworkGateways/get/VirtualNetworkGatewaysListConnections + - name: /VirtualNetworkGateways/get/GetVirtualNetworkGateway + - name: /VirtualNetworkGateways/get/ListVirtualNetworkGatewaysinResourceGroup + - name: /VirtualNetworkGateways/post/Disconnect VpnConnections from Virtual Network Gateway + - name: /VirtualNetworkGateways/post/GetVPNDeviceConfigurationScript + - name: /VirtualNetworkGateways/post/GetVirtualNetworkGatewayVpnclientConnectionHealth + - name: /VirtualNetworkGateways/post/Set VirtualNetworkGateway VpnClientIpsecParameters + - name: /VirtualNetworkGateways/post/Get VirtualNetworkGateway VpnClientIpsecParameters + - name: /VirtualNetworkGateways/post/GenerateVPNClientPackage + - name: /VirtualNetworkGateways/post/GetVirtualNetworkGatewayVPNProfilePackageURL + - name: /VirtualNetworkGateways/post/ResetVpnClientSharedKey + - name: /VirtualNetworkGateways/post/ListVirtualNetworkGatewaySupportedVPNDevices + - name: /VirtualNetworkGateways/post/GetVirtualNetworkGatewayAdvertisedRoutes + - name: /VirtualNetworkGateways/post/Start packet capture on virtual network gateway without filter + - name: /VirtualNetworkGateways/post/Start packet capture on virtual network gateway with filter + - name: /VirtualNetworkGateways/post/GenerateVirtualNetworkGatewayVPNProfile + - name: /VirtualNetworkGateways/post/Stop packet capture on virtual network gateway + - name: /VirtualNetworkGateways/post/GetVirtualNetworkGatewayLearnedRoutes + - name: /VirtualNetworkGateways/post/GetVirtualNetworkGatewayBGPPeerStatus + - name: /VirtualNetworkGateways/post/ResetVirtualNetworkGateway + - name: /VirtualNetworkGateways/patch/UpdateVirtualNetworkGatewayTags + disabled: true + comment: "FAILURE: Unable to find status link for polling." + - name: /VirtualNetworkGateways/delete/DeleteVirtualNetworkGateway + - split: p2svpngateways + - name: /P2sVpnGateways/put/P2SVpnGatewayPut + - name: /P2sVpnGateways/get/P2SVpnGatewayGet + - name: /P2sVpnGateways/get/P2SVpnGatewayListByResourceGroup + - name: /P2sVpnGateways/get/P2SVpnGatewayListBySubscription + - name: /P2sVpnGateways/post/Disconnect VpnConnections from P2sVpn Gateway + - name: /P2sVpnGateways/post/P2SVpnGatewayGetConnectionHealthDetailed + - name: /P2sVpnGateways/post/P2SVpnGatewayGetConnectionHealth + - name: /P2sVpnGateways/post/GenerateP2SVpnGatewayVPNProfile + - name: /P2sVpnGateways/patch/P2SVpnGatewayUpdate + - name: /P2sVpnGateways/delete/P2SVpnGatewayDelete + - split: privatelinkservices + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /LoadBalancers/put/Create load balancer with Frontend IP in Zone 1 + - name: /PrivateLinkServices/put/Create private link service + - name: /PrivateLinkServices/put/approve or reject private end point connection for a private link service + - name: /PrivateLinkServices/get/Get private end point connection + - name: /PrivateLinkServices/get/List private link service in resource group + - name: /PrivateLinkServices/get/Get list of private link service id that can be linked to a private end point with auto approved + - name: /PrivateLinkServices/get/Get private link service + - name: /PrivateLinkServices/get/Get list of private link service id that can be linked to a private end point with auto approved + - name: /PrivateLinkServices/get/List private link service in resource group + - name: /PrivateLinkServices/get/List all private list service + - name: /PrivateLinkServices/post/Check private link service visibility + - name: /PrivateLinkServices/post/Check private link service visibility + - name: /PrivateLinkServices/delete/delete private end point connection for a private link service + - name: /PrivateLinkServices/delete/Delete private link service + - split: expressroutecircuits + - name: /ExpressRouteCircuits/put/Create ExpressRouteCircuit + - name: /ExpressRouteCircuitPeerings/put/Create ExpressRouteCircuit Peerings + - name: /ExpressRouteCircuits/put/Create ExpressRouteCircuit on ExpressRoutePort + disabled: true + comment: Disabled as express route port can't be created + - name: /ExpressRouteCircuits/get/Get ExpressRoute Circuit Peering Traffic Stats + - name: /ExpressRouteCircuits/get/Get ExpressRoute Circuit Traffic Stats + - name: /ExpressRouteCircuits/get/Get ExpressRouteCircuit + - name: /ExpressRouteCircuits/get/List ExpressRouteCircuits in a resource group + - name: /ExpressRouteCircuits/get/List ExpressRouteCircuits in a subscription + - name: /ExpressRouteCircuits/post/List Route Table Summary + disabled: true + comment: Disabled - not sure what device path should be + - name: /ExpressRouteCircuits/post/List Route Tables + disabled: true + comment: Disabled - not sure what device path should be + - name: /ExpressRouteCircuits/post/List ARP Table + disabled: true + comment: Disabled - not sure what device path should be + - name: /ExpressRouteCircuits/patch/Update Express Route Circuit Tags + - name: /ExpressRouteCircuits/delete/Delete ExpressRouteCircuit + disabled: true + comment: "Azure Error: AnotherOperationInProgress" + - split: expressrouteports + - name: /ExpressRoutePorts/put/ExpressRoutePortCreate + disabled: true + comment: The resource type could not be found in the namespace 'Microsoft.Network' for api version '2020-04-01' + - name: /ExpressRoutePorts/put/ExpressRoutePortUpdateLink + disabled: true + comment: The resource type could not be found in the namespace 'Microsoft.Network' for api version '2020-04-01' + - name: /ExpressRoutePorts/get/ExpressRoutePortGet + disabled: true + comment: The resource type could not be found in the namespace 'Microsoft.Network' for api version '2020-04-01' + - name: /ExpressRoutePorts/get/ExpressRoutePortListByResourceGroup + disabled: true + comment: The resource type could not be found in the namespace 'Microsoft.Network' for api version '2020-04-01' + - name: /ExpressRoutePorts/get/ExpressRoutePortList + disabled: true + comment: The resource type could not be found in the namespace 'Microsoft.Network' for api version '2020-04-01' + - name: /ExpressRoutePorts/patch/ExpressRoutePortUpdateTags + disabled: true + comment: The resource type could not be found in the namespace 'Microsoft.Network' for api version '2020-04-01' + - name: /ExpressRoutePorts/delete/ExpressRoutePortDelete + disabled: true + comment: The resource type could not be found in the namespace 'Microsoft.Network' for api version '2020-04-01' + - split: networkwatchers + - name: /NetworkWatchers/put/Create network watcher + - name: /NetworkWatchers/get/Get network watcher + - name: /NetworkWatchers/get/List network watchers + - name: /NetworkWatchers/get/List all network watchers + - name: /NetworkWatchers/post/Network configuration diagnostic + - name: /NetworkWatchers/post/Get troubleshoot result + - name: /NetworkWatchers/post/Get Azure Reachability Report + - name: /NetworkWatchers/post/Get Available Providers List + - name: /NetworkWatchers/post/Get flow log status + - name: /NetworkWatchers/post/Get security group view + - name: /NetworkWatchers/post/Check connectivity + - name: /NetworkWatchers/post/Configure flow log + - name: /NetworkWatchers/post/Ip flow verify + - name: /NetworkWatchers/post/Get troubleshooting + - name: /NetworkWatchers/post/Get Topology + - name: /NetworkWatchers/post/Get next hop + - name: /NetworkWatchers/patch/Update network watcher tags + - name: /NetworkWatchers/delete/Delete network watcher + - split: privateendpoints + - name: /PrivateEndpoints/put/Create private endpoint with manual approval connection + - name: /PrivateEndpoints/put/Create private endpoint + - name: /PrivateEndpoints/get/Get private endpoint + - name: /PrivateEndpoints/get/Get private endpoint with manual approval connection + - name: /PrivateEndpoints/get/List private endpoints in resource group + - name: /PrivateEndpoints/get/List all private endpoints + - name: /PrivateEndpoints/delete/Delete private endpoint + - split: applicationgateways + - name: /ApplicationGateways/put/Create Application Gateway + - name: /ApplicationGateways/get/Get Available Ssl Predefined Policy by name + - name: /ApplicationGateways/get/Get Available Ssl Predefined Policies + - name: /ApplicationGateways/get/Get Available Ssl Options + - name: /ApplicationGateways/get/Get ApplicationGateway + - name: /ApplicationGateways/get/Lists all application gateways in a resource group + - name: /ApplicationGateways/get/Get Available Server Variables + - name: /ApplicationGateways/get/Get Available Response Headers + - name: /ApplicationGateways/get/Get Available Request Headers + - name: /ApplicationGateways/get/Get Available Waf Rule Sets + - name: /ApplicationGateways/get/Lists all application gateways in a subscription + - name: /ApplicationGateways/post/Test Backend Health + - name: /ApplicationGateways/post/Get Backend Health + - name: /ApplicationGateways/post/Start Application Gateway + - name: /ApplicationGateways/post/Stop Application Gateway + - name: /ApplicationGateways/patch/Update Application Gateway tags + - name: /ApplicationGateways/delete/Delete ApplicationGateway + - split: networkprofiles + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /NetworkProfiles/put/Create network profile defaults + - name: /NetworkProfiles/get/Get network profile with container network interfaces + - name: /NetworkProfiles/get/Get network profile + - name: /NetworkProfiles/get/List resource group network profiles + - name: /NetworkProfiles/get/List all network profiles + - name: /NetworkProfiles/patch/Update network profile tags + - name: /NetworkProfiles/delete/Delete network profile + - split: localnetworkgateways + - name: /LocalNetworkGateways/put/CreateLocalNetworkGateway + - name: /LocalNetworkGateways/get/GetLocalNetworkGateway + - name: /LocalNetworkGateways/get/ListLocalNetworkGateways + - name: /LocalNetworkGateways/patch/UpdateLocalNetworkGatewayTags + - name: /LocalNetworkGateways/delete/DeleteLocalNetworkGateway + - split: serviceendpointpolicies + - name: /ServiceEndpointPolicies/put/Create service endpoint policy with definition + - name: /ServiceEndpointPolicies/put/Create service endpoint policy + - name: /ServiceEndpointPolicies/get/Get service endPoint Policy + - name: /ServiceEndpointPolicies/get/List resource group service endpoint policies + - name: /ServiceEndpointPolicies/get/List all service endpoint policy + - name: /ServiceEndpointPolicies/patch/Update service endpoint policy tags + - name: /ServiceEndpointPolicies/delete/Delete service endpoint policy + - split: serviceendpointpolicydefinitions + - name: /ServiceEndpointPolicies/put/Create service endpoint policy + - name: /ServiceEndpointPolicyDefinitions/put/Create service endpoint policy definition + - name: /ServiceEndpointPolicyDefinitions/get/Get service endpoint definition in service endpoint policy + - name: /ServiceEndpointPolicyDefinitions/get/List service endpoint definitions in service end point policy + - name: /ServiceEndpointPolicyDefinitions/delete/Delete service endpoint policy definitions from service endpoint policy + - split: ddoscustompolicies + - name: /DdosCustomPolicies/put/Create DDoS custom policy + - name: /DdosCustomPolicies/get/Get DDoS custom policy + - name: /DdosCustomPolicies/patch/DDoS Custom policy Update tags + - name: /DdosCustomPolicies/delete/Delete DDoS custom policy + - split: ddosprotectionplans + - name: /DdosProtectionPlans/put/Create DDoS protection plan + - name: /DdosProtectionPlans/get/Get DDoS protection plan + - name: /DdosProtectionPlans/get/List DDoS protection plans in resource group + - name: /DdosProtectionPlans/get/List all DDoS protection plans + - name: /DdosProtectionPlans/patch/DDoS protection plan Update tags + - name: /DdosProtectionPlans/delete/Delete DDoS protection plan + - split: expressroutegateways + - name: /VirtualWans/put/VirtualWANCreate + - name: /VirtualHubs/put/VirtualHubPut + - name: /ExpressRouteGateways/put/ExpressRouteGatewayCreate + - name: /ExpressRouteGateways/get/ExpressRouteGatewayListByResourceGroup + - name: /ExpressRouteGateways/get/ExpressRouteGatewayListBySubscription + - name: /ExpressRouteGateways/get/ExpressRouteGatewayGet + - name: /ExpressRouteGateways/delete/ExpressRouteGatewayDelete + - split: expressroutecrossconnections + - name: /ExpressRouteCrossConnections/put/UpdateExpressRouteCrossConnection + - name: /ExpressRouteCrossConnections/get/GetExpressRouteCrossConnection + - name: /ExpressRouteCrossConnections/get/ExpressRouteCrossConnectionListByResourceGroup + - name: /ExpressRouteCrossConnections/get/ExpressRouteCrossConnectionList + - name: /ExpressRouteCrossConnections/post/GetExpressRouteCrossConnectionsRouteTableSummary + - name: /ExpressRouteCrossConnections/post/GetExpressRouteCrossConnectionsRouteTable + - name: /ExpressRouteCrossConnections/post/GetExpressRouteCrossConnectionsArpTable + - name: /ExpressRouteCrossConnections/patch/UpdateExpressRouteCrossConnectionTags + - split: virtualnetworkgatewayconnections + - name: /VirtualNetworkGatewayConnections/put/CreateVirtualNetworkGatewayConnection_S2S + - name: /VirtualNetworkGatewayConnections/put/SetVirtualNetworkGatewayConnectionSharedKey + - name: /VirtualNetworkGatewayConnections/get/GetVirtualNetworkGatewayConnectionSharedKey + - name: /VirtualNetworkGatewayConnections/get/GetVirtualNetworkGatewayConnection + - name: /VirtualNetworkGatewayConnections/get/ListVirtualNetworkGatewayConnectionsinResourceGroup + - name: /VirtualNetworkGatewayConnections/post/ResetVirtualNetworkGatewayConnectionSharedKey + - name: /VirtualNetworkGatewayConnections/post/Start packet capture on virtual network gateway connection with filter + - name: /VirtualNetworkGatewayConnections/post/Start packet capture on virtual network gateway connection without filter + - name: /VirtualNetworkGatewayConnections/post/Stop packet capture on virtual network gateway connection + - name: /VirtualNetworkGatewayConnections/patch/UpdateVirtualNetworkGatewayConnectionTags + - name: /VirtualNetworkGatewayConnections/delete/DeleteVirtualNetworkGatewayConnection + - split: vpnserverconfigurations + - name: /VpnServerConfigurations/put/VpnServerConfigurationCreate + - name: /VpnServerConfigurations/get/VpnServerConfigurationGet + - name: /VpnServerConfigurations/get/VpnServerConfigurationListByResourceGroup + - name: /VpnServerConfigurations/get/VpnServerConfigurationList + - name: /VpnServerConfigurations/patch/VpnServerConfigurationUpdate + - name: /VpnServerConfigurations/delete/VpnServerConfigurationDelete + - split: networkvirtualappliances + - name: /VirtualWans/put/VirtualWANCreate + - name: /VirtualHubs/put/VirtualHubPut + - name: /NetworkVirtualAppliances/put/Create NetworkVirtualAppliance + comment: "The resource type could not be found in the namespace 'Microsoft.Network' for api version '2020-04-01'" + - name: /NetworkVirtualAppliances/get/Get NetworkVirtualAppliance + - name: /NetworkVirtualAppliances/get/List all Network Virtual Appliance for a given resource group + - name: /NetworkVirtualAppliances/get/List all Network Virtual Appliances for a given subscription + - name: /NetworkVirtualAppliances/patch/Update NetworkVirtualAppliance + - name: /NetworkVirtualAppliances/delete/Delete NetworkVirtualAppliance + - split: securitypartnerproviders + - name: /SecurityPartnerProviders/put/Create Security Partner Provider + - name: /SecurityPartnerProviders/get/Get Security Partner Provider + - name: /SecurityPartnerProviders/get/List all Security Partner Providers for a given resource group + - name: /SecurityPartnerProviders/get/List all Security Partner Providers for a given subscription + - name: /SecurityPartnerProviders/patch/Update Security Partner Provider Tags + - name: /SecurityPartnerProviders/delete/Delete Security Partner Provider + - split: applicationsecuritygroups + - name: /ApplicationSecurityGroups/put/Create application security group + - name: /ApplicationSecurityGroups/get/Get application security group + - name: /ApplicationSecurityGroups/get/List load balancers in resource group + - name: /ApplicationSecurityGroups/get/List all application security groups + - name: /ApplicationSecurityGroups/patch/Update application security group tags + - name: /ApplicationSecurityGroups/delete/Delete application security group + - split: webapplicationfirewallpolicies + - name: /WebApplicationFirewallPolicies/put/Creates or updates a WAF policy within a resource group + - name: /WebApplicationFirewallPolicies/get/Gets a WAF policy within a resource group + - name: /WebApplicationFirewallPolicies/get/Lists all WAF policies in a resource group + - name: /WebApplicationFirewallPolicies/get/Lists all WAF policies in a subscription + - name: /WebApplicationFirewallPolicies/delete/Deletes a WAF policy within a resource group + - split: vpnconnections + - name: /VpnConnections/put/VpnConnectionPut + - name: /VpnConnections/get/VpnConnectionGet + - name: /VpnConnections/get/VpnConnectionList + - name: /VpnConnections/delete/VpnConnectionDelete + - split: loadbalancerbackendaddresspools + - name: /VirtualNetworks/put/Create virtual network + - name: /Subnets/put/Create subnet + - name: /PublicIPAddresses/put/Create public IP address defaults + - name: /LoadBalancers/put/Create load balancer with Frontend IP in Zone 1 + - name: /LoadBalancerBackendAddressPools/put/Update load balancer backend pool with backend addresses containing virtual network and IP address defined in network interfaces. + - name: /LoadBalancerBackendAddressPools/put/Update load balancer backend pool with backend addresses containing virtual network and IP address. + - name: /LoadBalancerBackendAddressPools/get/LoadBalancerBackendAddressPoolGet + - name: /LoadBalancerBackendAddressPools/get/LoadBalancer with BackendAddressPool with BackendAddresses + - name: /LoadBalancerBackendAddressPools/get/Load balancer with BackendAddressPool containing BackendAddresses + - name: /LoadBalancerBackendAddressPools/get/LoadBalancerBackendAddressPoolList + - name: /LoadBalancerBackendAddressPools/delete/BackendAddressPoolDelete + - split: expressroutecircuitpeerings + - name: /ExpressRouteCircuits/put/Create ExpressRouteCircuit + - name: /ExpressRouteCircuitPeerings/put/Create ExpressRouteCircuit Peerings + - name: /ExpressRouteCircuitPeerings/get/Get ExpressRouteCircuit Peering + - name: /ExpressRouteCircuitPeerings/get/List ExpressRouteCircuit Peerings + - name: /ExpressRouteCircuitPeerings/delete/Delete ExpressRouteCircuit Peerings + - split: virtualrouterpeerings + - name: /VirtualRouterPeerings/put/Create Virtual Router Peering + - name: /VirtualRouterPeerings/get/Get Virtual Router Peering + - name: /VirtualRouterPeerings/get/List all Virtual Router Peerings for a given Virtual Router + - name: /VirtualRouterPeerings/delete/Delete VirtualRouterPeering + - split: connectionmonitors + - name: /ConnectionMonitors/put/Create connection monitor V2 + - name: /ConnectionMonitors/put/Create connection monitor V1 + - name: /ConnectionMonitors/get/Get connection monitor + - name: /ConnectionMonitors/get/List connection monitors + - name: /ConnectionMonitors/post/Start connection monitor + - name: /ConnectionMonitors/post/Query connection monitor + - name: /ConnectionMonitors/post/Stop connection monitor + - name: /ConnectionMonitors/patch/Update connection monitor tags + - name: /ConnectionMonitors/delete/Delete connection monitor + - split: packetcaptures + - name: /PacketCaptures/put/Create packet capture + - name: /PacketCaptures/get/Get packet capture + - name: /PacketCaptures/get/List packet captures + - name: /PacketCaptures/post/Query packet capture status + - name: /PacketCaptures/post/Stop packet capture + - name: /PacketCaptures/delete/Delete packet capture + - split: flowlogs + - name: /NetworkSecurityGroups/put/Create network security group + - name: /FlowLogs/put/Create or update flow log + - name: /FlowLogs/get/Get flow log + - name: /FlowLogs/get/List connection monitors + - name: /FlowLogs/delete/Delete flow log + - split: hubroutetables + - name: /HubRouteTables/put/RouteTablePut + - name: /HubRouteTables/get/RouteTableGet + - name: /HubRouteTables/get/RouteTableList + - name: /HubRouteTables/delete/RouteTableDelete + - split: expressroutecircuitauthorizations + - name: /ExpressRouteCircuits/put/Create ExpressRouteCircuit + - name: /ExpressRouteCircuitAuthorizations/put/Create ExpressRouteCircuit Authorization + - name: /ExpressRouteCircuitAuthorizations/get/Get ExpressRouteCircuit Authorization + - name: /ExpressRouteCircuitAuthorizations/get/List ExpressRouteCircuit Authorization + - name: /ExpressRouteCircuitAuthorizations/delete/Delete ExpressRouteCircuit Authorization + - split: expressroutecrossconnectionpeerings + - name: /ExpressRouteCrossConnectionPeerings/put/ExpressRouteCrossConnectionBgpPeeringCreate + - name: /ExpressRouteCrossConnectionPeerings/get/GetExpressRouteCrossConnectionBgpPeering + - name: /ExpressRouteCrossConnectionPeerings/get/ExpressRouteCrossConnectionBgpPeeringList + - name: /ExpressRouteCrossConnectionPeerings/delete/DeleteExpressRouteCrossConnectionBgpPeering + - split: privatednszonegroups + - name: /PrivateDnsZoneGroups/put/Create private dns zone group + - name: /PrivateDnsZoneGroups/get/Get private dns zone group + - name: /PrivateDnsZoneGroups/get/List private endpoints in resource group + - name: /PrivateDnsZoneGroups/delete/Delete private dns zone group + - split: expressrouteconnections + - name: /ExpressRouteCircuits/put/Create ExpressRouteCircuit + - name: /ExpressRouteCircuitPeerings/put/Create ExpressRouteCircuit Peerings + - name: /VirtualWans/put/VirtualWANCreate + - name: /VirtualHubs/put/VirtualHubPut + - name: /ExpressRouteGateways/put/ExpressRouteGatewayCreate + - name: /ExpressRouteConnections/put/ExpressRouteConnectionCreate + - name: /ExpressRouteConnections/get/ExpressRouteConnectionGet + - name: /ExpressRouteConnections/get/ExpressRouteConnectionList + - name: /ExpressRouteConnections/delete/ExpressRouteConnectionDelete + - split: virtualnetworkpeerings + - name: /VirtualNetworkPeerings/put/Create peering + - name: /VirtualNetworkPeerings/get/Get peering + - name: /VirtualNetworkPeerings/get/List peerings + - name: /VirtualNetworkPeerings/delete/Delete peering + - split: expressroutecircuitconnections + - name: /ExpressRouteCircuitConnections/put/ExpressRouteCircuitConnectionCreate + - name: /ExpressRouteCircuitConnections/get/ExpressRouteCircuitConnectionGet + - name: /ExpressRouteCircuitConnections/get/List ExpressRouteCircuit Connection + - name: /ExpressRouteCircuitConnections/delete/Delete ExpressRouteCircuit + + - split: other + - name: /VpnSiteLinkConnections/get/VpnSiteLinkConnectionGet + - name: /DefaultSecurityRules/get/DefaultSecurityRuleGet + - name: /PeerExpressRouteCircuitConnections/get/PeerExpressRouteCircuitConnectionGet + - name: /LoadBalancerFrontendIPConfigurations/get/LoadBalancerFrontendIPConfigurationGet + - name: /ResourceNavigationLinks/get/Get Resource Navigation Links + - name: /ServiceAssociationLinks/get/Get Service Association Links + - name: /NetworkInterfaceIPConfigurations/get/NetworkInterfaceIPConfigurationGet + - name: /LoadBalancerLoadBalancingRules/get/LoadBalancerLoadBalancingRuleGet + - name: /VpnLinkConnections/get/VpnSiteLinkConnectionList + - name: /HubVirtualNetworkConnections/get/HubVirtualNetworkConnectionGet + - name: /PeerExpressRouteCircuitConnections/get/List Peer ExpressRouteCircuit Connection + - name: /LoadBalancerOutboundRules/get/LoadBalancerOutboundRuleGet + - name: /DefaultSecurityRules/get/DefaultSecurityRuleList + - name: /ExpressRouteLinks/get/ExpressRouteLinkGet + - name: /VpnSiteLinks/get/VpnSiteGet + - name: /LoadBalancerFrontendIPConfigurations/get/LoadBalancerFrontendIPConfigurationList + - name: /HubVirtualNetworkConnections/get/HubVirtualNetworkConnectionList + - name: /NetworkInterfaceIPConfigurations/get/NetworkInterfaceIPConfigurationList + - name: /LoadBalancerProbes/get/LoadBalancerProbeGet + - name: /AvailablePrivateEndpointTypes/get/Get available PrivateEndpoint types in the resource group + - name: //get/supportedSecurityProviders + - name: /NetworkInterfaceLoadBalancers/get/NetworkInterfaceLoadBalancerList + - name: /LoadBalancerLoadBalancingRules/get/LoadBalancerLoadBalancingRuleList + - name: /LoadBalancerNetworkInterfaces/get/LoadBalancerNetworkInterfaceListVmss + - name: /LoadBalancerNetworkInterfaces/get/LoadBalancerNetworkInterfaceListSimple + - name: /AvailableServiceAliases/get/Get available service aliases in the resource group + - name: /ExpressRouteLinks/get/ExpressRouteLinkGet + - name: /LoadBalancerOutboundRules/get/LoadBalancerOutboundRuleList + - name: /AvailableResourceGroupDelegations/get/Get available delegations in the resource group + - name: /LoadBalancerProbes/get/LoadBalancerProbeList + - name: /VpnSiteLinks/get/VpnSiteLinkListByVpnSite + - name: /AvailableEndpointServices/get/EndpointServicesList + - name: /AvailablePrivateEndpointTypes/get/Get available PrivateEndpoint types + - name: //get/Check Dns Name Availability + - name: /AvailableServiceAliases/get/Get available service aliases + - name: /AvailableDelegations/get/Get available delegations + - name: /ExpressRoutePortsLocations/get/ExpressRoutePortsLocationGet + - name: /ServiceTags/get/Get list of service tags + - name: /Usages/get/List usages + - name: /Usages/get/List usages spaced location + - name: /ExpressRouteServiceProviders/get/List ExpressRoute providers + - name: /ExpressRoutePortsLocations/get/ExpressRoutePortsLocationList + - name: /AzureFirewallFqdnTags/get/List all Azure Firewall FQDN Tags for a given subscription + - name: /BgpServiceCommunities/get/ServiceCommunityList + - name: /Operations/get/Get a list of operations for a resource provider + - name: //post/Deletes the specified active session + - name: //post/Create Bastion Shareable Links for the request VMs + - name: //post/Delete Bastion Shareable Links for the request VMs + - name: /VpnServerConfigurationsAssociatedWithVirtualWan/post/GetVirtualWanVpnServerConfigurations + - name: //post/Returns the Bastion Shareable Links for the request VMs + - name: //post/Returns a list of currently active sessions on the Bastion + - name: //post/GenerateVirtualWanVpnServerConfigurationVpnProfile + - name: /VpnSitesConfiguration/post/VpnSitesConfigurationDownload +``` From 4f5762bcf9c0ba570d0d99f3cd461b02a037f10c Mon Sep 17 00:00:00 2001 From: MyronFanQiu <49134743+MyronFanQiu@users.noreply.github.com> Date: Tue, 16 Jun 2020 12:26:49 +0800 Subject: [PATCH 157/318] Update readme.md for ruby (#9846) * Update readme.md * Update readme.md * Update readme.ruby.md --- .../security/resource-manager/readme.md | 53 ++++++++-- .../security/resource-manager/readme.ruby.md | 99 ++++++++++++++++--- 2 files changed, 132 insertions(+), 20 deletions(-) diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 982c3d005409..ea3392274978 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -175,7 +175,7 @@ override-info: ### Tag: package-2015-06-preview-only -These settings apply only when `--tag=package-2015-06-preview-only` is specified on the command line. +These settings apply only when `--tag=package-2015-06-preview-only` is specified on the command line. This tag is used for Ruby SDK. ``` yaml $(tag) == 'package-2015-06-preview-only' input-file: @@ -198,7 +198,7 @@ override-info: ### Tag: package-2017-08-preview-only -These settings apply only when `--tag=package-2017-08-preview-only` is specified on the command line. +These settings apply only when `--tag=package-2017-08-preview-only` is specified on the command line. This tag is used for Ruby SDK. ``` yaml $(tag) == 'package-2017-08-preview-only' input-file: @@ -221,7 +221,7 @@ override-info: ### Tag: package-2019-01-preview-only -These settings apply only when `--tag=package-2019-01-preview-only` is specified on the command line. +These settings apply only when `--tag=package-2019-01-preview-only` is specified on the command line. This tag is used for Ruby SDK. ``` yaml $(tag) == 'package-2019-01-preview-only' input-file: @@ -237,7 +237,7 @@ override-info: ### Tag: package-2020-01-preview-only -These settings apply only when `--tag=package-2020-01-preview-only` is specified on the command line. +These settings apply only when `--tag=package-2020-01-preview-only` is specified on the command line. This tag is used for Ruby SDK. ``` yaml $(tag) == 'package-2020-01-preview-only' input-file: @@ -250,7 +250,7 @@ override-info: ### Tag: package-2017-08-only -These settings apply only when `--tag=package-2017-08-only` is specified on the command line. +These settings apply only when `--tag=package-2017-08-only` is specified on the command line. This tag is used for Ruby SDK. ``` yaml $(tag) == 'package-2017-08-only' input-file: @@ -263,7 +263,7 @@ override-info: ### Tag: package-2018-06-only -These settings apply only when `--tag=package-2018-06-only` is specified on the command line. +These settings apply only when `--tag=package-2018-06-only` is specified on the command line. This tag is used for Ruby SDK. ``` yaml $(tag) == 'package-2018-06-only' input-file: @@ -276,7 +276,7 @@ override-info: ### Tag: package-2019-01-only -These settings apply only when `--tag=package-2019-01-only` is specified on the command line. +These settings apply only when `--tag=package-2019-01-only` is specified on the command line. This tag is used for Ruby SDK. ``` yaml $(tag) == 'package-2019-01-only' input-file: @@ -290,7 +290,7 @@ override-info: ### Tag: package-2019-08-only -These settings apply only when `--tag=package-2019-08-only` is specified on the command line. +These settings apply only when `--tag=package-2019-08-only` is specified on the command line. This tag is used for Ruby SDK. ``` yaml $(tag) == 'package-2019-08-only' input-file: @@ -302,6 +302,41 @@ override-info: title: SecurityCenter ``` +### Tag: package-2020-01-preview-only + +These settings apply only when `--tag=package-2020-01-preview-only` is specified on the command line. This tag is used for Ruby SDK. + +``` yaml $(tag) == 'package-package-2020-01-preview-only' +input-file: +- Microsoft.Security/preview/2020-01-01-preview/secureScore.json + +# Needed when there is more than one input file +override-info: + title: SecurityCenter +``` + +### Tag: package-2020-01-only + +These settings apply only when `--tag=package-2020-01-only` is specified on the command line. This tag is used for Ruby SDK. + +``` yaml $(tag) == 'package-2020-01-only' +input-file: +- Microsoft.Security/stable/2020-01-01/adaptiveNetworkHardenings.json +- Microsoft.Security/stable/2020-01-01/allowedConnections.json +- Microsoft.Security/stable/2020-01-01/applicationWhitelistings.json +- Microsoft.Security/stable/2020-01-01/assessmentMetadata.json +- Microsoft.Security/stable/2020-01-01/assessments.json +- Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json +- Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json +- Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json +- Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json +- Microsoft.Security/stable/2020-01-01/topologies.json + +# Needed when there is more than one input file +override-info: + title: SecurityCenter +``` + --- # Code Generation @@ -412,4 +447,4 @@ uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` \ No newline at end of file +``` diff --git a/specification/security/resource-manager/readme.ruby.md b/specification/security/resource-manager/readme.ruby.md index 475b93b981df..0adaee281057 100644 --- a/specification/security/resource-manager/readme.ruby.md +++ b/specification/security/resource-manager/readme.ruby.md @@ -5,7 +5,7 @@ Please also specify `--node-sdks-folder=`. -``` yaml $(tag) == 'package-composite-v1' && $(ruby) - namespace: "Azure::Security::Mgmt::package_composite_v1" +``` yaml $(tag) == 'package-2020-01-preview-only' && $(ruby) + namespace: "Azure::Security::Mgmt::V2020_01_01_preview" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_security/lib ``` -### Tag: package-composite-v2 and ruby +### Tag: package-2020-01-only and ruby -These settings apply only when `--tag=package-composite-v2 --ruby` is specified on the command line. +These settings apply only when `--tag=package-2020-01-only --ruby` is specified on the command line. Please also specify `--ruby-sdks-folder=`. -``` yaml $(tag) == 'package-composite-v2' && $(ruby) - namespace: "Azure::Security::Mgmt::package_composite_v2" +``` yaml $(tag) == 'package-2020-01-only' && $(ruby) + namespace: "Azure::Security::Mgmt::V2020_01_01" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_security/lib ``` + +### Tag: package-2019-08-only and ruby + +These settings apply only when `--tag=package-2019-08-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-08-only' && $(ruby) + namespace: "Azure::Security::Mgmt::V2019_08_01" + output-folder: $(ruby-sdks-folder)/management/azure_mgmt_security/lib +``` + +### Tag: package-2019-01-only and ruby + +These settings apply only when `--tag=package-2019-01-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-01-only' && $(ruby) + namespace: "Azure::Security::Mgmt::V2019_01_01" + output-folder: $(ruby-sdks-folder)/management/azure_mgmt_security/lib +``` + +### Tag: package-2018-06-only and ruby + +These settings apply only when `--tag=package-2018-06-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2018-03-only' && $(ruby) + namespace: "Azure::Security::Mgmt::V2018_06_01" + output-folder: $(ruby-sdks-folder)/management/azure_mgmt_security/lib +``` + +### Tag: package-2017-08-only and ruby + +These settings apply only when `--tag=package-2017-08-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-08-only' && $(ruby) + namespace: "Azure::Security::Mgmt::V2017_08_01" + output-folder: $(ruby-sdks-folder)/management/azure_mgmt_security/lib +``` +### Tag: package-2019-01-preview-only and ruby + +These settings apply only when `--tag=package-2019-01-preview-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-01-preview-only' && $(ruby) + namespace: "Azure::Security::Mgmt::V2019_01_01_preview" + output-folder: $(ruby-sdks-folder)/management/azure_mgmt_security/lib +``` + +### Tag: package-2017-08-preview-only and ruby + +These settings apply only when `--tag=package-2017-08-preview-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2017-08-preview-only' && $(ruby) + namespace: "Azure::Security::Mgmt::V2017_08_01_preview" + output-folder: $(ruby-sdks-folder)/management/azure_mgmt_security/lib +``` + +### Tag: package-2015-06-preview-only and ruby + +These settings apply only when `--tag=package-2015-06-preview-only --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2015-06-preview-only' && $(ruby) + namespace: "Azure::Security::Mgmt::V2015_06_01_preview" + output-folder: $(ruby-sdks-folder)/management/azure_mgmt_security/lib +``` + From 402ad4a20a97eefb52d35c6bb61022d2ae29206e Mon Sep 17 00:00:00 2001 From: Ritvika Reddy Nagula Date: Tue, 16 Jun 2020 00:23:45 -0700 Subject: [PATCH 158/318] [VirtualWan] Fix bug where list items where marked as subResources (#9839) * Fix bug where list items where marked as subResources * one more typo * fix 04 also --- .../Microsoft.Network/stable/2020-04-01/virtualWan.json | 4 ++-- .../Microsoft.Network/stable/2020-05-01/virtualWan.json | 6 +++--- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/virtualWan.json index 3062c1da736d..2d59aedac7af 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/virtualWan.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/virtualWan.json @@ -4682,7 +4682,7 @@ "description": "List of all connections associated with this route table.", "readOnly": true, "items": { - "$ref": "./network.json#/definitions/SubResource" + "type": "string" } }, "propagatingConnections": { @@ -4690,7 +4690,7 @@ "description": "List of all connections that advertise to this route table.", "readOnly": true, "items": { - "$ref": "./network.json#/definitions/SubResource" + "type": "string" } }, "provisioningState": { diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualWan.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualWan.json index 59268c93c1b1..6b4190ba2e50 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualWan.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/virtualWan.json @@ -5512,7 +5512,7 @@ "description": "List of all connections associated with this route table.", "readOnly": true, "items": { - "$ref": "./network.json#/definitions/SubResource" + "type": "string" } }, "propagatingConnections": { @@ -5520,7 +5520,7 @@ "description": "List of all connections that advertise to this route table.", "readOnly": true, "items": { - "$ref": "./network.json#/definitions/SubResource" + "type": "string" } }, "provisioningState": { @@ -6587,7 +6587,7 @@ } } }, - "VirtualHubEffectiveRouteEffectiveRouteList": { + "VirtualHubEffectiveRouteList": { "description": "EffectiveRoutes List.", "properties": { "value": { From 97b321440a42f889efee28f01b79f9d4fb09a7a6 Mon Sep 17 00:00:00 2001 From: Cameron Taggart Date: Tue, 16 Jun 2020 01:46:05 -0600 Subject: [PATCH 159/318] remove VMwareVirtustream (#9700) --- .../examples/CheckQuotaAvailability.json | 18 - .../examples/Clusters_CreateOrUpdate.json | 48 - .../examples/Clusters_Delete.json | 14 - .../examples/Clusters_Get.json | 28 - .../examples/Clusters_List.json | 28 - .../examples/Clusters_Update.json | 50 - .../examples/Operations_List.json | 22 - .../PrivateClouds_CreateOrUpdate.json | 112 -- .../examples/PrivateClouds_Delete.json | 13 - .../examples/PrivateClouds_Get.json | 57 - .../examples/PrivateClouds_List.json | 58 - .../PrivateClouds_ListAdminCredentials.json | 18 - .../PrivateClouds_ListInSubscription.json | 57 - .../examples/PrivateClouds_Update.json | 113 -- .../2019-08-09-preview/vmwarevirtustream.json | 1251 ----------------- .../resource-manager/readme.csharp.md | 15 - .../resource-manager/readme.md | 85 -- .../resource-manager/readme.python.md | 27 - .../resource-manager/readme.typescript.md | 14 - 19 files changed, 2028 deletions(-) delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/CheckQuotaAvailability.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_CreateOrUpdate.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Delete.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Get.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_List.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Update.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Operations_List.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_CreateOrUpdate.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Delete.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Get.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_List.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_ListAdminCredentials.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_ListInSubscription.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Update.json delete mode 100644 specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/vmwarevirtustream.json delete mode 100644 specification/vmwarevirtustream/resource-manager/readme.csharp.md delete mode 100644 specification/vmwarevirtustream/resource-manager/readme.md delete mode 100644 specification/vmwarevirtustream/resource-manager/readme.python.md delete mode 100644 specification/vmwarevirtustream/resource-manager/readme.typescript.md diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/CheckQuotaAvailability.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/CheckQuotaAvailability.json deleted file mode 100644 index 98a126c10073..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/CheckQuotaAvailability.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "subscriptionId": "{subscription-id}", - "api-version": "2019-08-09-preview", - "location": "eastus" - }, - "responses": { - "200": { - "body": { - "hostsRemaining": { - "gp": 0, - "he": 999 - }, - "quotaEnabled": "Enabled" - } - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_CreateOrUpdate.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_CreateOrUpdate.json deleted file mode 100644 index 516f612bdec1..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_CreateOrUpdate.json +++ /dev/null @@ -1,48 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1", - "privateCloudName": "cloud1", - "clusterName": "cluster1", - "cluster": { - "properties": { - "clusterSize": 3 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1/clusters/cluster1", - "name": "cluster1", - "properties": { - "clusterSize": 3, - "hosts": [ - "fakehost22.nyc1.kubernetes.center", - "fakehost23.nyc1.kubernetes.center", - "fakehost24.nyc1.kubernetes.center" - ], - "provisioningState": "Updating" - }, - "type": "Microsoft.VMwareVirtustream/privateClouds/clusters" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1/clusters/cluster1", - "name": "cluster1", - "properties": { - "clusterSize": 3, - "hosts": [ - "fakehost22.nyc1.kubernetes.center", - "fakehost23.nyc1.kubernetes.center", - "fakehost24.nyc1.kubernetes.center" - ], - "provisioningState": "Updating" - }, - "type": "Microsoft.VMwareVirtustream/privateClouds/clusters" - } - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Delete.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Delete.json deleted file mode 100644 index 7f0b6d61ed68..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Delete.json +++ /dev/null @@ -1,14 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1", - "privateCloudName": "cloud1", - "clusterName": "cluster1" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Get.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Get.json deleted file mode 100644 index 7439e9b3fdd7..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Get.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1", - "privateCloudName": "cloud1", - "clusterName": "cluster1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1/clusters/cluster1", - "name": "cluster1", - "properties": { - "clusterSize": 4, - "hosts": [ - "fakehost22.nyc1.kubernetes.center", - "fakehost23.nyc1.kubernetes.center", - "fakehost24.nyc1.kubernetes.center", - "fakehost25.nyc1.kubernetes.center" - ], - "provisioningState": "Updating" - }, - "type": "Microsoft.VMwareVirtustream/privateClouds/clusters" - } - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_List.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_List.json deleted file mode 100644 index b57cbdea4110..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_List.json +++ /dev/null @@ -1,28 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1", - "privateCloudName": "cloud1" - }, - "responses": { - "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1/clusters/cluster1", - "name": "cluster1", - "properties": { - "clusterSize": 3, - "hosts": [ - "fakehost22.nyc1.kubernetes.center", - "fakehost23.nyc1.kubernetes.center", - "fakehost24.nyc1.kubernetes.center" - ], - "provisioningState": "Succeeded" - }, - "type": "Microsoft.VMwareVirtustream/privateClouds/clusters" - } - ] - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Update.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Update.json deleted file mode 100644 index c8ae471a28b1..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Clusters_Update.json +++ /dev/null @@ -1,50 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1", - "privateCloudName": "cloud1", - "clusterName": "cluster1", - "cluster": { - "properties": { - "clusterSize": 4 - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1/clusters/cluster1", - "name": "cluster1", - "properties": { - "clusterSize": 4, - "hosts": [ - "fakehost22.nyc1.kubernetes.center", - "fakehost23.nyc1.kubernetes.center", - "fakehost24.nyc1.kubernetes.center", - "fakehost25.nyc1.kubernetes.center" - ], - "provisioningState": "Updating" - }, - "type": "Microsoft.VMwareVirtustream/privateClouds/clusters" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1/clusters/cluster1", - "name": "cluster1", - "properties": { - "clusterSize": 4, - "hosts": [ - "fakehost22.nyc1.kubernetes.center", - "fakehost23.nyc1.kubernetes.center", - "fakehost24.nyc1.kubernetes.center", - "fakehost25.nyc1.kubernetes.center" - ], - "provisioningState": "Updating" - }, - "type": "Microsoft.VMwareVirtustream/privateClouds/clusters" - } - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Operations_List.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Operations_List.json deleted file mode 100644 index a103fc70a7e7..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/Operations_List.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview" - }, - "responses": { - "200": { - "body": [ - { - "display": { - "description": "Creates a private cloud", - "operation": "Create Private Cloud", - "provider": "VMware Solution by Virtustream", - "resource": "Private Cloud" - }, - "name": "Microsoft.VMwareVirtustream/privateClouds/create", - "origin": "user,system" - } - ], - "nextLink": "string" - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_CreateOrUpdate.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_CreateOrUpdate.json deleted file mode 100644 index b66bb8939e90..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_CreateOrUpdate.json +++ /dev/null @@ -1,112 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1", - "privateCloudName": "cloud1", - "privateCloud": { - "location": "eastus2", - "properties": { - "cluster": { - "clusterSize": 4 - } - }, - "tags": {} - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1", - "location": "eastus2", - "name": "cloud1", - "properties": { - "circuit": { - "authorizations": [], - "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", - "primarySubnet": "192.168.53.0/30", - "secondarySubnet": "192.168.53.4/30" - }, - "cluster": { - "clusterId": 1, - "clusterSize": 4, - "hosts": [ - "fakehost18.nyc1.kubernetes.center", - "fakehost19.nyc1.kubernetes.center", - "fakehost20.nyc1.kubernetes.center", - "fakehost21.nyc1.kubernetes.center" - ] - }, - "clusters": [], - "endpoints": { - "nsxtManager": "https://192.168.50.3/", - "vcsa": "https://192.168.50.2/" - }, - "identitySources": [ - { - "alias": "groupAlias", - "baseGroupDN": "ou=baseGroup", - "baseUserDN": "ou=baseUser", - "domain": "domain1", - "name": "group1", - "primaryServer": "ldaps://1.1.1.1:636/", - "secondaryServer": "ldaps://1.1.1.2:636/", - "ssl": "Enabled" - } - ], - "internet": "Disabled", - "provisioningState": "Updating" - }, - "tags": {}, - "type": "Microsoft.VMwareVirtustream/privateClouds" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1", - "location": "eastus2", - "name": "cloud1", - "properties": { - "circuit": { - "authorizations": [], - "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", - "primarySubnet": "192.168.53.0/30", - "secondarySubnet": "192.168.53.4/30", - "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" - }, - "cluster": { - "clusterId": 1, - "clusterSize": 4, - "hosts": [ - "fakehost18.nyc1.kubernetes.center", - "fakehost19.nyc1.kubernetes.center", - "fakehost20.nyc1.kubernetes.center", - "fakehost21.nyc1.kubernetes.center" - ] - }, - "clusters": [], - "endpoints": { - "nsxtManager": "https://192.168.50.3/", - "vcsa": "https://192.168.50.2/" - }, - "identitySources": [ - { - "alias": "groupAlias", - "baseGroupDN": "ou=baseGroup", - "baseUserDN": "ou=baseUser", - "domain": "domain1", - "name": "group1", - "primaryServer": "ldaps://1.1.1.1:636/", - "secondaryServer": "ldaps://1.1.1.2:636/", - "ssl": "Enabled" - } - ], - "internet": "Disabled", - "provisioningState": "Updating" - }, - "tags": {}, - "type": "Microsoft.VMwareVirtustream/privateClouds" - } - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Delete.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Delete.json deleted file mode 100644 index cbadcd2a5823..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Delete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1", - "privateCloudName": "cloud1" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Get.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Get.json deleted file mode 100644 index 0a88f8d07e67..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Get.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1", - "privateCloudName": "cloud1" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1", - "location": "eastus2", - "name": "cloud1", - "properties": { - "circuit": { - "authorizations": [], - "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", - "primarySubnet": "192.168.53.0/30", - "secondarySubnet": "192.168.53.4/30", - "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" - }, - "cluster": { - "clusterId": 1, - "clusterSize": 4, - "hosts": [ - "fakehost18.nyc1.kubernetes.center", - "fakehost19.nyc1.kubernetes.center", - "fakehost20.nyc1.kubernetes.center", - "fakehost21.nyc1.kubernetes.center" - ] - }, - "clusters": [], - "endpoints": { - "nsxtManager": "https://192.168.50.3/", - "vcsa": "https://192.168.50.2/" - }, - "identitySources": [ - { - "alias": "groupAlias", - "baseGroupDN": "ou=baseGroup", - "baseUserDN": "ou=baseUser", - "domain": "domain1", - "name": "group1", - "primaryServer": "ldaps://1.1.1.1:636/", - "secondaryServer": "ldaps://1.1.1.2:636/", - "ssl": "Enabled" - } - ], - "internet": "Disabled", - "provisioningState": "Updating" - }, - "tags": {}, - "type": "Microsoft.VMwareVirtustream/privateClouds" - } - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_List.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_List.json deleted file mode 100644 index 13ffa9fe89e7..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_List.json +++ /dev/null @@ -1,58 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1" - }, - "responses": { - "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1", - "location": "eastus2", - "name": "cloud1", - "properties": { - "circuit": { - "authorizations": [], - "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", - "primarySubnet": "192.168.53.0/30", - "secondarySubnet": "192.168.53.4/30", - "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" - }, - "cluster": { - "clusterId": 1, - "clusterSize": 4, - "hosts": [ - "fakehost18.nyc1.kubernetes.center", - "fakehost19.nyc1.kubernetes.center", - "fakehost20.nyc1.kubernetes.center", - "fakehost21.nyc1.kubernetes.center" - ] - }, - "clusters": [], - "endpoints": { - "nsxtManager": "https://192.168.50.3/", - "vcsa": "https://192.168.50.2/" - }, - "identitySources": [ - { - "alias": "groupAlias", - "baseGroupDN": "ou=baseGroup", - "baseUserDN": "ou=baseUser", - "domain": "domain1", - "name": "group1", - "primaryServer": "ldaps://1.1.1.1:636/", - "secondaryServer": "ldaps://1.1.1.2:636/", - "ssl": "Enabled" - } - ], - "internet": "Disabled", - "provisioningState": "Updating" - }, - "tags": {}, - "type": "Microsoft.VMwareVirtustream/privateClouds" - } - ] - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_ListAdminCredentials.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_ListAdminCredentials.json deleted file mode 100644 index 7284be8ebf79..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_ListAdminCredentials.json +++ /dev/null @@ -1,18 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1", - "privateCloudName": "cloud1" - }, - "responses": { - "200": { - "body": { - "nsxtPassword": "$(1X4Dkk", - "nsxtUsername": "admin", - "vcenterPassword": "iG17wC^-", - "vcenterUsername": "cloudadmin@vmcp.local" - } - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_ListInSubscription.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_ListInSubscription.json deleted file mode 100644 index e1cfd76318dd..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_ListInSubscription.json +++ /dev/null @@ -1,57 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}" - }, - "responses": { - "200": { - "body": [ - { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1", - "location": "eastus2", - "name": "cloud1", - "properties": { - "circuit": { - "authorizations": [], - "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", - "primarySubnet": "192.168.53.0/30", - "secondarySubnet": "192.168.53.4/30", - "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" - }, - "cluster": { - "clusterId": 1, - "clusterSize": 4, - "hosts": [ - "fakehost18.nyc1.kubernetes.center", - "fakehost19.nyc1.kubernetes.center", - "fakehost20.nyc1.kubernetes.center", - "fakehost21.nyc1.kubernetes.center" - ] - }, - "clusters": [], - "endpoints": { - "nsxtManager": "https://192.168.50.3/", - "vcsa": "https://192.168.50.2/" - }, - "identitySources": [ - { - "alias": "groupAlias", - "baseGroupDN": "ou=baseGroup", - "baseUserDN": "ou=baseUser", - "domain": "domain1", - "name": "group1", - "primaryServer": "ldaps://1.1.1.1:636/", - "secondaryServer": "ldaps://1.1.1.2:636/", - "ssl": "Enabled" - } - ], - "internet": "Disabled", - "provisioningState": "Updating" - }, - "tags": {}, - "type": "Microsoft.VMwareVirtustream/privateClouds" - } - ] - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Update.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Update.json deleted file mode 100644 index 8e429efbe6aa..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/examples/PrivateClouds_Update.json +++ /dev/null @@ -1,113 +0,0 @@ -{ - "parameters": { - "api-version": "2019-08-09-preview", - "subscriptionId": "{subscription-id}", - "resourceGroupName": "group1", - "privateCloudName": "cloud1", - "privateCloud": { - "location": "eastus2", - "properties": { - "cluster": { - "clusterSize": 4 - } - }, - "tags": {} - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1", - "location": "eastus2", - "name": "cloud1", - "properties": { - "circuit": { - "authorizations": [], - "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", - "primarySubnet": "192.168.53.0/30", - "secondarySubnet": "192.168.53.4/30", - "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" - }, - "cluster": { - "clusterId": 1, - "clusterSize": 4, - "hosts": [ - "fakehost18.nyc1.kubernetes.center", - "fakehost19.nyc1.kubernetes.center", - "fakehost20.nyc1.kubernetes.center", - "fakehost21.nyc1.kubernetes.center" - ] - }, - "clusters": [], - "endpoints": { - "nsxtManager": "https://192.168.50.3/", - "vcsa": "https://192.168.50.2/" - }, - "identitySources": [ - { - "alias": "groupAlias", - "baseGroupDN": "ou=baseGroup", - "baseUserDN": "ou=baseUser", - "domain": "domain1", - "name": "group1", - "primaryServer": "ldaps://1.1.1.1:636/", - "secondaryServer": "ldaps://1.1.1.2:636/", - "ssl": "Enabled" - } - ], - "internet": "Disabled", - "provisioningState": "Updating" - }, - "tags": {}, - "type": "Microsoft.VMwareVirtustream/privateClouds" - } - }, - "201": { - "body": { - "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.VMwareVirtustream/privateClouds/cloud1", - "location": "eastus2", - "name": "cloud1", - "properties": { - "circuit": { - "authorizations": [], - "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", - "primarySubnet": "192.168.53.0/30", - "secondarySubnet": "192.168.53.4/30", - "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" - }, - "cluster": { - "clusterId": 1, - "clusterSize": 4, - "hosts": [ - "fakehost18.nyc1.kubernetes.center", - "fakehost19.nyc1.kubernetes.center", - "fakehost20.nyc1.kubernetes.center", - "fakehost21.nyc1.kubernetes.center" - ] - }, - "clusters": [], - "endpoints": { - "nsxtManager": "https://192.168.50.3/", - "vcsa": "https://192.168.50.2/" - }, - "identitySources": [ - { - "alias": "groupAlias", - "baseGroupDN": "ou=baseGroup", - "baseUserDN": "ou=baseUser", - "domain": "domain1", - "name": "group1", - "primaryServer": "ldaps://1.1.1.1:636/", - "secondaryServer": "ldaps://1.1.1.2:636/", - "ssl": "Enabled" - } - ], - "internet": "Disabled", - "provisioningState": "Updating" - }, - "tags": {}, - "type": "Microsoft.VMwareVirtustream/privateClouds" - } - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/vmwarevirtustream.json b/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/vmwarevirtustream.json deleted file mode 100644 index 3d7ca4fd555f..000000000000 --- a/specification/vmwarevirtustream/resource-manager/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/vmwarevirtustream.json +++ /dev/null @@ -1,1251 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Azure VMware Solution by Virtustream API", - "description": "Azure VMware Solution by Virtustream API", - "version": "2019-08-09-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "tags": [ - { - "name": "PrivateClouds", - "description": "" - }, - { - "name": "Clusters", - "description": "" - }, - { - "name": "Operations", - "description": "" - }, - { - "name": "Quotas", - "description": "" - } - ], - "parameters": { - "subscriptionId": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "Unique identifier for the Azure subscription" - }, - "resourceGroupName": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the resource group within the Azure subscription", - "x-ms-parameter-location": "method" - }, - "apiVersion": { - "name": "api-version", - "in": "query", - "required": true, - "type": "string", - "description": "Version of Azure VMware Solution by Virtustream API to be used with the client request" - }, - "privateCloudName": { - "name": "privateCloudName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the private cloud", - "x-ms-parameter-location": "method" - }, - "clusterName": { - "name": "clusterName", - "in": "path", - "required": true, - "type": "string", - "description": "Name of the cluster in the private cloud", - "x-ms-parameter-location": "method" - } - }, - "paths": { - "/providers/Microsoft.VMwareVirtustream/operations": { - "get": { - "tags": [ - "Operations" - ], - "description": "Lists all of the available operations", - "operationId": "Operations_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "parameters": [ - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Request has succeeded", - "schema": { - "$ref": "#/definitions/OperationList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "Operations_List": { - "$ref": "./examples/Operations_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.VMwareVirtustream/locations/{location}/checkQuotaAvailability": { - "post": { - "tags": [ - "Quotas" - ], - "description": "Return quota for subscription by region", - "operationId": "CheckQuotaAvailability", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "name": "location", - "in": "path", - "required": true, - "type": "string", - "description": "Azure region" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Request has succeeded", - "schema": { - "$ref": "#/definitions/Quota" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "CheckQuotaAvailability": { - "$ref": "./examples/CheckQuotaAvailability.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareVirtustream/privateClouds": { - "get": { - "operationId": "PrivateClouds_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "PrivateClouds" - ], - "summary": "List private clouds in a resource group", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PrivateCloudList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "PrivateClouds_List": { - "$ref": "./examples/PrivateClouds_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.VMwareVirtustream/privateClouds": { - "get": { - "operationId": "PrivateClouds_ListInSubscription", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "PrivateClouds" - ], - "summary": "List private clouds in a subscription", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PrivateCloudList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "PrivateClouds_List": { - "$ref": "./examples/PrivateClouds_ListInSubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareVirtustream/privateClouds/{privateCloudName}": { - "get": { - "operationId": "PrivateClouds_Get", - "tags": [ - "PrivateClouds" - ], - "summary": "Get a private cloud", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "PrivateClouds_Get": { - "$ref": "./examples/PrivateClouds_Get.json" - } - } - }, - "put": { - "operationId": "PrivateClouds_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "PrivateClouds" - ], - "summary": "Create or update a private cloud", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "name": "privateCloud", - "description": "The private cloud", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "PrivateClouds_CreateOrUpdate": { - "$ref": "./examples/PrivateClouds_CreateOrUpdate.json" - } - } - }, - "patch": { - "operationId": "PrivateClouds_Update", - "x-ms-long-running-operation": true, - "tags": [ - "PrivateClouds" - ], - "summary": "Update a private cloud", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "name": "privateCloud", - "description": "The private cloud", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "PrivateClouds_Update": { - "$ref": "./examples/PrivateClouds_Update.json" - } - } - }, - "delete": { - "operationId": "PrivateClouds_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "PrivateClouds" - ], - "summary": "Delete a private cloud", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No private cloud to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "PrivateClouds_Delete": { - "$ref": "./examples/PrivateClouds_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareVirtustream/privateClouds/{privateCloudName}/clusters": { - "get": { - "operationId": "Clusters_List", - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "tags": [ - "Clusters" - ], - "summary": "List clusters in a private cloud", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/ClusterList" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "Clusters_List": { - "$ref": "./examples/Clusters_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareVirtustream/privateClouds/{privateCloudName}/clusters/{clusterName}": { - "get": { - "operationId": "Clusters_Get", - "tags": [ - "Clusters" - ], - "summary": "Get a cluster by name in a private cloud", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "Clusters_Get": { - "$ref": "./examples/Clusters_Get.json" - } - } - }, - "put": { - "operationId": "Clusters_CreateOrUpdate", - "x-ms-long-running-operation": true, - "tags": [ - "Clusters" - ], - "summary": "Create or update a cluster in a private cloud", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "privateCloudName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the private cloud." - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "name": "cluster", - "description": "A cluster in the private cloud", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "Clusters_CreateOrUpdate": { - "$ref": "./examples/Clusters_CreateOrUpdate.json" - } - } - }, - "patch": { - "operationId": "Clusters_Update", - "x-ms-long-running-operation": true, - "tags": [ - "Clusters" - ], - "summary": "Update a cluster in a private cloud", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "name": "cluster", - "description": "A cluster in a private cloud", - "in": "body", - "required": true, - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "201": { - "description": "accepted operation", - "schema": { - "$ref": "#/definitions/Cluster" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "Clusters_Update": { - "$ref": "./examples/Clusters_Update.json" - } - } - }, - "delete": { - "operationId": "Clusters_Delete", - "x-ms-long-running-operation": true, - "tags": [ - "Clusters" - ], - "summary": "Delete a cluster in a private cloud", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/clusterName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK. The delete has succeeded" - }, - "202": { - "description": "Accepted. The delete will complete asynchronously" - }, - "204": { - "description": "No Content. No cluster to delete" - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "Clusters_Delete": { - "$ref": "./examples/Clusters_Delete.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.VMwareVirtustream/privateClouds/{privateCloudName}/listAdminCredentials": { - "post": { - "operationId": "PrivateClouds_ListAdminCredentials", - "tags": [ - "PrivateClouds" - ], - "summary": "List the admin credentials for the private cloud", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/privateCloudName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "successful operation", - "schema": { - "$ref": "#/definitions/AdminCredentials" - } - }, - "default": { - "description": "Error response describing why the operation failed", - "schema": { - "$ref": "#/definitions/ApiError" - } - } - }, - "x-ms-examples": { - "PrivateClouds_ListAdminCredentials": { - "$ref": "./examples/PrivateClouds_ListAdminCredentials.json" - } - } - } - } - }, - "definitions": { - "Quota": { - "description": "Subscription quotas", - "properties": { - "hostsRemaining": { - "description": "Remaining hosts quota by sku type", - "type": "object", - "readOnly": true, - "additionalProperties": { - "type": "integer", - "readOnly": true - } - }, - "quotaEnabled": { - "description": "Host quota is active for current subscription", - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "QuotaEnabled", - "modelAsString": true - } - } - } - }, - "Resource": { - "description": "The core properties of ARM resources", - "properties": { - "id": { - "description": "Resource ID.", - "readOnly": true, - "type": "string" - }, - "name": { - "description": "Resource name.", - "readOnly": true, - "type": "string" - }, - "type": { - "description": "Resource type.", - "readOnly": true, - "type": "string" - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "location": { - "type": "string", - "description": "Resource location" - }, - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags" - } - } - }, - "ApiError": { - "properties": { - "error": { - "description": "An error returned by the API", - "$ref": "#/definitions/ApiErrorBase" - } - }, - "description": "API error response" - }, - "ApiErrorBase": { - "properties": { - "code": { - "type": "string", - "description": "Error code" - }, - "message": { - "type": "string", - "description": "Error message" - } - }, - "description": "Api error." - }, - "OperationList": { - "description": "Pageable list of operations", - "properties": { - "value": { - "description": "List of operations", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Operation" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "Operation": { - "description": "A REST API operation", - "type": "object", - "properties": { - "name": { - "description": "Name of the operation being performed on this object", - "type": "string", - "readOnly": true - }, - "display": { - "description": "Contains the localized display information for this operation", - "readOnly": true, - "properties": { - "provider": { - "description": "Localized friendly form of the resource provider name", - "type": "string", - "readOnly": true - }, - "resource": { - "description": "Localized friendly form of the resource type related to this operation", - "type": "string", - "readOnly": true - }, - "operation": { - "description": "Localized friendly name for the operation", - "type": "string", - "readOnly": true - }, - "description": { - "description": "Localized friendly description for the operation", - "type": "string", - "readOnly": true - } - } - } - } - }, - "ExpressRouteAuthorization": { - "description": "Authorization for an ExpressRoute", - "properties": { - "name": { - "description": "The name of the ExpressRoute", - "type": "string" - }, - "id": { - "description": "The ID of the ExpressRoute", - "type": "string", - "readOnly": true - }, - "key": { - "description": "The key of the ExpressRoute", - "type": "string", - "readOnly": true - } - } - }, - "Circuit": { - "description": "An ExpressRoute Circuit", - "properties": { - "primarySubnet": { - "type": "string", - "readOnly": true, - "description": "CIDR of primary subnet" - }, - "secondarySubnet": { - "type": "string", - "readOnly": true, - "description": "CIDR of secondary subnet" - }, - "expressRouteID": { - "type": "string", - "readOnly": true, - "description": "Identifier of the ExpressRoute (Microsoft Colo only)" - }, - "authorizations": { - "type": "array", - "description": "Authorizations for the ExpressRoute (Microsoft Colo only)", - "items": { - "$ref": "#/definitions/ExpressRouteAuthorization" - } - }, - "expressRoutePrivatePeeringID": { - "type": "string", - "readOnly": true, - "description": "ExpressRoute private peering identifier" - } - } - }, - "Endpoints": { - "description": "Endpoint addresses", - "properties": { - "nsxtManager": { - "description": "Endpoint for the NSX-T Data Center manager", - "type": "string", - "readOnly": true - }, - "vcsa": { - "description": "Endpoint for Virtual Center Server Appliance", - "type": "string", - "readOnly": true - } - } - }, - "IdentitySource": { - "description": "vCenter Single Sign On Identity Source", - "properties": { - "name": { - "description": "The name of the identity source", - "type": "string" - }, - "alias": { - "description": "The domain's NetBIOS name", - "type": "string" - }, - "domain": { - "description": "The domain's dns name", - "type": "string" - }, - "baseUserDN": { - "description": "The base distinguished name for users", - "type": "string" - }, - "baseGroupDN": { - "description": "The base distinguished name for groups", - "type": "string" - }, - "primaryServer": { - "description": "Primary server URL", - "type": "string" - }, - "secondaryServer": { - "description": "Secondary server URL", - "type": "string" - }, - "ssl": { - "description": "Protect LDAP communication using SSL certificate (LDAPS)", - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "SslEnum", - "modelAsString": true - } - }, - "username": { - "description": "The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group", - "type": "string" - }, - "password": { - "description": "The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.", - "type": "string" - } - } - }, - "PrivateCloud": { - "description": "A private cloud resource", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "description": "The properties of a private cloud resource", - "$ref": "#/definitions/PrivateCloudProperties" - } - } - }, - "PrivateCloudProperties": { - "description": "The properties of a private cloud resource", - "properties": { - "provisioningState": { - "description": "The provisioning state", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Cancelled", - "Pending", - "Building", - "Updating" - ], - "x-ms-enum": { - "name": "PrivateCloudProvisioningState", - "modelAsString": true - } - }, - "circuit": { - "description": "An ExpressRoute Circuit", - "$ref": "#/definitions/Circuit" - }, - "cluster": { - "description": "The default cluster used for management", - "$ref": "#/definitions/DefaultClusterProperties" - }, - "clusters": { - "description": "The clusters", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - }, - "endpoints": { - "description": "The endpoints", - "readOnly": true, - "$ref": "#/definitions/Endpoints" - }, - "internet": { - "description": "Connectivity to internet is enabled or disabled", - "type": "string", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "InternetEnum", - "modelAsString": true - } - }, - "identitySources": { - "description": "vCenter Single Sign On Identity Sources", - "type": "array", - "items": { - "$ref": "#/definitions/IdentitySource" - } - }, - "networkBlock": { - "description": "The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22", - "type": "string" - }, - "managementNetwork": { - "description": "Network used to access vCenter Server and NSX-T Manager", - "type": "string", - "readOnly": true - }, - "provisioningNetwork": { - "description": "Used for virtual machine cold migration, cloning, and snapshot migration", - "type": "string", - "readOnly": true - }, - "vmotionNetwork": { - "description": "Used for live migration of virtual machines", - "type": "string", - "readOnly": true - }, - "vcenterPassword": { - "description": "Optionally, set the vCenter admin password when the private cloud is created", - "type": "string" - }, - "nsxtPassword": { - "description": "Optionally, set the NSX-T Manager password when the private cloud is created", - "type": "string" - } - } - }, - "Cluster": { - "description": "A cluster resource", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "properties": { - "properties": { - "description": "The properties of a cluster resource", - "$ref": "#/definitions/ClusterProperties" - } - } - }, - "DefaultClusterProperties": { - "description": "The properties of a default cluster", - "properties": { - "clusterId": { - "description": "The identity", - "type": "integer", - "readOnly": true - }, - "clusterSize": { - "description": "The cluster size", - "type": "integer" - }, - "hosts": { - "description": "The hosts", - "type": "array", - "readOnly": true, - "items": { - "type": "string" - } - } - } - }, - "ClusterProperties": { - "description": "The properties of a cluster", - "allOf": [ - { - "$ref": "#/definitions/DefaultClusterProperties" - } - ], - "properties": { - "provisioningState": { - "description": "The state of the cluster provisioning", - "type": "string", - "readOnly": true, - "enum": [ - "Succeeded", - "Failed", - "Cancelled", - "Updating" - ], - "x-ms-enum": { - "name": "ClusterProvisioningState", - "modelAsString": true - } - } - } - }, - "PrivateCloudList": { - "description": "A paged list of private clouds", - "properties": { - "value": { - "description": "The items on the page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/PrivateCloud" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "ClusterList": { - "description": "A paged list of clusters", - "properties": { - "value": { - "description": "The items on a page", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/Cluster" - } - }, - "nextLink": { - "description": "URL to get the next page if any", - "type": "string", - "readOnly": true - } - } - }, - "AdminCredentials": { - "description": "Administrative credentials for accessing vCenter and NSX-T", - "properties": { - "nsxtUsername": { - "description": "NSX-T Manager username", - "type": "string", - "readOnly": true - }, - "nsxtPassword": { - "description": "NSX-T Manager password", - "type": "string", - "readOnly": true - }, - "vcenterUsername": { - "description": "vCenter admin username", - "type": "string", - "readOnly": true - }, - "vcenterPassword": { - "description": "vCenter admin password", - "type": "string", - "readOnly": true - } - } - } - } -} diff --git a/specification/vmwarevirtustream/resource-manager/readme.csharp.md b/specification/vmwarevirtustream/resource-manager/readme.csharp.md deleted file mode 100644 index da240a6e154c..000000000000 --- a/specification/vmwarevirtustream/resource-manager/readme.csharp.md +++ /dev/null @@ -1,15 +0,0 @@ -## C# - -These settings apply only when `--csharp` is specified on the command line. -Please also specify `--csharp-sdks-folder=`. - -```yaml $(csharp) -csharp: - package-version: 0.2.0 - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - clear-output-folder: true - namespace: Microsoft.Azure.Management.VMwareVirtustream - output-folder: $(csharp-sdks-folder)/VMwareVirtustream/Management.VMwareVirtustream/Generated -``` \ No newline at end of file diff --git a/specification/vmwarevirtustream/resource-manager/readme.md b/specification/vmwarevirtustream/resource-manager/readme.md deleted file mode 100644 index 30c08c7eec57..000000000000 --- a/specification/vmwarevirtustream/resource-manager/readme.md +++ /dev/null @@ -1,85 +0,0 @@ -# VMware Solution by Virtustream - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for VMware Solution by Virtustream. - -## Getting Started -To build the SDK for VMware Solution by Virtustream, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - -### Basic Information -These are the global settings for the VMware Solution by Virtustream API. - -``` yaml -openapi-type: arm -tag: package-2019-08-09-preview -``` - -### Tag: package-2019-08-09-preview - -These settings apply only when `--tag=package-2019-08-09-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2019-08-09-preview' -input-file: -- Microsoft.VMwareVirtustream/preview/2019-08-09-preview/vmwarevirtustream.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-js - - repo: azure-sdk-for-python - - repo: azure-sdk-for-net -``` - -## TypeScript - -See configuration in [readme.typescript.md](./readme.typescript.md) - -## Python - -See configuration in [readme.python.md](./readme.python.md) - -## C# - -See configuration in [readme.csharp.md](./readme.csharp.md) -## Multi-API/Profile support for AutoRest v3 generators - -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.VMwareVirtustream/preview/2019-08-09-preview/vmwarevirtustream.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. - -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - diff --git a/specification/vmwarevirtustream/resource-manager/readme.python.md b/specification/vmwarevirtustream/resource-manager/readme.python.md deleted file mode 100644 index 8b7a17c8d47a..000000000000 --- a/specification/vmwarevirtustream/resource-manager/readme.python.md +++ /dev/null @@ -1,27 +0,0 @@ -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -```yaml $(python) -python-mode: create -python: - package-version: 0.2.0 - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.vmwarevirtustream - package-name: azure-mgmt-vmwarevirtustream - clear-output-folder: true -``` -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/compute/azure-mgmt-vmwarevirtustream/azure/mgmt/vmwarevirtustream -``` -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/compute/azure-mgmt-vmwarevirtustream -``` \ No newline at end of file diff --git a/specification/vmwarevirtustream/resource-manager/readme.typescript.md b/specification/vmwarevirtustream/resource-manager/readme.typescript.md deleted file mode 100644 index a4666ebb13f2..000000000000 --- a/specification/vmwarevirtustream/resource-manager/readme.typescript.md +++ /dev/null @@ -1,14 +0,0 @@ -## TypeScript - -These settings apply only when `--typescript` is specified on the command line. -Please also specify `--typescript-sdks-folder=`. - -```yaml $(typescript) -typescript: - package-version: 0.2.0 - azure-arm: true - package-name: "@azure/arm-vmwarevirtustream" - output-folder: "$(typescript-sdks-folder)/sdk/vmwarevirtustream/arm-vmwarevirtustream" - payload-flattening-threshold: 1 - generate-metadata: true -``` \ No newline at end of file From 0af3df7b876fb52db88e3558d7dba4508d752dab Mon Sep 17 00:00:00 2001 From: Marc Reyhner Date: Tue, 16 Jun 2020 02:45:15 -0700 Subject: [PATCH 160/318] Update resources.json help text (#9843) * Update resources.json * typo --- .../Microsoft.Resources/stable/2020-06-01/resources.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json index ff07635dde6f..7568710e3c8c 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json @@ -5421,11 +5421,11 @@ "statusCode": { "readOnly": true, "type": "string", - "description": "Operation status code." + "description": "Operation status code from the resource provider. This property may not be set if a response has not yet been received." }, "statusMessage": { "readOnly": true, - "description": "Operation status message.", + "description": "Operation status message from the resource provider. This property is optional. It will only be provided if an error was received from the resource provider.", "$ref": "#/definitions/StatusMessage" }, "targetResource": { From 12f42bdeb9ea701428014cad3673511645ab363b Mon Sep 17 00:00:00 2001 From: robins1212 <38265197+robins1212@users.noreply.github.com> Date: Tue, 16 Jun 2020 04:57:30 -0700 Subject: [PATCH 161/318] CloudShell -- create stable 2018-10-01 and preview 2020-04-01 swagger apis (#8895) * add specification for stable and preview version * readme and remove aci examples * service name * service name * style fixes * change casing on filename * run pretty fix * fix headers * add operation ids * fix lintdiff errors * Delete cloudShell.json * Delete cloudShell.json * add patch examples * add proper responses * fix schema * remove schema level * add missing responses * parameter title fixes * change body title to parameters * more parameters fixes * change body to properties * fix typo * fix enums * remove preview file from readme * add schema to putusersettingsresponse * fix version and removed required property * remove mislabeled file * run prettier * add modelAsString * run prettier * add resource definition with parameter * run prettier * add resource more places * lint fixes Co-authored-by: Robin Sturm --- custom-words.txt | 2 + .../stable/2018-10-01/CloudShell.json | 1002 +++++++++++++++++ .../2018-10-01/examples/DeleteConsole.json | 10 + .../examples/DeleteConsole_Location.json | 11 + .../examples/DeleteUserSettings.json | 10 + .../examples/DeleteUserSettings_Location.json | 11 + .../2018-10-01/examples/GetConsole.json | 17 + .../examples/GetConsole_Location.json | 18 + .../2018-10-01/examples/GetUserSettings.json | 26 + .../examples/GetUserSettings_Location.json | 27 + .../stable/2018-10-01/examples/KeepAlive.json | 18 + .../examples/KeepAlive_Location.json | 19 + .../examples/PatchUserSettings.json | 36 + .../examples/PatchUserSettings_Location.json | 36 + .../2018-10-01/examples/PutConsole.json | 31 + .../examples/PutConsole_Location.json | 32 + .../2018-10-01/examples/PutUserSettings.json | 42 + .../examples/PutUserSettings_Location.json | 43 + .../cloudshell/resource-manager/readme.md | 148 +++ 19 files changed, 1539 insertions(+) create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/CloudShell.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteConsole.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteConsole_Location.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteUserSettings.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteUserSettings_Location.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetConsole.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetConsole_Location.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetUserSettings.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetUserSettings_Location.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/KeepAlive.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/KeepAlive_Location.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PatchUserSettings.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PatchUserSettings_Location.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutConsole.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutConsole_Location.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutUserSettings.json create mode 100644 specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutUserSettings_Location.json create mode 100644 specification/cloudshell/resource-manager/readme.md diff --git a/custom-words.txt b/custom-words.txt index d1f32e855593..75494be7c350 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -924,6 +924,7 @@ modelmanagement MODIFYACLENTRIES monitoringconfiguration monitoringconfigurations +Monospace MPNS MSAZR MSAZRDE @@ -1160,6 +1161,7 @@ pullrequest Purgeable pushdown pushsettings +pwsh Pyspark pytorch QFEs diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/CloudShell.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/CloudShell.json new file mode 100644 index 000000000000..4c4a3ca9d214 --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/CloudShell.json @@ -0,0 +1,1002 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-10-01", + "title": "CloudShellClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Portal/locations/{location}/userSettings/{userSettingsName}": { + "get": { + "operationId": "getUserSettingsWithLocation", + "x-ms-examples": { + "GetUserSettings": { + "$ref": "./examples/GetUserSettings_Location.json" + } + }, + "summary": "Get user settings.", + "description": "Get current user settings for current signed in user. This operation returns settings for the user's cloud shell preferences including preferred location, storage profile, shell type, font and size settings.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserSettingsNameParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSettingsResponse" + }, + "headers": { + "x-ms-console-required-location-code": { + "type": "string", + "description": "normalized required location code" + }, + "x-ms-console-preview-user": { + "type": "boolean", + "description": "indicates whether user is a previous usr." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "operationId": "patchUserSettingsWithLocation", + "summary": "patch user settings.", + "description": "Patch cloud shell settings for current signed in user", + "x-ms-examples": { + "PatchUserSettings": { + "$ref": "./examples/PatchUserSettings_Location.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserSettingsNameParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "name": "parameters", + "description": "The properties of the user settings to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/CloudShellPatchUserSettings" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSettingsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "operationId": "deleteUserSettingsWithLocation", + "summary": "delete user settings.", + "x-ms-examples": { + "DeleteUserSettings": { + "$ref": "./examples/DeleteUserSettings_Location.json" + } + }, + "description": "Delete cloud shell settings for current signed in user", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserSettingsNameParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "operationId": "putUserSettingsWithLocation", + "summary": "put user settings.", + "x-ms-examples": { + "PutUserSettings": { + "$ref": "./examples/PutUserSettings_Location.json" + } + }, + "description": "Create or update cloud shell settings for current signed in user", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserSettingsNameParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "name": "parameters", + "description": "The properties of the user settings to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/CloudShellUserSettings" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSettingsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}": { + "get": { + "operationId": "getConsoleWithLocation", + "summary": "Get console", + "x-ms-examples": { + "GetConsole": { + "$ref": "./examples/GetConsole_Location.json" + } + }, + "description": "Gets the console for the user.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudShellConsole" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "operationId": "putConsoleWithLocation", + "summary": "Put console", + "x-ms-examples": { + "PutConsole": { + "$ref": "./examples/PutConsole_Location.json" + } + }, + "description": "Puts a request for a console", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudShellConsole" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CloudShellConsole" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "operationId": "deleteConsoleWithLocation", + "summary": "Delete console", + "x-ms-examples": { + "DeleteConsole": { + "$ref": "./examples/DeleteConsole_Location.json" + } + }, + "description": "Deletes the console", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Portal/locations/{location}/consoles/{consoleName}/keepAlive": { + "post": { + "operationId": "keepAliveWithLocation", + "x-ms-examples": { + "GetUserSettings": { + "$ref": "./examples/KeepAlive_Location.json" + } + }, + "summary": "Keep alive", + "description": "Keep console alive", + "parameters": [ + { + "$ref": "#/parameters/ConsoleNameParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "x-ms-console-remaining-seconds": { + "type": "integer", + "format": "int32", + "description": "Remaining time left in session, in seconds." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Portal/userSettings/{userSettingsName}": { + "get": { + "operationId": "GetUserSettings", + "x-ms-examples": { + "GetUserSettings": { + "$ref": "./examples/GetUserSettings.json" + } + }, + "summary": "Get user settings.", + "description": "Get current user settings for current signed in user. This operation returns settings for the user's cloud shell preferences including preferred location, storage profile, shell type, font and size settings.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserSettingsNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSettingsResponse" + }, + "headers": { + "x-ms-console-required-location-code": { + "type": "string", + "description": "normalized required location code" + }, + "x-ms-console-preview-user": { + "type": "boolean", + "description": "indicates whether user is a previous usr." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "operationId": "PatchUserSettings", + "summary": "patch user settings.", + "description": "Patch cloud shell settings for current signed in user", + "x-ms-examples": { + "PatchUserSettings": { + "$ref": "./examples/PatchUserSettings.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserSettingsNameParameter" + }, + { + "name": "parameters", + "description": "The properties of the user settings to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/CloudShellPatchUserSettings" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSettingsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "operationId": "DeleteUserSettings", + "x-ms-examples": { + "DeleteUserSettings": { + "$ref": "./examples/DeleteUserSettings.json" + } + }, + "summary": "delete user settings.", + "description": "Delete cloud shell settings for current signed in user", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserSettingsNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "operationId": "PutUserSettings", + "x-ms-examples": { + "PutUserSettings": { + "$ref": "./examples/PutUserSettings.json" + } + }, + "summary": "put user settings.", + "description": "Create or update cloud shell settings for current signed in user", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/UserSettingsNameParameter" + }, + { + "name": "parameters", + "description": "The properties of the user settings to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/CloudShellUserSettings" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UserSettingsResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Portal/consoles/{consoleName}": { + "get": { + "operationId": "GetConsole", + "x-ms-examples": { + "GetConsole": { + "$ref": "./examples/GetConsole.json" + } + }, + "summary": "Get console", + "description": "Gets the console for the user.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudShellConsole" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "operationId": "PutConsole", + "x-ms-examples": { + "PutConsole": { + "$ref": "./examples/PutConsole.json" + } + }, + "summary": "Put console", + "description": "Puts a request for a console", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + }, + { + "name": "parameters", + "description": "The console definition.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ConsoleDefinition" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CloudShellConsole" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/CloudShellConsole" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "operationId": "DeleteConsole", + "x-ms-examples": { + "DeleteConsole": { + "$ref": "./examples/DeleteConsole.json" + } + }, + "summary": "Delete console", + "description": "Deletes the console", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ConsoleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Portal/consoles/{consoleName}/keepAlive": { + "post": { + "operationId": "KeepAlive", + "x-ms-examples": { + "KeepAlive": { + "$ref": "./examples/KeepAlive.json" + } + }, + "summary": "Keep alive", + "description": "Keep console alive", + "parameters": [ + { + "$ref": "#/parameters/ConsoleNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "headers": { + "x-ms-console-remaining-seconds": { + "type": "integer", + "format": "int32", + "description": "Remaining time left in session, in seconds." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "CloudShellConsole": { + "description": "Cloud shell console", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConsoleProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "ConsoleProperties": { + "description": "Cloud shell console properties.", + "type": "object", + "required": [ + "osType", + "provisioningState", + "uri" + ], + "properties": { + "osType": { + "description": "The operating system type of the cloud shell.", + "type": "string", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "osType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Provisioning state of the console.", + "type": "string", + "enum": [ + "NotSpecified", + "Accepted", + "Pending", + "Updating", + "Creating", + "Repairing", + "Failed", + "Canceled", + "Succeeded" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "uri": { + "description": "Uri of the console.", + "type": "string" + } + } + }, + "ConsoleCreateProperties": { + "description": "Cloud shell properties for creating a console.", + "type": "object", + "required": [ + "osType" + ], + "properties": { + "osType": { + "description": "The operating system type of the cloud shell.", + "type": "string", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "osType", + "modelAsString": true + } + }, + "provisioningState": { + "description": "Provisioning state of the console.", + "type": "string", + "enum": [ + "NotSpecified", + "Accepted", + "Pending", + "Updating", + "Creating", + "Repairing", + "Failed", + "Canceled", + "Succeeded" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + } + }, + "uri": { + "description": "Uri of the console.", + "type": "string" + } + } + }, + "ConsoleDefinition": { + "description": "Console definition", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/ConsoleCreateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "Resource": { + "description": "The Resource model definition.", + "x-ms-azure-resource": true + }, + "UserSettingsResponse": { + "description": "Response to get user settings", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/UserProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "CloudShellUserSettings": { + "description": "Cloud shell user settings.", + "type": "object", + "required": [ + "properties" + ], + "properties": { + "properties": { + "$ref": "#/definitions/UserProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ] + }, + "CloudShellPatchUserSettings": { + "description": "Cloud shell patch operation user settings.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/UserProperties" + } + } + }, + "UserProperties": { + "description": "The cloud shell user settings properties.", + "type": "object", + "required": [ + "preferredOsType", + "preferredLocation", + "storageProfile", + "terminalSettings", + "preferredShellType" + ], + "properties": { + "preferredOsType": { + "description": "The operating system type of the cloud shell. Deprecated, use preferredShellType.", + "type": "string", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "osType", + "modelAsString": true + } + }, + "preferredLocation": { + "description": "The preferred location of the cloud shell.", + "type": "string" + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile" + }, + "terminalSettings": { + "$ref": "#/definitions/TerminalSettings" + }, + "preferredShellType": { + "description": "The shell type of the cloud shell.", + "type": "string", + "enum": [ + "bash", + "pwsh", + "powershell" + ], + "x-ms-enum": { + "name": "shellType", + "modelAsString": true + } + } + } + }, + "StorageProfile": { + "description": "The storage profile of the user settings.", + "type": "object", + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "Full resource ID of storage account." + }, + "fileShareName": { + "type": "string", + "description": "Name of the mounted file share. 63 characters or less, lowercase alphabet, numbers, and -" + }, + "diskSizeInGB": { + "type": "integer", + "format": "int32", + "description": "Size of file share" + } + } + }, + "TerminalSettings": { + "description": "Settings for terminal appearance.", + "type": "object", + "properties": { + "fontSize": { + "type": "string", + "description": "Size of terminal font.", + "enum": [ + "NotSpecified", + "Small", + "Medium", + "Large" + ], + "x-ms-enum": { + "name": "fontSize", + "modelAsString": true + } + }, + "fontStyle": { + "type": "string", + "description": "Style of terminal font.", + "enum": [ + "NotSpecified", + "Monospace", + "Courier" + ], + "x-ms-enum": { + "name": "fontStyle", + "modelAsString": true + } + } + } + }, + "ErrorResponse": { + "title": "ErrorResponse", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDetail" + } + }, + "required": [ + "error" + ] + }, + "ErrorDetail": { + "title": "ErrorDetail", + "type": "object", + "properties": { + "code": { + "description": "The error's code.", + "type": "string" + }, + "message": { + "description": "A human readable error message.", + "type": "string" + } + }, + "required": [ + "code", + "message" + ] + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version", + "x-ms-parameter-location": "client" + }, + "ConsoleNameParameter": { + "name": "consoleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the console", + "x-ms-parameter-location": "client" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The provider location", + "x-ms-parameter-location": "method" + }, + "UserSettingsNameParameter": { + "name": "userSettingsName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the user settings", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteConsole.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteConsole.json new file mode 100644 index 000000000000..a9580f1734a6 --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteConsole.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "consoleName": "default", + "api-version": "2018-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteConsole_Location.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteConsole_Location.json new file mode 100644 index 000000000000..98e9199a1c24 --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteConsole_Location.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "consoleName": "default", + "location": "eastus", + "api-version": "2018-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteUserSettings.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteUserSettings.json new file mode 100644 index 000000000000..e3b501a0830a --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteUserSettings.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "userSettingsName": "cloudconsole", + "api-version": "2018-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteUserSettings_Location.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteUserSettings_Location.json new file mode 100644 index 000000000000..626b8022a573 --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/DeleteUserSettings_Location.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "userSettingsName": "cloudconsole", + "location": "eastus", + "api-version": "2018-10-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetConsole.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetConsole.json new file mode 100644 index 000000000000..c8939a5fff0e --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetConsole.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "consoleName": "default", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Linux", + "provisioningState": "Succeeded", + "uri": "string" + } + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetConsole_Location.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetConsole_Location.json new file mode 100644 index 000000000000..fe8097963b2c --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetConsole_Location.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "consoleName": "default", + "location": "eastus", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Linux", + "provisioningState": "Succeeded", + "uri": "string" + } + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetUserSettings.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetUserSettings.json new file mode 100644 index 000000000000..9e1fffc82978 --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetUserSettings.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "userSettingsName": "cloudconsole", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "preferredOsType": "Linux", + "preferredLocation": "eastus", + "storageProfile": { + "storageAccountResourceId": "string", + "fileShareName": "string", + "diskSizeInGB": 5 + }, + "terminalSettings": { + "fontSize": "Medium", + "fontStyle": "Monospace" + }, + "preferredShellType": "bash" + } + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetUserSettings_Location.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetUserSettings_Location.json new file mode 100644 index 000000000000..3f99bf4fde31 --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/GetUserSettings_Location.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "userSettingsName": "cloudconsole", + "location": "eastus", + "api-version": "2018-10-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "preferredOsType": "Linux", + "preferredLocation": "eastus", + "storageProfile": { + "storageAccountResourceId": "string", + "fileShareName": "string", + "diskSizeInGB": 5 + }, + "terminalSettings": { + "fontSize": "Medium", + "fontStyle": "Monospace" + }, + "preferredShellType": "bash" + } + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/KeepAlive.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/KeepAlive.json new file mode 100644 index 000000000000..bddba272284f --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/KeepAlive.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "consoleName": "default", + "api-version": "2018-10-01", + "body": { + "properties": { + "OsType": "Linux" + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-console-remaining-seconds": 300 + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/KeepAlive_Location.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/KeepAlive_Location.json new file mode 100644 index 000000000000..6aecb9bdc77b --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/KeepAlive_Location.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "consoleName": "default", + "location": "eastus", + "api-version": "2018-10-01", + "body": { + "properties": { + "OsType": "Linux" + } + } + }, + "responses": { + "200": { + "headers": { + "x-ms-console-remaining-seconds": 300 + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PatchUserSettings.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PatchUserSettings.json new file mode 100644 index 000000000000..c646cf0af9ba --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PatchUserSettings.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "userSettingsName": "cloudconsole", + "location": "eastus", + "api-version": "2018-10-01", + "parameters": { + "properties": { + "preferredOsType": "Linux", + "preferredLocation": "", + "storageProfile": {}, + "terminalSettings": {}, + "preferredShellType": "bash" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "preferredOsType": "Linux", + "preferredLocation": "eastus", + "storageProfile": { + "storageAccountResourceId": "/subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourcegroups/cloud-shell-storage-westus/providers/Microsoft.Storage/storageAccounts/cs410033fffa1eebadb", + "fileShareName": "cs-rosturm-microsoft-com-10033fffa1eebadb", + "diskSizeInGB": 5 + }, + "terminalSettings": { + "fontSize": "Small", + "fontStyle": "Monospace" + }, + "preferredShellType": "bash" + } + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PatchUserSettings_Location.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PatchUserSettings_Location.json new file mode 100644 index 000000000000..c646cf0af9ba --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PatchUserSettings_Location.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "userSettingsName": "cloudconsole", + "location": "eastus", + "api-version": "2018-10-01", + "parameters": { + "properties": { + "preferredOsType": "Linux", + "preferredLocation": "", + "storageProfile": {}, + "terminalSettings": {}, + "preferredShellType": "bash" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "preferredOsType": "Linux", + "preferredLocation": "eastus", + "storageProfile": { + "storageAccountResourceId": "/subscriptions/ae43b1e3-c35d-4c8c-bc0d-f148b4c52b78/resourcegroups/cloud-shell-storage-westus/providers/Microsoft.Storage/storageAccounts/cs410033fffa1eebadb", + "fileShareName": "cs-rosturm-microsoft-com-10033fffa1eebadb", + "diskSizeInGB": 5 + }, + "terminalSettings": { + "fontSize": "Small", + "fontStyle": "Monospace" + }, + "preferredShellType": "bash" + } + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutConsole.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutConsole.json new file mode 100644 index 000000000000..34a3d68780cd --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutConsole.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "consoleName": "default", + "api-version": "2018-10-01", + "parameters": { + "properties": { + "osType": "Linux" + } + } + }, + "responses": { + "201": { + "body": { + "properties": { + "osType": "Linux", + "provisioningState": "Succeeded", + "uri": "string" + } + } + }, + "200": { + "body": { + "properties": { + "osType": "Linux", + "provisioningState": "Succeeded", + "uri": "string" + } + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutConsole_Location.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutConsole_Location.json new file mode 100644 index 000000000000..c1fc796c0288 --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutConsole_Location.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "consoleName": "default", + "location": "eastus", + "api-version": "2018-10-01", + "parameters": { + "properties": { + "osType": "Linux" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "osType": "Linux", + "provisioningState": "Succeeded", + "uri": "string" + } + } + }, + "201": { + "body": { + "properties": { + "osType": "Linux", + "provisioningState": "Succeeded", + "uri": "string" + } + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutUserSettings.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutUserSettings.json new file mode 100644 index 000000000000..2e74b9b9b157 --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutUserSettings.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "userSettingsName": "cloudconsole", + "api-version": "2018-10-01", + "parameters": { + "properties": { + "preferredOsType": "Linux", + "preferredLocation": "eastus", + "storageProfile": { + "storageAccountResourceId": "string", + "fileShareName": "string", + "diskSizeInGB": 5 + }, + "terminalSettings": { + "fontSize": "Medium", + "fontStyle": "Monospace" + }, + "preferredShellType": "bash" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "preferredOsType": "Linux", + "preferredLocation": "eastus", + "storageProfile": { + "storageAccountResourceId": "string", + "fileShareName": "string", + "diskSizeInGB": 5 + }, + "terminalSettings": { + "fontSize": "Medium", + "fontStyle": "Monospace" + }, + "preferredShellType": "bash" + } + } + } + } +} diff --git a/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutUserSettings_Location.json b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutUserSettings_Location.json new file mode 100644 index 000000000000..49ca747ec0e3 --- /dev/null +++ b/specification/cloudshell/resource-manager/Microsoft.Portal/stable/2018-10-01/examples/PutUserSettings_Location.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "userSettingsName": "cloudconsole", + "location": "eastus", + "api-version": "2018-10-01", + "parameters": { + "properties": { + "preferredOsType": "Linux", + "preferredLocation": "eastus", + "storageProfile": { + "storageAccountResourceId": "string", + "fileShareName": "string", + "diskSizeInGB": 5 + }, + "terminalSettings": { + "fontSize": "Medium", + "fontStyle": "Monospace" + }, + "preferredShellType": "bash" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "preferredOsType": "Linux", + "preferredLocation": "eastus", + "storageProfile": { + "storageAccountResourceId": "string", + "fileShareName": "string", + "diskSizeInGB": 5 + }, + "terminalSettings": { + "fontSize": "Medium", + "fontStyle": "Monospace" + }, + "preferredShellType": "bash" + } + } + } + } +} diff --git a/specification/cloudshell/resource-manager/readme.md b/specification/cloudshell/resource-manager/readme.md new file mode 100644 index 000000000000..383773dcd1ce --- /dev/null +++ b/specification/cloudshell/resource-manager/readme.md @@ -0,0 +1,148 @@ +# CloudShell + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for CloudShell. + +## Getting Started + +To build the SDKs for CloudShell, 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 CloudShell. + +```yaml +openapi-type: arm +tag: package-2018-10-01 +``` + +### Tag: package-2018-10-01 + +These settings apply only when `--tag=package-2018-10-01` is specified on the command line. + +```yaml $(tag) == 'package-2018-10-01' +input-file: + - Microsoft.Portal/stable/2018-10-01/CloudShell.json +``` + +--- + +# Code Generation + +## Swagger to SDK + +This section describes what SDK should be generated by the automatic system. +This is not used by Autorest itself. + +```yaml $(swagger-to-sdk) +swagger-to-sdk: + - repo: azure-sdk-for-python + - repo: azure-sdk-for-java + - repo: azure-sdk-for-go + - repo: azure-sdk-for-js + - repo: azure-sdk-for-ruby + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_mgmt_cloudshell'] +``` + +## Go + +These settings apply only when `--go` is specified on the command line. + +``` yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + clear-output-folder: true + namespace: cloudshell +``` + +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: Microsoft.Portal + package-name: CloudShell + clear-output-folder: true +``` +``` yaml $(python) +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/azure-mgmt/cloudshell +``` + +## Ruby + +```yaml +package-name: azure_mgmt_cloudshell +package-version: 2018-10-01 +azure-arm: true +``` + +### Tag: package-2018-10-01 and ruby + +These settings apply only when `--tag=package-2018-10-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2018-10-01' && $(ruby) +namespace: Microsoft.Portal +output-folder: $(ruby-sdks-folder)/CloudShell +``` + +### Tag: package-2020-04-01 and ruby + +These settings apply only when `--tag=package-2018-04-01 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +```yaml $(tag) == 'package-2018-04-01' && $(ruby) +namespace: Microsoft.Portal +output-folder: $(ruby-sdks-folder)/CloudShell +``` + +## 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: "CloudShell" + output-folder: "$(typescript-sdks-folder)/packages/CloudShell" + payload-flattening-threshold: 1 + generate-metadata: true +``` + +## CSharp + +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.CloudShell + output-folder: $(csharp-sdks-folder)/CloudShell/management/Microsoft.CloudShell/GeneratedProtocol +``` \ No newline at end of file From a1eac63e819fdefdbca6f0d67519807db0a4aa3b Mon Sep 17 00:00:00 2001 From: Novin Date: Tue, 16 Jun 2020 18:57:15 -0700 Subject: [PATCH 162/318] updated containerinstance owner (#9856) --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index c5db75e8217f..3548df4fa2ef 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -12,7 +12,7 @@ /specification/cognitiveservices/ @felixwa @yangyuan /specification/compute/ @hyonholee @mabhard @danielli90 @smotwani @ppatwa @vikramd-ms @savyasachisamal @yunusm @ZhidongPeng @nkuchta @maheshnemichand @najams @changov /specification/consumption/ @kjeur @panda-wang -/specification/containerinstance/ @samkreter +/specification/containerinstance/ @novinc /specification/containerregistry/ @djyou /specification/containerservice/ @yangl900 /specification/cosmos-db/ @dmakwana From 68f39a53d87e84e10fdc48ce1a47bc7299e3b1a9 Mon Sep 17 00:00:00 2001 From: aim-for-better Date: Wed, 17 Jun 2020 13:04:47 +0800 Subject: [PATCH 163/318] 1. Marked "sessionId" as required property in DataFlowDebugCommandRequest (#9850) Co-authored-by: Zhenyu Zhou --- .../preview/2019-06-01-preview/artifacts.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json index f78900be895d..df96c4e9e6fe 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json @@ -2714,7 +2714,10 @@ "description": "The command payload object.", "type": "object" } - } + }, + "required": [ + "sessionId" + ] }, "DataFlowDebugQueryResponse": { "description": "Response body structure of data flow query for data preview, statistics or expression preview.", From 4ea51f62c942dbce2e06c20d9e408f4497a887c1 Mon Sep 17 00:00:00 2001 From: Qiaoqiao Zhang <55688292+qiaozha@users.noreply.github.com> Date: Wed, 17 Jun 2020 13:41:07 +0800 Subject: [PATCH 164/318] test-costmanagement-automation (#9864) --- specification/cost-management/resource-manager/readme.az.md | 1 - 1 file changed, 1 deletion(-) diff --git a/specification/cost-management/resource-manager/readme.az.md b/specification/cost-management/resource-manager/readme.az.md index 0ab4b46e293f..961e2dab1422 100644 --- a/specification/cost-management/resource-manager/readme.az.md +++ b/specification/cost-management/resource-manager/readme.az.md @@ -11,5 +11,4 @@ az: client-base-url-bound: true az-output-folder: $(azure-cli-extension-folder)/src/costmanagement python-sdk-output-folder: "$(az-output-folder)/azext_costmanagement/vendored_sdks/costmanagement" - ``` From f48e338882f9469af9e000b84e1be52ce1344225 Mon Sep 17 00:00:00 2001 From: cachuahu <60233649+cachuahu@users.noreply.github.com> Date: Tue, 16 Jun 2020 23:41:08 -0700 Subject: [PATCH 165/318] Revert PYthon Directive Change (#9801) --- .../compute/resource-manager/readme.python.md | 17 ----------------- 1 file changed, 17 deletions(-) diff --git a/specification/compute/resource-manager/readme.python.md b/specification/compute/resource-manager/readme.python.md index e0a44c76fbe6..53decad609c1 100644 --- a/specification/compute/resource-manager/readme.python.md +++ b/specification/compute/resource-manager/readme.python.md @@ -10,23 +10,6 @@ python: package-name: azure-mgmt-compute no-namespace-folders: true clear-output-folder: true - -directive: - # dynamically add a DummyOrchestrationServiceName value to the enum - - from: compute.json - where: $..enum - transform: >- - if( $.length === 1 && $[0] === "AutomaticRepairs") { - $.push('DummyOrchestrationServiceName'); - } - return $; - - - from: source-file-python - where: $ - transform: >- - return $. - replace(/, 'DummyOrchestrationServiceName'/g,''). - replace(/dummy_orchestration_service_name = "DummyOrchestrationServiceName"/g,''); ``` These settings apply only when `--track2` is specified on the command line. From 189fe8eb8d1ce60c9a782bbd1a0d632ffd70f1ae Mon Sep 17 00:00:00 2001 From: vasanthrajams <60414148+vasanthrajams@users.noreply.github.com> Date: Wed, 17 Jun 2020 11:21:01 -0700 Subject: [PATCH 166/318] Security domain backup restore REST OpenAPI specification (#9647) * Adding 7.2-preview version (#8397) * Adding 7.2-preview version Signed-off-by: vasanthrajams * Resolve PR feedback * Fix output-folder for go code generation Co-authored-by: Heath Stewart * MHSM Security domain backup restore REST OpenAPI specifications * Reolved review comments * resolved conflicts * lint errors * Resolved x-ms-long running operation options comment * run pretty check * adding long running operation options * long-running-operation-options * fix avacado cl error * fixing avocado failures Co-authored-by: Heath Stewart Co-authored-by: vasanthrajams --- custom-words.txt | 6 + .../{7.2 => 7.2-preview}/backuprestore.json | 0 .../{7.2 => 7.2-preview}/certificates.json | 0 .../preview/{7.2 => 7.2-preview}/common.json | 0 .../examples/BackupCertificate-example.json | 0 .../examples/BackupKey-example.json | 0 .../examples/BackupSecret-example.json | 0 .../examples/CreateCertificate-example.json | 0 .../examples/CreateKey-example.json | 0 .../examples/DeleteCertificate-example.json | 0 .../DeleteCertificateContacts-example.json | 0 .../DeleteCertificateIssuer-example.json | 0 .../DeleteCertificateOperation-example.json | 0 .../examples/DeleteKey-example.json | 0 .../DeleteRoleAssignments-example.json | 0 .../examples/DeleteSecret-example.json | 0 .../examples/ExportKey-example.json | 0 .../examples/FullBackup-example.json | 0 .../examples/FullBackup-pending-example.json | 0 .../examples/FullRestore-example.json | 0 .../examples/FullRestore-pending-example.json | 0 .../examples/GetCertificate-example.json | 0 .../GetCertificateContacts-example.json | 0 .../GetCertificateIssuer-example.json | 0 .../GetCertificateIssuers-example.json | 0 .../GetCertificateOperation-example.json | 0 .../GetCertificatePolicy-example.json | 0 .../GetCertificateVersions-example.json | 0 .../examples/GetCertificates-example.json | 0 .../GetDeletedCertificate-example.json | 0 .../GetDeletedCertificates-example.json | 0 .../examples/GetDeletedKey-example.json | 0 .../examples/GetDeletedKeys-example.json | 0 .../examples/GetDeletedSecret-example.json | 0 .../examples/GetDeletedSecrets-example.json | 0 .../examples/GetKey-example.json | 0 .../examples/GetKeyVersions-example.json | 0 .../examples/GetKeys-example.json | 0 .../examples/GetRoleAssignments-example.json | 0 .../examples/GetSecret-example.json | 0 .../examples/GetSecretVersions-example.json | 0 .../examples/GetSecrets-example.json | 0 .../examples/ImportCertificate-example.json | 0 .../examples/ImportKey-example.json | 0 .../examples/ListRoleAssignments-example.json | 0 .../examples/ListRoleDefinitions-example.json | 0 .../examples/MergeCertificate-example.json | 0 .../PurgeDeletedCertificate-example.json | 0 .../examples/PurgeDeletedKey-example.json | 0 .../examples/PurgeDeletedSecret-example.json | 0 .../examples/PutRoleAssignments-example.json | 0 .../RecoverDeletedCertificate-example.json | 0 .../examples/RecoverDeletedKey-example.json | 0 .../RecoverDeletedSecret-example.json | 0 .../examples/RestoreCertificate-example.json | 0 .../examples/RestoreKey-example.json | 0 .../examples/RestoreSecret-example.json | 0 .../examples/SelectiveRestore-example.json | 0 .../SetCertificateContacts-example.json | 0 .../SetCertificateIssuer-example.json | 0 .../examples/SetSecret-example.json | 0 .../examples/UpdateCertificate-example.json | 0 .../UpdateCertificateIssuer-example.json | 0 .../UpdateCertificateOperation-example.json | 0 .../UpdateCertificatePolicy-example.json | 0 .../examples/UpdateKey-example.json | 0 .../examples/UpdateSecret-example.json | 0 .../examples/backupStorageAccount.json | 0 .../examples/decrypt-example.json | 0 .../examples/deleteStorageAccount.json | 0 .../examples/deleteStorageSasDefinition.json | 0 .../examples/encrypt-example.json | 0 .../examples/getDeletedStorageAccount.json | 0 .../getDeletedStorageSasDefinition.json | 0 .../examples/getStorageAccount.json | 0 .../examples/getStorageSasDefinition.json | 0 .../examples/listDeletedStorageAccount.json | 0 .../listDeletedStorageSasDefinition.json | 0 .../examples/listStorageAccount.json | 0 .../examples/listStorageSasDefinition.json | 0 .../examples/purgeStorageAccount.json | 0 .../examples/recoverStorageAccount.json | 0 .../examples/recoverStorageSasDefinition.json | 0 .../examples/regenerateStorageAccountKey.json | 0 .../examples/restoreStorageAccount.json | 0 .../securitydomaindownloadpost-example.json | 74 ++++ ...securitydomainoperationstatus-example.json | 14 + .../securitydomaintransferkey-example.json | 27 ++ ...securitydomainuploadoperation-example.json | 21 ++ .../examples/setStorageAccount.json | 0 .../examples/setStorageSasDefinition.json | 0 .../examples/sign-example.json | 0 .../examples/unwrapKey-example.json | 0 .../examples/updateStorageAccount.json | 0 .../examples/updateStorageSasDefinition.json | 0 .../examples/verify-example.json | 0 .../examples/wrapKey-example.json | 0 .../preview/{7.2 => 7.2-preview}/index.md | 0 .../preview/{7.2 => 7.2-preview}/keys.json | 0 .../preview/{7.2 => 7.2-preview}/rbac.json | 0 .../preview/{7.2 => 7.2-preview}/secrets.json | 0 .../preview/7.2-preview/securitydomain.json | 330 ++++++++++++++++++ .../preview/{7.2 => 7.2-preview}/storage.json | 0 specification/keyvault/data-plane/readme.md | 65 ++-- 104 files changed, 507 insertions(+), 30 deletions(-) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/backuprestore.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/certificates.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/common.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/BackupCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/BackupKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/BackupSecret-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/CreateCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/CreateKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/DeleteCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/DeleteCertificateContacts-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/DeleteCertificateIssuer-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/DeleteCertificateOperation-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/DeleteKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/DeleteRoleAssignments-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/DeleteSecret-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/ExportKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/FullBackup-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/FullBackup-pending-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/FullRestore-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/FullRestore-pending-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetCertificateContacts-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetCertificateIssuer-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetCertificateIssuers-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetCertificateOperation-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetCertificatePolicy-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetCertificateVersions-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetCertificates-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetDeletedCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetDeletedCertificates-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetDeletedKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetDeletedKeys-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetDeletedSecret-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetDeletedSecrets-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetKeyVersions-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetKeys-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetRoleAssignments-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetSecret-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetSecretVersions-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/GetSecrets-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/ImportCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/ImportKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/ListRoleAssignments-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/ListRoleDefinitions-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/MergeCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/PurgeDeletedCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/PurgeDeletedKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/PurgeDeletedSecret-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/PutRoleAssignments-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/RecoverDeletedCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/RecoverDeletedKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/RecoverDeletedSecret-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/RestoreCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/RestoreKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/RestoreSecret-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/SelectiveRestore-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/SetCertificateContacts-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/SetCertificateIssuer-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/SetSecret-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/UpdateCertificate-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/UpdateCertificateIssuer-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/UpdateCertificateOperation-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/UpdateCertificatePolicy-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/UpdateKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/UpdateSecret-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/backupStorageAccount.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/decrypt-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/deleteStorageAccount.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/deleteStorageSasDefinition.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/encrypt-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/getDeletedStorageAccount.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/getDeletedStorageSasDefinition.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/getStorageAccount.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/getStorageSasDefinition.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/listDeletedStorageAccount.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/listDeletedStorageSasDefinition.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/listStorageAccount.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/listStorageSasDefinition.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/purgeStorageAccount.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/recoverStorageAccount.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/recoverStorageSasDefinition.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/regenerateStorageAccountKey.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/restoreStorageAccount.json (100%) create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomaindownloadpost-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomainoperationstatus-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomaintransferkey-example.json create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomainuploadoperation-example.json rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/setStorageAccount.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/setStorageSasDefinition.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/sign-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/unwrapKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/updateStorageAccount.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/updateStorageSasDefinition.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/verify-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/examples/wrapKey-example.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/index.md (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/keys.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/rbac.json (100%) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/secrets.json (100%) create mode 100644 specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/securitydomain.json rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/{7.2 => 7.2-preview}/storage.json (100%) diff --git a/custom-words.txt b/custom-words.txt index 75494be7c350..d47d37ab39fc 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1790,6 +1790,12 @@ userprincipalname sessionstate sessionhosts hostpool +securitydomain +securitydomaindownloadpost +securitydomaintransferkey +securitydomainuploadoperation +securitydomainoperationstatus +transferkey Alexa regeneratekeys Directline diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/backuprestore.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/backuprestore.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/backuprestore.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/backuprestore.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/certificates.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/certificates.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/certificates.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/certificates.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/common.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/common.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/common.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/common.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/BackupCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/BackupCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/BackupCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/BackupCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/BackupKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/BackupKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/BackupKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/BackupKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/BackupSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/BackupSecret-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/BackupSecret-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/BackupSecret-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/CreateCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/CreateCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/CreateCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/CreateCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/CreateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/CreateKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/CreateKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/CreateKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteCertificateContacts-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteCertificateContacts-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteCertificateContacts-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteCertificateIssuer-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteCertificateIssuer-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteCertificateIssuer-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteCertificateOperation-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteCertificateOperation-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteCertificateOperation-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteRoleAssignments-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteRoleAssignments-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteRoleAssignments-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteRoleAssignments-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteSecret-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/DeleteSecret-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/DeleteSecret-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ExportKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/ExportKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ExportKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/ExportKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/FullBackup-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/FullBackup-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-pending-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/FullBackup-pending-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullBackup-pending-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/FullBackup-pending-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/FullRestore-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/FullRestore-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-pending-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/FullRestore-pending-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/FullRestore-pending-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/FullRestore-pending-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificateContacts-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificateContacts-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificateContacts-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificateIssuer-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificateIssuer-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificateIssuer-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificateIssuers-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificateIssuers-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificateIssuers-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificateIssuers-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificateOperation-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificateOperation-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificateOperation-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificatePolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificatePolicy-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificatePolicy-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificatePolicy-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificateVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificateVersions-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificateVersions-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificateVersions-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificates-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificates-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetCertificates-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetCertificates-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedCertificates-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedCertificates-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedCertificates-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedCertificates-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedKeys-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedKeys-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedKeys-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedKeys-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedSecret-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedSecret-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedSecret-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedSecrets-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedSecrets-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetDeletedSecrets-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetDeletedSecrets-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetKeyVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetKeyVersions-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetKeyVersions-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetKeyVersions-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetKeys-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetKeys-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetKeys-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetKeys-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetRoleAssignments-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetRoleAssignments-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetRoleAssignments-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetRoleAssignments-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetSecret-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetSecret-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetSecret-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetSecretVersions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetSecretVersions-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetSecretVersions-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetSecretVersions-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetSecrets-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetSecrets-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/GetSecrets-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/GetSecrets-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ImportCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/ImportCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ImportCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/ImportCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ImportKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/ImportKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ImportKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/ImportKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ListRoleAssignments-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/ListRoleAssignments-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ListRoleAssignments-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/ListRoleAssignments-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ListRoleDefinitions-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/ListRoleDefinitions-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/ListRoleDefinitions-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/ListRoleDefinitions-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/MergeCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/MergeCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/MergeCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/MergeCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/PurgeDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/PurgeDeletedCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/PurgeDeletedCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/PurgeDeletedCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/PurgeDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/PurgeDeletedKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/PurgeDeletedKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/PurgeDeletedKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/PurgeDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/PurgeDeletedSecret-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/PurgeDeletedSecret-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/PurgeDeletedSecret-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/PutRoleAssignments-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/PutRoleAssignments-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/PutRoleAssignments-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/PutRoleAssignments-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RecoverDeletedCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RecoverDeletedCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RecoverDeletedCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RecoverDeletedCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RecoverDeletedKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RecoverDeletedKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RecoverDeletedKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RecoverDeletedKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RecoverDeletedSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RecoverDeletedSecret-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RecoverDeletedSecret-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RecoverDeletedSecret-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RestoreCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RestoreCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RestoreCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RestoreCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RestoreKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RestoreKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RestoreKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RestoreKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RestoreSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RestoreSecret-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/RestoreSecret-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/RestoreSecret-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SelectiveRestore-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/SelectiveRestore-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SelectiveRestore-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/SelectiveRestore-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SetCertificateContacts-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/SetCertificateContacts-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SetCertificateContacts-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/SetCertificateContacts-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SetCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/SetCertificateIssuer-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SetCertificateIssuer-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/SetCertificateIssuer-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SetSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/SetSecret-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/SetSecret-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/SetSecret-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateCertificate-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateCertificate-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateCertificate-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateCertificate-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateCertificateIssuer-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateCertificateIssuer-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateCertificateIssuer-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateCertificateIssuer-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateCertificateOperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateCertificateOperation-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateCertificateOperation-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateCertificateOperation-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateCertificatePolicy-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateCertificatePolicy-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateCertificatePolicy-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateCertificatePolicy-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateSecret-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateSecret-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/UpdateSecret-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/UpdateSecret-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/backupStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/backupStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/backupStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/backupStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/decrypt-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/decrypt-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/decrypt-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/decrypt-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/deleteStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/deleteStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/deleteStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/deleteStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/deleteStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/deleteStorageSasDefinition.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/deleteStorageSasDefinition.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/deleteStorageSasDefinition.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/encrypt-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/encrypt-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/encrypt-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/encrypt-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/getDeletedStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/getDeletedStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/getDeletedStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/getDeletedStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/getDeletedStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/getDeletedStorageSasDefinition.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/getDeletedStorageSasDefinition.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/getDeletedStorageSasDefinition.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/getStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/getStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/getStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/getStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/getStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/getStorageSasDefinition.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/getStorageSasDefinition.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/getStorageSasDefinition.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/listDeletedStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/listDeletedStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/listDeletedStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/listDeletedStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/listDeletedStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/listDeletedStorageSasDefinition.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/listDeletedStorageSasDefinition.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/listDeletedStorageSasDefinition.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/listStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/listStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/listStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/listStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/listStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/listStorageSasDefinition.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/listStorageSasDefinition.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/listStorageSasDefinition.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/purgeStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/purgeStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/purgeStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/purgeStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/recoverStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/recoverStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/recoverStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/recoverStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/recoverStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/recoverStorageSasDefinition.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/recoverStorageSasDefinition.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/recoverStorageSasDefinition.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/regenerateStorageAccountKey.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/regenerateStorageAccountKey.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/regenerateStorageAccountKey.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/regenerateStorageAccountKey.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/restoreStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/restoreStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/restoreStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/restoreStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomaindownloadpost-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomaindownloadpost-example.json new file mode 100644 index 000000000000..1c733f9c7967 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomaindownloadpost-example.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "Certificates": { + "certificates": [ + { + "value": { + "kid": "id1", + "kty": "RSA", + "key_ops": [ + "verify", + "encrypt", + "wrapKey" + ], + "alg": "RSA-OAEP-256", + "x5c": [ + "MIIEnTCCBAgIBATANBgkAoWgAwIqhkiG9w0BAQsFADAQMQ4wDAYDVQQDDAVjZXJ0QTAeFw0yMDA0MjYwMzU1NDNaFw0yMTA0MjYwMzU1NDNaMBAxDjAMBgNVBAMMBWNlcnRBMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAi0+23X8hLsFgrh7O2VtM2fVrSRIUDM/7+/D7A+FQOyt1jsMC8CSYHixo65l/FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa+VRgylqKpS+Da0x9Om/mivTQ26aDwb1Pd8h+SGcgJNy1VOnmI5+uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB+6PXXM/nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ+hw2qtCtKrr8K+0rqC/Jq5r1cu6o0/NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA/yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp/TO5+kQigYkgVZXcPjbm2c0hdkisPt+APqEdMotmYTANxtC6McP+9KOO8+12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH/36Vfc5ad+nxRYwYObRYfgOh8vpYaw3cpj5+UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv/ZX7qbNhv11a76gJRi/IoHkcf1UTpxCoD+eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz/ZCOrc+RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vsCAwEAAaMCMAAwDQYJKoZIhvcNAQELBQADggIBAAjHy9GCPejDYIVb/iv8Wo40n317LQN7H6ay+YB5L2byEQATvC1ixde6VqwU6k9VdoQOTfP3xJhfstKrO+n5mFJBL4KG8BZBbd6XQu/ggPLKEIVZFbeQkX6o03K54gY8GxYjHr6gF12I6heLWVKA/Qi480GqSlp2Nz+LE1jgPp9u52xpUPjsvRHXtxYZ7Q3O2jhPToNr3D/TZSu3tmQOeqj9M/igLDe9TxqN9C9jraUGR7Lr4zN1srtvIKhxGMS3Q9kC4Mq+ZNNIwC9+jzzd8fB2pGJP/iTFDzB0pDh9Jz0/CR4O4aGoYqkQEx629aZH2TzhOh2yf04TaniwkHXnUEsPTxrpY8ty/OUG3HzBMHCDhS08ZSimrrxhiWyH6g0OEglXVGrI2nH6nnQIn1MTNILcjUTMRt/WSOz6G07oZciAouKD2YS/W1qPap600kGhTya81BuYThGmFoXVMs7Mk3XBzZ81b6hJ6ncwCLb3g4YzqeQ8bOf42jYJctq4tPNaXTfoC7N0FX7lPVJpRdh6BFcHYcg0NPWJsdk6LtSJB6bp2qptRAgJ5S94s843FRd8PRFE10TKDfj3YFRBNkx7qDjwUhtN8/JC9+RHHw0Ngd0x2/BLqeCEMAQaJoC53h0aMLW6PSyovnsLvdJbN/rYc15qUXSz8TtjaHFpjsy/Fo5H" + ], + "x5t": "dJKBile6IJDrRGqa3k5d8_IKFdI", + "x5t#S256": "0HylM2tkO5ny9CyZ9VLASxspFr8GknnsvuoJEzuZO2A", + "n": "i0-23X8hLsFgrh7O2VtM2fVrSRIUDM_7-_D7A-FQOyt1jsMC8CSYHixo65l_FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa-VRgylqKpS-Da0x9Om_mivTQ26aDwb1Pd8h-SGcgJNy1VOnmI5-uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB-6PXXM_nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ-hw2qtCtKrr8K-0rqC_Jq5r1cu6o0_NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA_yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp_TO5-kQigYkgVZXcPjbm2c0hdkisPt-APqEdMotmYTANxtC6McP-9KOO8-12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH_36Vfc5ad-nxRYwYObRYfgOh8vpYaw3cpj5-UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv_ZX7qbNhv11a76gJRi_IoHkcf1UTpxCoD-eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz_ZCOrc-RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vs", + "e": "AQAB" + } + }, + { + "value": { + "kid": "id2", + "kty": "RSA", + "key_ops": [ + "verify", + "encrypt", + "wrapKey" + ], + "alg": "RSA-OAEP-256", + "x5c": [ + "MIIEnTCCBAgIBAoWgAwIqhkiG9w0BTANBgkAAQsFADAQMQ4wDAYDVQQDDAVjZXJ0QTAeFw0yMDA0MjYwMzU1NDNaFw0yMTA0MjYwMzU1NDNaMBAxDjAMBgNVBAMMBWNlcnRBMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAi0+23X8hLsFgrh7O2VtM2fVrSRIUDM/7+/D7A+FQOyt1jsMC8CSYHixo65l/FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa+VRgylqKpS+Da0x9Om/mivTQ26aDwb1Pd8h+SGcgJNy1VOnmI5+uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB+6PXXM/nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ+hw2qtCtKrr8K+0rqC/Jq5r1cu6o0/NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA/yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp/TO5+kQigYkgVZXcPjbm2c0hdkisPt+APqEdMotmYTANxtC6McP+9KOO8+12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH/36Vfc5ad+nxRYwYObRYfgOh8vpYaw3cpj5+UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv/ZX7qbNhv11a76gJRi/IoHkcf1UTpxCoD+eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz/ZCOrc+RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vsCAwEAAaMCMAAwDQYJKoZIhvcNAQELBQADggIBAAjHy9GCPejDYIVb/iv8Wo40n317LQN7H6ay+YB5L2byEQATvC1ixde6VqwU6k9VdoQOTfP3xJhfstKrO+n5mFJBL4KG8BZBbd6XQu/ggPLKEIVZFbeQkX6o03K54gY8GxYjHr6gF12I6heLWVKA/Qi480GqSlp2Nz+LE1jgPp9u52xpUPjsvRHXtxYZ7Q3O2jhPToNr3D/TZSu3tmQOeqj9M/igLDe9TxqN9C9jraUGR7Lr4zN1srtvIKhxGMS3Q9kC4Mq+ZNNIwC9+jzzd8fB2pGJP/iTFDzB0pDh9Jz0/CR4O4aGoYqkQEx629aZH2TzhOh2yf04TaniwkHXnUEsPTxrpY8ty/OUG3HzBMHCDhS08ZSimrrxhiWyH6g0OEglXVGrI2nH6nnQIn1MTNILcjUTMRt/WSOz6G07oZciAouKD2YS/W1qPap600kGhTya81BuYThGmFoXVMs7Mk3XBzZ81b6hJ6ncwCLb3g4YzqeQ8bOf42jYJctq4tPNaXTfoC7N0FX7lPVJpRdh6BFcHYcg0NPWJsdk6LtSJB6bp2qptRAgJ5S94s843FRd8PRFE10TKDfj3YFRBNkx7qDjwUhtN8/JC9+RHHw0Ngd0x2/BLqeCEMAQaJoC53h0aMLW6PSyovnsLvdJbN/rYc15qUXSz8TtjaHFpjsy/Fo5H" + ], + "x5t": "dJKBile6IJDrRGqa3k5d8_IKFdI", + "x5t#S256": "0HylM2tkO5ny9CyZ9VLASxspFr8GknnsvuoJEzuZO2A", + "n": "i0-23X8hLsFgrh7O2VtM2fVrSRIUDM_7-_D7A-FQOyt1jsMC8CSYHixo65l_FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa-VRgylqKpS-Da0x9Om_mivTQ26aDwb1Pd8h-SGcgJNy1VOnmI5-uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB-6PXXM_nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ-hw2qtCtKrr8K-0rqC_Jq5r1cu6o0_NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA_yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp_TO5-kQigYkgVZXcPjbm2c0hdkisPt-APqEdMotmYTANxtC6McP-9KOO8-12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH_36Vfc5ad-nxRYwYObRYfgOh8vpYaw3cpj5-UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv_ZX7qbNhv11a76gJRi_IoHkcf1UTpxCoD-eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz_ZCOrc-RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vs", + "e": "AQAB" + } + }, + { + "value": { + "kid": "id3", + "kty": "RSA", + "key_ops": [ + "verify", + "encrypt", + "wrapKey" + ], + "alg": "RSA-OAEP-256", + "x5c": [ + "MIIEnTCCBkiG9w0BAQsFADAQMQ4wDAYDVQQDDAgIBATANBgkAoWgAwIqhAVjZXJ0QTAeFw0yMDA0MjYwMzU1NDNaFw0yMTA0MjYwMzU1NDNaMBAxDjAMBgNVBAMMBWNlcnRBMIICIjANBgkqhkiG9w0BAQEFAAOCAg8AMIICCgKCAgEAi0+23X8hLsFgrh7O2VtM2fVrSRIUDM/7+/D7A+FQOyt1jsMC8CSYHixo65l/FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa+VRgylqKpS+Da0x9Om/mivTQ26aDwb1Pd8h+SGcgJNy1VOnmI5+uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB+6PXXM/nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ+hw2qtCtKrr8K+0rqC/Jq5r1cu6o0/NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA/yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp/TO5+kQigYkgVZXcPjbm2c0hdkisPt+APqEdMotmYTANxtC6McP+9KOO8+12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH/36Vfc5ad+nxRYwYObRYfgOh8vpYaw3cpj5+UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv/ZX7qbNhv11a76gJRi/IoHkcf1UTpxCoD+eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz/ZCOrc+RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vsCAwEAAaMCMAAwDQYJKoZIhvcNAQELBQADggIBAAjHy9GCPejDYIVb/iv8Wo40n317LQN7H6ay+YB5L2byEQATvC1ixde6VqwU6k9VdoQOTfP3xJhfstKrO+n5mFJBL4KG8BZBbd6XQu/ggPLKEIVZFbeQkX6o03K54gY8GxYjHr6gF12I6heLWVKA/Qi480GqSlp2Nz+LE1jgPp9u52xpUPjsvRHXtxYZ7Q3O2jhPToNr3D/TZSu3tmQOeqj9M/igLDe9TxqN9C9jraUGR7Lr4zN1srtvIKhxGMS3Q9kC4Mq+ZNNIwC9+jzzd8fB2pGJP/iTFDzB0pDh9Jz0/CR4O4aGoYqkQEx629aZH2TzhOh2yf04TaniwkHXnUEsPTxrpY8ty/OUG3HzBMHCDhS08ZSimrrxhiWyH6g0OEglXVGrI2nH6nnQIn1MTNILcjUTMRt/WSOz6G07oZciAouKD2YS/W1qPap600kGhTya81BuYThGmFoXVMs7Mk3XBzZ81b6hJ6ncwCLb3g4YzqeQ8bOf42jYJctq4tPNaXTfoC7N0FX7lPVJpRdh6BFcHYcg0NPWJsdk6LtSJB6bp2qptRAgJ5S94s843FRd8PRFE10TKDfj3YFRBNkx7qDjwUhtN8/JC9+RHHw0Ngd0x2/BLqeCEMAQaJoC53h0aMLW6PSyovnsLvdJbN/rYc15qUXSz8TtjaHFpjsy/Fo5H" + ], + "x5t": "dJKBile6IJDrRGqa3k5d8_IKFdI", + "x5t#S256": "0HylM2tkO5ny9CyZ9VLASxspFr8GknnsvuoJEzuZO2A", + "n": "i0-23X8hLsFgrh7O2VtM2fVrSRIUDM_7-_D7A-FQOyt1jsMC8CSYHixo65l_FbAWGx79mqANMa0v2NX4UPDgkRhHlnQXstXa-VRgylqKpS-Da0x9Om_mivTQ26aDwb1Pd8h-SGcgJNy1VOnmI5-uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB-6PXXM_nReFWs32fiojoFeUbneQthQnRCS7CeokqIF1KJoOIrTZFCJ-hw2qtCtKrr8K-0rqC_Jq5r1cu6o0_NOweOqKgwRQKapcrbdY0JsmcTERisX07w9fMbtMA_yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp_TO5-kQigYkgVZXcPjbm2c0hdkisPt-APqEdMotmYTANxtC6McP-9KOO8-12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH_36Vfc5ad-nxRYwYObRYfgOh8vpYaw3cpj5-UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv_ZX7qbNhv11a76gJRi_IoHkcf1UTpxCoD-eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz_ZCOrc-RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vs", + "e": "AQAB" + } + } + ] + }, + "api-version": "7.2-preview" + }, + "responses": { + "200": { + "body": { + "value": "{\"EncData\":{\"data\":[{\"compact_jwe\":\"ey$Jhb%232GciOiJkaXIiLCJlbmMiOiJBMjU2Q0JDLUhTNTEyIiwia2lkIjoiZW5jbGF2ZS$J9..5eVwZFlsZQeYXQ11HPC_JJg.4d32grvkQBMxyGmncd82VHOggiFbtuaKX2wXvjU-vKukMAtS7oLl9QsSZZJ5s94xAz7Atye93e6gA_2tbHW0QEzLOXiuV-vZ342zP46dxV56bEEjENIOgzBWAfxUkuUdnYE2UDahGSJSbhNxo8URa44CaSAX682q_otmwqh0jgxk5ZcbHRdwpbSFZnfQ6SgHBqrvQUUpKlWJMJQNuWeEjmWaPkCOUnwkJ1ZLOnVj1AB8rlfj0qnEtBotc4V5066vztRDaTLEOV99lp08WRcRPAY2QVBSfhZdzslQ2baRukk6WOTI5KxIl0cf7o0db_zgoT6vluewXgzTSe6NTcrparwVJ-r6kxw12gkYJtrr3ytvOT_lgip5-7H3PLAgDDRDjHd_PEdNyPqsg56QjtVXBUwutQrfh46s_ATm0dFrhAF6Icf9H2rLDGCiFmKUn-CrtM3vErNzu9BMC8ekuSOe0t0XTnsKOjdiabE95MoRIqQYWQGfi02Rp2XO_lSEUnQJTNomd1IATKPiqqktE5YUu0OzDrVCdSGBGg5IDedmGSp0QIf8m7kSc8xYUsU1PTdJoSzgiOAue0ur_P1i2xr_BSSI6I4BJekw9e58qqBbWN-kc3swgLddsCfXqyW9RnNBvjQmnwdffv1O_4zF0wGVnohs6PYu-9RqIzLxgfHvnlBQbsauWlqpNfw5h_JpnoKW287vPc2iXRONHlGdd-4Mp3323JFbISM6NgGg8y6nUAdKASjyXuqR7bTnr3pNTpjF4523buuzKG3Q4nzr-jnWGPIpxeyBV6unEK0Aw3-QQpY7CG_s3-76P484gJm4vPum03I_V3tmnNt}]}}" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomainoperationstatus-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomainoperationstatus-example.json new file mode 100644 index 000000000000..36e66d0862b5 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomainoperationstatus-example.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.2-preview" + }, + "responses": { + "200": { + "body": { + "status": "InProgress", + "status_details": "" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomaintransferkey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomaintransferkey-example.json new file mode 100644 index 000000000000..9c9edb0d91fa --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomaintransferkey-example.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "api-version": "7.2-preview" + }, + "responses": { + "200": { + "body": { + "transfer_key": { + "kid": "https://myvault.vault.azure.net/transfer_key", + "kty": "RSA", + "key_ops": [ + "encrypt" + ], + "n": "2HJAE5fU3Cw2Rt9hEuq-F6XjINKGa-zskfISVqopqUy60GOs2eyhxbWbJBeUXNor_gf-tXtNeuqeBgitLeVa640UDvnEjYTKWjCniTxZRaU7ewY8BfTSk-7KxoDdLsPSpX_MX4rwlAx-_1UGk5t4sQgTbm9T6Fm2oqFd37dsz5-Gj27UP2GTAShfJPFD7MqU_zIgOI0pfqsbNL5xTQVM29K6rX4jSPtylZV3uWJtkoQIQnrIHhk1d0SC0KwlBV3V7R_LVYjiXLyIXsFzSNYgQ68ZjAwt8iL7I8Osa-ehQLM13DVvLASaf7Jnu3sC3CWl3Gyirgded6cfMmswJzY87w", + "e": "AQAB", + "alg": "RSA-OAEP-256", + "x5c": [ + "MIIEnTCCBAgIBATANBgkAoWgAwIqhkiG9w0BAQsFADAQMQ4wDAYDVQQDDAVjZXJ0QTAeFw0yMDA0MjYwM/mivTQ26aDwb1Pd8h+SGcgJNy1VOnmI5+uvgfh9Qj6glJZHEyvh6dat6f4DDTwRVf6Vvc5noB/yiilaMj1GPW0Bwg5u5atZcjzTb6wOFYOGd2Y1WFBwQqqxriWo62Fp/TO5+kQigYkgVZXcPjbm2c0hdkisPt+APqEdMotmYTANxtC6McP+9KOO8+12K2fj2a9NEhRJOboGQeZ0M7DJoQDl4wg8f2nswxH/36Vfc5ad+nxRYwYObRYfgOh8vpYaw3cpj5+UHBaPQ8ZiQNDoWHJWvX5z1nTmCc2NmLHdi3ijkoc7AKHIv/ZX7qbNhv11a76gJRi/IoHkcf1UTpxCoD+eTbo8Isxt4c9fBTk1vS4wSGsJCewxcyMlTB9FHufPM8k5Uz/ZCOrc+RoaznKPGamgMJOOwbPE1WcBnxuG4rQcskdCa59NiZXyZsx5vsCAwEAAaMCMAAwDQYJKoZIhvcNAQELBQADggIBAAjHy9GCPejDYIVb/iv8Wo40n317LQN7H6ay+YB5L2byEQATvC1ixde6VqwU6k9VdoQOTfP3xJhfstKrO+n5mFJBL4KG8BZBbd6XQu/ggPLKEIVZFbeQkX6o03K54gY8GxYjHr6gF12I6heLWVKA/Qi480GqSlp2Nz+LE1jgPp9u52xpUPjsvRHXtxYZ7Q3O2jhPToNr3D/TZSu3tmQOeqj9M/igLDe9TxqN9C9jraUGR7Lr4zN1srtvIKhxGMS3Q9kC4Mq+ZNNIwC9+jzzd8fB2pGJP/iTFDzB0pDh9Jz0/CR4O4aGoYqkQEx629aZH2TzhOh2yf04TaniwkHXnUEsPTxrpY8ty/OUG3HzBMHCDhS08ZSimrrxhiWyH6g0OEglXVGrI2nH6nnQIn1MTNILcjUTMRt/WSOz6G07oZciAouKD2YS/W1qPap600kGhTya81BuYThGmFoXVMs7Mk3XBzZ81b6hJ6ncwCLb3g4YzqeQ8bOf42jYJctq4tPNaXTfoC7N0FX7lPVJpRdh6BFcHYcg0NPWJsdk6LtSJB6bp2qptRAgJ5S94s843FRd8PRFE10TKDfj3YFRBNkx7qDjwUhtN8/JC9+RHHw0Ngd0x2/BLqeCEMAQaJoC53h0aMLW6PSyovnsLvdJbN/rYc15qUXSz8TtjaHFpjsy/Fo5H" + ], + "x5t": "dJKBile6IJDrRGqa3k5d8_IKFdI", + "x5t#S256": "gIBQCTDDN" + } + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomainuploadoperation-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomainuploadoperation-example.json new file mode 100644 index 000000000000..e59cc01e4939 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/securitydomainuploadoperation-example.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "vaultBaseUrl": "https://myvault.vault.azure.net/", + "security_domain": { + "value": "" + }, + "api-version": "7.2-preview" + }, + "responses": { + "202": { + "headers": { + "Retry-After": 5, + "Azure-AsyncOperation": "https://myvault.vault.azure.net/securitydomain/upload/pending" + }, + "body": { + "status": "InProgress", + "status_details": "" + } + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/setStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/setStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/setStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/setStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/setStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/setStorageSasDefinition.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/setStorageSasDefinition.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/setStorageSasDefinition.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/sign-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/sign-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/sign-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/sign-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/unwrapKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/unwrapKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/unwrapKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/unwrapKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/updateStorageAccount.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/updateStorageAccount.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/updateStorageAccount.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/updateStorageAccount.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/updateStorageSasDefinition.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/updateStorageSasDefinition.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/updateStorageSasDefinition.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/updateStorageSasDefinition.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/verify-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/verify-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/verify-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/verify-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/wrapKey-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/wrapKey-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/examples/wrapKey-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/wrapKey-example.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/index.md b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/index.md similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/index.md rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/index.md diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/keys.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/rbac.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/rbac.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/rbac.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/rbac.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/secrets.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/secrets.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/secrets.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/secrets.json diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/securitydomain.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/securitydomain.json new file mode 100644 index 000000000000..6f2bb9644780 --- /dev/null +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/securitydomain.json @@ -0,0 +1,330 @@ +{ + "swagger": "2.0", + "info": { + "title": "KeyVaultClient", + "description": "The key vault client performs cryptographic key operations and vault operations against the Key Vault service.", + "version": "7.2-preview" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{vaultBaseUrl}", + "useSchemePrefix": false, + "positionInOperation": "first", + "parameters": [ + { + "name": "vaultBaseUrl", + "description": "The vault name, for example https://myvault.vault.azure.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/securitydomain/download": { + "post": { + "tags": [ + "HSMSecurityDomain" + ], + "operationId": "HSMSecurityDomain_Download", + "description": "Retrieves Security domain from HSM enclave", + "parameters": [ + { + "in": "body", + "name": "Certificates", + "required": true, + "schema": { + "$ref": "#/definitions/CertificateSet" + }, + "description": "Security domain download operation requires customer to provide three certificates containing public key in JWK format." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Security domain download response", + "schema": { + "$ref": "#/definitions/SecurityDomainObject" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Retrieve Security domain": { + "$ref": "./examples/securitydomaindownloadpost-example.json" + } + } + } + }, + "/securitydomain/transferkey": { + "get": { + "tags": [ + "HSMSecurityDomain" + ], + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "operationId": "HSMSecurityDomain_TransferKey", + "description": "Retrieve security domain transfer key", + "responses": { + "200": { + "description": "Security domain transfer key operation", + "schema": { + "$ref": "#/definitions/TransferKey" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Retrieve security domain transfer key": { + "$ref": "./examples/securitydomaintransferkey-example.json" + } + } + } + }, + "/securitydomain/upload": { + "post": { + "tags": [ + "HSMSecurityDomain" + ], + "operationId": "HSMSecurityDomain_Upload", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "description": "Request Security domain upload operation", + "parameters": [ + { + "in": "body", + "name": "security_domain", + "description": "security domain", + "required": true, + "schema": { + "$ref": "#/definitions/SecurityDomainObject" + } + } + ], + "responses": { + "202": { + "description": "Security domain upload operation started", + "headers": { + "Retry-After": { + "description": "The recommended number of seconds to wait before calling the URI specified in Azure-AsyncOperation.", + "type": "integer" + }, + "Azure-AsyncOperation": { + "description": "The URI to poll for completion status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/SecurityDomainOperationStatus" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Security domain upload operation": { + "$ref": "./examples/securitydomainuploadoperation-example.json" + } + } + } + }, + "/securitydomain/upload/pending": { + "get": { + "tags": [ + "HSMSecurityDomain" + ], + "operationId": "HSMSecurityDomain_UploadPending", + "description": "Get Security domain upload operation status", + "responses": { + "200": { + "description": "Security domain upload operation status", + "schema": { + "$ref": "#/definitions/SecurityDomainOperationStatus" + } + }, + "default": { + "description": "Key Vault error response describing why the operation failed.", + "schema": { + "$ref": "common.json#/definitions/KeyVaultError" + } + } + }, + "x-ms-examples": { + "Find security domain upload operation status": { + "$ref": "./examples/securitydomainoperationstatus-example.json" + } + } + } + } + }, + "definitions": { + "CertificateSet": { + "properties": { + "certificates": { + "type": "array", + "items": { + "$ref": "#/definitions/SecurityDomainCertificateItem" + }, + "minItems": 3, + "maxItems": 3, + "uniqueItems": true, + "description": "Three certificates needed from customer" + } + }, + "required": [ + "certificates" + ] + }, + "SecurityDomainCertificateItem": { + "properties": { + "value": { + "$ref": "#/definitions/SecurityDomainJsonWebKey", + "description": "Customer generated certificate containing public key in JWK format" + } + }, + "required": [ + "value" + ] + }, + "TransferKey": { + "properties": { + "transfer_key": { + "$ref": "#/definitions/SecurityDomainJsonWebKey" + } + }, + "required": [ + "transfer_key" + ] + }, + "SecurityDomainObject": { + "properties": { + "value": { + "type": "string" + } + } + }, + "SecurityDomainOperationStatus": { + "properties": { + "status": { + "description": "operation status", + "enum": [ + "Success", + "InProgress", + "Failed" + ], + "x-ms-enum": { + "modelAsString": false, + "name": "OperationStatus" + }, + "type": "string" + }, + "status_details": { + "type": "string" + } + } + }, + "SecurityDomainJsonWebKey": { + "properties": { + "kid": { + "type": "string", + "description": "Key identifier." + }, + "kty": { + "type": "string", + "description": "JsonWebKey Key Type (kty), as defined in https://tools.ietf.org/html/draft-ietf-jose-json-web-algorithms-40. For security domain this value must be RSA", + "enum": [ + "RSA", + "RSA-HSM" + ], + "x-ms-enum": { + "name": "JsonWebKeyType", + "modelAsString": true + } + }, + "key_ops": { + "type": "array", + "items": { + "type": "string", + "description": "Supported key operations." + } + }, + "n": { + "type": "string", + "description": "RSA modulus." + }, + "e": { + "type": "string", + "description": "RSA public exponent." + }, + "x5c": { + "description": "X509 certificate chain parameter", + "type": "array", + "items": { + "type": "string" + } + }, + "use": { + "description": "Public Key Use Parameter. This is optional and if present must be enc.", + "type": "string" + }, + "x5t": { + "description": "X509 certificate SHA1 thumbprint. This is optional.", + "type": "string" + }, + "x5t#S256": { + "description": "X509 certificate SHA256 thumbprint.", + "type": "string" + }, + "alg": { + "description": "Algorithm intended for use with the key.", + "type": "string" + } + }, + "required": [ + "kty", + "key_ops", + "kid", + "x5c", + "x5t#S256", + "n", + "e" + ] + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version." + } + } +} diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/storage.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/storage.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2/storage.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/storage.json diff --git a/specification/keyvault/data-plane/readme.md b/specification/keyvault/data-plane/readme.md index 9db0128e0f77..601fc2219975 100644 --- a/specification/keyvault/data-plane/readme.md +++ b/specification/keyvault/data-plane/readme.md @@ -35,31 +35,16 @@ These settings apply only when `--tag=package-7.2-preview` is specified on the c ```yaml $(tag) == 'package-7.2-preview' input-file: -- Microsoft.KeyVault/preview/7.2/certificates.json -- Microsoft.KeyVault/preview/7.2/common.json -- Microsoft.KeyVault/preview/7.2/keys.json -- Microsoft.KeyVault/preview/7.2/rbac.json -- Microsoft.KeyVault/preview/7.2/secrets.json -- Microsoft.KeyVault/preview/7.2/storage.json -- Microsoft.KeyVault/preview/7.2/backuprestore.json +- Microsoft.KeyVault/preview/7.2-preview/certificates.json +- Microsoft.KeyVault/preview/7.2-preview/common.json +- Microsoft.KeyVault/preview/7.2-preview/keys.json +- Microsoft.KeyVault/preview/7.2-preview/rbac.json +- Microsoft.KeyVault/preview/7.2-preview/secrets.json +- Microsoft.KeyVault/preview/7.2-preview/storage.json +- Microsoft.KeyVault/preview/7.2-preview/backuprestore.json +- Microsoft.KeyVault/preview/7.2-preview/securitydomain.json ``` -### Tag: package-7.2-preview - -These settings apply only when `--tag=package-7.2-preview` is specified on the command line. - -```yaml $(tag) == 'package-7.2-preview' -input-file: -- Microsoft.KeyVault/preview/7.2/certificates.json -- Microsoft.KeyVault/preview/7.2/common.json -- Microsoft.KeyVault/preview/7.2/keys.json -- Microsoft.KeyVault/preview/7.2/rbac.json -- Microsoft.KeyVault/preview/7.2/secrets.json -- Microsoft.KeyVault/preview/7.2/storage.json -- Microsoft.KeyVault/preview/7.2/backuprestore.json -``` - - ### Tag: package-7.1-preview These settings apply only when `--tag=package-7.1-preview` is specified on the command line. @@ -169,13 +154,13 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - - $(this-folder)/Microsoft.KeyVault/preview/7.2/certificates.json - - $(this-folder)/Microsoft.KeyVault/preview/7.2/common.json - - $(this-folder)/Microsoft.KeyVault/preview/7.2/keys.json - - $(this-folder)/Microsoft.KeyVault/preview/7.2/rbac.json - - $(this-folder)/Microsoft.KeyVault/preview/7.2/secrets.json - - $(this-folder)/Microsoft.KeyVault/preview/7.2/storage.json - - $(this-folder)/Microsoft.KeyVault/preview/7.2/backuprestore.json + - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/certificates.json + - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/common.json + - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/keys.json + - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/rbac.json + - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/secrets.json + - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/storage.json + - $(this-folder)/Microsoft.KeyVault/preview/7.2-preview/backuprestore.json - $(this-folder)/Microsoft.KeyVault/preview/7.1/certificates.json - $(this-folder)/Microsoft.KeyVault/preview/7.1/common.json - $(this-folder)/Microsoft.KeyVault/preview/7.1/keys.json @@ -355,4 +340,24 @@ directive: - suppress: MISSING_REQUIRED_PARAMETER from: storage.json reason: Suppress an invalid error caused by a bug in the linter. + - suppress: DefinitionsPropertiesNamesCamelCase + from: securitydomain.json + where: $.definitions.TransferKey.properties.transfer_key + reason: Merely refactored existing definitions into new files. + - suppress: DefinitionsPropertiesNamesCamelCase + from: securitydomain.json + where: $.definitions.UploadPendingResponse.properties.status_details + reason: Consistency with other properties. + - suppress: DefinitionsPropertiesNamesCamelCase + from: securitydomain.json + where: $.definitions.SecurityDomainOperationStatus.properties.status_details + reason: Consistency with other properties. + - suppress: DefinitionsPropertiesNamesCamelCase + from: securitydomain.json + where: $.definitions.SecurityDomainOperationStatus.properties.key_ops + reason: Consistency with other properties. + - suppress: DefinitionsPropertiesNamesCamelCase + from: securitydomain.json + where: $.definitions.SecurityDomainOperationStatus.properties.x5t#S256 + reason: Consistency with other properties. ``` From b62fff3d57c30acf51944522c1b7c59d0e114b48 Mon Sep 17 00:00:00 2001 From: iscai-msft <43154838+iscai-msft@users.noreply.github.com> Date: Wed, 17 Jun 2020 17:32:44 -0400 Subject: [PATCH 167/318] [key vault] make key-version path parameter required for get key (#9860) * make key version required for get key * fix description * add clarifying comment about version path parameter to Get* methods in version 7.0 and up * remove references to OpenAPI version in version path parameter desccription --- .../Microsoft.KeyVault/preview/7.1/certificates.json | 2 +- .../data-plane/Microsoft.KeyVault/preview/7.1/keys.json | 2 +- .../Microsoft.KeyVault/preview/7.1/secrets.json | 2 +- .../preview/7.2-preview/certificates.json | 2 +- .../Microsoft.KeyVault/preview/7.2-preview/keys.json | 2 +- .../Microsoft.KeyVault/preview/7.2-preview/secrets.json | 2 +- .../Microsoft.KeyVault/stable/7.0/keyvault.json | 8 ++++---- 7 files changed, 10 insertions(+), 10 deletions(-) diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/certificates.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/certificates.json index 072cfce9477d..5a0bfa70211d 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/certificates.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/certificates.json @@ -778,7 +778,7 @@ "in": "path", "required": true, "type": "string", - "description": "The version of the certificate." + "description": "The version of the certificate. This URI fragment is optional. If not specified, the latest version of the certificate is returned." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/keys.json index f1177248f673..0bb932484ef9 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/keys.json @@ -247,7 +247,7 @@ "in": "path", "required": true, "type": "string", - "description": "Adding the version parameter retrieves a specific version of a key." + "description": "Adding the version parameter retrieves a specific version of a key. This URI fragment is optional. If not specified, the latest version of the key is returned." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/secrets.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/secrets.json index b0c5f3b3542e..60d8f7d5deb3 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/secrets.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/secrets.json @@ -195,7 +195,7 @@ "in": "path", "required": true, "type": "string", - "description": "The version of the secret." + "description": "The version of the secret. This URI fragment is optional. If not specified, the latest version of the secret is returned." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/certificates.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/certificates.json index ddcae29d2b30..68088de0eede 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/certificates.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/certificates.json @@ -778,7 +778,7 @@ "in": "path", "required": true, "type": "string", - "description": "The version of the certificate." + "description": "The version of the certificate. This URI fragment is optional. If not specified, the latest version of the certificate is returned." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json index 755c98196453..19218ec417ae 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json @@ -247,7 +247,7 @@ "in": "path", "required": true, "type": "string", - "description": "Adding the version parameter retrieves a specific version of a key." + "description": "Adding the version parameter retrieves a specific version of a key. This URI fragment is optional. If not specified, the latest version of the key is returned." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/secrets.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/secrets.json index 56c3c00f2b27..a8e201aa184d 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/secrets.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/secrets.json @@ -195,7 +195,7 @@ "in": "path", "required": true, "type": "string", - "description": "The version of the secret." + "description": "The version of the secret. This URI fragment is optional. If not specified, the latest version of the secret is returned." }, { "$ref": "#/parameters/ApiVersionParameter" diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json index bc7638a40ffd..25a2ceab1a35 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json @@ -245,9 +245,9 @@ { "name": "key-version", "in": "path", - "required": false, + "required": true, "type": "string", - "description": "Adding the version parameter retrieves a specific version of a key." + "description": "Adding the version parameter retrieves a specific version of a key. This URI fragment is optional. If not specified, the latest version of the key is returned." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -1141,7 +1141,7 @@ "in": "path", "required": true, "type": "string", - "description": "The version of the secret." + "description": "The version of the secret. This URI fragment is optional. If not specified, the latest version of the secret is returned." }, { "$ref": "#/parameters/ApiVersionParameter" @@ -2270,7 +2270,7 @@ "in": "path", "required": true, "type": "string", - "description": "The version of the certificate." + "description": "The version of the certificate. This URI fragment is optional. If not specified, the latest version of the certificate is returned." }, { "$ref": "#/parameters/ApiVersionParameter" From 6b4d50c289cb2a7db8577143e948e95fcaa7a61e Mon Sep 17 00:00:00 2001 From: msft-adrianma <43483041+msft-adrianma@users.noreply.github.com> Date: Wed, 17 Jun 2020 20:29:13 -0700 Subject: [PATCH 168/318] [Hub Generated] Review request for Microsoft.Billing EA Auth to version preview/2019-10-01-preview (#9827) * swagger for ea auth * fix example * adding link to example files. * update arm type for billingroleassignments. * pageable. * update comment * adding nextlink to responses for Lint failures. --- .../preview/2019-10-01-preview/billing.json | 770 ++++++++++++++++-- .../BillingAccountEaPermissionsList.json | 39 + .../BillingAccountEaRoleAssignment.json | 24 + .../BillingAccountEaRoleAssignmentDelete.json | 24 + .../BillingAccountEaRoleAssignmentList.json | 40 + .../BillingAccountEaRoleDefinition.json | 46 ++ .../BillingAccountEaRoleDefinitionsList.json | 70 ++ .../examples/DepartmentPermissionsList.json | 26 + .../examples/DepartmentRoleAssignment.json | 25 + .../DepartmentRoleAssignmentDelete.json | 25 + .../DepartmentRoleAssignmentList.json | 41 + .../examples/DepartmentRoleDefinition.json | 33 + .../DepartmentRoleDefinitionsList.json | 54 ++ .../EnrollmentAccountPermissionsList.json | 24 + .../EnrollmentAccountRoleAssignment.json | 25 + ...EnrollmentAccountRoleAssignmentDelete.json | 25 + .../EnrollmentAccountRoleAssignmentList.json | 39 + .../EnrollmentAccountRoleDefinition.json | 31 + .../EnrollmentAccountRoleDefinitionsList.json | 51 ++ ...ountSubscriptionCreatorRoleAssignment.json | 33 + 20 files changed, 1363 insertions(+), 82 deletions(-) create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaPermissionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignmentDelete.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignmentList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleDefinition.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleDefinitionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentPermissionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignmentDelete.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignmentList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleDefinition.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleDefinitionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountPermissionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignment.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignmentDelete.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignmentList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleDefinition.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleDefinitionsList.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/PutEnrollmentAccountSubscriptionCreatorRoleAssignment.json diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json index 9ef0b0294a0d..0a905a542cea 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json @@ -3732,6 +3732,9 @@ "x-ms-examples": { "BillingAccountPermissionsList": { "$ref": "./examples/BillingAccountPermissionsList.json" + }, + "BillingAccountEaPermissionsList": { + "$ref": "./examples/BillingAccountEaPermissionsList.json" } }, "operationId": "BillingPermissions_ListByBillingAccount", @@ -3757,6 +3760,9 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -3841,6 +3847,90 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermissions" + ], + "x-ms-examples": { + "DepartmentPermissionsList": { + "$ref": "./examples/DepartmentPermissionsList.json" + } + }, + "operationId": "BillingPermissions_ListByDepartment", + "description": "Lists the billing permissions the caller has on a department.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/departmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPermissionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingPermissions": { + "get": { + "tags": [ + "BillingPermissions" + ], + "x-ms-examples": { + "EnrollmentAccountPermissionsList": { + "$ref": "./examples/EnrollmentAccountPermissionsList.json" + } + }, + "operationId": "BillingPermissions_ListByEnrollmentAccount", + "description": "Lists the billing permissions the caller has on an enrollment account.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPermissionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}": { "get": { "tags": [ @@ -3849,6 +3939,9 @@ "x-ms-examples": { "BillingAccountRoleDefinition": { "$ref": "./examples/BillingAccountRoleDefinition.json" + }, + "BillingAccountEaRoleDefinition": { + "$ref": "./examples/BillingAccountEaRoleDefinition.json" } }, "operationId": "BillingRoleDefinitions_GetByBillingAccount", @@ -3955,7 +4048,380 @@ "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/BillingRoleDefinition" + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions/{billingRoleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "DepartmentRoleDefinition": { + "$ref": "./examples/DepartmentRoleDefinition.json" + } + }, + "operationId": "BillingRoleDefinitions_GetByDepartment", + "description": "Gets the definition for a role on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/departmentNameParameter" + }, + { + "$ref": "#/parameters/billingRoleDefinitionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions/{billingRoleDefinitionName}": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "EnrollmentAccountRoleDefinition": { + "$ref": "./examples/EnrollmentAccountRoleDefinition.json" + } + }, + "operationId": "BillingRoleDefinitions_GetByEnrollmentAccount", + "description": "Gets the definition for a role on an enrollment account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountNameParameter" + }, + { + "$ref": "#/parameters/billingRoleDefinitionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinition" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "BillingAccountRoleDefinitionsList": { + "$ref": "./examples/BillingAccountRoleDefinitionsList.json" + }, + "BillingAccountEaRoleDefinitionsList": { + "$ref": "./examples/BillingAccountEaRoleDefinitionsList.json" + } + }, + "operationId": "BillingRoleDefinitions_ListByBillingAccount", + "description": "Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "InvoiceSectionRoleDefinitionsList": { + "$ref": "./examples/InvoiceSectionRoleDefinitionsList.json" + } + }, + "operationId": "BillingRoleDefinitions_ListByInvoiceSection", + "description": "Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "BillingProfileRoleDefinitionsList": { + "$ref": "./examples/BillingProfileRoleDefinitionsList.json" + } + }, + "operationId": "BillingRoleDefinitions_ListByBillingProfile", + "description": "Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "DepartmentRoleDefinitionsList": { + "$ref": "./examples/DepartmentRoleDefinitionsList.json" + } + }, + "operationId": "BillingRoleDefinitions_ListByDepartment", + "description": "Lists the role definitions for a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/departmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleDefinitions": { + "get": { + "tags": [ + "BillingRoleDefinitions" + ], + "x-ms-examples": { + "EnrollmentAccountRoleDefinitionsList": { + "$ref": "./examples/EnrollmentAccountRoleDefinitionsList.json" + } + }, + "operationId": "BillingRoleDefinitions_ListByEnrollmentAccount", + "description": "Lists the role definitions for a enrollmentAccount. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "get": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "BillingAccountRoleAssignment": { + "$ref": "./examples/BillingAccountRoleAssignment.json" + }, + "BillingAccountEaRoleAssignment": { + "$ref": "./examples/BillingAccountEaRoleAssignment.json" + } + }, + "operationId": "BillingRoleAssignments_GetByBillingAccount", + "description": "Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "BillingAccountRoleAssignmentDelete": { + "$ref": "./examples/BillingAccountRoleAssignmentDelete.json" + }, + "BillingAccountEaRoleAssignmentDelete": { + "$ref": "./examples/BillingAccountEaRoleAssignmentDelete.json" + } + }, + "operationId": "BillingRoleAssignments_DeleteByBillingAccount", + "description": "Deletes a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { @@ -3967,31 +4433,40 @@ } } }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleDefinitions": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "tags": [ - "BillingRoleDefinitions" + "BillingRoleAssignments" ], "x-ms-examples": { - "BillingAccountRoleDefinitionsList": { - "$ref": "./examples/BillingAccountRoleDefinitionsList.json" + "InvoiceSectionRoleAssignment": { + "$ref": "./examples/InvoiceSectionRoleAssignment.json" } }, - "operationId": "BillingRoleDefinitions_ListByBillingAccount", - "description": "Lists the role definitions for a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "operationId": "BillingRoleAssignments_GetByInvoiceSection", + "description": "Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" }, { "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/invoiceSectionNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/BillingRoleDefinitionListResult" + "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { @@ -4001,20 +4476,18 @@ } } } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleDefinitions": { - "get": { + }, + "delete": { "tags": [ - "BillingRoleDefinitions" + "BillingRoleAssignments" ], "x-ms-examples": { - "InvoiceSectionRoleDefinitionsList": { - "$ref": "./examples/InvoiceSectionRoleDefinitionsList.json" + "InvoiceSectionRoleAssignmentDelete": { + "$ref": "./examples/InvoiceSectionRoleAssignmentDelete.json" } }, - "operationId": "BillingRoleDefinitions_ListByInvoiceSection", - "description": "Lists the role definitions for an invoice section. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "operationId": "BillingRoleAssignments_DeleteByInvoiceSection", + "description": "Deletes a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -4027,13 +4500,16 @@ }, { "$ref": "#/parameters/invoiceSectionNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/BillingRoleDefinitionListResult" + "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { @@ -4045,18 +4521,18 @@ } } }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleDefinitions": { + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}": { "get": { "tags": [ - "BillingRoleDefinitions" + "BillingRoleAssignments" ], "x-ms-examples": { - "BillingProfileRoleDefinitionsList": { - "$ref": "./examples/BillingProfileRoleDefinitionsList.json" + "BillingProfileRoleAssignment": { + "$ref": "./examples/BillingProfileRoleAssignment.json" } }, - "operationId": "BillingRoleDefinitions_ListByBillingProfile", - "description": "Lists the role definitions for a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "operationId": "BillingRoleAssignments_GetByBillingProfile", + "description": "Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -4066,13 +4542,16 @@ }, { "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/billingRoleAssignmentNameParameter" } ], "responses": { "200": { "description": "OK. The request has succeeded.", "schema": { - "$ref": "#/definitions/BillingRoleDefinitionListResult" + "$ref": "#/definitions/BillingRoleAssignment" } }, "default": { @@ -4082,20 +4561,18 @@ } } } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": { - "get": { + }, + "delete": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { - "BillingAccountRoleAssignment": { - "$ref": "./examples/BillingAccountRoleAssignment.json" + "BillingProfileRoleAssignmentDelete": { + "$ref": "./examples/BillingProfileRoleAssignmentDelete.json" } }, - "operationId": "BillingRoleAssignments_GetByBillingAccount", - "description": "Gets a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "operationId": "BillingRoleAssignments_DeleteByBillingProfile", + "description": "Deletes a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -4103,6 +4580,9 @@ { "$ref": "#/parameters/billingAccountNameParameter" }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" } @@ -4121,18 +4601,20 @@ } } } - }, - "delete": { + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "get": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { - "BillingAccountRoleAssignmentDelete": { - "$ref": "./examples/BillingAccountRoleAssignmentDelete.json" + "DepartmentRoleAssignment": { + "$ref": "./examples/DepartmentRoleAssignment.json" } }, - "operationId": "BillingRoleAssignments_DeleteByBillingAccount", - "description": "Deletes a role assignment for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "operationId": "BillingRoleAssignments_GetByDepartment", + "description": "Gets a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -4140,6 +4622,9 @@ { "$ref": "#/parameters/billingAccountNameParameter" }, + { + "$ref": "#/parameters/departmentNameParameter" + }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" } @@ -4158,20 +4643,18 @@ } } } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/invoiceSections/{invoiceSectionName}/billingRoleAssignments/{billingRoleAssignmentName}": { - "get": { + }, + "delete": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { - "InvoiceSectionRoleAssignment": { - "$ref": "./examples/InvoiceSectionRoleAssignment.json" + "DepartmentRoleAssignmentDelete": { + "$ref": "./examples/DepartmentRoleAssignmentDelete.json" } }, - "operationId": "BillingRoleAssignments_GetByInvoiceSection", - "description": "Gets a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "operationId": "BillingRoleAssignments_DeleteByDepartment", + "description": "Deletes a role assignment for the caller on a department. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -4180,10 +4663,7 @@ "$ref": "#/parameters/billingAccountNameParameter" }, { - "$ref": "#/parameters/billingProfileNameParameter" - }, - { - "$ref": "#/parameters/invoiceSectionNameParameter" + "$ref": "#/parameters/departmentNameParameter" }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" @@ -4203,18 +4683,20 @@ } } } - }, - "delete": { + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments/{billingRoleAssignmentName}": { + "get": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { - "InvoiceSectionRoleAssignmentDelete": { - "$ref": "./examples/InvoiceSectionRoleAssignmentDelete.json" + "EnrollmentAccountRoleAssignment": { + "$ref": "./examples/EnrollmentAccountRoleAssignment.json" } }, - "operationId": "BillingRoleAssignments_DeleteByInvoiceSection", - "description": "Deletes a role assignment for the caller on an invoice section. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "operationId": "BillingRoleAssignments_GetByEnrollmentAccount", + "description": "Gets a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -4223,10 +4705,7 @@ "$ref": "#/parameters/billingAccountNameParameter" }, { - "$ref": "#/parameters/billingProfileNameParameter" - }, - { - "$ref": "#/parameters/invoiceSectionNameParameter" + "$ref": "#/parameters/enrollmentAccountNameParameter" }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" @@ -4246,20 +4725,18 @@ } } } - } - }, - "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/billingRoleAssignments/{billingRoleAssignmentName}": { - "get": { + }, + "delete": { "tags": [ "BillingRoleAssignments" ], "x-ms-examples": { - "BillingProfileRoleAssignment": { - "$ref": "./examples/BillingProfileRoleAssignment.json" + "EnrollmentAccountRoleAssignmentDelete": { + "$ref": "./examples/EnrollmentAccountRoleAssignmentDelete.json" } }, - "operationId": "BillingRoleAssignments_GetByBillingProfile", - "description": "Gets a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "operationId": "BillingRoleAssignments_DeleteByEnrollmentAccount", + "description": "Deletes a role assignment for the caller on a enrollment Account. The operation is supported only for billing accounts with agreement type Enterprise Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -4268,7 +4745,7 @@ "$ref": "#/parameters/billingAccountNameParameter" }, { - "$ref": "#/parameters/billingProfileNameParameter" + "$ref": "#/parameters/enrollmentAccountNameParameter" }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" @@ -4289,17 +4766,17 @@ } } }, - "delete": { + "put": { "tags": [ "BillingRoleAssignments" ], + "operationId": "EnrollmentAccountRoleAssignments_Put", + "description": "Create or update a billing role assignment.", "x-ms-examples": { - "BillingProfileRoleAssignmentDelete": { - "$ref": "./examples/BillingProfileRoleAssignmentDelete.json" + "PutEnrollmentAccountSubscriptionCreatorRoleAssignment": { + "$ref": "./examples/PutEnrollmentAccountSubscriptionCreatorRoleAssignment.json" } }, - "operationId": "BillingRoleAssignments_DeleteByBillingProfile", - "description": "Deletes a role assignment for the caller on a billing profile. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -4308,10 +4785,19 @@ "$ref": "#/parameters/billingAccountNameParameter" }, { - "$ref": "#/parameters/billingProfileNameParameter" + "$ref": "#/parameters/enrollmentAccountNameParameter" }, { "$ref": "#/parameters/billingRoleAssignmentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/BillingRoleAssignment" + }, + "description": "The new or updated billing role assignment." } ], "responses": { @@ -4338,10 +4824,13 @@ "x-ms-examples": { "BillingAccountRoleAssignmentList": { "$ref": "./examples/BillingAccountRoleAssignmentList.json" + }, + "BillingAccountEaRoleAssignmentList": { + "$ref": "./examples/BillingAccountEaRoleAssignmentList.json" } }, "operationId": "BillingRoleAssignments_ListByBillingAccount", - "description": "Lists the role assignments for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement or Microsoft Customer Agreement.", + "description": "Lists the role assignments for the caller on a billing account. The operation is supported for billing accounts with agreement type Microsoft Partner Agreement, Microsoft Customer Agreement or Enterprise Agreement.", "parameters": [ { "$ref": "#/parameters/apiVersionParameter" @@ -4363,6 +4852,9 @@ "$ref": "#/definitions/ErrorResponse" } } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" } } }, @@ -4591,6 +5083,90 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/departments/{departmentName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "DepartmentRoleAssignmentList": { + "$ref": "./examples/DepartmentRoleAssignmentList.json" + } + }, + "operationId": "BillingRoleAssignments_ListByDepartment", + "description": "Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts of type Enterprise Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/departmentNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/enrollmentAccounts/{enrollmentAccountName}/billingRoleAssignments": { + "get": { + "tags": [ + "BillingRoleAssignments" + ], + "x-ms-examples": { + "EnrollmentAccountRoleAssignmentList": { + "$ref": "./examples/EnrollmentAccountRoleAssignmentList.json" + } + }, + "operationId": "BillingRoleAssignments_ListByEnrollmentAccount", + "description": "Lists the role assignments for the caller on a billing profile. The operation is supported for billing accounts of type Enterprise Agreement.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/enrollmentAccountNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingRoleAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/agreements": { "get": { "tags": [ @@ -7388,6 +7964,11 @@ "items": { "$ref": "#/definitions/BillingRoleAssignment" } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true } } }, @@ -7425,6 +8006,11 @@ "type": "string", "readOnly": true }, + "createdByUserEmailAddress": { + "description": "The email address of the user who created the role assignment. This is supported only for billing accounts with agreement type Enterprise Agreement.", + "type": "string", + "readOnly": true + }, "name": { "description": "The name of the role assignment.", "type": "string", @@ -7432,18 +8018,28 @@ }, "principalId": { "description": "The principal id of the user to whom the role was assigned.", - "type": "string", - "readOnly": true + "type": "string" + }, + "principalTenantId": { + "description": "The principal tenant id of the user to whom the role was assigned.", + "type": "string" }, - "roleDefinitionName": { + "roleDefinitionId": { "description": "The ID of the role definition.", - "type": "string", - "readOnly": true + "type": "string" }, "scope": { "description": "The scope at which the role was assigned.", "type": "string", "readOnly": true + }, + "userEmailAddress": { + "description": "The email address of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement.", + "type": "string" + }, + "userAuthenticationType": { + "description": "The authentication type of the user, whether Organization or MSA, of the user to whom the role was assigned. This is supported only for billing accounts with agreement type Enterprise Agreement.", + "type": "string" } } }, @@ -7457,6 +8053,11 @@ "items": { "$ref": "#/definitions/BillingRoleDefinition" } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true } } }, @@ -7508,6 +8109,11 @@ "items": { "$ref": "#/definitions/BillingPermissionsProperties" } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true } } }, diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaPermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaPermissionsList.json new file mode 100644 index 000000000000..a4f00c0f0c5c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaPermissionsList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Billing/billingAccounts/write", + "Microsoft.Billing/billingAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentPolicies/read", + "Microsoft.Billing/billingAccounts/enrollmentPolicies/write", + "Microsoft.Billing/billingAccounts/enrollmentPolicies/action", + "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/read", + "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/write", + "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/action", + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/departments/action", + "Microsoft.Billing/billingAccounts/departments/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/action" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignment.json new file mode 100644 index 000000000000..9e492b704ba5 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignment.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "billingRoleAssignmentName": "{billingRoleAssignmentId}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleAssignments/b20266a0-3966-4283-bbb6-fb8ad761f08b", + "name": "b20266a0-3966-4283-bbb6-fb8ad761f08b", + "properties": { + "createdOn": "2018-11-28T07:00:08.87-08:00", + "createdByUserEmailAddress": "foo@microsoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/8608480", + "userAuthenticationType": "Organization", + "userEmailAddress": "bar@testea.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignmentDelete.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignmentDelete.json new file mode 100644 index 000000000000..65dce810230b --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignmentDelete.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "billingRoleAssignmentName": "b20266a0-3966-4283-bbb6-fb8ad761f08b" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleAssignments/b20266a0-3966-4283-bbb6-fb8ad761f08b", + "name": "b20266a0-3966-4283-bbb6-fb8ad761f08b", + "properties": { + "createdOn": "2018-11-28T07:00:08.87-08:00", + "createdByUserEmailAddress": "foo@microsoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/8608480", + "userAuthenticationType": "Organization", + "userEmailAddress": "bar@testea.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignmentList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignmentList.json new file mode 100644 index 000000000000..1fdd6ae34f43 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleAssignmentList.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleAssignments/b20266a0-3966-4283-bbb6-fb8ad761f08b", + "name": "b20266a0-3966-4283-bbb6-fb8ad761f08b", + "properties": { + "createdOn": "2018-11-28T07:00:08.87-08:00", + "createdByUserEmailAddress": "foo@microsoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/8608480", + "userAuthenticationType": "Organization", + "userEmailAddress": "bar@testea.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleAssignments/c20266a0-3966-4283-bbb6-fb8ad761f08b", + "name": "c20266a0-3966-4283-bbb6-fb8ad761f08b", + "properties": { + "createdOn": "2018-11-28T07:00:08.87-08:00", + "createdByUserEmailAddress": "foo@microsoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "scope": "/providers/Microsoft.Billing/billingAccounts/8608480", + "userAuthenticationType": "Organization", + "userEmailAddress": "baz@testea.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleDefinition.json new file mode 100644 index 000000000000..8fab788889c8 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleDefinition.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "billingRoleDefinitionName": "{billingRoleDefinitionName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleDefinitions/{billingRoleDefinitionName}", + "name": "{billingRoleDefinitionName}", + "properties": { + "description": "The enrollment administrator role gives the user all permissions including access management rights to an Enrollment and its departments and accounts.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Billing/billingAccounts/write", + "Microsoft.Billing/billingAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentPolicies/read", + "Microsoft.Billing/billingAccounts/enrollmentPolicies/write", + "Microsoft.Billing/billingAccounts/enrollmentPolicies/action", + "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/read", + "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/write", + "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/action", + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/departments/action", + "Microsoft.Billing/billingAccounts/departments/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/action" + ] + } + ], + "roleName": "Enrollment administrator" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleDefinitionsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleDefinitionsList.json new file mode 100644 index 000000000000..42f8fff48958 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/BillingAccountEaRoleDefinitionsList.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleDefinitions/9f1983cb-2574-400c-87e9-34cf8e2280db", + "name": "9f1983cb-2574-400c-87e9-34cf8e2280db", + "properties": { + "description": "The enrollment administrator role gives the user all permissions including access management rights to an Enrollment and its departments and accounts.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Billing/billingAccounts/write", + "Microsoft.Billing/billingAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentPolicies/read", + "Microsoft.Billing/billingAccounts/enrollmentPolicies/write", + "Microsoft.Billing/billingAccounts/enrollmentPolicies/action", + "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/read", + "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/write", + "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/action", + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/departments/action", + "Microsoft.Billing/billingAccounts/departments/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/action", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/delete", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/action" + ] + } + ], + "roleName": "Enrollment administrator" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/8608480/billingRoleDefinitions/24f8edb6-1668-4659-b5e2-40bb5f3a7d7e", + "name": "24f8edb6-1668-4659-b5e2-40bb5f3a7d7e", + "properties": { + "description": "The enrollment reader role gives the user read-only permissions to an Enrollment and its departments and accounts.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentPolicies/read", + "Microsoft.Billing/billingAccounts/enrollmentNotificationContacts/read", + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read" + ] + } + ], + "roleName": "Enrollment reader" + }, + "type": "Microsoft.Billing/billingAccounts/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentPermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentPermissionsList.json new file mode 100644 index 000000000000..f04ddbe9e449 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentPermissionsList.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "departmentName": "{departmentName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignment.json new file mode 100644 index 000000000000..700a91dfd1a7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignment.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "departmentName": "{departmentName}", + "billingRoleAssignmentName": "{billingRoleAssignmentName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleAssignments/bc818868-7ade-4dbe-9a02-d2bef6fddb2f", + "name": "bc818868-7ade-4dbe-9a02-d2bef6fddb2f", + "properties": { + "createdOn": "2019-06-28T19:19:45.5380644+00:00", + "createdByUserEmailAddress": "e_admin@billtest900006.onmicrosoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleDefinitions/fb2cf67f-be5b-42e7-8025-4683c668f840", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603", + "userAuthenticationType": "Organization", + "userEmailAddress": "d_admin@billtest900006.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignmentDelete.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignmentDelete.json new file mode 100644 index 000000000000..700a91dfd1a7 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignmentDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "departmentName": "{departmentName}", + "billingRoleAssignmentName": "{billingRoleAssignmentName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleAssignments/bc818868-7ade-4dbe-9a02-d2bef6fddb2f", + "name": "bc818868-7ade-4dbe-9a02-d2bef6fddb2f", + "properties": { + "createdOn": "2019-06-28T19:19:45.5380644+00:00", + "createdByUserEmailAddress": "e_admin@billtest900006.onmicrosoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleDefinitions/fb2cf67f-be5b-42e7-8025-4683c668f840", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603", + "userAuthenticationType": "Organization", + "userEmailAddress": "d_admin@billtest900006.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignmentList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignmentList.json new file mode 100644 index 000000000000..88b8ca3cd9bf --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleAssignmentList.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "departmentName": "{departmentName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleAssignments/bc818868-7ade-4dbe-9a02-d2bef6fddb2f", + "name": "bc818868-7ade-4dbe-9a02-d2bef6fddb2f", + "properties": { + "createdOn": "2019-06-28T19:19:45.5380644+00:00", + "createdByUserEmailAddress": "e_admin@billtest900006.onmicrosoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleDefinitions/fb2cf67f-be5b-42e7-8025-4683c668f840", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603", + "userAuthenticationType": "Organization", + "userEmailAddress": "d_admin@billtest900006.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleAssignments/af1239f3-15d9-4faf-800a-673882134d9f", + "name": "af1239f3-15d9-4faf-800a-673882134d9f", + "properties": { + "createdOn": "2019-06-28T19:20:04.1301372+00:00", + "createdByUserEmailAddress": "e_admin@billtest900006.onmicrosoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleDefinitions/db609904-a47f-4794-9be8-9bd86fbffd8a", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603", + "userAuthenticationType": "Organization", + "userEmailAddress": "d_reader@billtest900006.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleDefinition.json new file mode 100644 index 000000000000..e6fa37a3cc86 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleDefinition.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "departmentName": "{departmentName}", + "billingRoleDefinitionName": "{billingRoleDefinitionName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleDefinitions/fb2cf67f-be5b-42e7-8025-4683c668f840", + "name": "fb2cf67f-be5b-42e7-8025-4683c668f840", + "properties": { + "description": "The department administrator role gives the user read/write permissions including access management rights to an Enrollment Department and its accounts.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write" + ] + } + ], + "roleName": "Department administrator" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleDefinitionsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleDefinitionsList.json new file mode 100644 index 000000000000..66508e6e2c86 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/DepartmentRoleDefinitionsList.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "departmentName": "{departmentName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleDefinitions/fb2cf67f-be5b-42e7-8025-4683c668f840", + "name": "fb2cf67f-be5b-42e7-8025-4683c668f840", + "properties": { + "description": "The department administrator role gives the user read/write permissions including access management rights to an Enrollment Department and its accounts.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/departments/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write" + ] + } + ], + "roleName": "Department administrator" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/departments/97603/billingRoleDefinitions/db609904-a47f-4794-9be8-9bd86fbffd8a", + "name": "db609904-a47f-4794-9be8-9bd86fbffd8a", + "properties": { + "description": "The department reader role gives the user read-only permissions to an Enrollment Department and its accounts.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/departments/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read" + ] + } + ], + "roleName": "Department reader" + }, + "type": "Microsoft.Billing/billingAccounts/departments/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountPermissionsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountPermissionsList.json new file mode 100644 index 000000000000..19a9f23a6435 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountPermissionsList.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "enrollmentAccountName": "{enrollmentAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write" + ], + "notActions": [] + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignment.json new file mode 100644 index 000000000000..a29fac860edc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignment.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "enrollmentAccountName": "{enrollmentAccountName}", + "billingRoleAssignmentName": "{billingRoleAssignmentName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2019-06-28T19:11:50.6168809+00:00", + "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314", + "userAuthenticationType": "Organization", + "userEmailAddress": "a_owner@billtest900006.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignmentDelete.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignmentDelete.json new file mode 100644 index 000000000000..a29fac860edc --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignmentDelete.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "enrollmentAccountName": "{enrollmentAccountName}", + "billingRoleAssignmentName": "{billingRoleAssignmentName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2019-06-28T19:11:50.6168809+00:00", + "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314", + "userAuthenticationType": "Organization", + "userEmailAddress": "a_owner@billtest900006.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignmentList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignmentList.json new file mode 100644 index 000000000000..b0f01792a6be --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleAssignmentList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "enrollmentAccountName": "{enrollmentAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2019-06-28T19:11:50.6168809+00:00", + "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314", + "userAuthenticationType": "Organization", + "userEmailAddress": "a_owner@billtest900006.onmicrosoft.com" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleAssignments/56fba638-e6d7-4b66-a051-1ba543b15360", + "name": "56fba638-e6d7-4b66-a051-1ba543b15360", + "properties": { + "createdOn": "2020-05-31T22:51:21.3629303+00:00", + "createdByUserEmailAddress": "test@billtest900006.onmicrosoft.com", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/a0bcee42-bf30-4d1b-926a-48d21664ef71", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleDefinition.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleDefinition.json new file mode 100644 index 000000000000..e9637255739e --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleDefinition.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "enrollmentAccountName": "{enrollmentAccountName}", + "billingRoleDefinitionName": "{billingRoleDefinitionName}" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "name": "c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "properties": { + "description": "The account owner role gives the user read/write permissions to an Enrollment Account.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write" + ] + } + ], + "roleName": "Enrollment account owner" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions" + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleDefinitionsList.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleDefinitionsList.json new file mode 100644 index 000000000000..904a81a37915 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/EnrollmentAccountRoleDefinitionsList.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "enrollmentAccountName": "{enrollmentAccountName}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "name": "c15c22c0-9faf-424c-9b7e-bd91c06a240b", + "properties": { + "description": "The account owner role gives the user read/write permissions to an Enrollment Account.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/write", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/read", + "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingSubscriptions/write" + ] + } + ], + "roleName": "Enrollment account owner" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions" + }, + { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/a0bcee42-bf30-4d1b-926a-48d21664ef71", + "name": "a0bcee42-bf30-4d1b-926a-48d21664ef71", + "properties": { + "description": "The enrollent account subscription creator role gives the user permissions to create a subscription under the enrollment account.", + "permissions": [ + { + "actions": [ + "Microsoft.Billing/billingAccounts/enrollmentAccounts/read", + "Microsoft.Subscription/subscriptions/write" + ] + } + ], + "roleName": "Enrollment account subscription creator" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleDefinitions" + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/PutEnrollmentAccountSubscriptionCreatorRoleAssignment.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/PutEnrollmentAccountSubscriptionCreatorRoleAssignment.json new file mode 100644 index 000000000000..e5d3b2ed0dae --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/PutEnrollmentAccountSubscriptionCreatorRoleAssignment.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "enrollmentAccountName": "{enrollmentAccountName}", + "billingRoleAssignmentName": "{billingRoleAssignmentName}", + "parameters": { + "properties": { + "principalId": "99a1a759-30dd-42c2-828c-db398826bb67", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/a0bcee42-bf30-4d1b-926a-48d21664ef71" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleAssignments/9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "name": "9dfd08c2-62a3-4d47-85bd-1cdba1408402", + "properties": { + "createdOn": "2019-06-28T19:11:50.6168809+00:00", + "createdByPrincipalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "createdByPrincipalId": "60d97094-2be4-46cc-a4fe-3633021a25b9", + "principalId": "99a1a759-30dd-42c2-828c-db398826bb67", + "principalTenantId": "7ca289b9-c32d-4f01-8566-7ff93261d76f", + "roleDefinitionId": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314/billingRoleDefinitions/a0bcee42-bf30-4d1b-926a-48d21664ef71", + "scope": "/providers/Microsoft.Billing/billingAccounts/7898901/enrollmentAccounts/225314" + }, + "type": "Microsoft.Billing/billingAccounts/enrollmentAccounts/billingRoleAssignments" + } + } + } +} From 425f426ba64c0fef22b0b3bedfdbf772a294bbbf Mon Sep 17 00:00:00 2001 From: Tanyi Chen Date: Thu, 18 Jun 2020 12:45:14 +0800 Subject: [PATCH 169/318] update java readme digitaltwins (#9878) --- .../resource-manager/readme.java.md | 33 +++++++++++++++++++ .../digitaltwins/resource-manager/readme.md | 4 +++ 2 files changed, 37 insertions(+) create mode 100644 specification/digitaltwins/resource-manager/readme.java.md diff --git a/specification/digitaltwins/resource-manager/readme.java.md b/specification/digitaltwins/resource-manager/readme.java.md new file mode 100644 index 000000000000..14298c23e4ee --- /dev/null +++ b/specification/digitaltwins/resource-manager/readme.java.md @@ -0,0 +1,33 @@ +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.digitaltwins +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-digitaltwins +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2020-03-01-preview +``` + +### Tag: package-2020-03-01-preview and java + +These settings apply only when `--tag=package-2020-03-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-03-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.digitaltwins.v2020_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/digitaltwins/mgmt-v2020_03_01_preview +regenerate-manager: true +generate-interface: true +``` diff --git a/specification/digitaltwins/resource-manager/readme.md b/specification/digitaltwins/resource-manager/readme.md index 7e6c12494037..dcdba572a32c 100644 --- a/specification/digitaltwins/resource-manager/readme.md +++ b/specification/digitaltwins/resource-manager/readme.md @@ -78,6 +78,10 @@ See configuration in [readme.typescript.md](./readme.typescript.md) See configuration in [readme.csharp.md](./readme.csharp.md) +## Java + +See configuration in [readme.java.md](./readme.java.md) + ## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. From 405bef91bc72574ff74907fc9603426168758a9f Mon Sep 17 00:00:00 2001 From: Claire Chen Date: Wed, 17 Jun 2020 22:47:41 -0700 Subject: [PATCH 170/318] Update Attestation control plane swagger to include 2 new defaultprovider API (#9819) * default provider update * fix space * run prettier check * address cr comments * runner prettier * rerun prettier * change get default provider to be subscription level api --- .../2018-09-01-preview/attestation.json | 80 +++++++++++++++++++ .../Get_DefaultProviderByLocation.json | 22 +++++ .../examples/Get_DefaultProviders.json | 36 +++++++++ 3 files changed, 138 insertions(+) create mode 100644 specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_DefaultProviderByLocation.json create mode 100644 specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_DefaultProviders.json diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json index 3813af740c8c..9a6aff8f2069 100644 --- a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/attestation.json @@ -341,6 +341,86 @@ } } } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Attestation/defaultProviders": { + "get": { + "tags": [ + "AttestationProviders" + ], + "operationId": "AttestationProviders_ListDefault", + "description": "Get the default provider", + "x-ms-examples": { + "AttestationProviders_GetDefault": { + "$ref": "./examples/Get_DefaultProviders.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about the default provider.", + "schema": { + "$ref": "#/definitions/AttestationProviderListResult" + } + }, + "default": { + "description": "Attestation service error result", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Attestation/locations/{location}/defaultProvider": { + "get": { + "tags": [ + "AttestationProviders" + ], + "operationId": "AttestationProviders_GetDefaultByLocation", + "description": "Get the default provider by location.", + "x-ms-examples": { + "AttestationProviders_GetDefaultWithLocation": { + "$ref": "./examples/Get_DefaultProviderByLocation.json" + } + }, + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "description": "The location of the default provider." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Retrieved information about the default provider.", + "schema": { + "$ref": "#/definitions/AttestationProvider" + } + }, + "default": { + "description": "Attestation service error result", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } } }, "definitions": { diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_DefaultProviderByLocation.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_DefaultProviderByLocation.json new file mode 100644 index 000000000000..b32bef265455 --- /dev/null +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_DefaultProviderByLocation.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "6c96b33e-f5b8-40a6-9011-5cb1c58b0915", + "api-version": "2018-09-01-preview", + "location": "Central US" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Attestation/attestationProviders/sharedcus", + "name": "sharedcus", + "type": "Microsoft.Attestation/attestationProviders", + "location": "Central US", + "properties": { + "trustModel": "AAD", + "status": "Ready", + "attestUri": "https://sharedcus.cus.attest.azure.net" + } + } + } + } +} diff --git a/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_DefaultProviders.json b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_DefaultProviders.json new file mode 100644 index 000000000000..5d39d2b7e646 --- /dev/null +++ b/specification/attestation/resource-manager/Microsoft.Attestation/preview/2018-09-01-preview/examples/Get_DefaultProviders.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "6c96b33e-f5b8-40a6-9011-5cb1c58b0915", + "api-version": "2018-09-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Attestation/attestationProviders/sharedcus", + "name": "sharedcus", + "type": "Microsoft.Attestation/attestationProviders", + "location": "Central US", + "properties": { + "trustModel": "AAD", + "status": "Ready", + "attestUri": "https://sharedcus.cus.attest.azure.net" + } + }, + { + "id": "providers/Microsoft.Attestation/attestationProviders/shareduks", + "name": "shareduks", + "type": "Microsoft.Attestation/attestationProviders", + "location": "UK South", + "properties": { + "trustModel": "AAD", + "status": "Ready", + "attestUri": "https://shareduks.uks.attest.azure.net" + } + } + ] + } + } + } +} From 8f388680fe4ff8d37c88359eccedbf247e1dfbca Mon Sep 17 00:00:00 2001 From: Josephine Qiu Date: Thu, 18 Jun 2020 17:45:21 +0800 Subject: [PATCH 171/318] Update ci-fix.md (#9881) add suppression process section at the bottom --- documentation/ci-fix.md | 3 +++ 1 file changed, 3 insertions(+) diff --git a/documentation/ci-fix.md b/documentation/ci-fix.md index c566c7a67908..ec5dc0e5625c 100644 --- a/documentation/ci-fix.md +++ b/documentation/ci-fix.md @@ -91,3 +91,6 @@ Note: When running in Swagger PR pipeline, Avocado only report errors with file Refer to [Avocado Readme](https://github.com/Azure/avocado/blob/master/README.md) for detailed description of validations and how-to-fix guidance. +## Suppression Process + +In case there are validation errors reported against your service that you believe do not apply, we have a suppression process you can follow to permanently remove these reported errors for your specs. Refer to [Swagger Suppression Process](https://dev.azure.com/azure-sdk/internal/_wiki/wikis/internal.wiki/85/Swagger-Suppression-Process) for detailed guidance. From 4b2aa12fe415caa4ea0148372466fc15d006d37e Mon Sep 17 00:00:00 2001 From: irrogozh Date: Thu, 18 Jun 2020 05:17:46 -0700 Subject: [PATCH 172/318] =?UTF-8?q?BUG=20FIX:=20Fixed=20HopLink=20properti?= =?UTF-8?q?es:=20context=20should=20be=20a=20dictionary,=20uint32=20from?= =?UTF-8?q?=E2=80=A6=20(#9868)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * Fixed HopLink properties: context should be a dictionary, uint32 fromat instead of int32 * removed format for RoundTripTime --- .../stable/2020-05-01/networkWatcher.json | 11 ++++------- 1 file changed, 4 insertions(+), 7 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkWatcher.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkWatcher.json index edeedd8b860e..0166ba1b75e7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkWatcher.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/networkWatcher.json @@ -3397,10 +3397,10 @@ }, "context": { "readOnly": true, - "type": "array", - "description": "Provides additional context on the issue.", - "items": { - "$ref": "#/definitions/IssueContext" + "type": "object", + "description": "Provides additional context on links.", + "additionalProperties": { + "type": "string" } }, "resourceId": { @@ -3416,19 +3416,16 @@ "roundTripTimeMin": { "description": "Minimum roundtrip time in milliseconds.", "readOnly": true, - "format": "int32", "type": "integer" }, "roundTripTimeAvg": { "description": "Average roundtrip time in milliseconds.", "readOnly": true, - "format": "int32", "type": "integer" }, "roundTripTimeMax": { "description": "Maximum roundtrip time in milliseconds.", "readOnly": true, - "format": "int32", "type": "integer" } } From fd95d201491901bb70fa54902eec1db7f2bb8e55 Mon Sep 17 00:00:00 2001 From: shahbj79 Date: Thu, 18 Jun 2020 05:56:11 -0700 Subject: [PATCH 173/318] Microsoft.Support RP documentation updates (#9880) * support rp swagger for public preview * fixing spelling error * addressing review comments * adding common resource properties * fixing readme.csharp.md * adding example that was missed * fix syntax error in swagger spec * fixing model validation error * put support for communication resource and other updates based on comments * updating communication to be async, fixing version on async and location headers * updating documentation and examples * fixing spelling error * ran prettier fix and addressing review comments * documentation updates * documentation update Co-authored-by: Bhavin Shah --- .../preview/2019-05-01-preview/support.json | 6 +- .../CreateSqlManagedInstanceQuotaTicket.json | 100 ++++++++++++++++++ .../stable/2020-04-01/support.json | 11 +- 3 files changed, 110 insertions(+), 7 deletions(-) create mode 100644 specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/CreateSqlManagedInstanceQuotaTicket.json diff --git a/specification/support/resource-manager/Microsoft.Support/preview/2019-05-01-preview/support.json b/specification/support/resource-manager/Microsoft.Support/preview/2019-05-01-preview/support.json index 7f5478e7d80c..8bc987f3f6f3 100644 --- a/specification/support/resource-manager/Microsoft.Support/preview/2019-05-01-preview/support.json +++ b/specification/support/resource-manager/Microsoft.Support/preview/2019-05-01-preview/support.json @@ -286,7 +286,7 @@ "tags": [ "SupportTickets" ], - "description": "Lists all the support tickets for an Azure subscription.

You can also filter the support tickets by Status or CreatedDate using the $filter parameter. Output will be a paged result with nextLink, using which you can retrieve the next set of support tickets.

Support ticket data is available for 12 months after ticket creation. If a ticket was created more than 12 months ago, a request for data might cause an error.", + "description": "Lists all the support tickets for an Azure subscription.

You can also filter the support tickets by Status or CreatedDate using the $filter parameter. Output will be a paged result with nextLink, using which you can retrieve the next set of support tickets.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", "operationId": "SupportTickets_List", "parameters": [ { @@ -345,7 +345,7 @@ "tags": [ "SupportTickets" ], - "description": "Gets details for a specific support ticket in an Azure subscription.

Support ticket data is available for 12 months after ticket creation. If a ticket was created more than 12 months ago, a request for data might cause an error.", + "description": "Gets details for a specific support ticket in an Azure subscription.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", "operationId": "SupportTickets_Get", "parameters": [ { @@ -589,7 +589,7 @@ "tags": [ "Communications" ], - "description": "Lists all communications (attachments not included) for a support ticket.

You can also filter support ticket communications by CreatedDate�or CommunicationType using the $filter parameter. The only type of communication supported today is Web. Output will be a paged result with nextLink, using which you can retrieve the next set of Communication results.

Support ticket data is available for 12 months after ticket creation. If a ticket was created more than 12 months ago, a request for data might cause an error.", + "description": "Lists all communications (attachments not included) for a support ticket.

You can also filter support ticket communications by CreatedDate�or CommunicationType using the $filter parameter. The only type of communication supported today is Web. Output will be a paged result with nextLink, using which you can retrieve the next set of Communication results.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", "operationId": "Communications_List", "parameters": [ { diff --git a/specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/CreateSqlManagedInstanceQuotaTicket.json b/specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/CreateSqlManagedInstanceQuotaTicket.json new file mode 100644 index 000000000000..8a92e986a09e --- /dev/null +++ b/specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/examples/CreateSqlManagedInstanceQuotaTicket.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "supportTicketName": "testticket", + "api-version": "2020-04-01", + "createSupportTicketParameters": { + "properties": { + "serviceId": "/providers/Microsoft.Support/services/quota_service_guid", + "title": "my title", + "description": "my description", + "problemClassificationId": "/providers/Microsoft.Support/services/quota_service_guid/problemClassifications/sql_managedinstance_problemClassification_guid", + "severity": "moderate", + "contactDetails": { + "firstName": "abc", + "lastName": "xyz", + "primaryEmailAddress": "abc@contoso.com", + "preferredContactMethod": "email", + "preferredTimeZone": "Pacific Standard Time", + "preferredSupportLanguage": "en-US", + "country": "usa" + }, + "quotaTicketDetails": { + "quotaChangeRequestVersion": "1.0", + "quotaChangeRequestSubType": "SQLMI", + "quotaChangeRequests": [ + { + "region": "EastUS", + "payload": "{\"NewLimit\":200, \"Metadata\":null, \"Type\":\"vCore\"}" + }, + { + "region": "EastUS", + "payload": "{\"NewLimit\":200, \"Metadata\":null, \"Type\":\"Subnet\"}" + } + ] + } + } + } + }, + "responses": { + "202": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/operationResults/operationid?api-version=2020-04-01", + "azure-asyncoperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.Support/operationsStatus/operationid?api-version=2020-04-01" + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.Support/supportTickets/testticket", + "name": "testticket", + "type": "Microsoft.Support/supportTickets", + "properties": { + "supportTicketId": "119120321001170", + "description": "my description", + "problemClassificationId": "/providers/Microsoft.Support/services/quota_service_guid/problemClassifications/sql_datawarehouse_problemClassification_guid", + "problemClassificationDisplayName": "SQL Database Managed Instance", + "severity": "moderate", + "require24X7Response": false, + "contactDetails": { + "firstName": "abc", + "lastName": "xyz", + "preferredContactMethod": "email", + "primaryEmailAddress": "abc@contoso.com", + "preferredTimeZone": "Pacific Standard Time", + "country": "usa", + "preferredSupportLanguage": "en-US" + }, + "quotaTicketDetails": { + "quotaChangeRequestVersion": "1.0", + "quotaChangeRequestSubType": "SQLMI", + "quotaChangeRequests": [ + { + "region": "EastUS", + "payload": "{\"NewLimit\":200, \"Metadata\":null, \"Type\":\"vCore\"}" + }, + { + "region": "EastUS", + "payload": "{\"NewLimit\":200, \"Metadata\":null, \"Type\":\"Subnet\"}" + } + ] + }, + "serviceLevelAgreement": { + "startTime": "2020-03-20T21:36:18Z", + "expirationTime": "2020-03-21T17:36:18Z", + "slaMinutes": 240 + }, + "supportEngineer": { + "emailAddress": null + }, + "supportPlanType": "Premier", + "title": "my title", + "serviceId": "/providers/Microsoft.Support/services/quota_service_guid", + "serviceDisplayName": "Service and subscription limits (quotas)", + "status": "Open", + "createdDate": "2020-03-20T21:36:18Z", + "modifiedDate": "2020-03-20T21:36:23Z" + } + } + } + } +} diff --git a/specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/support.json b/specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/support.json index 1ced78a858a1..c68263506e7c 100644 --- a/specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/support.json +++ b/specification/support/resource-manager/Microsoft.Support/stable/2020-04-01/support.json @@ -286,7 +286,7 @@ "tags": [ "SupportTickets" ], - "description": "Lists all the support tickets for an Azure subscription. You can also filter the support tickets by _Status_ or _CreatedDate_ using the $filter parameter. Output will be a paged result with _nextLink_, using which you can retrieve the next set of support tickets.

Support ticket data is available for 12 months after ticket creation. If a ticket was created more than 12 months ago, a request for data might cause an error.", + "description": "Lists all the support tickets for an Azure subscription. You can also filter the support tickets by _Status_ or _CreatedDate_ using the $filter parameter. Output will be a paged result with _nextLink_, using which you can retrieve the next set of support tickets.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", "operationId": "SupportTickets_List", "parameters": [ { @@ -345,7 +345,7 @@ "tags": [ "SupportTickets" ], - "description": "Get ticket details for an Azure subscription. Support ticket data is available for 12 months after ticket creation. If a ticket was created more than 12 months ago, a request for data might cause an error.", + "description": "Get ticket details for an Azure subscription. Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", "operationId": "SupportTickets_Get", "parameters": [ { @@ -535,6 +535,9 @@ "Create a ticket to request Quota increase for Low-priority cores for Machine Learning service": { "$ref": "./examples/CreateMachineLearningQuotaTicketForLowPriorityCores.json" }, + "Create a ticket to request Quota increase for Azure SQL managed instance": { + "$ref": "./examples/CreateSqlManagedInstanceQuotaTicket.json" + }, "Create a ticket to request Quota increase for services that do not require additional details in the quotaTicketDetails object": { "$ref": "./examples/CreateGenericQuotaTicket.json" } @@ -598,7 +601,7 @@ "tags": [ "Communications" ], - "description": "Lists all communications (attachments not included) for a support ticket.

You can also filter support ticket communications by _CreatedDate_ or _CommunicationType_ using the $filter parameter. The only type of communication supported today is _Web_. Output will be a paged result with _nextLink_, using which you can retrieve the next set of Communication results.

Support ticket data is available for 12 months after ticket creation. If a ticket was created more than 12 months ago, a request for data might cause an error.", + "description": "Lists all communications (attachments not included) for a support ticket.

You can also filter support ticket communications by _CreatedDate_ or _CommunicationType_ using the $filter parameter. The only type of communication supported today is _Web_. Output will be a paged result with _nextLink_, using which you can retrieve the next set of Communication results.

Support ticket data is available for 18 months after ticket creation. If a ticket was created more than 18 months ago, a request for data might cause an error.", "operationId": "Communications_List", "parameters": [ { @@ -1147,7 +1150,7 @@ "readOnly": true }, "severity": { - "description": "A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact' severity is reserved only for our Premium customers.", + "description": "A value that indicates the urgency of the case, which in turn determines the response time according to the service level agreement of the technical support plan you have with Azure. Note: 'Highest critical impact', also known as the 'Emergency - Severe impact' level in the Azure portal is reserved only for our Premium customers.", "enum": [ "minimal", "moderate", From 42be68e2d89acffaac477b9228ce15e6043cd55e Mon Sep 17 00:00:00 2001 From: Arthur Ning <57385816+akning-ms@users.noreply.github.com> Date: Thu, 18 Jun 2020 20:57:46 +0800 Subject: [PATCH 174/318] Fix typo in common private links definition for actionsRequired (#9727) * Add FAQ document * Fix typo & change MV descriptions * fix ci-fix url * Change SDK generation * Fix typo in common private links definition * fix actionsRequired typo for Storage example * restore storage.json to use local defintion * Changeback example files * Fix types.json ref * fix types.json ref --- .../resource-management/v1/privatelinks.json | 2 +- .../stable/2019-06-01/privatelinks.json | 174 ++++++++++++++++++ .../stable/2019-06-01/storage.json | 12 +- 3 files changed, 181 insertions(+), 7 deletions(-) create mode 100644 specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/privatelinks.json diff --git a/specification/common-types/resource-management/v1/privatelinks.json b/specification/common-types/resource-management/v1/privatelinks.json index d6cb94988421..91e640b03feb 100644 --- a/specification/common-types/resource-management/v1/privatelinks.json +++ b/specification/common-types/resource-management/v1/privatelinks.json @@ -61,7 +61,7 @@ "type": "string", "description": "The reason for approval/rejection of the connection." }, - "actionRequired": { + "actionsRequired": { "type": "string", "description": "A message indicating if changes on the service provider require any updates on the consumer." } diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/privatelinks.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/privatelinks.json new file mode 100644 index 000000000000..5997c5274600 --- /dev/null +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/privatelinks.json @@ -0,0 +1,174 @@ +{ + "swagger": "2.0", + "info": { + "version": "1.0", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "PrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "PrivateEndpointConnectionListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private endpoint connections", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + }, + "description": "List of private endpoint connection associated with the specified storage account" + }, + "PrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + } + }, + "parameters": { + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the Azure resource", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json index 9416555d58d2..19d992139d87 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json @@ -845,7 +845,7 @@ "200": { "description": "OK -- Successfully retrieved private endpoint connections.", "schema": { - "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnectionListResult" } } }, @@ -887,7 +887,7 @@ "200": { "description": "OK -- Get the private endpoint connection properties successfully.", "schema": { - "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection" } }, "default": { @@ -930,7 +930,7 @@ "in": "body", "required": true, "schema": { - "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection" }, "description": "The private endpoint connection properties." } @@ -939,7 +939,7 @@ "200": { "description": "OK -- Update the private endpoint connection properties successfully.", "schema": { - "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection" } }, "default": { @@ -1024,7 +1024,7 @@ "200": { "description": "Successfully retrieved private link resources.", "schema": { - "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult" + "$ref": "./privatelinks.json#/definitions/PrivateLinkResourceListResult" } } } @@ -2552,7 +2552,7 @@ "readOnly": true, "type": "array", "items": { - "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + "$ref": "./privatelinks.json#/definitions/PrivateEndpointConnection" }, "description": "List of private endpoint connection associated with the specified storage account" }, From baa07635f40af79477f0ed1859c301da1f7e6539 Mon Sep 17 00:00:00 2001 From: Abyssknight <501835725@qq.com> Date: Fri, 19 Jun 2020 09:19:17 +0800 Subject: [PATCH 175/318] change vmware client name to AVSClient (#9863) Co-authored-by: Shixun Guan --- specification/vmware/resource-manager/readme.python.md | 10 ++++++---- .../vmware/resource-manager/readme.typescript.md | 5 +++-- 2 files changed, 9 insertions(+), 6 deletions(-) diff --git a/specification/vmware/resource-manager/readme.python.md b/specification/vmware/resource-manager/readme.python.md index 1e2c6c36803d..272675865581 100644 --- a/specification/vmware/resource-manager/readme.python.md +++ b/specification/vmware/resource-manager/readme.python.md @@ -6,22 +6,24 @@ Use `--python-mode=update` if you already have a setup.py and just want to updat ```yaml $(python) python-mode: create + python: package-version: 0.1.0 azure-arm: true license-header: MICROSOFT_MIT_NO_VERSION payload-flattening-threshold: 2 - namespace: azure.mgmt.vmware - package-name: azure-mgmt-vmware + override-client-name: AVSClient + namespace: azure.mgmt.avs + package-name: azure-mgmt-avs clear-output-folder: true ``` ``` yaml $(python) && $(python-mode) == 'update' python: no-namespace-folders: true - output-folder: $(python-sdks-folder)/compute/azure-mgmt-vmware/azure/mgmt/vmware + output-folder: $(python-sdks-folder)/compute/azure-mgmt-avs/azure/mgmt/avs ``` ``` yaml $(python) && $(python-mode) == 'create' python: basic-setup-py: true - output-folder: $(python-sdks-folder)/compute/azure-mgmt-vmware + output-folder: $(python-sdks-folder)/compute/azure-mgmt-avs ``` diff --git a/specification/vmware/resource-manager/readme.typescript.md b/specification/vmware/resource-manager/readme.typescript.md index 6dc60494b88d..c6984e869dc1 100644 --- a/specification/vmware/resource-manager/readme.typescript.md +++ b/specification/vmware/resource-manager/readme.typescript.md @@ -7,8 +7,9 @@ Please also specify `--typescript-sdks-folder= Date: Fri, 19 Jun 2020 05:01:07 +0300 Subject: [PATCH 176/318] LaMigrationDate (#9882) --- .../preview/2020-02-02-preview/components_API.json | 6 ++++++ 1 file changed, 6 insertions(+) diff --git a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json index c8606af89280..574b88250e5d 100644 --- a/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json +++ b/specification/applicationinsights/resource-manager/Microsoft.Insights/preview/2020-02-02-preview/components_API.json @@ -509,6 +509,12 @@ "type": "string", "description": "ResourceId of the log analytics workspace which the data will be ingested to." }, + "LaMigrationDate": { + "type": "string", + "readOnly": true, + "description": "The date which the component got migrated to LA, in ISO 8601 format.", + "format": "date-time" + }, "PrivateLinkScopedResources": { "readOnly": true, "type": "array", From 82f599660e7ac7203bd30cc982992bcb351b1aae Mon Sep 17 00:00:00 2001 From: Cameron Taggart Date: Thu, 18 Jun 2020 20:07:46 -0600 Subject: [PATCH 177/318] add Java to AVS (#9855) * add Java to AVS * add Java multi-api & tag --- .../vmware/resource-manager/readme.java.md | 33 +++++++++++++++++++ .../vmware/resource-manager/readme.md | 5 +++ 2 files changed, 38 insertions(+) create mode 100644 specification/vmware/resource-manager/readme.java.md diff --git a/specification/vmware/resource-manager/readme.java.md b/specification/vmware/resource-manager/readme.java.md new file mode 100644 index 000000000000..4d9b9ee0af9b --- /dev/null +++ b/specification/vmware/resource-manager/readme.java.md @@ -0,0 +1,33 @@ +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +java: + azure-arm: true + namespace: com.microsoft.azure.management.avs + override-client-name: AvsClient + license-header: MICROSOFT_MIT_NO_CODEGEN + output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-avs +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2019-08-09-preview +``` + +### Tag: package-2019-08-09-preview and java + +These settings apply only when `--tag=package-2019-08-09 --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2019-08-09-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.avs.v2019_08_09_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/avs/mgmt-v2019_08_09_preview +regenerate-manager: true +generate-interface: true +``` \ No newline at end of file diff --git a/specification/vmware/resource-manager/readme.md b/specification/vmware/resource-manager/readme.md index 94e25f8fd487..89553bfed17c 100644 --- a/specification/vmware/resource-manager/readme.md +++ b/specification/vmware/resource-manager/readme.md @@ -57,6 +57,7 @@ swagger-to-sdk: - repo: azure-sdk-for-python - repo: azure-sdk-for-net - repo: azure-sdk-for-go + - repo: azure-sdk-for-java ``` ## TypeScript @@ -75,6 +76,10 @@ See configuration in [readme.csharp.md](./readme.csharp.md) See configuration in [readme.go.md](./readme.go.md) +## Java + +See configuration in [readme.java.md](./readme.java.md) + ## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. From ae8d69cc6c78331c24b13951979bf171bf132d26 Mon Sep 17 00:00:00 2001 From: Novin Date: Sat, 20 Jun 2020 05:15:45 -0700 Subject: [PATCH 178/318] [Hub Generated] Review request for Microsoft.ContainerInstance to add version stable/2019-12-01 (#9838) --- .../stable/2019-12-01/containerInstance.json | 2064 +++++++++++++++++ .../2019-12-01/examples/CachedImagesList.json | 27 + .../2019-12-01/examples/CapabilitiesList.json | 39 + .../2019-12-01/examples/ContainerExec.json | 24 + .../examples/ContainerGroupUsage.json | 24 + .../ContainerGroupsCreateOrUpdate.json | 302 +++ .../examples/ContainerGroupsDelete.json | 78 + .../examples/ContainerGroupsGet_Failed.json | 115 + .../ContainerGroupsGet_Succeeded.json | 76 + .../examples/ContainerGroupsList.json | 87 + .../ContainerGroupsListByResourceGroup.json | 79 + .../examples/ContainerGroupsRestart.json | 11 + .../examples/ContainerGroupsStart.json | 11 + .../examples/ContainerGroupsStop.json | 11 + .../examples/ContainerGroupsUpdate.json | 100 + .../examples/ContainerListLogs.json | 17 + .../2019-12-01/examples/OperationsList.json | 23 + .../resource-manager/readme.csharp.md | 14 + .../resource-manager/readme.go.md | 9 + .../resource-manager/readme.java.md | 117 + .../resource-manager/readme.md | 144 +- .../resource-manager/readme.ruby.md | 11 + 22 files changed, 3267 insertions(+), 116 deletions(-) create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/containerInstance.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/CachedImagesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/CapabilitiesList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerExec.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupUsage.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsCreateOrUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsDelete.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsGet_Failed.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsGet_Succeeded.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsList.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsListByResourceGroup.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsRestart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsStart.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsStop.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsUpdate.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerListLogs.json create mode 100644 specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/OperationsList.json create mode 100644 specification/containerinstance/resource-manager/readme.csharp.md create mode 100644 specification/containerinstance/resource-manager/readme.java.md diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/containerInstance.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/containerInstance.json new file mode 100644 index 000000000000..943e6f8abbde --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/containerInstance.json @@ -0,0 +1,2064 @@ +{ + "swagger": "2.0", + "info": { + "version": "2019-12-01", + "title": "ContainerInstanceManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_List", + "x-ms-examples": { + "ContainerGroupsList": { + "$ref": "./examples/ContainerGroupsList.json" + } + }, + "summary": "Get a list of container groups in the specified subscription.", + "description": "Get a list of container groups in the specified subscription. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups": { + "get": { + "operationId": "ContainerGroups_ListByResourceGroup", + "x-ms-examples": { + "ContainerGroupsListByResourceGroup": { + "$ref": "./examples/ContainerGroupsListByResourceGroup.json" + } + }, + "summary": "Get a list of container groups in the specified subscription and resource group.", + "description": "Get a list of container groups in a specified subscription and resource group. This operation returns properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroupListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}": { + "get": { + "operationId": "ContainerGroups_Get", + "x-ms-examples": { + "ContainerGroupsGet_Succeeded": { + "$ref": "./examples/ContainerGroupsGet_Succeeded.json" + }, + "ContainerGroupsGet_Failed": { + "$ref": "./examples/ContainerGroupsGet_Failed.json" + } + }, + "summary": "Get the properties of the specified container group.", + "description": "Gets the properties of the specified container group in the specified subscription and resource group. The operation returns the properties of each container group including containers, image registry credentials, restart policy, IP address type, OS type, state, and volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "operationId": "ContainerGroups_CreateOrUpdate", + "x-ms-examples": { + "ContainerGroupsCreateOrUpdate": { + "$ref": "./examples/ContainerGroupsCreateOrUpdate.json" + } + }, + "summary": "Create or update container groups.", + "description": "Create or update container groups with specified configurations.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerGroup", + "description": "The properties of the container group to be created or updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "201": { + "description": "Created - the container group is created.", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "operationId": "ContainerGroups_Update", + "x-ms-examples": { + "ContainerGroupsUpdate": { + "$ref": "./examples/ContainerGroupsUpdate.json" + } + }, + "summary": "Update container groups.", + "description": "Updates container group tags with specified values.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "Resource", + "description": "The container group resource with just the tags to be updated.", + "required": true, + "in": "body", + "schema": { + "$ref": "#/definitions/Resource" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "operationId": "ContainerGroups_Delete", + "x-ms-examples": { + "ContainerGroupsDelete": { + "$ref": "./examples/ContainerGroupsDelete.json" + } + }, + "summary": "Delete the specified container group.", + "description": "Delete the specified container group in the specified subscription and resource group. The operation does not delete other resources provided by the user, such as volumes.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerGroup" + } + }, + "202": { + "description": "Delete started." + }, + "204": { + "description": "No Content - the specified container group was not found." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/restart": { + "post": { + "operationId": "ContainerGroups_Restart", + "x-ms-examples": { + "ContainerRestart": { + "$ref": "./examples/ContainerGroupsRestart.json" + } + }, + "summary": "Restarts all containers in a container group.", + "description": "Restarts all containers in a container group in place. If container image has updates, new image will be downloaded.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/stop": { + "post": { + "operationId": "ContainerGroups_Stop", + "x-ms-examples": { + "ContainerStop": { + "$ref": "./examples/ContainerGroupsStop.json" + } + }, + "summary": "Stops all containers in a container group.", + "description": "Stops all containers in a container group. Compute resources will be deallocated and billing will stop.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/start": { + "post": { + "operationId": "ContainerGroups_Start", + "x-ms-examples": { + "ContainerStart": { + "$ref": "./examples/ContainerGroupsStart.json" + } + }, + "summary": "Starts all containers in a container group.", + "description": "Starts all containers in a container group. Compute resources will be allocated and billing will start.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + } + ], + "responses": { + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.ContainerInstance/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "OperationsList": { + "$ref": "./examples/OperationsList.json" + } + }, + "description": "List the operations for Azure Container Instance service.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/usages": { + "get": { + "operationId": "Location_ListUsage", + "x-ms-examples": { + "ContainerUsage": { + "$ref": "./examples/ContainerGroupUsage.json" + } + }, + "description": "Get the usage for a subscription", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/UsageListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/logs": { + "get": { + "operationId": "Containers_ListLogs", + "x-ms-examples": { + "ContainerListLogs": { + "$ref": "./examples/ContainerListLogs.json" + } + }, + "summary": "Get the logs for a specified container instance.", + "description": "Get the logs for a specified container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "tail", + "in": "query", + "description": "The number of lines to show from the tail of the container instance log. If not provided, all available logs are shown up to 4mb.", + "type": "integer" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Logs" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerInstance/containerGroups/{containerGroupName}/containers/{containerName}/exec": { + "post": { + "operationId": "Containers_ExecuteCommand", + "x-ms-examples": { + "ContainerExec": { + "$ref": "./examples/ContainerExec.json" + } + }, + "summary": "Executes a command in a specific container instance.", + "description": "Executes a command for a specific container instance in a specified resource group and container group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ContainerGroupNameParameter" + }, + { + "name": "containerName", + "in": "path", + "description": "The name of the container instance.", + "required": true, + "type": "string" + }, + { + "name": "containerExecRequest", + "in": "body", + "description": "The request for the exec command.", + "required": true, + "schema": { + "$ref": "#/definitions/ContainerExecRequest" + } + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContainerExecResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/cachedImages": { + "get": { + "operationId": "Location_ListCachedImages", + "x-ms-examples": { + "CachedImages": { + "$ref": "./examples/CachedImagesList.json" + } + }, + "summary": "Get the list of cached images.", + "description": "Get the list of cached images on specific OS type for a subscription in a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CachedImagesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerInstance/locations/{location}/capabilities": { + "get": { + "operationId": "Location_ListCapabilities", + "x-ms-examples": { + "GetCapabilities": { + "$ref": "./examples/CapabilitiesList.json" + } + }, + "summary": "Get the list of capabilities of the location.", + "description": "Get the list of CPU/memory/GPU capabilities of a region.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/LocationParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CapabilitiesListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "Container": { + "description": "A container instance.", + "type": "object", + "required": [ + "properties", + "name" + ], + "properties": { + "name": { + "description": "The user-provided name of the container instance.", + "type": "string" + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the container instance.", + "$ref": "#/definitions/ContainerProperties" + } + } + }, + "ContainerProperties": { + "description": "The container instance properties.", + "type": "object", + "required": [ + "image", + "resources" + ], + "properties": { + "image": { + "description": "The name of the image used to create the container instance.", + "type": "string" + }, + "command": { + "description": "The commands to execute within the container instance in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "ports": { + "description": "The exposed ports on the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/ContainerPort" + } + }, + "environmentVariables": { + "description": "The environment variables to set in the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "instanceView": { + "description": "The instance view of the container instance. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "description": "The number of times that the container instance has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "Current container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "Previous container instance state.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + } + } + }, + "resources": { + "description": "The resource requirements of the container instance.", + "$ref": "#/definitions/ResourceRequirements" + }, + "volumeMounts": { + "description": "The volume mounts available to the container instance.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + } + }, + "livenessProbe": { + "description": "The liveness probe.", + "$ref": "#/definitions/ContainerProbe" + }, + "readinessProbe": { + "description": "The readiness probe.", + "$ref": "#/definitions/ContainerProbe" + } + } + }, + "ContainerState": { + "description": "The container instance state.", + "type": "object", + "readOnly": true, + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the container instance." + }, + "startTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state started." + }, + "exitCode": { + "type": "integer", + "readOnly": true, + "description": "The container instance exit codes correspond to those from the `docker run` command." + }, + "finishTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time when the container instance state finished." + }, + "detailStatus": { + "type": "string", + "readOnly": true, + "description": "The human-readable status of the container instance state." + } + } + }, + "Event": { + "description": "A container group or container instance event.", + "type": "object", + "readOnly": true, + "properties": { + "count": { + "type": "integer", + "readOnly": true, + "description": "The count of the event." + }, + "firstTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the earliest logged event." + }, + "lastTimestamp": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The date-time of the latest logged event." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The event name." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The event message." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The event type." + } + } + }, + "ResourceRequirements": { + "description": "The resource requirements.", + "type": "object", + "required": [ + "requests" + ], + "properties": { + "requests": { + "description": "The resource requests of this container instance.", + "$ref": "#/definitions/ResourceRequests" + }, + "limits": { + "description": "The resource limits of this container instance.", + "$ref": "#/definitions/ResourceLimits" + } + } + }, + "ResourceRequests": { + "description": "The resource requests.", + "type": "object", + "required": [ + "memoryInGB", + "cpu" + ], + "properties": { + "memoryInGB": { + "description": "The memory request in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU request of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU request of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "ResourceLimits": { + "description": "The resource limits.", + "type": "object", + "properties": { + "memoryInGB": { + "description": "The memory limit in GB of this container instance.", + "type": "number", + "format": "double" + }, + "cpu": { + "description": "The CPU limit of this container instance.", + "type": "number", + "format": "double" + }, + "gpu": { + "description": "The GPU limit of this container instance.", + "$ref": "#/definitions/GpuResource" + } + } + }, + "GpuResource": { + "description": "The GPU resource.", + "type": "object", + "required": [ + "count", + "sku" + ], + "properties": { + "count": { + "description": "The count of the GPU resource.", + "type": "integer", + "format": "int32" + }, + "sku": { + "type": "string", + "description": "The SKU of the GPU resource.", + "enum": [ + "K80", + "P100", + "V100" + ], + "x-ms-enum": { + "name": "GpuSku", + "modelAsString": true + } + } + } + }, + "AzureFileVolume": { + "description": "The properties of the Azure File volume. Azure File shares are mounted as volumes.", + "type": "object", + "required": [ + "shareName", + "storageAccountName" + ], + "properties": { + "shareName": { + "description": "The name of the Azure File share to be mounted as a volume.", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the Azure File shared mounted as a volume is read-only.", + "type": "boolean" + }, + "storageAccountName": { + "description": "The name of the storage account that contains the Azure File share.", + "type": "string" + }, + "storageAccountKey": { + "description": "The storage account access key used to access the Azure File share.", + "type": "string" + } + } + }, + "EmptyDirVolume": { + "description": "The empty directory volume.", + "type": "object", + "properties": {} + }, + "SecretVolume": { + "description": "The secret volume.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "GitRepoVolume": { + "description": "Represents a volume that is populated with the contents of a git repository", + "required": [ + "repository" + ], + "properties": { + "directory": { + "description": "Target directory name. Must not contain or start with '..'. If '.' is supplied, the volume directory will be the git repository. Otherwise, if specified, the volume will contain the git repository in the subdirectory with the given name.", + "type": "string" + }, + "repository": { + "description": "Repository URL", + "type": "string" + }, + "revision": { + "description": "Commit hash for the specified revision.", + "type": "string" + } + } + }, + "Volume": { + "description": "The properties of the volume.", + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The name of the volume.", + "type": "string" + }, + "azureFile": { + "description": "The Azure File volume.", + "$ref": "#/definitions/AzureFileVolume" + }, + "emptyDir": { + "description": "The empty directory volume.", + "$ref": "#/definitions/EmptyDirVolume" + }, + "secret": { + "description": "The secret volume.", + "$ref": "#/definitions/SecretVolume" + }, + "gitRepo": { + "description": "The git repo volume.", + "$ref": "#/definitions/GitRepoVolume" + } + } + }, + "VolumeMount": { + "description": "The properties of the volume mount.", + "type": "object", + "required": [ + "name", + "mountPath" + ], + "properties": { + "name": { + "description": "The name of the volume mount.", + "type": "string" + }, + "mountPath": { + "description": "The path within the container where the volume should be mounted. Must not contain colon (:).", + "type": "string" + }, + "readOnly": { + "description": "The flag indicating whether the volume mount is read-only.", + "type": "boolean" + } + } + }, + "ContainerExec": { + "type": "object", + "description": "The container execution command, for liveness or readiness probe", + "properties": { + "command": { + "description": "The commands to execute within the container.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ContainerHttpGet": { + "type": "object", + "description": "The container Http Get settings, for liveness or readiness probe", + "properties": { + "path": { + "description": "The path to probe.", + "type": "string" + }, + "port": { + "type": "integer", + "description": "The port number to probe.", + "format": "int32" + }, + "scheme": { + "description": "The scheme.", + "type": "string", + "enum": [ + "http", + "https" + ], + "x-ms-enum": { + "name": "Scheme", + "modelAsString": true + } + } + }, + "required": [ + "port" + ] + }, + "ContainerProbe": { + "type": "object", + "description": "The container probe, for liveness or readiness", + "properties": { + "exec": { + "description": "The execution command to probe", + "$ref": "#/definitions/ContainerExec" + }, + "httpGet": { + "description": "The Http Get settings to probe", + "$ref": "#/definitions/ContainerHttpGet" + }, + "initialDelaySeconds": { + "description": "The initial delay seconds.", + "type": "integer", + "format": "int32" + }, + "periodSeconds": { + "description": "The period seconds.", + "type": "integer", + "format": "int32" + }, + "failureThreshold": { + "description": "The failure threshold.", + "type": "integer", + "format": "int32" + }, + "successThreshold": { + "description": "The success threshold.", + "type": "integer", + "format": "int32" + }, + "timeoutSeconds": { + "description": "The timeout seconds.", + "type": "integer", + "format": "int32" + } + } + }, + "ContainerGroup": { + "description": "A container group.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object", + "required": [ + "properties" + ], + "properties": { + "identity": { + "$ref": "#/definitions/ContainerGroupIdentity", + "description": "The identity of the container group, if configured." + }, + "properties": { + "x-ms-client-flatten": true, + "type": "object", + "description": "The container group properties", + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the container group. This only appears in the response." + }, + "containers": { + "type": "array", + "description": "The containers within the container group.", + "items": { + "$ref": "#/definitions/Container" + } + }, + "imageRegistryCredentials": { + "type": "array", + "description": "The image registry credentials by which the container group is created from.", + "items": { + "$ref": "#/definitions/ImageRegistryCredential" + } + }, + "restartPolicy": { + "type": "string", + "description": "Restart policy for all containers within the container group. \n- `Always` Always restart\n- `OnFailure` Restart on failure\n- `Never` Never restart\n", + "enum": [ + "Always", + "OnFailure", + "Never" + ], + "x-ms-enum": { + "name": "ContainerGroupRestartPolicy", + "modelAsString": true + } + }, + "ipAddress": { + "description": "The IP address type of the container group.", + "$ref": "#/definitions/IpAddress" + }, + "osType": { + "type": "string", + "description": "The operating system type required by the containers in the container group.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": true + } + }, + "volumes": { + "type": "array", + "description": "The list of volumes that can be mounted by containers in this container group.", + "items": { + "$ref": "#/definitions/Volume" + } + }, + "instanceView": { + "description": "The instance view of the container group. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "events": { + "description": "The events of this container group.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + }, + "state": { + "readOnly": true, + "type": "string", + "description": "The state of the container group. Only valid in response." + } + } + }, + "diagnostics": { + "description": "The diagnostic information for a container group.", + "$ref": "#/definitions/ContainerGroupDiagnostics" + }, + "networkProfile": { + "description": "The network profile information for a container group.", + "$ref": "#/definitions/ContainerGroupNetworkProfile" + }, + "dnsConfig": { + "description": "The DNS config information for a container group.", + "$ref": "#/definitions/DnsConfiguration" + }, + "sku": { + "description": "The SKU for a container group.", + "$ref": "#/definitions/ContainerGroupSku" + }, + "encryptionProperties": { + "description": "The encryption properties for a container group.", + "$ref": "#/definitions/EncryptionProperties" + }, + "initContainers": { + "type": "array", + "description": "The init containers for a container group.", + "items": { + "$ref": "#/definitions/InitContainerDefinition" + } + } + }, + "required": [ + "containers", + "osType" + ] + } + } + } + ] + }, + "ContainerGroupIdentity": { + "description": "Identity for the container group.", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the container group identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the container group. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the container group. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the container group.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "description": "The list of user identities associated with the container group. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + } + } + } + }, + "ImageRegistryCredential": { + "description": "Image registry credential.", + "type": "object", + "properties": { + "server": { + "type": "string", + "description": "The Docker image registry server without a protocol such as \"http\" and \"https\"." + }, + "username": { + "type": "string", + "description": "The username for the private registry." + }, + "password": { + "type": "string", + "description": "The password for the private registry." + } + }, + "required": [ + "server", + "username" + ] + }, + "ContainerGroupDiagnostics": { + "description": "Container group diagnostic information.", + "type": "object", + "properties": { + "logAnalytics": { + "description": "Container group log analytics information.", + "$ref": "#/definitions/LogAnalytics" + } + } + }, + "LogAnalytics": { + "description": "Container group log analytics information.", + "type": "object", + "properties": { + "workspaceId": { + "description": "The workspace id for log analytics", + "type": "string" + }, + "workspaceKey": { + "description": "The workspace key for log analytics", + "type": "string" + }, + "logType": { + "type": "string", + "description": "The log type to be used.", + "enum": [ + "ContainerInsights", + "ContainerInstanceLogs" + ], + "x-ms-enum": { + "name": "LogAnalyticsLogType", + "modelAsString": true + } + }, + "metadata": { + "type": "object", + "description": "Metadata for log analytics.", + "additionalProperties": { + "type": "string" + } + } + }, + "required": [ + "workspaceId", + "workspaceKey" + ] + }, + "ContainerGroupNetworkProfile": { + "description": "Container group network profile information.", + "type": "object", + "properties": { + "id": { + "description": "The identifier for a network profile.", + "type": "string" + } + }, + "required": [ + "id" + ] + }, + "IpAddress": { + "description": "IP address for the container group.", + "type": "object", + "properties": { + "ports": { + "type": "array", + "description": "The list of ports exposed on the container group.", + "items": { + "$ref": "#/definitions/Port" + } + }, + "type": { + "type": "string", + "description": "Specifies if the IP is exposed to the public internet or private VNET.", + "enum": [ + "Public", + "Private" + ], + "x-ms-enum": { + "name": "ContainerGroupIpAddressType", + "modelAsString": true + } + }, + "ip": { + "type": "string", + "description": "The IP exposed to the public internet." + }, + "dnsNameLabel": { + "type": "string", + "description": "The Dns name label for the IP." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "The FQDN for the IP." + } + }, + "required": [ + "ports", + "type" + ] + }, + "Port": { + "description": "The port exposed on the container group.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerGroupNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "description": "The port number.", + "format": "int32" + } + }, + "required": [ + "port" + ] + }, + "ContainerPort": { + "description": "The port exposed on the container instance.", + "type": "object", + "properties": { + "protocol": { + "type": "string", + "description": "The protocol associated with the port.", + "enum": [ + "TCP", + "UDP" + ], + "x-ms-enum": { + "name": "ContainerNetworkProtocol", + "modelAsString": true + } + }, + "port": { + "type": "integer", + "format": "int32", + "description": "The port number exposed within the container group." + } + }, + "required": [ + "port" + ] + }, + "EnvironmentVariable": { + "description": "The environment variable to set within the container instance.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the environment variable." + }, + "value": { + "type": "string", + "description": "The value of the environment variable." + }, + "secureValue": { + "type": "string", + "description": "The value of the secure environment variable." + } + }, + "required": [ + "name" + ] + }, + "OperationListResult": { + "description": "The operation list response that contains all operations for Azure Container Instance service.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "The list of operations." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of operations." + } + } + }, + "Operation": { + "description": "An operation for Azure Container Instance service.", + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of the operation." + }, + "display": { + "description": "The display information of the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The name of the provider of the operation.", + "type": "string" + }, + "resource": { + "type": "string", + "description": "The name of the resource type of the operation." + }, + "operation": { + "description": "The friendly name of the operation.", + "type": "string" + }, + "description": { + "description": "The description of the operation.", + "type": "string" + } + } + }, + "properties": { + "type": "object", + "description": "The additional properties.", + "x-ms-client-flatten": true + }, + "origin": { + "type": "string", + "description": "The intended executor of the operation.", + "enum": [ + "User", + "System" + ], + "x-ms-enum": { + "name": "ContainerInstanceOperationsOrigin", + "modelAsString": true + } + } + }, + "required": [ + "name", + "display" + ] + }, + "UsageListResult": { + "description": "The response containing the usage data", + "type": "object", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "The usage data.", + "items": { + "$ref": "#/definitions/Usage" + } + } + } + }, + "Usage": { + "description": "A single usage result", + "type": "object", + "properties": { + "unit": { + "readOnly": true, + "type": "string", + "description": "Unit of the usage result" + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "description": "The current usage of the resource" + }, + "limit": { + "readOnly": true, + "type": "integer", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "type": "object", + "description": "The name object of the resource", + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource" + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource" + } + } + } + } + }, + "ContainerGroupListResult": { + "description": "The container group list response that contains the container group properties.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerGroup" + }, + "description": "The list of container groups." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of container groups." + } + } + }, + "Logs": { + "description": "The logs.", + "type": "object", + "properties": { + "content": { + "type": "string", + "description": "The content of the log." + } + } + }, + "ContainerExecRequest": { + "description": "The container exec request.", + "type": "object", + "properties": { + "command": { + "type": "string", + "description": "The command to be executed." + }, + "terminalSize": { + "type": "object", + "description": "The size of the terminal.", + "properties": { + "rows": { + "type": "integer", + "description": "The row size of the terminal" + }, + "cols": { + "type": "integer", + "description": "The column size of the terminal" + } + } + } + } + }, + "ContainerExecResponse": { + "description": "The information for the container exec command.", + "type": "object", + "properties": { + "webSocketUri": { + "type": "string", + "description": "The uri for the exec websocket." + }, + "password": { + "type": "string", + "description": "The password to start the exec command." + } + } + }, + "DnsConfiguration": { + "description": "DNS configuration for the container group.", + "type": "object", + "required": [ + "nameServers" + ], + "properties": { + "nameServers": { + "description": "The DNS servers for the container group.", + "type": "array", + "items": { + "type": "string" + } + }, + "searchDomains": { + "description": "The DNS search domains for hostname lookup in the container group.", + "type": "string" + }, + "options": { + "description": "The DNS options for the container group.", + "type": "string" + } + } + }, + "Resource": { + "type": "object", + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The resource id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "location": { + "type": "string", + "description": "The resource location." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The resource tags." + } + }, + "x-ms-azure-resource": true + }, + "CachedImagesListResult": { + "description": "The response containing cached images.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/cachedImages" + }, + "description": "The list of cached images." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of cached images." + } + } + }, + "cachedImages": { + "description": "The cached image and OS type.", + "type": "object", + "required": [ + "osType", + "image" + ], + "properties": { + "osType": { + "type": "string", + "description": "The OS type of the cached image." + }, + "image": { + "type": "string", + "description": "The cached image name." + } + } + }, + "CapabilitiesListResult": { + "description": "The response containing list of capabilities.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Capabilities" + }, + "description": "The list of capabilities." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of capabilities." + } + } + }, + "Capabilities": { + "description": "The regional capabilities.", + "type": "object", + "properties": { + "resourceType": { + "type": "string", + "readOnly": true, + "description": "The resource type that this capability describes." + }, + "osType": { + "type": "string", + "readOnly": true, + "description": "The OS type that this capability describes." + }, + "location": { + "type": "string", + "readOnly": true, + "description": "The resource location." + }, + "ipAddressType": { + "type": "string", + "readOnly": true, + "description": "The ip address type that this capability describes." + }, + "gpu": { + "type": "string", + "readOnly": true, + "description": "The GPU sku that this capability describes." + }, + "capabilities": { + "type": "object", + "readOnly": true, + "description": "The supported capabilities.", + "properties": { + "maxMemoryInGB": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed memory request in GB." + }, + "maxCpu": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed CPU request in cores." + }, + "maxGpuCount": { + "type": "number", + "readOnly": true, + "description": "The maximum allowed GPU count." + } + } + } + } + }, + "ContainerGroupSku": { + "description": "The container group SKU.", + "type": "string", + "enum": [ + "Standard", + "Dedicated" + ], + "x-ms-enum": { + "name": "ContainerGroupSku", + "modelAsString": true + } + }, + "EncryptionProperties": { + "description": "The container group encryption properties.", + "type": "object", + "properties": { + "vaultBaseUrl": { + "description": "The keyvault base url.", + "type": "string" + }, + "keyName": { + "description": "The encryption key name.", + "type": "string" + }, + "keyVersion": { + "description": "The encryption key version.", + "type": "string" + } + }, + "required": [ + "vaultBaseUrl", + "keyName", + "keyVersion" + ] + }, + "InitContainerDefinition": { + "description": "The init container definition.", + "type": "object", + "properties": { + "name": { + "description": "The name for the init container.", + "type": "string" + }, + "properties": { + "description": "The properties for the init container.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/InitContainerPropertiesDefinition" + } + }, + "required": [ + "name", + "properties" + ] + }, + "InitContainerPropertiesDefinition": { + "description": "The init container definition properties.", + "type": "object", + "properties": { + "image": { + "description": "The image of the init container.", + "type": "string" + }, + "command": { + "description": "The command to execute within the init container in exec form.", + "type": "array", + "items": { + "type": "string" + } + }, + "environmentVariables": { + "description": "The environment variables to set in the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentVariable" + } + }, + "instanceView": { + "description": "The instance view of the init container. Only valid in response.", + "readOnly": true, + "type": "object", + "properties": { + "restartCount": { + "readOnly": true, + "type": "integer", + "description": "The number of times that the init container has been restarted." + }, + "currentState": { + "readOnly": true, + "description": "The current state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "previousState": { + "readOnly": true, + "description": "The previous state of the init container.", + "$ref": "#/definitions/ContainerState" + }, + "events": { + "readOnly": true, + "description": "The events of the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/Event" + } + } + } + }, + "volumeMounts": { + "description": "The volume mounts available to the init container.", + "type": "array", + "items": { + "$ref": "#/definitions/VolumeMount" + } + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody" + } + }, + "description": "An error response from the Container Instance service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container Instance service." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "LocationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The identifier for the physical azure location.", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API version", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ContainerGroupNameParameter": { + "name": "containerGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the container group.", + "x-ms-parameter-location": "method" + }, + "OperationIdParameter": { + "name": "operationId", + "in": "path", + "required": true, + "type": "string", + "description": "The operation Id.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/CachedImagesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/CachedImagesList.json new file mode 100644 index 000000000000..8da2922987a8 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/CachedImagesList.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2019-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "osType": "Linux", + "image": "ubuntu:16.04" + }, + { + "osType": "Linux", + "image": "alpine:3.6" + }, + { + "osType": "Windows", + "image": "microsoft/nanoserver:10.0.14393.2485" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/CapabilitiesList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/CapabilitiesList.json new file mode 100644 index 000000000000..9eadf0fd7f76 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/CapabilitiesList.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westus", + "api-version": "2019-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "containerGroups", + "osType": "Linux", + "location": "West US", + "ipAddressType": "Public", + "gpu": "K80", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 4 + } + }, + { + "resourceType": "containerGroups", + "osType": "Windows", + "location": "West US", + "ipAddressType": "Public", + "gpu": "None", + "capabilities": { + "maxMemoryInGB": 14, + "maxCpu": 4, + "maxGpuCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerExec.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerExec.json new file mode 100644 index 000000000000..920b96b6c6b2 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerExec.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2019-12-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "containerExecRequest": { + "command": "/bin/bash", + "terminalSize": { + "rows": 12, + "cols": 12 + } + } + }, + "responses": { + "200": { + "body": { + "webSocketUri": "wss://web-socket-uri", + "password": "password" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupUsage.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupUsage.json new file mode 100644 index 000000000000..b84c41dadcc2 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupUsage.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "westcentralus", + "api-version": "2019-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Count", + "currentValue": 1, + "limit": 2000, + "name": { + "value": "ContainerGroups", + "localizedValue": "Container Groups" + } + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsCreateOrUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsCreateOrUpdate.json new file mode 100644 index 000000000000..6e150b1a4b17 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsCreateOrUpdate.json @@ -0,0 +1,302 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2019-12-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerGroup": { + "location": "west us", + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "workspaceKey", + "logType": "ContainerInsights", + "metadata": { + "test-key": "test-metadata-value" + } + } + }, + "networkProfile": { + "id": "test-network-profile-id" + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ports": [ + { + "protocol": "TCP", + "port": 80 + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1" + }, + "osType": "Linux", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName", + "storageAccountKey": "accountKey" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": { + "secretKey1": "SecretValue1InBase64", + "secretKey2": "SecretValue2InBase64" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "diagnostics": { + "logAnalytics": { + "workspaceId": "workspaceid", + "workspaceKey": "" + } + }, + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ], + "searchDomains": "cluster.local svc.cluster.local", + "options": "ndots:2" + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5, + "gpu": { + "count": 1, + "sku": "K80" + } + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "dnsConfig": { + "nameServers": [ + "1.1.1.1" + ] + }, + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsDelete.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsDelete.json new file mode 100644 index 000000000000..bd9972477c70 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsDelete.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2019-12-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + }, + "202": {}, + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsGet_Failed.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsGet_Failed.json new file mode 100644 index 000000000000..2e1670cc6b40 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsGet_Failed.json @@ -0,0 +1,115 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2019-12-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Waiting", + "startTime": "2017-08-08T00:09:10Z", + "detailStatus": "" + }, + "events": [ + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:01Z", + "lastTimestamp": "2017-08-08T00:09:01Z", + "message": "pulling image \"nginx\"", + "name": "Pulling", + "type": "Normal" + }, + { + "count": 1, + "firstTimestamp": "2017-08-08T00:09:10Z", + "lastTimestamp": "2017-08-08T00:09:10Z", + "message": "Successfully pulled image \"nginx\"", + "name": "Pulled", + "type": "Normal" + } + ] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "instanceView": { + "events": [ + { + "count": 1, + "firstTimestamp": "2017-10-08T00:19:10Z", + "lastTimestamp": "2017-10-08T00:19:10Z", + "message": "Output: mount error(2): Permission denied", + "name": "FailedMount", + "type": "Normal" + } + ], + "state": "Pending" + }, + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Failed", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsGet_Succeeded.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsGet_Succeeded.json new file mode 100644 index 000000000000..effa5c9976a3 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsGet_Succeeded.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "api-version": "2019-12-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsList.json new file mode 100644 index 000000000000..3eba7d23f683 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsList.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2019-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "instanceView": { + "restartCount": 0, + "currentState": { + "state": "Running", + "startTime": "2017-10-17T17:27:21Z", + "detailStatus": "" + }, + "events": [] + }, + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsListByResourceGroup.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsListByResourceGroup.json new file mode 100644 index 000000000000..2e3bbcd1580f --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsListByResourceGroup.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "demo", + "api-version": "2019-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/demo/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "mountPath": "/mnt/volume1", + "name": "volume1", + "readOnly": false + } + ] + } + } + ], + "imageRegistryCredentials": [ + { + "server": "azcloudconsoleregistry.azurecr.io", + "username": "azcloudconsoleregistry" + } + ], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "azureFile": { + "readOnly": false, + "shareName": "share1", + "storageAccountName": "storage1" + }, + "name": "volume1" + } + ] + }, + "type": "Microsoft.ContainerInstance/containerGroups" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsRestart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsRestart.json new file mode 100644 index 000000000000..d8a9c37fb7d1 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsRestart.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2019-12-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsStart.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsStart.json new file mode 100644 index 000000000000..d8a9c37fb7d1 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsStart.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2019-12-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsStop.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsStop.json new file mode 100644 index 000000000000..d8a9c37fb7d1 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsStop.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2019-12-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1" + }, + "responses": { + "204": {} + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsUpdate.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsUpdate.json new file mode 100644 index 000000000000..f73f9822b981 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerGroupsUpdate.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2019-12-01", + "resourceGroupName": "demoResource", + "containerGroupName": "demo1", + "Resource": { + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/demoResource/providers/Microsoft.ContainerInstance/containerGroups/demo1", + "location": "WestUs", + "name": "demo1", + "type": "Microsoft.ContainerInstance/containerGroups", + "tags": { + "tag1key": "tag1Value", + "tag2key": "tag2Value" + }, + "properties": { + "containers": [ + { + "name": "demo1", + "properties": { + "command": [], + "environmentVariables": [], + "image": "nginx", + "ports": [ + { + "port": 80 + } + ], + "resources": { + "requests": { + "cpu": 1, + "memoryInGB": 1.5 + } + }, + "volumeMounts": [ + { + "name": "volume1", + "mountPath": "/mnt/volume1", + "readOnly": false + }, + { + "name": "volume2", + "mountPath": "/mnt/volume2", + "readOnly": false + }, + { + "name": "volume3", + "mountPath": "/mnt/volume3", + "readOnly": true + } + ] + } + } + ], + "imageRegistryCredentials": [], + "ipAddress": { + "ip": "10.0.0.1", + "ports": [ + { + "port": 80, + "protocol": "TCP" + } + ], + "type": "Public", + "dnsNameLabel": "dnsnamelabel1", + "fqdn": "dnsnamelabel1.azure-container.io" + }, + "osType": "Linux", + "provisioningState": "Succeeded", + "volumes": [ + { + "name": "volume1", + "azureFile": { + "shareName": "shareName", + "storageAccountName": "accountName" + } + }, + { + "name": "volume2", + "emptyDir": {} + }, + { + "name": "volume3", + "secret": {} + } + ] + } + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerListLogs.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerListLogs.json new file mode 100644 index 000000000000..6b7d92d6e8a2 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/ContainerListLogs.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2019-12-01", + "resourceGroupName": "demo", + "containerGroupName": "demo1", + "containerName": "container1", + "tail": 10 + }, + "responses": { + "200": { + "body": { + "content": "log content" + } + } + } +} diff --git a/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/OperationsList.json b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/OperationsList.json new file mode 100644 index 000000000000..c97bee1cdd55 --- /dev/null +++ b/specification/containerinstance/resource-manager/Microsoft.ContainerInstance/stable/2019-12-01/examples/OperationsList.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2019-12-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.ContainerInstance/containerGroups/read", + "display": { + "provider": "Microsoft Container Instance", + "resource": "Container Group", + "operation": "Get Container Groups", + "description": "Get all container goups." + }, + "origin": "User" + } + ] + } + } + } +} diff --git a/specification/containerinstance/resource-manager/readme.csharp.md b/specification/containerinstance/resource-manager/readme.csharp.md new file mode 100644 index 000000000000..c9346d21e519 --- /dev/null +++ b/specification/containerinstance/resource-manager/readme.csharp.md @@ -0,0 +1,14 @@ +## 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 + namespace: Microsoft.Azure.Management.ContainerInstance + payload-flattening-threshold: 1 + output-folder: $(csharp-sdks-folder)/containerinstance/Microsoft.Azure.Management.ContainerInstance/src/Generated + clear-output-folder: true +``` diff --git a/specification/containerinstance/resource-manager/readme.go.md b/specification/containerinstance/resource-manager/readme.go.md index 337b7b5056c8..ee1b342738a1 100644 --- a/specification/containerinstance/resource-manager/readme.go.md +++ b/specification/containerinstance/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2019-12 - tag: package-2018-10 - tag: package-2018-09 - tag: package-2018-06 @@ -22,6 +23,14 @@ batch: - tag: package-2017-10-preview - tag: package-2017-08-preview ``` +### Tag: package-2019-12 and go + +These settings apply only when `--tag=package-2019-12 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2019-12' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2019-12-01/$(namespace) +``` ### Tag: package-2018-10 and go diff --git a/specification/containerinstance/resource-manager/readme.java.md b/specification/containerinstance/resource-manager/readme.java.md new file mode 100644 index 000000000000..e8edc02c0f8c --- /dev/null +++ b/specification/containerinstance/resource-manager/readme.java.md @@ -0,0 +1,117 @@ +## Java + +These settings apply only when `--java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(java) +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.containerinstance +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerinstance +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2019-12 + - tag: package-2018-10 + - tag: package-2018-04 + - tag: package-2018-02-preview + - tag: package-2017-12-preview + - tag: package-2017-10-preview + - tag: package-2017-08-preview +``` + +### Tag: package-2019-12 and java + +These settings apply only when `--tag=package-2019-12 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2019-12' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2019_12_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2019_12_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-10 and java + +These settings apply only when `--tag=package-2018-10 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-10' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2018_10_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2018_10_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-04 and java + +These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2018_04_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2018_04_01 +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2018-02-preview and java + +These settings apply only when `--tag=package-2018-02-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2018-02-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2018_02_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2018_02_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-12-preview and java + +These settings apply only when `--tag=package-2017-12-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-12-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2017_12_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2017_12_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-10-preview and java + +These settings apply only when `--tag=package-2017-10-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-10-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2017_10_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2017_10_01_preview +regenerate-manager: true +generate-interface: true +``` + +### Tag: package-2017-08-preview and java + +These settings apply only when `--tag=package-2017-08-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2017-08-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerinstance.v2017_08_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2017_08_01_preview +regenerate-manager: true +generate-interface: true +``` \ No newline at end of file diff --git a/specification/containerinstance/resource-manager/readme.md b/specification/containerinstance/resource-manager/readme.md index 9d309a675746..14839315995e 100644 --- a/specification/containerinstance/resource-manager/readme.md +++ b/specification/containerinstance/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for ContainerInstance. - - --- + ## Getting Started + To build the SDK for ContainerInstance, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,18 +15,28 @@ To build the SDK for ContainerInstance, simply [Install AutoRest](https://aka.ms To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the ContainerInstance API. ``` yaml openapi-type: arm -tag: package-2018-10 +tag: package-2019-12 +``` + + +### Tag: package-2019-12 + +These settings apply only when `--tag=package-2019-12` is specified on the command line. + +```yaml $(tag) == 'package-2019-12' +input-file: + - Microsoft.ContainerInstance/stable/2019-12-01/containerInstance.json ``` ### Tag: package-2018-10 @@ -83,7 +93,6 @@ input-file: - Microsoft.ContainerInstance/preview/2017-12-01-preview/containerInstance.json ``` - ### Tag: package-2017-10-preview These settings apply only when `--tag=package-2017-10-preview` is specified on the command line. @@ -93,7 +102,6 @@ input-file: - Microsoft.ContainerInstance/preview/2017-10-01-preview/containerInstance.json ``` - ### Tag: package-2017-08-preview These settings apply only when `--tag=package-2017-08-preview` is specified on the command line. @@ -113,8 +121,8 @@ directive: ``` --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -134,21 +142,9 @@ swagger-to-sdk: - bundle install && rake arm:regen_all_profiles['azure_mgmt_container_instance'] ``` - ## 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 - namespace: Microsoft.Azure.Management.ContainerInstance - payload-flattening-threshold: 1 - output-folder: $(csharp-sdks-folder)/containerinstance/Microsoft.Azure.Management.ContainerInstance/src/Generated - clear-output-folder: true -``` +See configuration in [readme.csharp.md](./readme.csharp.md) ## Go @@ -156,109 +152,26 @@ See configuration in [readme.go.md](./readme.go.md) ## Java -These settings apply only when `--java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. +See configuration in [readme.java.md](./readme.java.md) -``` yaml $(java) -azure-arm: true -fluent: true -namespace: com.microsoft.azure.management.containerinstance -license-header: MICROSOFT_MIT_NO_CODEGEN -payload-flattening-threshold: 1 -output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-containerinstance -``` +## Node.js -### Java multi-api +See configuration in [readme.nodejs.md](./readme.nodejs.md) -``` yaml $(java) && $(multiapi) -batch: - - tag: package-2018-10 - - tag: package-2018-04 - - tag: package-2018-02-preview - - tag: package-2017-12-preview - - tag: package-2017-10-preview - - tag: package-2017-08-preview -``` - -### Tag: package-2018-10 and java - -These settings apply only when `--tag=package-2018-10 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-10' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerinstance.v2018_10_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2018_10_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-04 and java - -These settings apply only when `--tag=package-2018-04 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2018-04' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerinstance.v2018_04_01 - output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2018_04_01 -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2018-02-preview and java +## Python -These settings apply only when `--tag=package-2018-02-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. +See configuration in [readme.python.md](./readme.python.md) -``` yaml $(tag) == 'package-2018-02-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerinstance.v2018_02_01_preview - output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2018_02_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-12-preview and java - -These settings apply only when `--tag=package-2017-12-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. - -``` yaml $(tag) == 'package-2017-12-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerinstance.v2017_12_01_preview - output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2017_12_01_preview -regenerate-manager: true -generate-interface: true -``` +## Ruby -### Tag: package-2017-10-preview and java +See configuration in [readme.ruby.md](./readme.ruby.md) -These settings apply only when `--tag=package-2017-10-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. +## TypeScript -``` yaml $(tag) == 'package-2017-10-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerinstance.v2017_10_01_preview - output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2017_10_01_preview -regenerate-manager: true -generate-interface: true -``` - -### Tag: package-2017-08-preview and java +See configuration in [readme.typescript.md](./readme.typescript.md) -These settings apply only when `--tag=package-2017-08-preview --java` is specified on the command line. -Please also specify `--azure-libraries-for-java=`. -``` yaml $(tag) == 'package-2017-08-preview' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.containerinstance.v2017_08_01_preview - output-folder: $(azure-libraries-for-java-folder)/sdk/containerinstance/mgmt-v2017_08_01_preview -regenerate-manager: true -generate-interface: true -``` - -## Multi-API/Profile support for AutoRest v3 generators +## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -281,11 +194,10 @@ input-file: ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - diff --git a/specification/containerinstance/resource-manager/readme.ruby.md b/specification/containerinstance/resource-manager/readme.ruby.md index 6b401900041b..add086619a5f 100644 --- a/specification/containerinstance/resource-manager/readme.ruby.md +++ b/specification/containerinstance/resource-manager/readme.ruby.md @@ -12,6 +12,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2019-12 - tag: package-2018-10 - tag: package-2018-09 - tag: package-2018-06 @@ -22,6 +23,16 @@ batch: - tag: package-2017-08-preview ``` +### Tag: package-2019-12 and ruby + +These settings apply only when `--tag=package-2019-12 --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-12' && $(ruby) +namespace: "Azure::ContainerInstance::Mgmt::V2019_12_01" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_container_instance/lib +``` + ### Tag: package-2018-09 and ruby These settings apply only when `--tag=package-2018-10 --ruby` is specified on the command line. From 80784443eefe04bf6f4d253f9f210044e6d432b1 Mon Sep 17 00:00:00 2001 From: Himanshu Chhabra Date: Sun, 21 Jun 2020 23:56:52 -0700 Subject: [PATCH 179/318] [SRP]Adding allowBlobPublicAccess and minimumTlsVersion property for June19 and April19 (#9831) * Add allowBlobPublicAccess and minimumTlsVersion properties * Adding allowBlobPublicAccess and minimumTlsVersion properties to april19 swagger version. * validation fix, added example * filename correction * Ran prettier check, Moved the example to StorageAccountCreate * Updating comments * Updating description * Added update account example --- .../examples/StorageAccountCreate.json | 6 ++- .../examples/StorageAccountUpdate.json | 4 ++ .../stable/2019-04-01/storage.json | 54 +++++++++++++++++++ .../examples/StorageAccountCreate.json | 4 ++ .../examples/StorageAccountUpdate.json | 4 ++ .../stable/2019-06-01/storage.json | 54 +++++++++++++++++++ 6 files changed, 125 insertions(+), 1 deletion(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/StorageAccountCreate.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/StorageAccountCreate.json index 716fd1ae6ced..d3930f349262 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/StorageAccountCreate.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/StorageAccountCreate.json @@ -11,7 +11,9 @@ "kind": "Storage", "location": "eastus2euap", "properties": { - "isHnsEnabled": true + "isHnsEnabled": true, + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2" }, "tags": { "key1": "value1", @@ -28,6 +30,8 @@ "name": "sto4445", "properties": { "isHnsEnabled": true, + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", "creationTime": "2017-05-24T13:25:33.4863236Z", "primaryEndpoints": { "web": "https://sto4445.web.core.windows.net/", diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/StorageAccountUpdate.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/StorageAccountUpdate.json index 35fa48432ba7..9b5ed0641d32 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/StorageAccountUpdate.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/examples/StorageAccountUpdate.json @@ -7,6 +7,8 @@ "monitor": "true", "parameters": { "properties": { + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", "networkAcls": { "defaultAction": "Allow" }, @@ -33,6 +35,8 @@ "name": "sto8596", "properties": { "isHnsEnabled": true, + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", "creationTime": "2017-06-01T02:42:41.7633306Z", "networkAcls": { "bypass": "AzureServices", diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/storage.json index 8ce581604c9e..e1cf321fdfa3 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-04-01/storage.json @@ -1451,6 +1451,24 @@ "modelAsString": true }, "description": "Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled." + }, + "allowBlobPublicAccess": { + "type": "boolean", + "x-ms-client-name": "AllowBlobPublicAccess", + "description": "Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property." + }, + "minimumTlsVersion": { + "type": "string", + "enum": [ + "TLS1_0", + "TLS1_1", + "TLS1_2" + ], + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": true + }, + "description": "Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property." } }, "description": "The parameters used to create the storage account." @@ -1738,6 +1756,24 @@ "modelAsString": true }, "description": "Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled." + }, + "allowBlobPublicAccess": { + "type": "boolean", + "x-ms-client-name": "AllowBlobPublicAccess", + "description": "Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property." + }, + "minimumTlsVersion": { + "type": "string", + "enum": [ + "TLS1_0", + "TLS1_1", + "TLS1_2" + ], + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": true + }, + "description": "Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property." } }, "description": "Properties of the storage account." @@ -1900,6 +1936,24 @@ "modelAsString": true }, "description": "Allow large file shares if sets to Enabled. It cannot be disabled once it is enabled." + }, + "allowBlobPublicAccess": { + "type": "boolean", + "x-ms-client-name": "AllowBlobPublicAccess", + "description": "Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property." + }, + "minimumTlsVersion": { + "type": "string", + "enum": [ + "TLS1_0", + "TLS1_1", + "TLS1_2" + ], + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": true + }, + "description": "Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property." } }, "description": "The parameters used when updating a storage account." diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountCreate.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountCreate.json index 13f6c5388b0b..0151d8284d76 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountCreate.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountCreate.json @@ -12,6 +12,8 @@ "location": "eastus", "properties": { "isHnsEnabled": true, + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", "routingPreference": { "routingChoice": "MicrosoftRouting", "publishMicrosoftEndpoints": true, @@ -47,6 +49,8 @@ "name": "sto4445", "properties": { "isHnsEnabled": true, + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", "creationTime": "2017-05-24T13:25:33.4863236Z", "primaryEndpoints": { "web": "https://sto4445.web.core.windows.net/", diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountUpdate.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountUpdate.json index 2a64ed59b064..46b35b050ae5 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountUpdate.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/examples/StorageAccountUpdate.json @@ -7,6 +7,8 @@ "monitor": "true", "parameters": { "properties": { + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", "networkAcls": { "defaultAction": "Allow" }, @@ -40,6 +42,8 @@ "name": "sto8596", "properties": { "isHnsEnabled": true, + "allowBlobPublicAccess": false, + "minimumTlsVersion": "TLS1_2", "creationTime": "2017-06-01T02:42:41.7633306Z", "networkAcls": { "bypass": "AzureServices", diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json index 19d992139d87..8ec6e6bdd1db 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/storage.json @@ -2131,6 +2131,24 @@ "$ref": "#/definitions/RoutingPreference", "x-ms-client-name": "RoutingPreference", "description": "Maintains information about the network routing choice opted by the user for data transfer" + }, + "allowBlobPublicAccess": { + "type": "boolean", + "x-ms-client-name": "AllowBlobPublicAccess", + "description": "Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property." + }, + "minimumTlsVersion": { + "type": "string", + "enum": [ + "TLS1_0", + "TLS1_1", + "TLS1_2" + ], + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": true + }, + "description": "Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property." } }, "description": "The parameters used to create the storage account." @@ -2566,6 +2584,24 @@ "x-ms-client-name": "BlobRestoreStatus", "description": "Blob restore status", "readOnly": true + }, + "allowBlobPublicAccess": { + "type": "boolean", + "x-ms-client-name": "AllowBlobPublicAccess", + "description": "Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property." + }, + "minimumTlsVersion": { + "type": "string", + "enum": [ + "TLS1_0", + "TLS1_1", + "TLS1_2" + ], + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": true + }, + "description": "Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property." } }, "description": "Properties of the storage account." @@ -2733,6 +2769,24 @@ "$ref": "#/definitions/RoutingPreference", "x-ms-client-name": "RoutingPreference", "description": "Maintains information about the network routing choice opted by the user for data transfer" + }, + "allowBlobPublicAccess": { + "type": "boolean", + "x-ms-client-name": "AllowBlobPublicAccess", + "description": "Allow or disallow public access to all blobs or containers in the storage account. The default interpretation is true for this property." + }, + "minimumTlsVersion": { + "type": "string", + "enum": [ + "TLS1_0", + "TLS1_1", + "TLS1_2" + ], + "x-ms-enum": { + "name": "MinimumTlsVersion", + "modelAsString": true + }, + "description": "Set the minimum TLS version to be permitted on requests to storage. The default interpretation is TLS 1.0 for this property." } }, "description": "The parameters used when updating a storage account." From 46882ee8ec2ea74bb35beb7c501b4ff11760707b Mon Sep 17 00:00:00 2001 From: hohershk <58219337+hohershk@users.noreply.github.com> Date: Mon, 22 Jun 2020 15:24:37 +0300 Subject: [PATCH 180/318] Operational insights delete wrong lines data export (#9849) * microsoft.operationalinsights_add_data_export * fix * fix * delete wrong code from data ecport json file * add new line where needed * fix data export get example * delete unneeded x-ms-pageable * back Co-authored-by: Hodaya Hershkovich --- .../preview/2020-03-01-preview/DataExports.json | 7 ------- .../preview/2020-03-01-preview/examples/DataExportGet.json | 3 +-- 2 files changed, 1 insertion(+), 9 deletions(-) diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json index b458c89226a6..d776e4a1ff24 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/DataExports.json @@ -143,10 +143,6 @@ "$ref": "#/definitions/DataExportErrorResponse" } } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" } }, "get": { @@ -188,9 +184,6 @@ "$ref": "#/definitions/DataExport" } }, - "404": { - "description": "Not found the specific data export." - }, "default": { "description": "Error response describing why the operation failed.", "schema": { diff --git a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json index c6142d9fe8c4..0bb0b00f44b5 100644 --- a/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json +++ b/specification/operationalinsights/resource-manager/Microsoft.OperationalInsights/preview/2020-03-01-preview/examples/DataExportGet.json @@ -27,7 +27,6 @@ "name": "export1", "type": "Microsoft.OperationalInsights/workspaces/export" } - }, - "404": {} + } } } From 570395104a8da700dad54054a29e42868a7544f7 Mon Sep 17 00:00:00 2001 From: aim-for-better Date: Tue, 23 Jun 2020 00:59:37 +0800 Subject: [PATCH 181/318] 1. Add a property as required (#9899) 2. Remove AccessControl's operation id to elevate methods to client Co-authored-by: Zhenyu Zhou --- .../preview/2019-06-01-preview/artifacts.json | 3 ++- .../preview/2020-02-01-preview/roleAssignments.json | 10 +++++----- .../preview/2020-02-01-preview/roles.json | 4 ++-- 3 files changed, 9 insertions(+), 8 deletions(-) diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json index df96c4e9e6fe..0dfc0e51ebbd 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json @@ -2716,7 +2716,8 @@ } }, "required": [ - "sessionId" + "sessionId", + "commandPayload" ] }, "DataFlowDebugQueryResponse": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json index 634133c68370..5d2a04daacd5 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roleAssignments.json @@ -22,7 +22,7 @@ "tags": [ "RoleAssignments" ], - "operationId": "AccessControl_CreateRoleAssignment", + "operationId": "CreateRoleAssignment", "description": "Create role assignment.", "x-ms-examples": { "Create role assignment": { @@ -68,7 +68,7 @@ "tags": [ "RoleAssignments" ], - "operationId": "AccessControl_GetRoleAssignments", + "operationId": "GetRoleAssignments", "description": "List role assignments.", "x-ms-examples": { "Get role assignment information": { @@ -120,7 +120,7 @@ "tags": [ "RoleAssignments" ], - "operationId": "AccessControl_GetRoleAssignmentById", + "operationId": "GetRoleAssignmentById", "description": "Get role assignment by role assignment Id.", "x-ms-examples": { "Get role assignment information": { @@ -158,7 +158,7 @@ "tags": [ "RoleAssignments" ], - "operationId": "AccessControl_DeleteRoleAssignmentById", + "operationId": "DeleteRoleAssignmentById", "description": "Delete role assignment by role assignment Id.", "x-ms-examples": { "Delete role assignment": { @@ -198,7 +198,7 @@ "tags": [ "RoleAssignments" ], - "operationId": "AccessControl_GetCallerRoleAssignments", + "operationId": "GetCallerRoleAssignments", "description": "List role assignments of the caller.", "x-ms-examples": { "Get caller role assignments": { diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roles.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roles.json index f17f83f41ade..8751013f2784 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roles.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2020-02-01-preview/roles.json @@ -22,7 +22,7 @@ "tags": [ "SynapseRoles" ], - "operationId": "AccessControl_GetRoleDefinitions", + "operationId": "GetRoleDefinitions", "description": "List roles.", "x-ms-examples": { "Get access control information": { @@ -62,7 +62,7 @@ "tags": [ "SynapseRoles" ], - "operationId": "AccessControl_GetRoleDefinitionById", + "operationId": "GetRoleDefinitionById", "description": "Get role by role Id.", "x-ms-examples": { "Get access control information": { From 71aa4731350bcabb2da6c589080b460affc8f134 Mon Sep 17 00:00:00 2001 From: Alex Cheng Date: Mon, 22 Jun 2020 11:30:57 -0700 Subject: [PATCH 182/318] new Batch Document Translation API Preview 1.0 (#9218) * Merged from master again * updated swagger based on API review feedback * updated post * fix spelling * added x-ms-pageable, x-ms-error-response, x-ms-long-running * fix enum * remove long running operation * bug in sdk go generation * Revert "bug in sdk go generation" This reverts commit 025b8758f3b4fbeaa4c623645bdc600895c6e86b. * remove x-ms-pageable * addressed changes * fix casing for x-ms-parameterized-host * fix endpoint in examples * move everything in the same SDK readme file * change path to v1.0_preview.1 * fix path * dummy change to restart merge for a 502 server error on sdk generation * fix batch json --- custom-words.txt | 6 + .../v1.0-preview.1/TranslatorBatch.json | 1282 +++++++++++++++++ .../v1.0-preview.1/examples/batch.json | 120 ++ .../v1.0-preview.1/examples/cancel.json | 104 ++ .../v1.0-preview.1/examples/document.json | 104 ++ .../v1.0-preview.1/examples/documents.json | 125 ++ .../v1.0-preview.1/examples/format.json | 82 ++ .../v1.0-preview.1/examples/glossary.json | 83 ++ .../v1.0-preview.1/examples/operation.json | 107 ++ .../v1.0-preview.1/examples/operations.json | 110 ++ .../v1.0-preview.1/examples/storage.json | 63 + .../data-plane/TranslatorText/readme.md | 44 +- 12 files changed, 2228 insertions(+), 2 deletions(-) create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/batch.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/cancel.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/document.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operation.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json create mode 100644 specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/storage.json diff --git a/custom-words.txt b/custom-words.txt index d47d37ab39fc..0aa7135edfb9 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -191,6 +191,7 @@ BCDR BCWG beider Bfor +bfqt bigint Bigram bigrams @@ -1026,6 +1027,7 @@ octokit Odata odatatype ODBC +officedocument OLTP onboarded Onboarding @@ -1042,6 +1044,7 @@ openapi opencode opencontainers openid +openxmlformats operationalinsights Operationalization operationresults @@ -1320,6 +1323,7 @@ runcounts runid runsource runtimes +rwdlacup rwxrw Saas salesforcetables @@ -1459,6 +1463,7 @@ storageaccount storageaccounts storagedatalake storageimportexport +storagesources storagesync storagetarget storageuri @@ -1744,6 +1749,7 @@ Widevine windowsazuremediaservices windowsesu wlmengg +wordprocessingml workbooktemplates Workernode workloadmonitor diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json new file mode 100644 index 000000000000..abdf5f8a1425 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/TranslatorBatch.json @@ -0,0 +1,1282 @@ +{ + "swagger": "2.0", + "info": { + "title": "Batch Document Translation Client", + "version": "v1.0-preview.1" + }, + "paths": { + "/batches": { + "post": { + "tags": [ + "Translation" + ], + "summary": "Submit a batch document translation request to the translation service", + "description": "Submit a batch request to the document translation service.\r\n \r\nEach request can consists of multiple inputs.\r\nEach input will contains both a source and destination container for source and target language pair.\r\n \r\nThe prefix and suffix filter (if supplied) will be used to filter the folders.\r\nThe prefix will be applied to the subpath after the container name\r\n \r\nGlossaries / Translation memory can be supplied and will be applied when the document is being translated.\r\nIf the glossary is invalid or unreachable during translation time. An error will be indicated in the document status.\r\n \r\nIf the file with the same name already exists in the destination, it will be overwritten.\r\nTargetUrl for each target language needs to be unique.", + "operationId": "Translation_SubmitBatchRequest", + "consumes": [ + "application/json", + "text/json", + "application/*+json" + ], + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "body", + "description": "request details", + "schema": { + "$ref": "#/definitions/BatchSubmissionRequest" + } + } + ], + "responses": { + "202": { + "description": "Successful request and the batch request is created by the service. The header Operation-Location will indicate a status url with the operation id.", + "headers": { + "Operation-Location": { + "description": "Location of batch the operation", + "type": "string", + "format": "" + } + } + }, + "400": { + "description": "Invalid request. Check input parameters", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InvalidRequest\",\r\n \"message\": \"Some argument is incorrect\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 400120,\r\n \"error\": \"SASTokenInvalid\",\r\n \"message\": \"SAS token for storage is invalid\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Batch Submit": { + "$ref": "./examples/batch.json" + } + } + }, + "get": { + "tags": [ + "Translation" + ], + "summary": "Returns the list of operations submitted and their summary status", + "description": "Returns the list of status of the translation batch operation.\r\nThe list will consist only of the batch request submitted by the user (based on their subscription)\r\n \r\nThe operation status are sorted by the operation Id\r\n \r\nIf the number of operations exceed our paging limit, server side paging will be used.\r\nPaginated responses will indicate a partial result by including a continuation token in the response. The absence of a continuation token means that no additional pages are available.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nThe server will honor the values specified by the client; however, clients MUST be prepared to handle responses that contain a different page size or contain a continuation token.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. This will avoid the risk of the client making assumptions about the data returned.", + "operationId": "Translation_GetOperations", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "query", + "name": "$top", + "description": "Take the $top entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 100, + "minimum": 1 + }, + { + "in": "query", + "name": "$skip", + "description": "Skip the $skip entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first", + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Successful request and returns the status of the all the operations", + "schema": { + "$ref": "#/definitions/BatchStatusResponse" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + }, + "ETag": { + "description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.", + "type": "string", + "format": "" + } + } + }, + "400": { + "description": "Invalid request. Check input parameters", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InvalidRequest\",\r\n \"message\": \"Some argument is incorrect\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 400120,\r\n \"error\": \"SASTokenInvalid\",\r\n \"message\": \"SAS token for storage is invalid\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get status for batch operations": { + "$ref": "./examples/operations.json" + } + } + } + }, + "/batches/{id}/documents/{documentId}": { + "get": { + "tags": [ + "Translation" + ], + "summary": "Returns the status of the specific document", + "description": "Returns the status of the translation of the document.", + "operationId": "Translation_GetDocumentStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Format - uuid. The batch id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "path", + "name": "documentId", + "description": "Format - uuid. The document id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successful request and it is accepted by the service. The operation details are returned", + "schema": { + "$ref": "#/definitions/DocumentStatusDetail" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + }, + "ETag": { + "description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.", + "type": "string", + "format": "" + } + } + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "404": { + "description": "Resource is not found", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 404000,\r\n \"error\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Document Status": { + "$ref": "./examples/document.json" + } + } + } + }, + "/batches/{id}": { + "get": { + "tags": [ + "Translation" + ], + "summary": "Returns the status of the batch translation operation", + "description": "Returns the status of the translation batch operation.\r\nThe status will include the overall job status as well as a summary of the current progress of all the documents being translated.", + "operationId": "Translation_GetOperationStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Format - uuid. The operation id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Successful request and returns the status of the batch translation operation", + "schema": { + "$ref": "#/definitions/BatchStatusDetail" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + }, + "ETag": { + "description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.", + "type": "string", + "format": "" + } + } + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "404": { + "description": "Resource is not found", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 404000,\r\n \"error\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Batch Operation Status": { + "$ref": "./examples/operation.json" + } + } + }, + "delete": { + "tags": [ + "Translation" + ], + "summary": "Cancel a currently processing or queued operation.", + "description": "Cancel a currently processing or queued operation.\r\nAn operation will not be cancelled if it is already completed or failed or cancelling. A bad request will be returned.\r\nAll documents that have completed translation will not be cancelled and will be charged.\r\nAll pending documents will be cancelled if possible.", + "operationId": "Translation_CancelOperation", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Format - uuid. The operation-id", + "required": true, + "type": "string", + "format": "uuid" + } + ], + "responses": { + "200": { + "description": "Cancel request has been submitted", + "schema": { + "$ref": "#/definitions/BatchStatusDetail" + } + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "404": { + "description": "Resource is not found", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 404000,\r\n \"error\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"batch\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Cancel a batch operation example": { + "$ref": "./examples/cancel.json" + } + } + } + }, + "/batches/{id}/documents": { + "get": { + "tags": [ + "Translation" + ], + "summary": "Returns the status of the documents of a translation batch operation", + "description": "Returns the status of the list of documents translation operation by a given operation id.\r\n \r\nThe documents are sorted by the document Id\r\n \r\nIf the number of documents exceed our paging limit, server side paging will be used.\r\nPaginated responses will indicate a partial result by including a continuation token in the response. The absence of a continuation token means that no additional pages are available.\r\n \r\nClients MAY use $top and $skip query parameters to specify a number of results to return and an offset into the collection.\r\nThe server will honor the values specified by the client; however, clients MUST be prepared to handle responses that contain a different page size or contain a continuation token.\r\nWhen both $top and $skip are given by a client, the server SHOULD first apply $skip and then $top on the collection.\r\nNote: If the server can't honor $top and/or $skip, the server MUST return an error to the client informing about it instead of just ignoring the query options. This will avoid the risk of the client making assumptions about the data returned.", + "operationId": "Translation_GetOperationDocumentsStatus", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "path", + "name": "id", + "description": "Format - uuid. The operation id", + "required": true, + "type": "string", + "format": "uuid" + }, + { + "in": "query", + "name": "$top", + "description": "Take the $top entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first", + "type": "integer", + "format": "int32", + "default": 50, + "maximum": 100, + "minimum": 1 + }, + { + "in": "query", + "name": "$skip", + "description": "Skip the $skip entries in the collection\r\nWhen both $top and $skip are supplied, $skip is applied first", + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 2147483647, + "minimum": 0 + } + ], + "responses": { + "200": { + "description": "Successful request and returns the status of the documents", + "schema": { + "$ref": "#/definitions/DocumentStatusResponse" + }, + "headers": { + "Retry-After": { + "description": "Indicates how long to wait before making a new request.", + "type": "integer", + "format": "int32" + }, + "ETag": { + "description": "The ETag response-header field provides the current value of the entity tag for the requested variant. Used with If-Match, If-None-Match and If-Range to implement optimistic concurrency control.", + "type": "string", + "format": "" + } + } + }, + "400": { + "description": "Invalid request. Check input parameters", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InvalidRequest\",\r\n \"message\": \"Some argument is incorrect\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 400120,\r\n \"error\": \"SASTokenInvalid\",\r\n \"message\": \"SAS token for storage is invalid\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "401": { + "description": "Unauthorized. Please check your credentials", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"Unauthorized\",\r\n \"message\": \"User is not authorized\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 401000,\r\n \"error\": \"Unauthorized\",\r\n \"message\": \"Operation is not authorized\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "404": { + "description": "Resource is not found", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ResourceNotFound\",\r\n \"message\": \"id not found\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 404000,\r\n \"error\": \"ResourceNotFound\",\r\n \"message\": \"Resource requested is not found\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"document\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Documents Status for the operation batch id": { + "$ref": "./examples/documents.json" + } + } + } + }, + "/documents/formats": { + "get": { + "tags": [ + "Translation" + ], + "summary": "Returns the list of supported document formats", + "description": "The list of supported document formats supported by our service.\r\nThe list will include the common file extension used and supported as well as the content-type if using the upload API.", + "operationId": "Translation_GetDocumentFormats", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns the list of supported document file formats", + "schema": { + "$ref": "#/definitions/FileFormatListResult" + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Document Formats": { + "$ref": "./examples/format.json" + } + } + } + }, + "/glossaries/formats": { + "get": { + "tags": [ + "Translation" + ], + "summary": "Returns the list of supported document formats", + "description": "The list of supported glossary formats supported by our service.\r\nThe list will include the common file extension used.", + "operationId": "Translation_GetGlossaryFormats", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Returns the list of supported glossary file formats", + "schema": { + "$ref": "#/definitions/FileFormatListResult" + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"format\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Glossary Formats": { + "$ref": "./examples/glossary.json" + } + } + } + }, + "/storagesources": { + "get": { + "tags": [ + "Translation" + ], + "summary": "Returns the list of supported storage sources", + "description": "The list of storage sources supported by our service.", + "operationId": "Translation_GetDocumentStorageSource", + "produces": [ + "application/json" + ], + "responses": { + "200": { + "description": "Successful request and returns the list of storage sources", + "schema": { + "$ref": "#/definitions/StorageSourceListResult" + } + }, + "429": { + "description": "Too many requests", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"RequestRateTooHigh\",\r\n \"message\": \"User\\u0027s request rate is too high\",\r\n \"target\": \"source\",\r\n \"innerError\": {\r\n \"code\": 429000,\r\n \"error\": \"RateTooHigh\",\r\n \"message\": \"Request rate is too high\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "500": { + "description": "Internal Server Error", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"InternalServerError\",\r\n \"message\": \"Internal Server Error\",\r\n \"target\": \"source\",\r\n \"innerError\": {\r\n \"code\": 500000,\r\n \"error\": \"Internal Server Error\",\r\n \"message\": \"Unexpected internal server error has occurred\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + }, + "503": { + "description": "Server temporary unavailable", + "schema": { + "$ref": "#/definitions/ErrorResponseV2" + }, + "examples": { + "application/json": "{\r\n \"error\": {\r\n \"code\": \"ServiceUnavailable\",\r\n \"message\": \"Service is temporary unavailable\",\r\n \"target\": \"source\",\r\n \"innerError\": {\r\n \"code\": 503000,\r\n \"error\": \"ServiceTemporaryUnavailable\",\r\n \"message\": \"Service is currently unavailable. Please try again later\"\r\n }\r\n }\r\n}" + }, + "x-ms-error-response": true + } + }, + "x-ms-examples": { + "Get Document Storage Sources": { + "$ref": "./examples/storage.json" + } + } + } + } + }, + "definitions": { + "DocumentFilter": { + "type": "object", + "properties": { + "prefix": { + "description": "A case-sensitive prefix string to filter documents in the source path for translation. \r\nFor example, when using a Azure storage blob Uri, use the prefix to restrict sub folders for translation.", + "type": "string", + "example": "FolderA" + }, + "suffix": { + "description": "A case-sensitive suffix string to filter documents in the source path for translation. \r\nThis is most often use for file extensions", + "type": "string", + "example": ".txt" + } + } + }, + "StorageSource": { + "description": "Storage Source", + "enum": [ + "AzureBlob" + ], + "type": "string" + }, + "SourceInput": { + "description": "Source of the input documents", + "required": [ + "sourceUrl" + ], + "type": "object", + "properties": { + "sourceUrl": { + "description": "Location of the folder / container with your documents", + "type": "string", + "example": "https://myblob.blob.core.windows.net/Container/" + }, + "filter": { + "$ref": "#/definitions/DocumentFilter" + }, + "language": { + "description": "Language code\r\nIf none is specified, we will perform auto detect on the document", + "type": "string", + "example": "en" + }, + "storageSource": { + "$ref": "#/definitions/StorageSource" + } + } + }, + "Glossary": { + "description": "Glossary / translation memory for the request", + "required": [ + "glossaryUrl" + ], + "type": "object", + "properties": { + "glossaryUrl": { + "description": "Location of the glossary. \r\nWe will use the file extension to extract the formating if the format parameter is not supplied.\r\n\r\nIf the translation language pair is not present in the glossary, it will not be applied", + "type": "string", + "example": "https://myblob.blob.core.windows.net/Container/myglossary.tsv" + }, + "format": { + "description": "Format", + "type": "string", + "example": "XLIFF" + }, + "version": { + "description": "Version", + "type": "string", + "example": "2.0" + } + } + }, + "TargetInput": { + "description": "Destination for the finished translated documents", + "required": [ + "language", + "targetUrl" + ], + "type": "object", + "properties": { + "targetUrl": { + "description": "Location of the folder / container with your documents", + "type": "string", + "example": "https://myblob.blob.core.windows.net/TargetUrl/" + }, + "category": { + "description": "Category / custom system for translation request", + "type": "string", + "example": "general" + }, + "language": { + "description": "Target Language", + "type": "string", + "example": "fr" + }, + "glossaries": { + "description": "List of Glossary", + "type": "array", + "items": { + "$ref": "#/definitions/Glossary" + } + }, + "storageSource": { + "$ref": "#/definitions/StorageSource" + } + } + }, + "BatchRequest": { + "description": "Definition for the input batch translation request", + "required": [ + "source", + "targets" + ], + "type": "object", + "properties": { + "source": { + "$ref": "#/definitions/SourceInput" + }, + "targets": { + "description": "Location of the destination for the output", + "type": "array", + "items": { + "$ref": "#/definitions/TargetInput" + } + } + } + }, + "BatchSubmissionRequest": { + "description": "Job submission batch request", + "required": [ + "inputs" + ], + "type": "object", + "properties": { + "inputs": { + "description": "The input list of documents or folders containing documents", + "type": "array", + "items": { + "$ref": "#/definitions/BatchRequest" + } + } + } + }, + "Status": { + "description": "List of possible statuses for job or document", + "enum": [ + "NotStarted", + "Running", + "Succeeded", + "Failed", + "Cancelled", + "Cancelling" + ], + "type": "string" + }, + "StatusSummary": { + "type": "object", + "properties": { + "total": { + "format": "int32", + "description": "Total count", + "type": "integer", + "example": 1 + }, + "failed": { + "format": "int32", + "description": "Failed count", + "type": "integer", + "example": 0 + }, + "success": { + "format": "int32", + "description": "Number of Success", + "type": "integer", + "example": 1 + }, + "inProgress": { + "format": "int32", + "description": "Number of in progress", + "type": "integer", + "example": 0 + }, + "notYetStarted": { + "format": "int32", + "description": "Count of not yet started", + "type": "integer", + "example": 0 + }, + "cancelled": { + "format": "int32", + "description": "Number of cancelled", + "type": "integer", + "example": 0 + } + } + }, + "BatchStatusDetail": { + "description": "Job status response", + "required": [ + "createdDateTimeUtc", + "id", + "lastActionDateTimeUtc", + "summary" + ], + "type": "object", + "properties": { + "id": { + "format": "uuid", + "description": "Id of the operation.", + "type": "string", + "example": "36724748-f7a0-4db7-b7fd-f041ddc75033" + }, + "createdDateTimeUtc": { + "format": "date-time", + "description": "Operation created date time", + "type": "string", + "example": "2020-01-20T11:40:07.7010000-08:00" + }, + "lastActionDateTimeUtc": { + "format": "date-time", + "description": "Date time in which the operation's status has been updated", + "type": "string", + "example": "2020-01-20T11:41:07.7010000-08:00" + }, + "status": { + "$ref": "#/definitions/Status" + }, + "summary": { + "$ref": "#/definitions/StatusSummary" + } + } + }, + "BatchStatusResponse": { + "description": "Document Status Response", + "type": "object", + "properties": { + "value": { + "description": "The summary status of individual operation", + "type": "array", + "items": { + "$ref": "#/definitions/BatchStatusDetail" + } + }, + "@nextLink": { + "description": "Url for the next page. Null if no more pages available", + "type": "string", + "example": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operations?$top=5&$skip=15" + } + } + }, + "ErrorCodeV2": { + "description": "Enums containing high level error codes.", + "enum": [ + "InvalidRequest", + "InvalidArgument", + "InternalServerError", + "ServiceUnavailable", + "ResourceNotFound", + "Unauthorized", + "RequestRateTooHigh" + ], + "type": "string" + }, + "InnerErrorV2": { + "description": "New Inner Error format which conforms to Cognitive Services API Guidelines which is available at https://microsoft.sharepoint.com/%3Aw%3A/t/CognitiveServicesPMO/EUoytcrjuJdKpeOKIK_QRC8BPtUYQpKBi8JsWyeDMRsWlQ?e=CPq8ow.\r\nThis contains required properties ErrorCode, message and optional properties target, details(key value pair), inner error(this can be nested).", + "type": "object", + "properties": { + "code": { + "format": "int32", + "description": "Gets detailed error code.", + "type": "integer", + "readOnly": true + }, + "error": { + "description": "Gets detailed error string.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Gets high level error message.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Gets the source of the error. \r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string", + "readOnly": true + }, + "innerError": { + "$ref": "#/definitions/InnerErrorV2" + } + } + }, + "ErrorV2": { + "description": "This contains an outer error with error code, message, details, target and an inner error with more descriptive details.", + "type": "object", + "properties": { + "code": { + "$ref": "#/definitions/ErrorCodeV2" + }, + "message": { + "description": "Gets high level error message.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "Gets the source of the error. \r\nFor example it would be \"documents\" or \"document id\" in case of invalid document.", + "type": "string", + "readOnly": true + }, + "innerError": { + "$ref": "#/definitions/InnerErrorV2" + } + } + }, + "DocumentStatusDetail": { + "required": [ + "createdDateTimeUtc", + "lastActionDateTimeUtc", + "path", + "status", + "to" + ], + "type": "object", + "properties": { + "path": { + "description": "Location of the document or folder", + "type": "string", + "example": "https://myblob.blob.core.windows.net/mycontainer/fr/mydoc.txt" + }, + "createdDateTimeUtc": { + "format": "date-time", + "description": "Operation created date time", + "type": "string", + "example": "2020-01-20T11:40:07.7010000-08:00" + }, + "lastActionDateTimeUtc": { + "format": "date-time", + "description": "Date time in which the operation's status has been updated", + "type": "string", + "example": "2020-01-20T11:41:07.7010000-08:00" + }, + "status": { + "$ref": "#/definitions/Status" + }, + "detectedLanguage": { + "description": "Detected language of the original document (to be implemented)", + "type": "string", + "example": "en" + }, + "to": { + "description": "To language", + "type": "string" + }, + "error": { + "$ref": "#/definitions/ErrorV2" + }, + "progress": { + "format": "float", + "description": "Progress of the translation if available", + "maximum": 1, + "minimum": 0, + "type": "number", + "example": 0.5 + }, + "id": { + "format": "uuid", + "description": "Document Id", + "type": "string", + "example": "1c7399a7-6913-4f20-bb43-e2fe2ba1a67d" + } + } + }, + "DocumentStatusResponse": { + "description": "Document Status Response", + "type": "object", + "properties": { + "value": { + "description": "The detail status of individual documents", + "type": "array", + "items": { + "$ref": "#/definitions/DocumentStatusDetail" + } + }, + "@nextLink": { + "description": "Url for the next page. Null if no more pages available", + "type": "string", + "example": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operations/727BF148-F327-47A0-9481-ABAE6362F11E/documents?$top=5&$skip=15" + } + } + }, + "FileFormat": { + "type": "object", + "properties": { + "format": { + "description": "Name of the format", + "type": "string", + "example": "PlainText" + }, + "fileExtensions": { + "description": "Supported file extension for this format", + "type": "array", + "items": { + "type": "string" + } + }, + "contentTypes": { + "description": "Supported Content-Types for this format", + "type": "array", + "items": { + "type": "string" + } + }, + "versions": { + "description": "Supported Version", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "FileFormatListResult": { + "description": "Base type for List return in our api", + "type": "object", + "properties": { + "value": { + "description": "list of objects", + "type": "array", + "items": { + "$ref": "#/definitions/FileFormat" + } + } + } + }, + "StorageSourceListResult": { + "description": "Base type for List return in our api", + "type": "object", + "properties": { + "value": { + "description": "list of objects", + "type": "array", + "items": { + "$ref": "#/definitions/StorageSource" + } + } + } + }, + "ErrorResponseV2": { + "description": "Contains unified error information used for HTTP responses across any Cognitive Service. Instances\r\ncan be created either through Microsoft.CloudAI.Containers.HttpStatusExceptionV2 or by returning it directly from\r\na controller.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorV2" + } + } + } + }, + "securityDefinitions": { + "subscription_key": { + "type": "apiKey", + "name": "Ocp-Apim-Subscription-Key", + "in": "header", + "description": "Provide your cognitive services subscription key here." + } + }, + "security": [ + { + "subscription_key": [] + } + ], + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/translator/text/batch/v1.0-preview.1", + "useSchemePrefix": false, + "parameters": [ + { + "in": "path", + "name": "endpoint", + "description": "Supported Cognitive Services endpoints (protocol and hostname, for example: https://westus.api.cognitive.microsoft.com).", + "required": true, + "type": "string", + "x-ms-parameter-location": "client", + "x-ms-skip-url-encoding": true + } + ] + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/batch.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/batch.json new file mode 100644 index 000000000000..f4c0fe1c1c19 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/batch.json @@ -0,0 +1,120 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "batchRequest": { + "inputs": [ + { + "source": { + "sourceUrl": "https://myblob.blob.core.windows.net/sourceContainer", + "filter": { + "prefix": "pre", + "suffix": ".txt" + }, + "language": "en", + "storageSource": "AzureBlob" + }, + "targets": [ + { + "targetUrl": "https://myblob.blob.core.windows.net/destinationContainer1", + "category": "general", + "language": "fr", + "glossaries": [ + { + "glossaryUrl": "https://myblob.blob.core.windows.net/myglossary/en_fr_glossary.xlf" + } + ], + "storageSource": "AzureBlob" + }, + { + "targetUrl": "https://myblob.blob.core.windows.net/destinationContainer2", + "category": "general", + "language": "es", + "storageSource": "AzureBlob" + } + ] + } + ] + } + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "innerError": { + "code": 401000, + "error": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "innerError": { + "code": 429000, + "error": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "innerError": { + "code": 500000, + "error": "Internal Server Error", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "innerError": { + "code": 503000, + "error": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "202": { + "headers": { + "Operation-Location": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Some argument is incorrect", + "innerError": { + "code": 400120, + "error": "SASTokenInvalid", + "message": "SAS token for storage is invalid" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/cancel.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/cancel.json new file mode 100644 index 000000000000..582b7c86043b --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/cancel.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "id": "727BF148-F327-47A0-9481-ABAE6362F11E" + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "target": "Operation", + "innerError": { + "code": 401000, + "error": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "target": "Operation", + "innerError": { + "code": 429000, + "error": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "target": "Operation", + "innerError": { + "code": 500000, + "error": "Internal Server Error", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "target": "Operation", + "innerError": { + "code": 503000, + "error": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "ResourceNotFound", + "message": "id not found", + "target": "Operation", + "innerError": { + "code": 404000, + "error": "ResourceNotFound", + "message": "Resource requested is not found" + } + } + } + }, + "200": { + "headers": {}, + "body": { + "id": "727bf148-f327-47a0-9481-abae6362f11e", + "createdDateTimeUtc": "2020-03-26T00:00:00Z", + "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", + "status": "Succeeded", + "summary": { + "total": 10, + "failed": 1, + "success": 9, + "inProgress": 0, + "notYetStarted": 0, + "cancelled": 0 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/document.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/document.json new file mode 100644 index 000000000000..0ba43466b7de --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/document.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "id": "727BF148-F327-47A0-9481-ABAE6362F11E", + "documentId": 199800 + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "target": "Document", + "innerError": { + "code": 401000, + "error": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "target": "Document", + "innerError": { + "code": 429000, + "error": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "target": "Document", + "innerError": { + "code": 500000, + "error": "Internal Server Error", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "target": "Document", + "innerError": { + "code": 503000, + "error": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "ResourceNotFound", + "message": "id not found", + "target": "Document", + "innerError": { + "code": 404000, + "error": "ResourceNotFound", + "message": "Resource requested is not found" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt", + "createdDateTimeUtc": "2020-03-26T00:00:00Z", + "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", + "status": "Running", + "detectedLanguage": "en", + "to": "fr", + "progress": 0.1, + "id": "273622bd-835c-4946-9798-fd8f19f6bbf2" + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json new file mode 100644 index 000000000000..cdb8df766ea7 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/documents.json @@ -0,0 +1,125 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "id": "727BF148-F327-47A0-9481-ABAE6362F11E", + "$top": 5, + "$skip": 10 + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "target": "Document", + "innerError": { + "code": 401000, + "error": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "target": "Document", + "innerError": { + "code": 429000, + "error": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "target": "Document", + "innerError": { + "code": 500000, + "error": "Internal Server Error", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "target": "Document", + "innerError": { + "code": 503000, + "error": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "ResourceNotFound", + "message": "id not found", + "target": "Document", + "innerError": { + "code": 404000, + "error": "ResourceNotFound", + "message": "Resource requested is not found" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "value": [ + { + "path": "https://myblob.blob.core.windows.net/destinationContainer/fr/mydoc.txt", + "createdDateTimeUtc": "2020-03-26T00:00:00Z", + "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", + "status": "Running", + "detectedLanguage": "en", + "to": "fr", + "progress": 0.1, + "id": "273622bd-835c-4946-9798-fd8f19f6bbf2" + } + ], + "@nextLink": "https://westus.cognitiveservices.azure.com/translator/text/batch/v1.0.preview.1/operation/0FA2822F-4C2A-4317-9C20-658C801E0E55/documents?$top=5&$skip=15" + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Some argument is incorrect", + "target": "Document", + "innerError": { + "code": 400120, + "error": "SASTokenInvalid", + "message": "SAS token for storage is invalid" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json new file mode 100644 index 000000000000..66452ed6c1a9 --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/format.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "innerError": { + "code": 429000, + "error": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "innerError": { + "code": 500000, + "error": "Internal Server Error", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "innerError": { + "code": 503000, + "error": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "200": { + "headers": { + "ETag": "686897696a7c876b7e" + }, + "body": { + "value": [ + { + "format": "PlainText", + "fileExtensions": [ + ".txt" + ], + "contentTypes": [ + "text/plain" + ], + "versions": [] + }, + { + "format": "OpenXmlWord", + "fileExtensions": [ + ".docx" + ], + "contentTypes": [ + "application/vnd.openxmlformats-officedocument.wordprocessingml.document" + ], + "versions": [] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json new file mode 100644 index 000000000000..6c8fd7d5af2b --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/glossary.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "innerError": { + "code": 429000, + "error": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "innerError": { + "code": 500000, + "error": "Internal Server Error", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "innerError": { + "code": 503000, + "error": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "200": { + "headers": { + "ETag": "686897696a7c876b7e" + }, + "body": { + "value": [ + { + "format": "XLIFF", + "fileExtensions": [ + ".xlf" + ], + "contentTypes": [ + "application/xliff+xml" + ], + "versions": [ + "1.2", + "2.0" + ] + }, + { + "format": "TMX", + "fileExtensions": [ + ".tmx" + ], + "contentTypes": [], + "versions": [] + } + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operation.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operation.json new file mode 100644 index 000000000000..88adf548729e --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operation.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}", + "id": "727BF148-F327-47A0-9481-ABAE6362F11E" + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "target": "Operation", + "innerError": { + "code": 401000, + "error": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "target": "Operation", + "innerError": { + "code": 429000, + "error": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "target": "Operation", + "innerError": { + "code": 500000, + "error": "Internal Server Error", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "target": "Operation", + "innerError": { + "code": 503000, + "error": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "404": { + "headers": {}, + "body": { + "error": { + "code": "ResourceNotFound", + "message": "id not found", + "target": "Operation", + "innerError": { + "code": 404000, + "error": "ResourceNotFound", + "message": "Resource requested is not found" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "id": "727bf148-f327-47a0-9481-abae6362f11e", + "createdDateTimeUtc": "2020-03-26T00:00:00Z", + "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", + "status": "Succeeded", + "summary": { + "total": 10, + "failed": 1, + "success": 9, + "inProgress": 0, + "notYetStarted": 0, + "cancelled": 0 + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json new file mode 100644 index 000000000000..0bef1580c01f --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/operations.json @@ -0,0 +1,110 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "401": { + "headers": {}, + "body": { + "error": { + "code": "Unauthorized", + "message": "User is not authorized", + "target": "Operation", + "innerError": { + "code": 401000, + "error": "Unauthorized", + "message": "Operation is not authorized" + } + } + } + }, + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "target": "Operation", + "innerError": { + "code": 429000, + "error": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "target": "Operation", + "innerError": { + "code": 500000, + "error": "Internal Server Error", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "target": "Operation", + "innerError": { + "code": 503000, + "error": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "200": { + "headers": { + "retry-after": "30", + "ETag": "686897696a7c876b7e" + }, + "body": { + "value": [ + { + "id": "727bf148-f327-47a0-9481-abae6362f11e", + "createdDateTimeUtc": "2020-03-26T00:00:00Z", + "lastActionDateTimeUtc": "2020-03-26T01:00:00Z", + "status": "Succeeded", + "summary": { + "total": 10, + "failed": 1, + "success": 9, + "inProgress": 0, + "notYetStarted": 0, + "cancelled": 0 + } + } + ] + } + }, + "400": { + "headers": {}, + "body": { + "error": { + "code": "InvalidRequest", + "message": "Some argument is incorrect", + "target": "Operation", + "innerError": { + "code": 400120, + "error": "SASTokenInvalid", + "message": "SAS token for storage is invalid" + } + } + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/storage.json b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/storage.json new file mode 100644 index 000000000000..309b22d92b7e --- /dev/null +++ b/specification/cognitiveservices/data-plane/TranslatorText/preview/v1.0-preview.1/examples/storage.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "v1.0-preview.1", + "subscriptionId": "EA19050C-51FC-4B55-84E5-9EA7283601DA", + "resourceGroupName": "TestResourceGroup", + "endpoint": "{endpoint}", + "Ocp-Apim-Subscription-Key": "{API key}" + }, + "responses": { + "429": { + "headers": {}, + "body": { + "error": { + "code": "RequestRateTooHigh", + "message": "User's request rate is too high", + "innerError": { + "code": 429000, + "error": "RateTooHigh", + "message": "Request rate is too high" + } + } + } + }, + "500": { + "headers": {}, + "body": { + "error": { + "code": "InternalServerError", + "message": "Internal Server Error", + "innerError": { + "code": 500000, + "error": "Internal Server Error", + "message": "Unexpected internal server error has occurred" + } + } + } + }, + "503": { + "headers": {}, + "body": { + "error": { + "code": "ServiceUnavailable", + "message": "Service is temporary unavailable", + "innerError": { + "code": 503000, + "error": "ServiceTemporaryUnavailable", + "message": "Service is currently unavailable. Please try again later" + } + } + } + }, + "200": { + "headers": { + "ETag": "686897696a7c876b7e" + }, + "body": { + "value": [ + "AzureBlob" + ] + } + } + } +} diff --git a/specification/cognitiveservices/data-plane/TranslatorText/readme.md b/specification/cognitiveservices/data-plane/TranslatorText/readme.md index 4e0143fa3acc..f6b28b8d49fe 100644 --- a/specification/cognitiveservices/data-plane/TranslatorText/readme.md +++ b/specification/cognitiveservices/data-plane/TranslatorText/readme.md @@ -6,6 +6,8 @@ Configuration for generating Translator Text SDK. The current release is `release_3_0`. +The current document batch preview release is `release_1_0_preview.1'`. + ``` yaml tag: release_3_0 @@ -13,8 +15,21 @@ add-credentials: true openapi-type: data-plane ``` +``` yaml + +tag: release_1_0_preview.1 +add-credentials: true +openapi-type: data-plane +``` + # Releases +### Preview 1.0 +This setting is for batch document translator and only applied when `--tag=release_1_0_preview.1` is specified on the command line. +``` yaml $(tag) == 'release_1_0_preview.1' +input-file: preview/v1.0-preview.1/TranslatorBatch.json +``` + ### Release 3.0 These settings apply only when `--tag=release_3_0` is specified on the command line. @@ -90,6 +105,15 @@ go: ``` yaml $(go) && $(multiapi) batch: - tag: release_3_0 + - tag: release_1_0_preview.1 +``` +### Tag: release_1_0_preview.1 and go + +These settings apply only when `--tag=release_1_0_preview.1 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'release_1_0_preview.1' && $(go) +output-folder: $(go-sdk-folder)/services/cognitiveservices/v1.0_preview.1/$(namespace) ``` ### Tag: release_3_0 and go @@ -120,8 +144,7 @@ java: ``` yaml $(nodejs) nodejs: - package-name: azure-cognitiveservices-newssearch - package-version: 3.0.0 + package-name: azure-cognitiveservices-translatortext output-folder: $(node-sdks-folder)/lib/services/translatorText azure-arm: false generate-license-txt: true @@ -129,6 +152,22 @@ nodejs: generate-readme-md: false ``` +### Tag: release_1_0_preview.1 and nodejs + +These settings apply only when `--tag=release_1_0_preview.1 --nodejs` is specified on the command line. + +``` yaml $(tag) == 'release_1_0_preview.1' && $(nodejs) + package-version: 1.0.1 +``` + +### Tag: release_3_0 and go + +These settings apply only when `--tag=release_3_0 --nodejs` is specified on the command line. + +``` yaml $(tag) == 'release_3_0' && $(nodejs) + package-version: 3.0.0 +``` + ## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -142,6 +181,7 @@ require: $(this-folder)/../../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/stable/v3.0/TranslatorText.json + - $(this-folder)/preview/v1.0-preview.1/TranslatorBatch.json ``` From a0431baad0465172db06ca9684e8a6ad80836c67 Mon Sep 17 00:00:00 2001 From: tilnl <44656553+tilnl@users.noreply.github.com> Date: Mon, 22 Jun 2020 19:06:08 -0700 Subject: [PATCH 183/318] Merge Dev containerservice microsoft.container service 2020 06 01 (#9914) --- .../examples/AgentPoolsCreate_PPG.json | 52 + .../examples/AgentPoolsCreate_Spot.json | 84 + .../examples/AgentPoolsCreate_Update.json | 86 + .../2020-06-01/examples/AgentPoolsDelete.json | 13 + .../2020-06-01/examples/AgentPoolsGet.json | 29 + ...entPoolsGetAgentPoolAvailableVersions.json | 32 + .../examples/AgentPoolsGetUpgradeProfile.json | 28 + .../2020-06-01/examples/AgentPoolsList.json | 29 + .../examples/AgentPools_Update.json | 73 + .../examples/ManagedClustersCreate_PPG.json | 237 ++ .../ManagedClustersCreate_Update.json | 273 ++ ...stersCreate_UpdateWithEnableAzureRBAC.json | 265 ++ .../examples/ManagedClustersDelete.json | 12 + .../examples/ManagedClustersGet.json | 96 + .../ManagedClustersGetAccessProfile.json | 22 + .../ManagedClustersGetUpgradeProfile.json | 49 + .../examples/ManagedClustersList.json | 65 + .../ManagedClustersListByResourceGroup.json | 66 + ...edClustersListClusterCredentialResult.json | 20 + .../ManagedClustersResetAADProfile.json | 18 + ...dClustersResetServicePrincipalProfile.json | 16 + ...agedClustersRotateClusterCertificates.json | 12 + .../examples/ManagedClustersUpdateTags.json | 68 + .../PrivateEndpointConnectionsDelete.json | 13 + .../PrivateEndpointConnectionsGet.json | 26 + .../PrivateEndpointConnectionsList.json | 29 + .../PrivateEndpointConnectionsUpdate.json | 33 + .../stable/2020-06-01/managedClusters.json | 2958 +++++++++++++++++ .../resource-manager/readme.go.md | 10 + .../resource-manager/readme.java.md | 14 + .../resource-manager/readme.md | 30 +- .../resource-manager/readme.python.md | 12 + 32 files changed, 4768 insertions(+), 2 deletions(-) create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_Spot.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPools_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_PPG.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_Update.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGetAccessProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGetUpgradeProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersListByResourceGroup.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersListClusterCredentialResult.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersResetAADProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersResetServicePrincipalProfile.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersRotateClusterCertificates.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersUpdateTags.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsDelete.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsGet.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsList.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsUpdate.json create mode 100644 specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/managedClusters.json diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_PPG.json new file mode 100644 index 000000000000..dc1b74e96ef5 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_PPG.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_Spot.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_Spot.json new file mode 100644 index 000000000000..50002ea64342 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_Spot.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "spotMaxPrice": -1 + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_Update.json new file mode 100644 index 000000000000..35a6bb854d56 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsCreate_Update.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "tags": { + "name1": "val1" + }, + "nodeLabels": { + "key1": "val1" + }, + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete", + "mode": "User" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsDelete.json new file mode 100644 index 000000000000..2ede92507048 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGet.json new file mode 100644 index 000000000000..46437321e790 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json new file mode 100644 index 000000000000..753d6f5f7789 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGetAgentPoolAvailableVersions.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/availableagentpoolversions", + "name": "default", + "properties": { + "agentPoolVersions": [ + { + "kubernetesVersion": "1.12.7" + }, + { + "kubernetesVersion": "1.12.8" + }, + { + "default": true, + "kubernetesVersion": "1.13.5", + "isPreview": true + } + ] + }, + "type": "Microsoft.ContainerService/managedClusters/availableAgentpoolVersions" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGetUpgradeProfile.json new file mode 100644 index 000000000000..14039932b31a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsGetUpgradeProfile.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1/upgradeprofiles/default", + "name": "default", + "properties": { + "kubernetesVersion": "1.12.8", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.13.5" + } + ], + "latestNodeImageVersion": "AKSUbuntu:1604:2020.03.11" + }, + "type": "Microsoft.ContainerService/managedClusters/agentPools/upgradeProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsList.json new file mode 100644 index 000000000000..2ef373f515bb --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPoolsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "orchestratorVersion": "1.9.6", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPools_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPools_Update.json new file mode 100644 index 000000000000..cad9aed64e89 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/AgentPools_Update.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "agentPoolName": "agentpool1", + "parameters": { + "properties": { + "orchestratorVersion": "", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/agentPools/agentpool1", + "type": "Microsoft.ContainerService/managedClusters/agentPools", + "name": "agentpool1", + "properties": { + "provisioningState": "Updating", + "orchestratorVersion": "1.9.6", + "count": 3, + "enableAutoScaling": true, + "minCount": 2, + "maxCount": 2, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "nodeTaints": [ + "Key1=Value1:NoSchedule" + ], + "scaleSetPriority": "Spot", + "scaleSetEvictionPolicy": "Delete" + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_PPG.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_PPG.json new file mode 100644 index 000000000000..17ad15f53e24 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_PPG.json @@ -0,0 +1,237 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS2_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "enableNodePublicIP": true, + "mode": "System", + "proximityPlacementGroupID": "/subscriptions/subid1/resourcegroups/rg1/providers//Microsoft.Compute/proximityPlacementGroups/ppg1" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_Update.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_Update.json new file mode 100644 index 000000000000..04dd21377676 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_Update.json @@ -0,0 +1,273 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + }, + "identity": { + "type": "UserAssigned", + "userAssignedIdentities": { + "/subscriptions/subid1/resourceGroups/rgName1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity1": { + "principalId": "principalId1", + "clientId": "clientId1" + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json new file mode 100644 index 000000000000..ccbd290b5d9e --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json @@ -0,0 +1,265 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "location": "location1", + "tags": { + "tier": "production", + "archv2": "" + }, + "sku": { + "name": "Basic", + "tier": "Free" + }, + "properties": { + "kubernetesVersion": "", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "osType": "Linux", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "networkProfile": { + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "managedOutboundIPs": { + "count": 2 + } + } + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + }, + "windowsProfile": { + "adminUsername": "azureuser", + "adminPassword": "replacePassword1234$" + }, + "servicePrincipalProfile": { + "clientId": "clientid", + "secret": "secret" + }, + "addonProfiles": {}, + "aadProfile": { + "managed": true, + "enableAzureRBAC": true + }, + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System", + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "loadBalancerSku": "basic", + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Creating", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Creating", + "orchestratorVersion": "1.9.6", + "type": "VirtualMachineScaleSets", + "availabilityZones": [ + "1", + "2", + "3" + ], + "enableNodePublicIP": true, + "mode": "System" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "windowsProfile": { + "adminUsername": "azureuser" + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": true, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "enablePodSecurityPolicy": true, + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "managedOutboundIPs": { + "count": 2 + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + }, + "aadProfile": { + "managed": true, + "adminGroupObjectIDs": null, + "enableAzureRBAC": true, + "tenantID": "tenantID" + }, + "autoScalerProfile": { + "scan-interval": "20s", + "scale-down-delay-after-add": "15m" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersDelete.json new file mode 100644 index 000000000000..ed2c55924421 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGet.json new file mode 100644 index 000000000000..873473904cc8 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGet.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "maxAgentPools": 1, + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6", + "availabilityZones": [ + "1", + "2", + "3" + ], + "nodeImageVersion": "AKSUbuntu:1604:2020.03.11", + "upgradeSettings": { + "maxSurge": "33%" + } + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16", + "loadBalancerSku": "standard", + "outboundType": "loadBalancer", + "loadBalancerProfile": { + "allocatedOutboundPorts": 2000, + "idleTimeoutInMinutes": 10, + "outboundIPs": { + "publicIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Network/publicIPAddresses/customeroutboundip2" + } + ] + }, + "effectiveOutboundIPs": [ + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip1" + }, + { + "id": "/subscriptions/subid1/resourceGroups/MC_rg1/providers/Microsoft.Network/publicIPAddresses/mgdoutboundip2" + } + ] + } + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGetAccessProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGetAccessProfile.json new file mode 100644 index 000000000000..96b7055f4a8c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGetAccessProfile.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "roleName": "clusterUser" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/accessProfiles/clusterUser", + "location": "location1", + "name": "clusterUser", + "properties": { + "kubeConfig": "kubeConfig1" + }, + "type": "Microsoft.ContainerService/ManagedClusters/AccessProfiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGetUpgradeProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGetUpgradeProfile.json new file mode 100644 index 000000000000..5f5b6488729c --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersGetUpgradeProfile.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1/upgradeprofiles/default", + "name": "default", + "properties": { + "agentPoolProfiles": [ + { + "kubernetesVersion": "1.7.7", + "name": "agent", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9" + }, + { + "kubernetesVersion": "1.7.11", + "isPreview": true + } + ] + } + ], + "controlPlaneProfile": { + "kubernetesVersion": "1.7.7", + "name": "master", + "osType": "Linux", + "upgrades": [ + { + "kubernetesVersion": "1.7.9", + "isPreview": true + }, + { + "kubernetesVersion": "1.7.11" + } + ] + } + }, + "type": "Microsoft.ContainerService/managedClusters/upgradeprofiles" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersList.json new file mode 100644 index 000000000000..b8d2dc023d4f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersList.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersListByResourceGroup.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersListByResourceGroup.json new file mode 100644 index 000000000000..86696f7060d9 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersListByResourceGroup.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters", + "location": "location1", + "name": "clustername1", + "tags": { + "archv2": "", + "tier": "production" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "maxAgentPools": 1, + "dnsPrefix": "dnsprefix1", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersListClusterCredentialResult.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersListClusterCredentialResult.json new file mode 100644 index 000000000000..a3f86daa7a9f --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersListClusterCredentialResult.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "kubeconfigs": [ + { + "name": "credentialName1", + "value": "credentialValue1" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersResetAADProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersResetAADProfile.json new file mode 100644 index 000000000000..6cb827c2c670 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersResetAADProfile.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientAppID": "clientappid", + "serverAppID": "serverappid", + "serverAppSecret": "serverappsecret", + "tenantID": "tenantid" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersResetServicePrincipalProfile.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersResetServicePrincipalProfile.json new file mode 100644 index 000000000000..71f3f957608a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersResetServicePrincipalProfile.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "clientId": "clientid", + "secret": "secret" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersRotateClusterCertificates.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersRotateClusterCertificates.json new file mode 100644 index 000000000000..ed2c55924421 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersRotateClusterCertificates.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersUpdateTags.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersUpdateTags.json new file mode 100644 index 000000000000..569e0392ca7a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/ManagedClustersUpdateTags.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "parameters": { + "tags": { + "tier": "testing", + "archv3": "" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid1/resourcegroups/rg1/providers/Microsoft.ContainerService/managedClusters/clustername1", + "location": "location1", + "name": "clustername1", + "tags": { + "archv3": "", + "tier": "testing" + }, + "type": "Microsoft.ContainerService/ManagedClusters", + "properties": { + "provisioningState": "Succeeded", + "kubernetesVersion": "1.9.6", + "dnsPrefix": "dnsprefix1", + "agentPoolProfiles": [ + { + "name": "nodepool1", + "count": 3, + "vmSize": "Standard_DS1_v2", + "maxPods": 110, + "osType": "Linux", + "provisioningState": "Succeeded", + "orchestratorVersion": "1.9.6" + } + ], + "linuxProfile": { + "adminUsername": "azureuser", + "ssh": { + "publicKeys": [ + { + "keyData": "keydata" + } + ] + } + }, + "servicePrincipalProfile": { + "clientId": "clientid" + }, + "nodeResourceGroup": "MC_rg1_clustername1_location1", + "enableRBAC": false, + "diskEncryptionSetID": "/subscriptions/subid1/resourceGroups/rg1/providers/Microsoft.Compute/diskEncryptionSets/des", + "fqdn": "dnsprefix1-abcd1234.hcp.eastus.azmk8s.io", + "networkProfile": { + "networkPlugin": "kubenet", + "podCidr": "10.244.0.0/16", + "serviceCidr": "10.0.0.0/16", + "dnsServiceIP": "10.0.0.10", + "dockerBridgeCidr": "172.17.0.1/16" + } + } + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsDelete.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsDelete.json new file mode 100644 index 000000000000..64c8e8d92e9a --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsGet.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsGet.json new file mode 100644 index 000000000000..0a18cad228f0 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsGet.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1" + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsList.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsList.json new file mode 100644 index 000000000000..ce63ece40250 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsList.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + ] + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsUpdate.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsUpdate.json new file mode 100644 index 000000000000..3ee7e1bf0c83 --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/examples/PrivateEndpointConnectionsUpdate.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "subid1", + "resourceGroupName": "rg1", + "resourceName": "clustername1", + "privateEndpointConnectionName": "privateendpointconnection1", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subid2/resourceGroups/rg2/providers/Microsoft.Network/privateEndpoints/pe2" + }, + "privateLinkServiceConnectionState": { + "status": "Approved" + }, + "provisioningState": "Succeeded" + }, + "name": "privateendpointconnection1", + "type": "Microsoft.Network/privateLinkServices/privateEndpointConnections" + } + } + } +} diff --git a/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/managedClusters.json b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/managedClusters.json new file mode 100644 index 000000000000..e726cd78022b --- /dev/null +++ b/specification/containerservice/resource-manager/Microsoft.ContainerService/stable/2020-06-01/managedClusters.json @@ -0,0 +1,2958 @@ +{ + "swagger": "2.0", + "info": { + "title": "ContainerServiceClient", + "description": "The Container Service Client.", + "version": "2020-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.ContainerService/operations": { + "get": { + "tags": [ + "managedClusters" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_List", + "summary": "Gets a list of managed clusters in the specified subscription.", + "description": "Gets a list of managed clusters in the specified subscription. The operation returns properties of each managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Managed Clusters": { + "$ref": "./examples/ManagedClustersList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListByResourceGroup", + "summary": "Lists managed clusters in the specified subscription and resource group.", + "description": "Lists managed clusters in the specified subscription and resource group. The operation returns properties of each managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get Managed Clusters by Resource Group": { + "$ref": "./examples/ManagedClustersListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/upgradeProfiles/default": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetUpgradeProfile", + "summary": "Gets upgrade profile for a managed cluster.", + "description": "Gets the details of the upgrade profile for a managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Managed Cluster": { + "$ref": "./examples/ManagedClustersGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/accessProfiles/{roleName}/listCredential": { + "post": { + "deprecated": true, + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_GetAccessProfile", + "summary": "Gets an access profile of a managed cluster.", + "description": "Gets the accessProfile for the specified role name of the managed cluster with a specified resource group and name. **WARNING**: This API will be deprecated. Instead use [ListClusterUserCredentials](https://docs.microsoft.com/en-us/rest/api/aks/managedclusters/listclusterusercredentials) or [ListClusterAdminCredentials](https://docs.microsoft.com/en-us/rest/api/aks/managedclusters/listclusteradmincredentials) .", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "roleName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role for managed cluster accessProfile resource." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedClusterAccessProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGetAccessProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterAdminCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterAdminCredentials", + "summary": "Gets cluster admin credential of a managed cluster.", + "description": "Gets cluster admin credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterUserCredentials", + "summary": "Gets cluster user credential of a managed cluster.", + "description": "Gets cluster user credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/listClusterMonitoringUserCredential": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ListClusterMonitoringUserCredentials", + "summary": "Gets cluster monitoring user credential of a managed cluster.", + "description": "Gets cluster monitoring user credential of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/CredentialResults" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersListClusterCredentialResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}": { + "get": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Get", + "summary": "Gets a managed cluster.", + "description": "Gets the details of the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Managed Cluster": { + "$ref": "./examples/ManagedClustersGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_CreateOrUpdate", + "summary": "Creates or updates a managed cluster.", + "description": "Creates or updates a managed cluster with the specified configuration for agents and Kubernetes version.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "Parameters supplied to the Create or Update a Managed Cluster operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Managed Cluster": { + "$ref": "./examples/ManagedClustersCreate_Update.json" + }, + "Create/Update AAD Managed Cluster with EnableAzureRBAC": { + "$ref": "./examples/ManagedClustersCreate_UpdateWithEnableAzureRBAC.json" + }, + "Create Managed Cluster with PPG": { + "$ref": "./examples/ManagedClustersCreate_PPG.json" + } + } + }, + "patch": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_UpdateTags", + "summary": "Updates tags on a managed cluster.", + "description": "Updates a managed cluster with the specified tags.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TagsObject" + }, + "description": "Parameters supplied to the Update Managed Cluster Tags operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ManagedCluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update Managed Cluster Tags": { + "$ref": "./examples/ManagedClustersUpdateTags.json" + } + } + }, + "delete": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_Delete", + "summary": "Deletes a managed cluster.", + "description": "Deletes the managed cluster with a specified resource group and name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Managed Cluster": { + "$ref": "./examples/ManagedClustersDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_List", + "summary": "Gets a list of agent pools in the specified managed cluster.", + "description": "Gets a list of agent pools in the specified managed cluster. The operation returns properties of each agent pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Agent Pools by Managed Cluster": { + "$ref": "./examples/AgentPoolsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Get", + "summary": "Gets the agent pool.", + "description": "Gets the details of the agent pool by managed cluster and resource group.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Agent Pool": { + "$ref": "./examples/AgentPoolsGet.json" + } + } + }, + "put": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_CreateOrUpdate", + "summary": "Creates or updates an agent pool.", + "description": "Creates or updates an agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AgentPool" + }, + "description": "Parameters supplied to the Create or Update an agent pool operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AgentPool" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create/Update Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Update.json" + }, + "Update Agent Pool": { + "$ref": "./examples/AgentPools_Update.json" + }, + "Create Spot Agent Pool": { + "$ref": "./examples/AgentPoolsCreate_Spot.json" + }, + "Create Agent Pool with PPG": { + "$ref": "./examples/AgentPoolsCreate_PPG.json" + } + } + }, + "delete": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_Delete", + "summary": "Deletes an agent pool.", + "description": "Deletes the agent pool in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Agent Pool": { + "$ref": "./examples/AgentPoolsDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/agentPools/{agentPoolName}/upgradeProfiles/default": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetUpgradeProfile", + "summary": "Gets upgrade profile for an agent pool.", + "description": "Gets the details of the upgrade profile for an agent pool with a specified resource group and managed cluster name.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "agentPoolName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the agent pool." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolUpgradeProfile" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Upgrade Profile for Agent Pool": { + "$ref": "./examples/AgentPoolsGetUpgradeProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/availableAgentPoolVersions": { + "get": { + "tags": [ + "AgentPools" + ], + "operationId": "AgentPools_GetAvailableAgentPoolVersions", + "summary": "Gets a list of supported versions for the specified agent pool.", + "description": "Gets a list of supported versions for the specified agent pool.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AgentPoolAvailableVersions" + } + } + }, + "x-ms-examples": { + "Get available versions for agent pool": { + "$ref": "./examples/AgentPoolsGetAgentPoolAvailableVersions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetServicePrincipalProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetServicePrincipalProfile", + "summary": "Reset Service Principal Profile of a managed cluster.", + "description": "Update the service principal Profile for a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile" + }, + "description": "Parameters supplied to the Reset Service Principal Profile operation for a Managed Cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset Service Principal Profile": { + "$ref": "./examples/ManagedClustersResetServicePrincipalProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/resetAADProfile": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_ResetAADProfile", + "summary": "Reset AAD Profile of a managed cluster.", + "description": "Update the AAD Profile for a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedClusterAADProfile" + }, + "description": "Parameters supplied to the Reset AAD Profile operation for a Managed Cluster." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset AAD Profile": { + "$ref": "./examples/ManagedClustersResetAADProfile.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/rotateClusterCertificates": { + "post": { + "tags": [ + "ManagedClusters" + ], + "operationId": "ManagedClusters_RotateClusterCertificates", + "summary": "Rotate certificates of a managed cluster.", + "description": "Rotate certificates of a managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "202": { + "description": "Accepted" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Error response describing why the operation failed. If the cluster doesn't exist, 404 (Not found) is returned.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Rotate Cluster Certificates": { + "$ref": "./examples/ManagedClustersRotateClusterCertificates.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_List", + "summary": "Gets a list of private endpoint connections in the specified managed cluster.", + "description": "Gets a list of private endpoint connections in the specified managed cluster. The operation returns properties of each private endpoint connection.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List Private Endpoint Connections by Managed Cluster": { + "$ref": "./examples/PrivateEndpointConnectionsList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ContainerService/managedClusters/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "summary": "Gets the private endpoint connection.", + "description": "Gets the details of the private endpoint connection by managed cluster and resource group.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsGet.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Update", + "summary": "Updates a private endpoint connection.", + "description": "Updates a private endpoint connection in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "Parameters supplied to the Update a private endpoint connection operation." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Update Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsUpdate.json" + } + } + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "summary": "Deletes a private endpoint connection.", + "description": "Deletes the private endpoint connection in the specified managed cluster.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceNameParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Private Endpoint Connection": { + "$ref": "./examples/PrivateEndpointConnectionsDelete.json" + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/OperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "OperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/OperationValueDisplay", + "description": "Describes the properties of a Compute Operation Value Display." + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "OperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "SubResource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource ID." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the resource that is unique within a resource group. This name can be used to access the resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Reference to another subresource.", + "x-ms-azure-resource": true + }, + "TagsObject": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "description": "Tags object for patch operations." + }, + "ContainerServiceOSDisk": { + "type": "integer", + "format": "int32", + "maximum": 1023, + "minimum": 0, + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "ContainerServiceStorageProfile": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceStorageProfileTypes", + "modelAsString": true + }, + "enum": [ + "StorageAccount", + "ManagedDisks" + ], + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "ContainerServiceVnetSubnetID": { + "type": "string", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "ContainerServiceVMSize": { + "type": "string", + "x-ms-enum": { + "name": "ContainerServiceVMSizeTypes", + "modelAsString": true + }, + "description": "Size of agent VMs.", + "enum": [ + "Standard_A1", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2", + "Standard_A2_v2", + "Standard_A2m_v2", + "Standard_A3", + "Standard_A4", + "Standard_A4_v2", + "Standard_A4m_v2", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A8_v2", + "Standard_A8m_v2", + "Standard_A9", + "Standard_B2ms", + "Standard_B2s", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D11", + "Standard_D11_v2", + "Standard_D11_v2_Promo", + "Standard_D12", + "Standard_D12_v2", + "Standard_D12_v2_Promo", + "Standard_D13", + "Standard_D13_v2", + "Standard_D13_v2_Promo", + "Standard_D14", + "Standard_D14_v2", + "Standard_D14_v2_Promo", + "Standard_D15_v2", + "Standard_D16_v3", + "Standard_D16s_v3", + "Standard_D1_v2", + "Standard_D2", + "Standard_D2_v2", + "Standard_D2_v2_Promo", + "Standard_D2_v3", + "Standard_D2s_v3", + "Standard_D3", + "Standard_D32_v3", + "Standard_D32s_v3", + "Standard_D3_v2", + "Standard_D3_v2_Promo", + "Standard_D4", + "Standard_D4_v2", + "Standard_D4_v2_Promo", + "Standard_D4_v3", + "Standard_D4s_v3", + "Standard_D5_v2", + "Standard_D5_v2_Promo", + "Standard_D64_v3", + "Standard_D64s_v3", + "Standard_D8_v3", + "Standard_D8s_v3", + "Standard_DS1", + "Standard_DS11", + "Standard_DS11_v2", + "Standard_DS11_v2_Promo", + "Standard_DS12", + "Standard_DS12_v2", + "Standard_DS12_v2_Promo", + "Standard_DS13", + "Standard_DS13-2_v2", + "Standard_DS13-4_v2", + "Standard_DS13_v2", + "Standard_DS13_v2_Promo", + "Standard_DS14", + "Standard_DS14-4_v2", + "Standard_DS14-8_v2", + "Standard_DS14_v2", + "Standard_DS14_v2_Promo", + "Standard_DS15_v2", + "Standard_DS1_v2", + "Standard_DS2", + "Standard_DS2_v2", + "Standard_DS2_v2_Promo", + "Standard_DS3", + "Standard_DS3_v2", + "Standard_DS3_v2_Promo", + "Standard_DS4", + "Standard_DS4_v2", + "Standard_DS4_v2_Promo", + "Standard_DS5_v2", + "Standard_DS5_v2_Promo", + "Standard_E16_v3", + "Standard_E16s_v3", + "Standard_E2_v3", + "Standard_E2s_v3", + "Standard_E32-16s_v3", + "Standard_E32-8s_v3", + "Standard_E32_v3", + "Standard_E32s_v3", + "Standard_E4_v3", + "Standard_E4s_v3", + "Standard_E64-16s_v3", + "Standard_E64-32s_v3", + "Standard_E64_v3", + "Standard_E64s_v3", + "Standard_E8_v3", + "Standard_E8s_v3", + "Standard_F1", + "Standard_F16", + "Standard_F16s", + "Standard_F16s_v2", + "Standard_F1s", + "Standard_F2", + "Standard_F2s", + "Standard_F2s_v2", + "Standard_F32s_v2", + "Standard_F4", + "Standard_F4s", + "Standard_F4s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_F8", + "Standard_F8s", + "Standard_F8s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS4-4", + "Standard_GS4-8", + "Standard_GS5", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H16", + "Standard_H16m", + "Standard_H16mr", + "Standard_H16r", + "Standard_H8", + "Standard_H8m", + "Standard_L16s", + "Standard_L32s", + "Standard_L4s", + "Standard_L8s", + "Standard_M128-32ms", + "Standard_M128-64ms", + "Standard_M128ms", + "Standard_M128s", + "Standard_M64-16ms", + "Standard_M64-32ms", + "Standard_M64ms", + "Standard_M64s", + "Standard_NC12", + "Standard_NC12s_v2", + "Standard_NC12s_v3", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC24rs_v2", + "Standard_NC24rs_v3", + "Standard_NC24s_v2", + "Standard_NC24s_v3", + "Standard_NC6", + "Standard_NC6s_v2", + "Standard_NC6s_v3", + "Standard_ND12s", + "Standard_ND24rs", + "Standard_ND24s", + "Standard_ND6s", + "Standard_NV12", + "Standard_NV24", + "Standard_NV6" + ] + }, + "ManagedClusterServicePrincipalProfile": { + "properties": { + "clientId": { + "type": "string", + "description": "The ID for the service principal." + }, + "secret": { + "type": "string", + "description": "The secret password associated with the service principal in plain text." + } + }, + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs.", + "required": [ + "clientId" + ] + }, + "ContainerServiceMasterProfile": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "enum": [ + 1, + 3, + 5 + ], + "x-ms-enum": { + "name": "Count", + "modelAsString": false + }, + "description": "Number of masters (VMs) in the container service cluster. Allowed values are 1, 3, and 5. The default value is 1.", + "default": 1 + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix to be used to create the FQDN for the master pool." + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "firstConsecutiveStaticIP": { + "type": "string", + "description": "FirstConsecutiveStaticIP used to specify the first static ip of masters.", + "default": "10.240.255.5" + }, + "storageProfile": { + "$ref": "#/definitions/ContainerServiceStorageProfile", + "description": "Storage profile specifies what kind of storage used. Choose from StorageAccount and ManagedDisks. Leave it empty, we will choose for you based on the orchestrator choice." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FQDN for the master pool." + } + }, + "required": [ + "dnsPrefix", + "vmSize" + ], + "description": "Profile for the container service master." + }, + "ManagedClusterAgentPoolProfileProperties": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "description": "Number of agents (VMs) to host docker containers. Allowed values must be in the range of 0 to 100 (inclusive) for user pools and in the range of 1 to 100 (inclusive) for system pools. The default value is 1." + }, + "vmSize": { + "$ref": "#/definitions/ContainerServiceVMSize", + "description": "Size of agent VMs." + }, + "osDiskSizeGB": { + "$ref": "#/definitions/ContainerServiceOSDisk", + "description": "OS Disk Size in GB to be used to specify the disk size for every machine in this master/agent pool. If you specify 0, it will apply the default osDisk size according to the vmSize specified." + }, + "vnetSubnetID": { + "$ref": "#/definitions/ContainerServiceVnetSubnetID", + "description": "VNet SubnetID specifies the VNet's subnet identifier." + }, + "maxPods": { + "type": "integer", + "format": "int32", + "description": "Maximum number of pods that can run on a node." + }, + "osType": { + "$ref": "#/definitions/OSType", + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "maxCount": { + "type": "integer", + "format": "int32", + "description": "Maximum number of nodes for auto-scaling" + }, + "minCount": { + "type": "integer", + "format": "int32", + "description": "Minimum number of nodes for auto-scaling" + }, + "enableAutoScaling": { + "type": "boolean", + "description": "Whether to enable auto-scaler" + }, + "type": { + "$ref": "#/definitions/AgentPoolType", + "description": "AgentPoolType represents types of an agent pool" + }, + "mode": { + "$ref": "#/definitions/AgentPoolMode", + "description": "AgentPoolMode represents mode of an agent pool" + }, + "orchestratorVersion": { + "type": "string", + "description": "Version of orchestrator specified when creating the managed cluster." + }, + "nodeImageVersion": { + "type": "string", + "description": "Version of node image" + }, + "upgradeSettings": { + "$ref": "#/definitions/AgentPoolUpgradeSettings", + "description": "Settings for upgrading the agentpool" + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + }, + "availabilityZones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability zones for nodes. Must use VirtualMachineScaleSets AgentPoolType." + }, + "enableNodePublicIP": { + "type": "boolean", + "description": "Enable public IP for nodes" + }, + "scaleSetPriority": { + "$ref": "#/definitions/ScaleSetPriority", + "description": "ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular." + }, + "scaleSetEvictionPolicy": { + "$ref": "#/definitions/ScaleSetEvictionPolicy", + "description": "ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete." + }, + "spotMaxPrice": { + "$ref": "#/definitions/SpotMaxPrice", + "description": "SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Agent pool tags to be persisted on the agent pool virtual machine scale set." + }, + "nodeLabels": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Agent pool node labels to be persisted across all nodes in agent pool." + }, + "nodeTaints": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Taints added to new nodes during node pool create and scale. For example, key=value:NoSchedule." + }, + "proximityPlacementGroupID": { + "$ref": "#/definitions/ProximityPlacementGroupID", + "description": "The ID for Proximity Placement Group." + } + }, + "description": "Properties for the container service agent pool profile." + }, + "ManagedClusterAgentPoolProfile": { + "allOf": [ + { + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties" + }, + { + "properties": { + "name": { + "type": "string", + "description": "Unique name of the agent pool profile in the context of the subscription and resource group.", + "pattern": "^[a-z][a-z0-9]{0,11}$" + } + } + } + ], + "required": [ + "name" + ], + "description": "Profile for the container service agent pool." + }, + "AgentPoolType": { + "type": "string", + "enum": [ + "VirtualMachineScaleSets", + "AvailabilitySet" + ], + "x-ms-enum": { + "name": "AgentPoolType", + "modelAsString": true + }, + "description": "AgentPoolType represents types of an agent pool." + }, + "AgentPoolMode": { + "type": "string", + "enum": [ + "System", + "User" + ], + "x-ms-enum": { + "name": "AgentPoolMode", + "modelAsString": true + }, + "description": "AgentPoolMode represents mode of an agent pool." + }, + "AgentPoolListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AgentPool" + }, + "description": "The list of agent pools." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of agent pool results.", + "readOnly": true + } + }, + "description": "The response from the List Agent Pools operation." + }, + "AgentPoolUpgradeSettings": { + "properties": { + "maxSurge": { + "type": "string", + "description": "Count or percentage of additional nodes to be added during upgrade. If empty uses AKS default" + } + }, + "description": "Settings for upgrading an agentpool" + }, + "AgentPool": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + }, + { + "properties": { + "properties": { + "description": "Properties of an agent pool.", + "$ref": "#/definitions/ManagedClusterAgentPoolProfileProperties", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Agent Pool." + }, + "ManagedClusterWindowsProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Windows VMs.", + "pattern": "^[a-zA-Z0-9]+([._]?[a-zA-Z0-9]+)*$" + }, + "adminPassword": { + "type": "string", + "description": "The administrator password to use for Windows VMs.", + "pattern": "^(?=.*[a-z])(?=.*[A-Z])(?=.*[!@#$%\\^&\\*\\(\\)])[a-zA-Z\\d!@#$%\\^&\\*\\(\\)]{12,123}$" + } + }, + "required": [ + "adminUsername" + ], + "description": "Profile for Windows VMs in the container service cluster." + }, + "ContainerServiceLinuxProfile": { + "properties": { + "adminUsername": { + "type": "string", + "description": "The administrator username to use for Linux VMs.", + "pattern": "^[A-Za-z][-A-Za-z0-9_]*$" + }, + "ssh": { + "$ref": "#/definitions/ContainerServiceSshConfiguration", + "description": "SSH configuration for Linux-based VMs running on Azure." + } + }, + "required": [ + "adminUsername", + "ssh" + ], + "description": "Profile for Linux VMs in the container service cluster." + }, + "ContainerServiceNetworkProfile": { + "properties": { + "networkPlugin": { + "type": "string", + "enum": [ + "azure", + "kubenet" + ], + "default": "kubenet", + "x-ms-enum": { + "name": "NetworkPlugin", + "modelAsString": true + }, + "description": "Network plugin used for building Kubernetes network." + }, + "networkPolicy": { + "type": "string", + "enum": [ + "calico", + "azure" + ], + "x-ms-enum": { + "name": "NetworkPolicy", + "modelAsString": true + }, + "description": "Network policy used for building Kubernetes network." + }, + "networkMode": { + "type": "string", + "enum": [ + "transparent", + "bridge" + ], + "x-ms-enum": { + "name": "networkMode", + "modelAsString": true + }, + "description": "Network mode used for building Kubernetes network." + }, + "podCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.244.0.0/16", + "description": "A CIDR notation IP range from which to assign pod IPs when kubenet is used." + }, + "serviceCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "10.0.0.0/16", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges." + }, + "dnsServiceIP": { + "type": "string", + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "default": "10.0.0.10", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr." + }, + "dockerBridgeCidr": { + "type": "string", + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "default": "172.17.0.1/16", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range." + }, + "outboundType": { + "type": "string", + "enum": [ + "loadBalancer", + "userDefinedRouting" + ], + "x-ms-enum": { + "name": "outboundType", + "modelAsString": true + }, + "default": "loadBalancer", + "description": "The outbound (egress) routing method." + }, + "loadBalancerSku": { + "type": "string", + "enum": [ + "standard", + "basic" + ], + "x-ms-enum": { + "name": "loadBalancerSku", + "modelAsString": true + }, + "description": "The load balancer sku for the managed cluster." + }, + "loadBalancerProfile": { + "$ref": "#/definitions/ManagedClusterLoadBalancerProfile", + "description": "Profile of the cluster load balancer." + } + }, + "description": "Profile of network configuration." + }, + "ManagedClusterLoadBalancerProfile": { + "properties": { + "managedOutboundIPs": { + "properties": { + "count": { + "type": "integer", + "format": "int32", + "maximum": 100, + "minimum": 1, + "description": "Desired number of outbound IP created/managed by Azure for the cluster load balancer. Allowed values must be in the range of 1 to 100 (inclusive). The default value is 1. ", + "default": 1 + } + }, + "description": "Desired managed outbound IPs for the cluster load balancer." + }, + "outboundIPPrefixes": { + "properties": { + "publicIPPrefixes": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP prefix resources." + } + }, + "description": "Desired outbound IP Prefix resources for the cluster load balancer." + }, + "outboundIPs": { + "properties": { + "publicIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "A list of public IP resources." + } + }, + "description": "Desired outbound IP resources for the cluster load balancer." + }, + "effectiveOutboundIPs": { + "type": "array", + "items": { + "$ref": "#/definitions/ResourceReference" + }, + "description": "The effective outbound IP resources of the cluster load balancer." + }, + "allocatedOutboundPorts": { + "type": "integer", + "format": "int32", + "maximum": 64000, + "minimum": 0, + "description": "Desired number of allocated SNAT ports per VM. Allowed values must be in the range of 0 to 64000 (inclusive). The default value is 0 which results in Azure dynamically allocating ports.", + "default": 0 + }, + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "maximum": 120, + "minimum": 4, + "description": "Desired outbound flow idle timeout in minutes. Allowed values must be in the range of 4 to 120 (inclusive). The default value is 30 minutes.", + "default": 30 + } + }, + "description": "Profile of the managed cluster load balancer." + }, + "ResourceReference": { + "properties": { + "id": { + "type": "string", + "description": "The fully qualified Azure resource id." + } + }, + "description": "A reference to an Azure resource." + }, + "ContainerServiceSshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContainerServiceSshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with Linux-based VMs. Only expect one key specified." + } + }, + "description": "SSH configuration for Linux-based VMs running on Azure.", + "required": [ + "publicKeys" + ] + }, + "ContainerServiceSshPublicKey": { + "properties": { + "keyData": { + "type": "string", + "description": "Certificate public key used to authenticate with VMs through SSH. The certificate must be in PEM format with or without headers." + } + }, + "required": [ + "keyData" + ], + "description": "Contains information about SSH certificate public key data." + }, + "ContainerServiceDiagnosticsProfile": { + "properties": { + "vmDiagnostics": { + "$ref": "#/definitions/ContainerServiceVMDiagnostics", + "description": "Profile for diagnostics on the container service VMs." + } + }, + "description": "Profile for diagnostics on the container service cluster.", + "required": [ + "vmDiagnostics" + ] + }, + "ContainerServiceVMDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the VM diagnostic agent is provisioned on the VM." + }, + "storageUri": { + "readOnly": true, + "type": "string", + "description": "The URI of the storage account where diagnostics are stored." + } + }, + "description": "Profile for diagnostics on the container service VMs.", + "required": [ + "enabled" + ] + }, + "ManagedClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedCluster" + }, + "description": "The list of managed clusters." + }, + "nextLink": { + "type": "string", + "description": "The URL to get the next set of managed cluster results.", + "readOnly": true + } + }, + "description": "The response from the List Managed Clusters operation." + }, + "ManagedCluster": { + "properties": { + "sku": { + "$ref": "#/definitions/ManagedClusterSKU", + "description": "The managed cluster SKU." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "Properties of a managed cluster.", + "$ref": "#/definitions/ManagedClusterProperties", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/ManagedClusterIdentity", + "description": "The identity of the managed cluster, if configured." + } + } + } + ], + "description": "Managed cluster." + }, + "ManagedClusterProperties": { + "properties": { + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The current deployment or provisioning state, which only appears in the response." + }, + "maxAgentPools": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The max number of agent pools for the managed cluster." + }, + "kubernetesVersion": { + "type": "string", + "description": "Version of Kubernetes specified when creating the managed cluster." + }, + "dnsPrefix": { + "type": "string", + "description": "DNS prefix specified when creating the managed cluster." + }, + "fqdn": { + "readOnly": true, + "type": "string", + "description": "FQDN for the master pool." + }, + "privateFQDN": { + "readOnly": true, + "type": "string", + "description": "FQDN of private cluster." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterAgentPoolProfile" + }, + "description": "Properties of the agent pool." + }, + "linuxProfile": { + "$ref": "#/definitions/ContainerServiceLinuxProfile", + "description": "Profile for Linux VMs in the container service cluster." + }, + "windowsProfile": { + "$ref": "#/definitions/ManagedClusterWindowsProfile", + "description": "Profile for Windows VMs in the container service cluster." + }, + "servicePrincipalProfile": { + "$ref": "#/definitions/ManagedClusterServicePrincipalProfile", + "description": "Information about a service principal identity for the cluster to use for manipulating Azure APIs." + }, + "addonProfiles": { + "additionalProperties": { + "$ref": "#/definitions/ManagedClusterAddonProfile" + }, + "description": "Profile of managed cluster add-on." + }, + "nodeResourceGroup": { + "type": "string", + "description": "Name of the resource group containing agent pool nodes." + }, + "enableRBAC": { + "type": "boolean", + "description": "Whether to enable Kubernetes Role-Based Access Control." + }, + "enablePodSecurityPolicy": { + "type": "boolean", + "description": "(PREVIEW) Whether to enable Kubernetes Pod security policy." + }, + "networkProfile": { + "$ref": "#/definitions/ContainerServiceNetworkProfile", + "description": "Profile of network configuration." + }, + "aadProfile": { + "$ref": "#/definitions/ManagedClusterAADProfile", + "description": "Profile of Azure Active Directory configuration." + }, + "autoScalerProfile": { + "type": "object", + "properties": { + "balance-similar-node-groups": { + "type": "string" + }, + "scan-interval": { + "type": "string" + }, + "scale-down-delay-after-add": { + "type": "string" + }, + "scale-down-delay-after-delete": { + "type": "string" + }, + "scale-down-delay-after-failure": { + "type": "string" + }, + "scale-down-unneeded-time": { + "type": "string" + }, + "scale-down-unready-time": { + "type": "string" + }, + "scale-down-utilization-threshold": { + "type": "string" + }, + "max-graceful-termination-sec": { + "type": "string" + } + }, + "description": "Parameters to be applied to the cluster-autoscaler when enabled" + }, + "apiServerAccessProfile": { + "$ref": "#/definitions/ManagedClusterAPIServerAccessProfile", + "description": "Access profile for managed cluster API server." + }, + "diskEncryptionSetID": { + "type": "string", + "description": "ResourceId of the disk encryption set to use for enabling encryption at rest." + }, + "identityProfile": { + "additionalProperties": { + "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + }, + "description": "Identities associated with the cluster." + } + }, + "description": "Properties of the managed cluster." + }, + "ManagedClusterAPIServerAccessProfile": { + "properties": { + "authorizedIPRanges": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Authorized IP Ranges to kubernetes API server." + }, + "enablePrivateCluster": { + "type": "boolean", + "description": "Whether to create the cluster as a private cluster or not." + } + }, + "description": "Access profile for managed cluster API server." + }, + "ManagedClusterIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity which is used by master components." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity which is used by master components." + }, + "type": { + "type": "string", + "description": "The type of identity used for the managed cluster. Type 'SystemAssigned' will use an implicitly created identity in master components and an auto-created user assigned identity in MC_ resource group in agent nodes. Type 'None' will not use MSI for the managed cluster, service principal will be used instead.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The user identity associated with the managed cluster. This identity will be used in control plane and only one user assigned identity is allowed. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the managed cluster." + }, + "UserAssignedIdentity": { + "properties": { + "resourceId": { + "type": "string", + "description": "The resource id of the user assigned identity." + }, + "clientId": { + "type": "string", + "description": "The client id of the user assigned identity." + }, + "objectId": { + "type": "string", + "description": "The object id of the user assigned identity." + } + } + }, + "ManagedClusterAccessProfile": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "properties": { + "properties": { + "description": "AccessProfile of a managed cluster.", + "$ref": "#/definitions/AccessProfile", + "x-ms-client-flatten": true + } + } + } + ], + "description": "Managed cluster Access Profile.", + "x-ms-azure-resource": false + }, + "AccessProfile": { + "type": "object", + "properties": { + "kubeConfig": { + "type": "string", + "format": "byte", + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "Profile for enabling a user to access a managed cluster." + }, + "ManagedClusterPoolUpgradeProfile": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "name": { + "type": "string", + "description": "Pool name." + }, + "osType": { + "$ref": "#/definitions/OSType", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "ContainerServiceOSTypes", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "ManagedClusterUpgradeProfileProperties": { + "properties": { + "controlPlaneProfile": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile", + "description": "The list of available upgrade versions for the control plane." + }, + "agentPoolProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagedClusterPoolUpgradeProfile" + }, + "description": "The list of available upgrade versions for agent pools." + } + }, + "required": [ + "controlPlaneProfile", + "agentPoolProfiles" + ], + "description": "Control plane and agent pool upgrade profiles." + }, + "ManagedClusterAADProfile": { + "properties": { + "managed": { + "type": "boolean", + "description": "Whether to enable managed AAD." + }, + "enableAzureRBAC": { + "type": "boolean", + "description": "Whether to enable Azure RBAC for Kubernetes authorization." + }, + "adminGroupObjectIDs": { + "type": "array", + "items": { + "type": "string" + }, + "description": "AAD group object IDs that will have admin role of the cluster." + }, + "clientAppID": { + "type": "string", + "description": "The client AAD application ID." + }, + "serverAppID": { + "type": "string", + "description": "The server AAD application ID." + }, + "serverAppSecret": { + "type": "string", + "description": "The server AAD application secret." + }, + "tenantID": { + "type": "string", + "description": "The AAD tenant ID to use for authentication. If not specified, will use the tenant of the deployment subscription." + } + }, + "description": "AADProfile specifies attributes for Azure Active Directory integration." + }, + "ManagedClusterAddonProfile": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether the add-on is enabled or not." + }, + "config": { + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs for configuring an add-on." + }, + "identity": { + "readOnly": true, + "description": "Information of user assigned identity used by this add-on.", + "allOf": [ + { + "$ref": "#/definitions/UserAssignedIdentity" + } + ] + } + }, + "required": [ + "enabled" + ], + "description": "A Kubernetes add-on profile for a managed cluster." + }, + "ManagedClusterUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of upgrade profile." + }, + "properties": { + "$ref": "#/definitions/ManagedClusterUpgradeProfileProperties", + "description": "Properties of upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for compute pools." + }, + "AgentPoolUpgradeProfile": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the agent pool upgrade profile." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the agent pool upgrade profile." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool upgrade profile." + }, + "properties": { + "$ref": "#/definitions/AgentPoolUpgradeProfileProperties", + "description": "Properties of agent pool upgrade profile.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available upgrades for an agent pool." + }, + "AgentPoolUpgradeProfileProperties": { + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "osType": { + "$ref": "#/definitions/OSType", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "ContainerServiceOSTypes", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "upgrades": { + "type": "array", + "items": { + "type": "object", + "properties": { + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of orchestrator types and versions available for upgrade." + }, + "latestNodeImageVersion": { + "type": "string", + "description": "LatestNodeImageVersion is the latest AKS supported node image version." + } + }, + "required": [ + "kubernetesVersion", + "osType" + ], + "description": "The list of available upgrade versions." + }, + "AgentPoolAvailableVersions": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Id of the agent pool available versions." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the agent pool available versions." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the agent pool available versions." + }, + "properties": { + "$ref": "#/definitions/AgentPoolAvailableVersionsProperties", + "description": "Properties of agent pool available versions.", + "x-ms-client-flatten": true + } + }, + "required": [ + "properties" + ], + "description": "The list of available versions for an agent pool." + }, + "AgentPoolAvailableVersionsProperties": { + "properties": { + "agentPoolVersions": { + "type": "array", + "items": { + "type": "object", + "properties": { + "default": { + "type": "boolean", + "description": "Whether this version is the default agent pool version." + }, + "kubernetesVersion": { + "type": "string", + "description": "Kubernetes version (major, minor, patch)." + }, + "isPreview": { + "type": "boolean", + "description": "Whether Kubernetes version is currently in preview." + } + } + }, + "description": "List of versions available for agent pool." + } + }, + "description": "The list of available agent pool versions." + }, + "OSType": { + "type": "string", + "default": "Linux", + "enum": [ + "Linux", + "Windows" + ], + "x-ms-enum": { + "name": "OSType", + "modelAsString": true + }, + "description": "OsType to be used to specify os type. Choose from Linux and Windows. Default to Linux." + }, + "ScaleSetPriority": { + "type": "string", + "default": "Regular", + "enum": [ + "Spot", + "Regular" + ], + "x-ms-enum": { + "name": "ScaleSetPriority", + "modelAsString": true + }, + "description": "ScaleSetPriority to be used to specify virtual machine scale set priority. Default to regular." + }, + "ScaleSetEvictionPolicy": { + "type": "string", + "default": "Delete", + "enum": [ + "Delete", + "Deallocate" + ], + "x-ms-enum": { + "name": "ScaleSetEvictionPolicy", + "modelAsString": true + }, + "description": "ScaleSetEvictionPolicy to be used to specify eviction policy for Spot virtual machine scale set. Default to Delete." + }, + "SpotMaxPrice": { + "type": "number", + "default": -1, + "description": "SpotMaxPrice to be used to specify the maximum price you are willing to pay in US Dollars. Possible values are any decimal value greater than zero or -1 which indicates default price to be up-to on-demand." + }, + "ProximityPlacementGroupID": { + "type": "string", + "description": "The ID for Proximity Placement Group." + }, + "CredentialResults": { + "properties": { + "kubeconfigs": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/CredentialResult" + }, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The list of credential result response." + }, + "CredentialResult": { + "type": "object", + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the credential." + }, + "value": { + "type": "string", + "format": "byte", + "readOnly": true, + "description": "Base64-encoded Kubernetes configuration file." + } + }, + "description": "The credential result response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Details about the error." + } + }, + "description": "An error response from the Container service." + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for display in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from the Container service." + }, + "ManagedClusterSKU": { + "properties": { + "name": { + "type": "string", + "description": "Name of a managed cluster SKU.", + "enum": [ + "Basic" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUName", + "modelAsString": true + } + }, + "tier": { + "type": "string", + "description": "Tier of a managed cluster SKU.", + "enum": [ + "Paid", + "Free" + ], + "x-ms-enum": { + "name": "ManagedClusterSKUTier", + "modelAsString": true + } + } + } + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ID of the private endpoint connection." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the private endpoint connection.", + "externalDocs": { + "url": "https://aka.ms/search-naming-rules" + } + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The resource type." + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource Id for private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version.", + "x-ms-parameter-location": "client" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceNameParameter": { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "minLength": 1, + "maxLength": 63, + "pattern": "^[a-zA-Z0-9]$|^[a-zA-Z0-9][-_a-zA-Z0-9]{0,61}[a-zA-Z0-9]$", + "description": "The name of the managed cluster resource.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/containerservice/resource-manager/readme.go.md b/specification/containerservice/resource-manager/readme.go.md index 0e97d488f974..657781427475 100644 --- a/specification/containerservice/resource-manager/readme.go.md +++ b/specification/containerservice/resource-manager/readme.go.md @@ -12,6 +12,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-06 - tag: package-2020-04 - tag: package-2020-03 - tag: package-2020-02 @@ -31,6 +32,15 @@ batch: - tag: package-2017-08 - tag: package-2017-07 ``` +### Tag: package-2020-06 and go + +These settings apply only when `--package-2020-06 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2020-06' && $(go) +namespace: containerservice +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-01/$(namespace) +``` ### Tag: package-2020-04 and go diff --git a/specification/containerservice/resource-manager/readme.java.md b/specification/containerservice/resource-manager/readme.java.md index 4f496925aa45..f902c9011114 100644 --- a/specification/containerservice/resource-manager/readme.java.md +++ b/specification/containerservice/resource-manager/readme.java.md @@ -24,6 +24,20 @@ batch: - tag: package-2020-02 - tag: package-2020-03 - tag: package-2020-04 + - tag: package-2020-06 +``` + +### Tag: package-2020-06 and java + +These settings apply only when `--tag=package-2020-06` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-06' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.containerservice.v2020_06_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/containerservice/mgmt-v2020_06_01 +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2020-04 and java diff --git a/specification/containerservice/resource-manager/readme.md b/specification/containerservice/resource-manager/readme.md index 3b25efeec43a..296d71dd7e19 100644 --- a/specification/containerservice/resource-manager/readme.md +++ b/specification/containerservice/resource-manager/readme.md @@ -34,21 +34,33 @@ These are the global settings for the ContainerServices API. ``` yaml openapi-type: arm -tag: package-2020-04 +tag: package-2020-06 ``` +### Tag: package-2020-06 + +These settings apply only when `--tag=package-2020-06` is specified on the command line. + +```yaml $(tag) == 'package-2020-06' +input-file: + - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json + - Microsoft.ContainerService/stable/2017-07-01/containerService.json + - Microsoft.ContainerService/stable/2019-08-01/location.json + - Microsoft.ContainerService/stable/2020-06-01/managedClusters.json +``` ### Tag: package-2020-04 These settings apply only when `--tag=package-2020-04` is specified on the command line. -```yaml $(tag) == 'package-2020-04' +``` yaml $(tag) == 'package-2020-04' input-file: - Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json - Microsoft.ContainerService/stable/2017-07-01/containerService.json - Microsoft.ContainerService/stable/2019-08-01/location.json - Microsoft.ContainerService/stable/2020-04-01/managedClusters.json ``` + ### Tag: package-2020-03 These settings apply only when `--tag=package-2020-03` is specified on the command line. @@ -246,6 +258,19 @@ input-file: - Microsoft.ContainerService/stable/2017-07-01/containerService.json ``` +### Tag: package-2020-06-01-only + +These settings apply only when `--tag=package-2020-06-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06-01-only' +input-file: +- Microsoft.ContainerService/stable/2020-06-01/managedClusters.json +directive: + - suppress: DefinitionsPropertiesNamesCamelCase + where: $.definitions.ManagedClusterProperties.properties.autoScalerProfile + reason: Cluster-autoscaler settings are not camel-cased +``` + ### Tag: package-2020-04-01-only These settings apply only when `--tag=package-2020-04-01-only` is specified on the command line. @@ -535,6 +560,7 @@ input-file: - $(this-folder)/Microsoft.ContainerService/stable/2019-04-30/openShiftManagedClusters.json - $(this-folder)/Microsoft.ContainerService/stable/2017-07-01/containerService.json - $(this-folder)/Microsoft.ContainerService/stable/2019-08-01/location.json + - $(this-folder)/Microsoft.ContainerService/stable/2020-06-01/managedClusters.json - $(this-folder)/Microsoft.ContainerService/stable/2020-04-01/managedClusters.json - $(this-folder)/Microsoft.ContainerService/stable/2020-03-01/managedClusters.json - $(this-folder)/Microsoft.ContainerService/stable/2020-02-01/managedClusters.json diff --git a/specification/containerservice/resource-manager/readme.python.md b/specification/containerservice/resource-manager/readme.python.md index 9b8f710a5632..5fee0ec5f9e4 100644 --- a/specification/containerservice/resource-manager/readme.python.md +++ b/specification/containerservice/resource-manager/readme.python.md @@ -18,6 +18,7 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2020-06-01-only - tag: package-2020-04-01-only - tag: package-2020-03-01-only - tag: package-2020-02-01-only @@ -37,6 +38,17 @@ batch: - tag: package-2017-07-only-extended ``` +### Tag: package-2020-06-01-only and python + +These settings apply only when `--tag=package-2020-06-01-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-06-01-only' && $(python) +python: + namespace: azure.mgmt.containerservice.v2020_06_01 + output-folder: $(python-sdks-folder)/containerservice/azure-mgmt-containerservice/azure/mgmt/containerservice/v2020_06_01 +``` + ### Tag: package-2020-04-01-only and python These settings apply only when `--tag=package-2020-04-01-only --python` is specified on the command line. From 28bbbf899402f71fdcf372e4f4aa10cf95bfc50a Mon Sep 17 00:00:00 2001 From: Hyonho Lee Date: Mon, 22 Jun 2020 22:02:58 -0700 Subject: [PATCH 184/318] Compute 2020-06-01 API version (#9167) * Preparatory commit for compute 2020-06-01 API version * Auto patch swagger change (#9524) * Preparatory commit for compute 2020-06-01 API version * Adding DisallowedConfiguration property to VirtualMachineImageProperties (#9065) * Adding in-guest vm patch propertyies to VM model * making the enum model as string * adding the change to end of the file for easy comparison * Fixing the name of the property * Preparatory commit for compute 2020-06-01 API version * Preparatory commit for compute 2020-06-01 API version * Adding DisallowedConfiguration property to VirtualMachineImageProperties (#9065) * Adding in-guest vm patch propertyies to VM model * making the enum model as string * adding the change to end of the file for easy comparison * Fixing the name of the property * fixing merge conflict * fixing the checks * adding reference to the example * fixing the checks error * fixing the example validation * running prettier Co-authored-by: Hyonho Lee Co-authored-by: Sirajudeen Sahul Hameed * Revert the breaking change * Adding DisallowedConfiguration property to VirtualMachineImageProperties (#9520) * Preparatory commit for compute 2020-06-01 API version * Adding DisallowedConfiguration property to VirtualMachineImageProperties Co-authored-by: Hyonho Lee Co-authored-by: Hyonho Lee * Added SecurityProfile to support Host Encryption for VM and Scaleset resources - Changes reviewed in PR: 9366 (#9666) * Preparatory commit for compute 2020-06-01 API version * updated swagger * updated swagger * fixed the prettier issues * updated the documentation' * Preparatory commit for compute 2020-06-01 API version * resolved * updated code * resolved conflicts * udpated comments * updated code * resolved prettier fix Co-authored-by: Hyonho Lee * Adding new RetrieveBootDiagnosticsData.POST API. VM/VMSS managed boot diagnostics changes with examples. (#9460) * Preparatory commit for compute 2020-06-01 API version * Adding DisallowedConfiguration property to VirtualMachineImageProperties (#9065) * managed boot diagnostics changes. * Add new lines to the EOF. * Adding missing response schema. * Preparatory commit for compute 2020-06-01 API version * Adding default error response. * Review comments. * Remove extra comma Co-authored-by: Hyonho Lee Co-authored-by: Sirajudeen Sahul Hameed Co-authored-by: Avinash Akka * Addressing minor corrections in examples related PR#9460 (#9685) * Preparatory commit for compute 2020-06-01 API version * Adding DisallowedConfiguration property to VirtualMachineImageProperties (#9065) * managed boot diagnostics changes. * Add new lines to the EOF. * Adding missing response schema. * Preparatory commit for compute 2020-06-01 API version * Adding default error response. * Review comments. * Remove extra comma * Addressing pending review changes. Co-authored-by: Hyonho Lee Co-authored-by: Sirajudeen Sahul Hameed Co-authored-by: Avinash Akka * Add AssessPatches API (#9275) * Initial commit with updates to compute.json for assessPatches and softwarePatches * Add VirtualMachinesAssessPatches.json * Fix minor issues with softwarePatches * Updates to correct the example per oav * Remove GET and LIST softwarePatches * Remove unneeded list result * update description strings * Add kbid to spell check list. Include Prettier formating changes. * Update SoftwarePatch.InstallationState to AssessmentState * Remove extra properties from patch object array * Fix name of PublishedDate * Add generic error response * Add readonly, make rebootPending a boolean again * Remove LastModifiedDateTime from result object * Adding ExtensionsTimeBudget to new Api Version (#9319) * fixing encoding (+2 squashed commit) Squashed commit: [e73eef734] Prettier [68d011b86] adding 201 response (+1 squashed commits) Squashed commits: [83f71bb48] Adding references (+1 squashed commits) Squashed commits: [d8ed89476] updating GET example (+1 squashed commits) Squashed commits: [61920933d] fix (+1 squashed commits) Squashed commits: [f0151eb78] updated with extensionsTimeBudget * fixing file name Co-authored-by: Hyonho Lee * Changes related to dedicated host group automatic placement (#9684) * Made changes for dedicated host group instance view * Added definitions for dedicated host group instance view * Made changes for SupportAutomaticPlacement * Made changes for assigned host * Made changes on properties.hostGroup * Added a missing comma * Addressed comments * Updated * Added assignedHost to VMScaleSetVMInstanceView * Addressed comments * Added minimum API version for assignedHost * Addressed comments * ModelAsString to false * Added exmples for VM * Added examples for VMSS * small fix * Addressed comments * Added missing parameter * Fixed examples * Add example for VMSS RunCommand (#9875) Co-authored-by: Jemal Abdulkadir Co-authored-by: Sirajudeen Sahul Hameed Co-authored-by: hari-bodicherla <43284966+hari-bodicherla@users.noreply.github.com> Co-authored-by: Avinash Co-authored-by: Avinash Akka Co-authored-by: Mike Richmond Co-authored-by: kamusta-msft <56413142+kamusta-msft@users.noreply.github.com> Co-authored-by: dochung4 <40577926+dochung4@users.noreply.github.com> Co-authored-by: Atanas Koralski --- custom-words.txt | 1 + .../stable/2020-06-01/compute.json | 11565 ++++++++++++++++ ...eSetFromAnUnmanagedGeneralizedOsImage.json | 202 + ...geVmFromAnUnmanagedGeneralizedOsImage.json | 145 + ...formImageScaleSetWithUnmanagedOsDisks.json | 222 + ...ormImageVmWithUnmanagedOsAndDataDisks.json | 213 + .../CreateAScaleSetFromACustomImage.json | 204 + ...ateAScaleSetWithAMarketplaceImagePlan.json | 230 + ...ScaleSetWithAnAzureApplicationGateway.json | 230 + ...reateAScaleSetWithAnAzureLoadBalancer.json | 251 + .../CreateAScaleSetWithAutomaticRepairs.json | 227 + .../CreateAScaleSetWithBootDiagnostics.json | 233 + .../CreateAScaleSetWithDiffOsDisk.json | 239 + ...tWithDiffOsDiskUsingDiffDiskPlacement.json | 242 + ...teAScaleSetWithEmptyDataDisksOnEachVm.json | 270 + .../CreateAScaleSetWithEncryptionAtHost.json | 239 + ...eateAScaleSetWithExtensionsTimeBudget.json | 278 + ...teAScaleSetWithManagedBootDiagnostics.json | 230 + ...teAScaleSetWithPasswordAuthentication.json | 215 + .../CreateAScaleSetWithPremiumStorage.json | 215 + .../CreateAScaleSetWithSshAuthentication.json | 239 + ...SetWithTerminateScheduledEventEnabled.json | 233 + ...reateAScaleSetWithVMsInDifferentZones.json | 284 + ...ScalesetWithDiskEncryptionSetResource.json | 255 + .../examples/CreateAVmFromACustomImage.json | 144 + .../CreateAVmInAnAvailabilitySet.json | 162 + .../examples/CreateAVmWithADiffOsDisk.json | 177 + ...DiskUsingDiffDiskPlacementAsCacheDisk.json | 180 + ...kUsingDiffDiskPlacementAsResourceDisk.json | 180 + .../CreateAVmWithAMarketplaceImagePlan.json | 168 + .../CreateAVmWithBootDiagnostics.json | 171 + ...reateAVmWithDiskEncryptionSetResource.json | 229 + .../examples/CreateAVmWithEmptyDataDisks.json | 205 + .../CreateAVmWithEncryptionAtHost.json | 177 + .../CreateAVmWithExtensionsTimeBudget.json | 174 + .../CreateAVmWithManagedBootDiagnostics.json | 168 + .../CreateAVmWithPasswordAuthentication.json | 153 + ...VmWithPatchSettingModeOfAutomaticByOS.json | 166 + ...PatchSettingModeOfAutomaticByPlatform.json | 166 + ...CreateAVmWithPatchSettingModeOfManual.json | 166 + .../examples/CreateAVmWithPremiumStorage.json | 153 + .../CreateAVmWithSshAuthentication.json | 177 + .../examples/CreateAnAvailabilitySet.json | 32 + .../examples/CreateAnImageFromABlob.json | 65 + ...AnImageFromABlobWithDiskEncryptionSet.json | 71 + .../CreateAnImageFromAManagedDisk.json | 71 + ...FromAManagedDiskWithDiskEncryptionSet.json | 77 + .../examples/CreateAnImageFromASnapshot.json | 71 + ...ageFromASnapshotWithDiskEncryptionSet.json | 77 + .../examples/CreateAnImageFromAVM.json | 70 + ...AnImageThatIncludesADataDiskFromABlob.json | 81 + ...ThatIncludesADataDiskFromAManagedDisk.json | 93 + ...ageThatIncludesADataDiskFromASnapshot.json | 93 + .../examples/CreateAnSshPublicKey.json | 36 + .../CreateOrUpdateADedicatedHost.json | 60 + .../CreateOrUpdateADedicatedHostGroup.json | 58 + ...reateOrUpdateAProximityPlacementGroup.json | 38 + ...ateVirtualMachineScaleSetVMExtensions.json | 60 + .../DeleteAProximityPlacementGroup.json | 12 + ...eteVirtualMachineScaleSetVMExtensions.json | 15 + .../examples/GeneralizeVirtualMachine.json | 11 + .../examples/GenerateSshKeyPair.json | 17 + .../examples/GetADedicatedHost.json | 58 + .../examples/GetADedicatedHostGroup.json | 87 + .../examples/GetAProximityPlacementGroup.json | 37 + .../examples/GetAnSshPublicKey.json | 23 + .../examples/GetInformationAboutAnImage.json | 50 + .../examples/GetVirtualMachine.json | 119 + ...MachineAutoPlacedOnDedicatedHostGroup.json | 67 + .../GetVirtualMachineInstanceView.json | 99 + ...nceViewAutoPlacedOnDedicatedHostGroup.json | 57 + ...caleSetAutoPlacedOnDedicatedHostGroup.json | 92 + ...GetVirtualMachineScaleSetVMExtensions.json | 30 + ...nceViewAutoPlacedOnDedicatedHostGroup.json | 65 + .../ListAvailabilitySetsInASubscription.json | 85 + .../ListAvailableVmSizes_VirtualMachines.json | 32 + .../examples/ListImagesInAResourceGroup.json | 51 + .../examples/ListImagesInASubscription.json | 50 + ...ximityPlacementGroupsInAResourceGroup.json | 41 + ...oximityPlacementGroupsInASubscription.json | 40 + ...istVirtualMachineScaleSetVMExtensions.json | 49 + ...tualMachinesInASubscriptionByLocation.json | 127 + .../LogAnalyticsRequestRateByInterval.json | 24 + .../LogAnalyticsThrottledRequests.json | 24 + .../PatchAProximityPlacementGroup.json | 26 + .../examples/ReapplyVirtualMachine.json | 12 + .../examples/ReimageVirtualMachine.json | 15 + ...trieveBootDiagnosticsDataVMScaleSetVM.json | 18 + ...ieveBootDiagnosticsDataVirtualMachine.json | 17 + .../examples/SimulateEvictionOfVM.json | 11 + .../examples/SimulateEvictionOfVmssVM.json | 12 + .../2020-06-01/examples/UpdateImage.json | 107 + ...tachDataDiskUsingToBeDetachedProperty.json | 208 + ...ateVirtualMachineScaleSetVMExtensions.json | 41 + .../VMScaleSetExtensionRollingUpgrade.json | 12 + .../examples/VMScaleSetRunCommand.json | 36 + .../examples/VirtualMachineAssessPatches.json | 52 + .../examples/VirtualMachineRunCommand.json | 34 + .../examples/VirtualMachineRunCommandGet.json | 38 + .../VirtualMachineRunCommandList.json | 85 + .../stable/2020-06-01/runCommands.json | 472 + .../compute/resource-manager/readme.md | 31 +- 102 files changed, 23414 insertions(+), 6 deletions(-) create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetFromACustomImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAutomaticRepairs.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithBootDiagnostics.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithDiffOsDisk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithDiffOsDiskUsingDiffDiskPlacement.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithEncryptionAtHost.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithExtensionsTimeBudget.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithManagedBootDiagnostics.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithPasswordAuthentication.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithPremiumStorage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithSshAuthentication.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithVMsInDifferentZones.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScalesetWithDiskEncryptionSetResource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmFromACustomImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmInAnAvailabilitySet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDisk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithAMarketplaceImagePlan.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithBootDiagnostics.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithDiskEncryptionSetResource.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithEmptyDataDisks.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithEncryptionAtHost.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithExtensionsTimeBudget.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithManagedBootDiagnostics.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPasswordAuthentication.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfAutomaticByOS.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfAutomaticByPlatform.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfManual.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPremiumStorage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithSshAuthentication.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnAvailabilitySet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromABlob.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromABlobWithDiskEncryptionSet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAManagedDisk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromASnapshot.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAVM.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnSshPublicKey.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateADedicatedHost.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateADedicatedHostGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateAProximityPlacementGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteAProximityPlacementGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteVirtualMachineScaleSetVMExtensions.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GeneralizeVirtualMachine.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GenerateSshKeyPair.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetADedicatedHost.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetADedicatedHostGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetAProximityPlacementGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetAnSshPublicKey.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetInformationAboutAnImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachine.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineAutoPlacedOnDedicatedHostGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineInstanceView.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineInstanceViewAutoPlacedOnDedicatedHostGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetAutoPlacedOnDedicatedHostGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetVMExtensions.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetVMInstanceViewAutoPlacedOnDedicatedHostGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListAvailabilitySetsInASubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListAvailableVmSizes_VirtualMachines.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListImagesInAResourceGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListImagesInASubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListProximityPlacementGroupsInAResourceGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListProximityPlacementGroupsInASubscription.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListVirtualMachineScaleSetVMExtensions.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListVirtualMachinesInASubscriptionByLocation.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/LogAnalyticsRequestRateByInterval.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/LogAnalyticsThrottledRequests.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/PatchAProximityPlacementGroup.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ReapplyVirtualMachine.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ReimageVirtualMachine.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/RetrieveBootDiagnosticsDataVMScaleSetVM.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/RetrieveBootDiagnosticsDataVirtualMachine.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/SimulateEvictionOfVM.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/SimulateEvictionOfVmssVM.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateImage.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateVirtualMachineScaleSetVMExtensions.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VMScaleSetExtensionRollingUpgrade.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VMScaleSetRunCommand.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineAssessPatches.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommand.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommandGet.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommandList.json create mode 100644 specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/runCommands.json diff --git a/custom-words.txt b/custom-words.txt index 0aa7135edfb9..6330b73c3ebd 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -763,6 +763,7 @@ jumpbox jwts kafkarest Kaliningrad +kbid Kbps KECA kernelspec diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json new file mode 100644 index 000000000000..2528535c2435 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json @@ -0,0 +1,11565 @@ +{ + "swagger": "2.0", + "info": { + "title": "ComputeManagementClient", + "description": "The Compute Management Client.", + "version": "2020-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.Compute/operations": { + "get": { + "tags": [ + "ComputeOperations" + ], + "operationId": "Operations_List", + "description": "Gets a list of compute operations.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ComputeOperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}": { + "put": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_CreateOrUpdate", + "description": "Create or update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "Parameters supplied to the Create Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + }, + "x-ms-examples": { + "Create an availability set.": { + "$ref": "./examples/CreateAnAvailabilitySet.json" + } + } + }, + "patch": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Update", + "description": "Update an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AvailabilitySetUpdate" + }, + "description": "Parameters supplied to the Update Availability Set operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + }, + "delete": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Delete", + "description": "Delete an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_Get", + "description": "Retrieves information about an availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySet" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListBySubscription", + "description": "Lists all availability sets in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List availability sets in a subscription.": { + "$ref": "./examples/ListAvailabilitySetsInASubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_List", + "description": "Lists all availability sets in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AvailabilitySetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}/vmSizes": { + "get": { + "tags": [ + "AvailabilitySets" + ], + "operationId": "AvailabilitySets_ListAvailableSizes", + "description": "Lists all available virtual machine sizes that can be used to create a new virtual machine in an existing availability set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "availabilitySetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the availability set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups/{proximityPlacementGroupName}": { + "put": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_CreateOrUpdate", + "description": "Create or update a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + }, + "description": "Parameters supplied to the Create Proximity Placement Group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create or Update a proximity placement group.": { + "$ref": "./examples/CreateOrUpdateAProximityPlacementGroup.json" + } + } + }, + "patch": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Update", + "description": "Update a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupUpdate" + }, + "description": "Parameters supplied to the Update Proximity Placement Group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/PatchAProximityPlacementGroup.json" + } + } + }, + "delete": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Delete", + "description": "Delete a proximity placement group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/DeleteAProximityPlacementGroup.json" + } + } + }, + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_Get", + "description": "Retrieves information about a proximity placement group .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "proximityPlacementGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the proximity placement group." + }, + { + "name": "includeColocationStatus", + "in": "query", + "required": false, + "type": "string", + "description": "includeColocationStatus=true enables fetching the colocation status of all the resources in the proximity placement group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroup" + } + } + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/GetAProximityPlacementGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListBySubscription", + "description": "Lists all proximity placement groups in a subscription.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/ListProximityPlacementGroupsInASubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/proximityPlacementGroups": { + "get": { + "tags": [ + "ProximityPlacementGroups" + ], + "operationId": "ProximityPlacementGroups_ListByResourceGroup", + "description": "Lists all proximity placement groups in a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ProximityPlacementGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Create a proximity placement group.": { + "$ref": "./examples/ListProximityPlacementGroupsInAResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}": { + "put": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_CreateOrUpdate", + "description": "Create or update a dedicated host group. For details of Dedicated Host and Dedicated Host Groups please see [Dedicated Host Documentation] (https://go.microsoft.com/fwlink/?linkid=2082596)", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "Parameters supplied to the Create Dedicated Host Group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host group.": { + "$ref": "./examples/CreateOrUpdateADedicatedHostGroup.json" + } + } + }, + "patch": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Update", + "description": "Update an dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostGroupUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host Group operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + } + }, + "delete": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Delete", + "description": "Delete a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_Get", + "description": "Retrieves information about a dedicated host group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation. The response shows the list of instance view of the dedicated hosts under the dedicated host group.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroup" + } + } + }, + "x-ms-examples": { + "Create a dedicated host group.": { + "$ref": "./examples/GetADedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListByResourceGroup", + "description": "Lists all of the dedicated host groups in the specified resource group. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/hostGroups": { + "get": { + "tags": [ + "DedicatedHostGroups" + ], + "operationId": "DedicatedHostGroups_ListBySubscription", + "description": "Lists all of the dedicated host groups in the subscription. Use the nextLink property in the response to get the next page of dedicated host groups.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts/{hostName}": { + "put": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_CreateOrUpdate", + "description": "Create or update a dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "Parameters supplied to the Create Dedicated Host." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-examples": { + "Create or update a dedicated host .": { + "$ref": "./examples/CreateOrUpdateADedicatedHost.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Update", + "description": "Update an dedicated host .", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host ." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DedicatedHostUpdate" + }, + "description": "Parameters supplied to the Update Dedicated Host operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Delete", + "description": "Delete a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "DedicatedHosts" + ], + "operationId": "DedicatedHosts_Get", + "description": "Retrieves information about a dedicated host.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "name": "hostName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHost" + } + } + }, + "x-ms-examples": { + "Get a dedicated host.": { + "$ref": "./examples/GetADedicatedHost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/hostGroups/{hostGroupName}/hosts": { + "get": { + "tags": [ + "DedicatedHost" + ], + "operationId": "DedicatedHosts_ListByHostGroup", + "description": "Lists all of the dedicated hosts in the specified dedicated host group. Use the nextLink property in the response to get the next page of dedicated hosts.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "hostGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the dedicated host group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DedicatedHostListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/sshPublicKeys": { + "get": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_ListBySubscription", + "description": "Lists all of the SSH public keys in the subscription. Use the nextLink property in the response to get the next page of SSH public keys.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeysGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys": { + "get": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_ListByResourceGroup", + "description": "Lists all of the SSH public keys in the specified resource group. Use the nextLink property in the response to get the next page of SSH public keys.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeysGroupListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}": { + "put": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Create", + "description": "Creates a new SSH public key resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + }, + "description": "Parameters supplied to create the SSH public key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + } + }, + "x-ms-examples": { + "Create a new SSH public key resource.": { + "$ref": "./examples/CreateAnSshPublicKey.json" + } + } + }, + "patch": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Update", + "description": "Updates a new SSH public key resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SshPublicKeyUpdateResource" + }, + "description": "Parameters supplied to update the SSH public key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + } + } + }, + "delete": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Delete", + "description": "Delete an SSH public key.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "No Content" + } + } + }, + "get": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_Get", + "description": "Retrieves information about an SSH public key.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyResource" + } + } + }, + "x-ms-examples": { + "Get an ssh public key.": { + "$ref": "./examples/GetAnSshPublicKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{sshPublicKeyName}/generateKeyPair": { + "post": { + "tags": [ + "SshPublicKeys" + ], + "operationId": "SshPublicKeys_GenerateKeyPair", + "description": "Generates and returns a public/private key pair and populates the SSH public key resource with the public key. The length of the key will be 3072 bits. This operation can only be performed once per SSH public key resource.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "sshPublicKeyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the SSH public key." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SshPublicKeyGenerateKeyPairResult" + } + } + }, + "x-ms-examples": { + "Generate an SSH key pair.": { + "$ref": "./examples/GenerateSshKeyPair.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_Get", + "description": "Gets a virtual machine extension image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListTypes", + "description": "Gets a list of virtual machine extension image types.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmextension/types/{type}/versions": { + "get": { + "tags": [ + "VirtualMachineExtensionImages" + ], + "operationId": "VirtualMachineExtensionImages_ListVersions", + "description": "Gets a list of virtual machine extension image versions.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "type", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionImage" + } + } + } + }, + "x-ms-odata": "#/definitions/VirtualMachineExtensionImage" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_CreateOrUpdate", + "description": "The operation to create or update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be created or updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Update", + "description": "The operation to update the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be updated." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine where the extension should be deleted." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/extensions": { + "get": { + "tags": [ + "VirtualMachineExtensions" + ], + "operationId": "VirtualMachineExtensions_List", + "description": "The operation to get all extensions of a Virtual Machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine containing the extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionsListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions/{version}": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_Get", + "description": "Gets a virtual machine image.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "version", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU version." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineImage" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus/{skus}/versions": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_List", + "description": "Gets a list of all virtual machine image versions for the specified location, publisher, offer, and SKU.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "name": "skus", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image SKU." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "format": "int32" + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListOffers", + "description": "Gets a list of virtual machine image offers for the specified location and publisher.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListPublishers", + "description": "Gets a list of virtual machine image publishers for the specified Azure location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/publishers/{publisherName}/artifacttypes/vmimage/offers/{offer}/skus": { + "get": { + "tags": [ + "VirtualMachineImages" + ], + "operationId": "VirtualMachineImages_ListSkus", + "description": "Gets a list of virtual machine image SKUs for the specified location, publisher, and offer.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The name of a supported Azure region." + }, + { + "name": "publisherName", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher." + }, + { + "name": "offer", + "in": "path", + "required": true, + "type": "string", + "description": "A valid image publisher offer." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineImageResource" + } + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usage_List", + "description": "Gets, for the specified location, the current compute resource usage information as well as the limits for compute resources under the subscription.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListByLocation", + "description": "Gets all the virtual machines under the specified subscription for the specified location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which virtual machines under the subscription are queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-examples": { + "Lists all the virtual machines under the specified subscription for the specified location.": { + "$ref": "./examples/ListVirtualMachinesInASubscriptionByLocation.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "This API is deprecated. Use [Resources Skus](https://docs.microsoft.com/en-us/rest/api/compute/resourceskus/list)", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images/{imageName}": { + "put": { + "tags": [ + "Images" + ], + "operationId": "Images_CreateOrUpdate", + "description": "Create or update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Image" + }, + "description": "Parameters supplied to the Create Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Create a virtual machine image from a blob.": { + "$ref": "./examples/CreateAnImageFromABlob.json" + }, + "Create a virtual machine image from a snapshot.": { + "$ref": "./examples/CreateAnImageFromASnapshot.json" + }, + "Create a virtual machine image from a managed disk.": { + "$ref": "./examples/CreateAnImageFromAManagedDisk.json" + }, + "Create a virtual machine image from an existing virtual machine.": { + "$ref": "./examples/CreateAnImageFromAVM.json" + }, + "Create a virtual machine image that includes a data disk from a blob.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromABlob.json" + }, + "Create a virtual machine image that includes a data disk from a snapshot.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json" + }, + "Create a virtual machine image that includes a data disk from a managed disk.": { + "$ref": "./examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json" + }, + "Create a virtual machine image from a blob with DiskEncryptionSet resource.": { + "$ref": "./examples/CreateAnImageFromABlobWithDiskEncryptionSet.json" + }, + "Create a virtual machine image from a snapshot with DiskEncryptionSet resource.": { + "$ref": "./examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json" + }, + "Create a virtual machine image from a managed disk with DiskEncryptionSet resource.": { + "$ref": "./examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Images" + ], + "operationId": "Images_Update", + "description": "Update an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ImageUpdate" + }, + "description": "Parameters supplied to the Update Image operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates tags of an Image.": { + "$ref": "./examples/UpdateImage.json" + } + } + }, + "delete": { + "tags": [ + "Images" + ], + "operationId": "Images_Delete", + "description": "Deletes an Image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_Get", + "description": "Gets an image.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "imageName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the image." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Image" + } + } + }, + "x-ms-examples": { + "Get information about a virtual machine image.": { + "$ref": "./examples/GetInformationAboutAnImage.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_ListByResourceGroup", + "description": "Gets the list of images under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a resource group.": { + "$ref": "./examples/ListImagesInAResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/images": { + "get": { + "tags": [ + "Images" + ], + "operationId": "Images_List", + "description": "Gets the list of Images in the subscription. Use nextLink property in the response to get the next page of Images. Do this till nextLink is null to fetch all the Images.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ImageListResult" + } + } + }, + "x-ms-examples": { + "List all virtual machine images in a subscription.": { + "$ref": "./examples/ListImagesInASubscription.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/capture": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Capture", + "description": "Captures the VM by copying virtual hard disks of the VM and outputs a template that can be used to create similar VMs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureParameters" + }, + "description": "Parameters supplied to the Capture Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineCaptureResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}": { + "put": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_CreateOrUpdate", + "description": "The operation to create or update a virtual machine. Please note some properties can be set only during virtual machine creation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "Parameters supplied to the Create Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a vm with password authentication.": { + "$ref": "./examples/CreateAVmWithPasswordAuthentication.json" + }, + "Create a vm with ssh authentication.": { + "$ref": "./examples/CreateAVmWithSshAuthentication.json" + }, + "Create a vm with premium storage.": { + "$ref": "./examples/CreateAVmWithPremiumStorage.json" + }, + "Create a vm in an availability set.": { + "$ref": "./examples/CreateAVmInAnAvailabilitySet.json" + }, + "Create a vm with boot diagnostics.": { + "$ref": "./examples/CreateAVmWithBootDiagnostics.json" + }, + "Create a vm with managed boot diagnostics.": { + "$ref": "./examples/CreateAVmWithManagedBootDiagnostics.json" + }, + "Create a vm with empty data disks.": { + "$ref": "./examples/CreateAVmWithEmptyDataDisks.json" + }, + "Create a vm with a marketplace image plan.": { + "$ref": "./examples/CreateAVmWithAMarketplaceImagePlan.json" + }, + "Create a vm from a custom image.": { + "$ref": "./examples/CreateAVmFromACustomImage.json" + }, + "Create a platform-image vm with unmanaged os and data disks.": { + "$ref": "./examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json" + }, + "Create a custom-image vm from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a vm with ephemeral os disk.": { + "$ref": "./examples/CreateAVmWithADiffOsDisk.json" + }, + "Create a vm with DiskEncryptionSet resource id in the os disk and data disk.": { + "$ref": "./examples/CreateAVmWithDiskEncryptionSetResource.json" + }, + "Create a vm with ephemeral os disk provisioning in Resource disk using placement property.": { + "$ref": "./examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json" + }, + "Create a vm with ephemeral os disk provisioning in Cache disk using placement property.": { + "$ref": "./examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json" + }, + "Create a vm with Host Encryption using encryptionAtHost property.": { + "$ref": "./examples/CreateAVmWithEncryptionAtHost.json" + }, + "Create a vm with a patch setting patchMode of AutomaticByOS.": { + "$ref": "./examples/CreateAVmWithPatchSettingModeOfAutomaticByOS.json" + }, + "Create a vm with a patch setting patchMode of AutomaticByPlatform.": { + "$ref": "./examples/CreateAVmWithPatchSettingModeOfAutomaticByPlatform.json" + }, + "Create a vm with a patch setting patchMode of Manual.": { + "$ref": "./examples/CreateAVmWithPatchSettingModeOfManual.json" + }, + "Create a vm with an extensions time budget.": { + "$ref": "./examples/CreateAVmWithExtensionsTimeBudget.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Update", + "description": "The operation to update a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a VM by detaching data disk": { + "$ref": "./examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Delete", + "description": "The operation to delete a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Get", + "description": "Retrieves information about the model view or the instance view of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachine" + } + } + }, + "x-ms-examples": { + "Get a Virtual Machine.": { + "$ref": "./examples/GetVirtualMachine.json" + }, + "Get a virtual machine placed on a dedicated host group through automatic placement": { + "$ref": "./examples/GetVirtualMachineAutoPlacedOnDedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/instanceView": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_InstanceView", + "description": "Retrieves information about the run-time state of a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineInstanceView" + } + } + }, + "x-ms-examples": { + "Get Virtual Machine Instance View.": { + "$ref": "./examples/GetVirtualMachineInstanceView.json" + }, + "Get instance view of a virtual machine placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/GetVirtualMachineInstanceViewAutoPlacedOnDedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/convertToManagedDisks": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ConvertToManagedDisks", + "description": "Converts virtual machine disks from blob-based to managed disks. Virtual machine must be stop-deallocated before invoking this operation.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/deallocate": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Deallocate", + "description": "Shuts down the virtual machine and releases the compute resources. You are not billed for the compute resources that this virtual machine uses.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/generalize": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Generalize", + "description": "Sets the OS state of the virtual machine to generalized. It is recommended to sysprep the virtual machine before performing this operation.
For Windows, please refer to [Create a managed image of a generalized VM in Azure](https://docs.microsoft.com/en-us/azure/virtual-machines/windows/capture-image-resource).
For Linux, please refer to [How to create an image of a virtual machine or VHD](https://docs.microsoft.com/en-us/azure/virtual-machines/linux/capture-image).", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + }, + "x-ms-examples": { + "Generalize a Virtual Machine.": { + "$ref": "./examples/GeneralizeVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_List", + "description": "Lists all of the virtual machines in the specified resource group. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachines": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAll", + "description": "Lists all of the virtual machines in the specified subscription. Use the nextLink property in the response to get the next page of virtual machines.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "statusOnly", + "in": "query", + "required": false, + "type": "string", + "description": "statusOnly=true enables fetching run time status of all Virtual Machines in the subscription." + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/vmSizes": { + "get": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_ListAvailableSizes", + "description": "Lists all available virtual machine sizes to which the specified virtual machine can be resized.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Lists all available virtual machine sizes to which the specified virtual machine can be resized": { + "$ref": "./examples/ListAvailableVmSizes_VirtualMachines.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/powerOff": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PowerOff", + "description": "The operation to power off (stop) a virtual machine. The virtual machine can be restarted with the same provisioned resources. You are still charged for this virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reapply": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reapply", + "description": "The operation to reapply a virtual machine's state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reapply the state of a virtual machine.": { + "$ref": "./examples/ReapplyVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/restart": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Restart", + "description": "The operation to restart a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/start": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Start", + "description": "The operation to start a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/redeploy": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Redeploy", + "description": "Shuts down the virtual machine, moves it to a new node, and powers it back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/reimage": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_Reimage", + "description": "Reimages the virtual machine which has an ephemeral OS disk back to its initial state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineReimageParameters" + }, + "description": "Parameters supplied to the Reimage Virtual Machine operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reimage a Virtual Machine.": { + "$ref": "./examples/ReimageVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/retrieveBootDiagnosticsData": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_RetrieveBootDiagnosticsData", + "description": "The operation to retrieve SAS URIs for a virtual machine's boot diagnostic logs.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "sasUriExpirationTimeInMinutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes.

NOTE: If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RetrieveBootDiagnosticsDataResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "RetrieveBootDiagnosticsData of a virtual machine.": { + "$ref": "./examples/RetrieveBootDiagnosticsDataVirtualMachine.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_PerformMaintenance", + "description": "The operation to perform maintenance on a virtual machine.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/simulateEviction": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_SimulateEviction", + "description": "The operation to simulate the eviction of spot virtual machine. The eviction will occur within 30 minutes of calling the API", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Simulate Eviction a virtual machine.": { + "$ref": "./examples/SimulateEvictionOfVM.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/assessPatches": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_AssessPatches", + "x-ms-examples": { + "Assess patch state of a virtual machine.": { + "$ref": "./examples/VirtualMachineAssessPatches.json" + } + }, + "description": "Assess patches on the VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineAssessPatchesResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}": { + "put": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_CreateOrUpdate", + "description": "Create or update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a scale set with password authentication.": { + "$ref": "./examples/CreateAScaleSetWithPasswordAuthentication.json" + }, + "Create a scale set with ssh authentication.": { + "$ref": "./examples/CreateAScaleSetWithSshAuthentication.json" + }, + "Create a scale set with premium storage.": { + "$ref": "./examples/CreateAScaleSetWithPremiumStorage.json" + }, + "Create a scale set with empty data disks on each vm.": { + "$ref": "./examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json" + }, + "Create a scale set with an azure load balancer.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureLoadBalancer.json" + }, + "Create a scale set with an azure application gateway.": { + "$ref": "./examples/CreateAScaleSetWithAnAzureApplicationGateway.json" + }, + "Create a scale set with boot diagnostics.": { + "$ref": "./examples/CreateAScaleSetWithBootDiagnostics.json" + }, + "Create a scale set with managed boot diagnostics.": { + "$ref": "./examples/CreateAScaleSetWithManagedBootDiagnostics.json" + }, + "Create a scale set with a marketplace image plan.": { + "$ref": "./examples/CreateAScaleSetWithAMarketplaceImagePlan.json" + }, + "Create a scale set from a custom image.": { + "$ref": "./examples/CreateAScaleSetFromACustomImage.json" + }, + "Create a platform-image scale set with unmanaged os disks.": { + "$ref": "./examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json" + }, + "Create a custom-image scale set from an unmanaged generalized os image.": { + "$ref": "./examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json" + }, + "Create a scale set with virtual machines in different zones.": { + "$ref": "./examples/CreateAScaleSetWithVMsInDifferentZones.json" + }, + "Create a scale set with ephemeral os disks.": { + "$ref": "./examples/CreateAScaleSetWithDiffOsDisk.json" + }, + "Create a scale set with terminate scheduled events enabled.": { + "$ref": "./examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json" + }, + "Create a scale set with automatic repairs enabled": { + "$ref": "./examples/CreateAScaleSetWithAutomaticRepairs.json" + }, + "Create a scale set with DiskEncryptionSet resource in os disk and data disk.": { + "$ref": "./examples/CreateAScalesetWithDiskEncryptionSetResource.json" + }, + "Create a scale set with ephemeral os disks using placement property.": { + "$ref": "./examples/CreateAScaleSetWithDiffOsDiskUsingDiffDiskPlacement.json" + }, + "Create a scale set with extension time budget.": { + "$ref": "./examples/CreateAScaleSetWithExtensionsTimeBudget.json" + }, + "Create a scale set with Host Encryption using encryptionAtHost property.": { + "$ref": "./examples/CreateAScaleSetWithEncryptionAtHost.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Update", + "description": "Update a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdate" + }, + "description": "The scale set object." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Delete", + "description": "Deletes a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Get", + "description": "Display information about a virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSet" + } + } + }, + "x-ms-examples": { + "Get a virtual machine scale set placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/GetVirtualMachineScaleSetAutoPlacedOnDedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Deallocate", + "description": "Deallocates specific virtual machines in a VM scale set. Shuts down the virtual machines and releases the compute resources. You are not billed for the compute resources that this virtual machine scale set deallocates.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/delete": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_DeleteInstances", + "description": "Deletes virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetInstanceView", + "description": "Gets the status of a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceView" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_List", + "description": "Gets a list of all VM scale sets under a resource group.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions/{vmssExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_CreateOrUpdate", + "description": "The operation to create or update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "Parameters supplied to the Create VM scale set Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Update", + "description": "The operation to update an extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be updated." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionUpdate" + }, + "description": "Parameters supplied to the Update VM scale set Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Delete", + "description": "The operation to delete the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be deleted." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_Get", + "description": "The operation to get the extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "name": "vmssExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetExtensions" + ], + "operationId": "VirtualMachineScaleSetExtensions_List", + "description": "Gets a list of all extensions in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set containing the extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/virtualMachineScaleSets": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListAll", + "description": "Gets a list of all VM Scale Sets in the subscription, regardless of the associated resource group. Use nextLink property in the response to get the next page of VM Scale Sets. Do this till nextLink is null to fetch all the VM Scale Sets.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListWithLinkResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/skus": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ListSkus", + "description": "Gets a list of SKUs available for your VM scale set, including the minimum and maximum VM instances allowed for each SKU.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListSkusResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osUpgradeHistory": { + "get": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_GetOSUpgradeHistory", + "description": "Gets list of OS upgrades on a VM scale set instance.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetListOSUpgradeHistory" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PowerOff", + "description": "Power off (stop) one or more virtual machines in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Restart", + "description": "Restarts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Start", + "description": "Starts one or more virtual machines in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Redeploy", + "description": "Shuts down all the virtual machines in the virtual machine scale set, moves them to a new node, and powers them back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_PerformMaintenance", + "description": "Perform maintenance on one or more virtual machines in a VM scale set. Operation on instances which are not eligible for perform maintenance will be failed. Please refer to best practices for more details: https://docs.microsoft.com/en-us/azure/virtual-machine-scale-sets/virtual-machine-scale-sets-maintenance-notifications", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/manualupgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_UpdateInstances", + "description": "Upgrades one or more virtual machines to the latest SKU set in the VM scale set model.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceRequiredIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_Reimage", + "description": "Reimages (upgrade the operating system) one or more virtual machines in a VM scale set which don't have a ephemeral OS disk, for virtual machines who have a ephemeral OS disk the virtual machine is reset to initial state.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmScaleSetReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetReimageParameters" + }, + "description": "Parameters for Reimaging VM ScaleSet." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ReimageAll", + "description": "Reimages all the disks ( including data disks ) in the virtual machines in a VM scale set. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "vmInstanceIDs", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceIDs" + }, + "description": "A list of virtual machine instance IDs from the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/cancel": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_Cancel", + "description": "Cancels the current virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/osRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartOSUpgrade", + "description": "Starts a rolling upgrade to move all virtual machine scale set instances to the latest available Platform Image OS version. Instances which are already running the latest available OS version are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/extensionRollingUpgrade": { + "post": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_StartExtensionUpgrade", + "description": "Starts a rolling upgrade to move all extensions for all virtual machine scale set instances to the latest available extension version. Instances which are already running the latest extension versions are not affected.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start an extension rolling upgrade.": { + "$ref": "./examples/VMScaleSetExtensionRollingUpgrade.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/rollingUpgrades/latest": { + "get": { + "tags": [ + "VirtualMachineScaleSetRollingUpgrades" + ], + "operationId": "VirtualMachineScaleSetRollingUpgrades_GetLatest", + "description": "Gets the status of the latest virtual machine scale set rolling upgrade.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RollingUpgradeStatusInfo" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/forceRecoveryServiceFabricPlatformUpdateDomainWalk": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ForceRecoveryServiceFabricPlatformUpdateDomainWalk", + "description": "Manual platform update domain walk to update virtual machines in a service fabric virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "platformUpdateDomain", + "in": "query", + "required": true, + "type": "integer", + "description": "The platform update domain for which a manual recovery walk is requested" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RecoveryWalkResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/convertToSinglePlacementGroup": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_ConvertToSinglePlacementGroup", + "description": "Converts SinglePlacementGroup property to false for a existing virtual machine scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VMScaleSetConvertToSinglePlacementGroupInput" + }, + "description": "The input object for ConvertToSinglePlacementGroup API." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/setOrchestrationServiceState": { + "post": { + "tags": [ + "VirtualMachineScaleSets" + ], + "operationId": "VirtualMachineScaleSets_SetOrchestrationServiceState", + "description": "Changes ServiceState property for a given service", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine scale set to create or update." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/OrchestrationServiceStateInput" + }, + "description": "The input object for SetOrchestrationServiceState API." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions/{vmExtensionName}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_CreateOrUpdate", + "description": "The operation to create or update the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "Parameters supplied to the Create Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json" + } + } + }, + "patch": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Update", + "description": "The operation to update the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "extensionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionUpdate" + }, + "description": "Parameters supplied to the Update Virtual Machine Extension operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/UpdateVirtualMachineScaleSetVMExtensions.json" + } + } + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Delete", + "description": "The operation to delete the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/DeleteVirtualMachineScaleSetVMExtensions.json" + } + } + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_Get", + "description": "The operation to get the VMSS VM extension.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmExtensionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine extension." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtension" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Get VirtualMachineScaleSet VM extension.": { + "$ref": "./examples/GetVirtualMachineScaleSetVMExtensions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/extensions": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMExtensions" + ], + "operationId": "VirtualMachineScaleSetVMExtensions_List", + "description": "The operation to get all extensions of an instance in Virtual Machine Scaleset.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineExtensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "List extensions in Vmss instance.": { + "$ref": "./examples/ListVirtualMachineScaleSetVMExtensions.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimage": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Reimage", + "description": "Reimages (upgrade the operating system) a specific virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "vmScaleSetVMReimageInput", + "in": "body", + "required": false, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + }, + "description": "Parameters for the Reimaging Virtual machine in ScaleSet." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/reimageall": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_ReimageAll", + "description": "Allows you to re-image all the disks ( including data disks ) in the a VM scale set instance. This operation is only supported for managed disks.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/deallocate": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Deallocate", + "description": "Deallocates a specific virtual machine in a VM scale set. Shuts down the virtual machine and releases the compute resources it uses. You are not billed for the compute resources of this virtual machine once it is deallocated.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}": { + "put": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Update", + "description": "Updates a virtual machine of a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set where the extension should be create or updated." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "Parameters supplied to the Update Virtual Machine Scale Sets VM operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "202": { + "description": "Accepted", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Delete", + "description": "Deletes a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + }, + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": true + }, + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Get", + "description": "Gets a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply on the operation.", + "enum": [ + "instanceView" + ], + "x-ms-enum": { + "name": "InstanceViewTypes", + "modelAsString": false + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/instanceView": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_GetInstanceView", + "description": "Gets the status of a virtual machine from a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView" + } + } + }, + "x-ms-examples": { + "Get instance view of a virtual machine from a VM scale set placed on a dedicated host group through automatic placement.": { + "$ref": "./examples/GetVirtualMachineScaleSetVMInstanceViewAutoPlacedOnDedicatedHostGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{virtualMachineScaleSetName}/virtualMachines": { + "get": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_List", + "description": "Gets a list of all virtual machines in a VM scale sets.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "virtualMachineScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply to the operation. Allowed values are 'startswith(instanceView/statuses/code, 'PowerState') eq true', 'properties/latestModelApplied eq true', 'properties/latestModelApplied eq false'." + }, + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "The list parameters. Allowed values are 'instanceView', 'instanceView/statuses'." + }, + { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "description": "The expand expression to apply to the operation. Allowed values are 'instanceView'." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineScaleSetVMListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/VirtualMachineScaleSetVM" + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/poweroff": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PowerOff", + "description": "Power off (stop) a virtual machine in a VM scale set. Note that resources are still attached and you are getting charged for the resources. Instead, use deallocate to release resources and avoid charges.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "skipShutdown", + "in": "query", + "required": false, + "type": "boolean", + "default": false, + "description": "The parameter to request non-graceful VM shutdown. True value for this flag indicates non-graceful shutdown whereas false indicates otherwise. Default value for this flag is false if not specified" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/restart": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Restart", + "description": "Restarts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/start": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Start", + "description": "Starts a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/redeploy": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_Redeploy", + "description": "Shuts down the virtual machine in the virtual machine scale set, moves it to a new node, and powers it back on.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/retrieveBootDiagnosticsData": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_RetrieveBootDiagnosticsData", + "description": "The operation to retrieve SAS URIs of boot diagnostic logs for a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "sasUriExpirationTimeInMinutes", + "in": "query", + "required": false, + "type": "integer", + "format": "int32", + "description": "Expiration duration in minutes for the SAS URIs with a value between 1 to 1440 minutes.

NOTE: If not specified, SAS URIs will be generated with a default expiration duration of 120 minutes." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RetrieveBootDiagnosticsDataResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "RetrieveBootDiagnosticsData of a virtual machine.": { + "$ref": "./examples/RetrieveBootDiagnosticsDataVMScaleSetVM.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/performMaintenance": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_PerformMaintenance", + "description": "Performs maintenance on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualMachines/{instanceId}/simulateEviction": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_SimulateEviction", + "description": "The operation to simulate the eviction of spot virtual machine in a VM scale set. The eviction will occur within 30 minutes of calling the API", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "204": { + "description": "No Content" + } + }, + "x-ms-long-running-operation": false, + "x-ms-examples": { + "Simulate Eviction a virtual machine.": { + "$ref": "./examples/SimulateEvictionOfVmssVM.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getRequestRateByInterval": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportRequestRateByInterval", + "x-ms-examples": { + "Export logs which contain all Api requests made to Compute Resource Provider within the given time period broken down by intervals.": { + "$ref": "./examples/LogAnalyticsRequestRateByInterval.json" + } + }, + "description": "Export logs that show Api requests made by this subscription in the given time window to show throttling activities.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RequestRateByIntervalInput" + }, + "description": "Parameters supplied to the LogAnalytics getRequestRateByInterval Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/logAnalytics/apiAccess/getThrottledRequests": { + "post": { + "tags": [ + "LogAnalytics" + ], + "operationId": "LogAnalytics_ExportThrottledRequests", + "x-ms-examples": { + "Export logs which contain all throttled Api requests made to Compute Resource Provider within the given time period.": { + "$ref": "./examples/LogAnalyticsThrottledRequests.json" + } + }, + "description": "Export logs that show total throttled Api requests for this subscription in the given time window.", + "parameters": [ + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThrottledRequestsInput" + }, + "description": "Parameters supplied to the LogAnalytics getThrottledRequests Api." + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/LogAnalyticsOperationResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + } + } + } + }, + "definitions": { + "ComputeOperationListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ComputeOperationValue" + }, + "description": "The list of compute operations" + } + }, + "description": "The List Compute Operation operation response." + }, + "ComputeOperationValue": { + "properties": { + "origin": { + "type": "string", + "readOnly": true, + "description": "The origin of the compute operation." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the compute operation." + }, + "display": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ComputeOperationValueDisplay" + } + }, + "description": "Describes the properties of a Compute Operation value." + }, + "ComputeOperationValueDisplay": { + "properties": { + "operation": { + "type": "string", + "readOnly": true, + "description": "The display name of the compute operation." + }, + "resource": { + "type": "string", + "readOnly": true, + "description": "The display name of the resource the operation applies to." + }, + "description": { + "type": "string", + "readOnly": true, + "description": "The description of the operation." + }, + "provider": { + "type": "string", + "readOnly": true, + "description": "The resource provider for the operation." + } + }, + "description": "Describes the properties of a Compute Operation Value Display." + }, + "DisallowedConfiguration": { + "properties": { + "vmDiskType": { + "type": "string", + "description": "VM disk types which are disallowed.", + "enum": [ + "None", + "Unmanaged" + ], + "x-ms-enum": { + "name": "VmDiskTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the disallowed configuration for a virtual machine image." + }, + "RetrieveBootDiagnosticsDataResult": { + "properties": { + "consoleScreenshotBlobUri": { + "type": "string", + "readOnly": true, + "description": "The console screenshot blob URI" + }, + "serialConsoleLogBlobUri": { + "type": "string", + "readOnly": true, + "description": "The serial console log blob URI." + } + }, + "description": "The SAS URIs of the console screenshot and serial log blobs." + }, + "HyperVGenerationType": { + "type": "string", + "description": "Specifies the HyperVGeneration Type", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationTypes", + "modelAsString": true + } + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "AvailabilitySetProperties": { + "properties": { + "platformUpdateDomainCount": { + "type": "integer", + "format": "int32", + "description": "Update Domain count." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "A list of references to all virtual machines in the availability set." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the availability set should be assigned to.

Minimum api-version: 2018-04-01." + }, + "statuses": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a resource." + }, + "AvailabilitySetSkuType": { + "type": "string", + "description": "Specifies the sku of an Availability Set. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'.", + "enum": [ + "Classic", + "Aligned" + ], + "x-ms-enum": { + "name": "AvailabilitySetSkuTypes", + "modelAsString": true + } + }, + "AvailabilitySet": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set, only name is required to be set. See AvailabilitySetSkuTypes for possible set of values. Use 'Aligned' for virtual machines with managed disks and 'Classic' for virtual machines with unmanaged disks. Default value is 'Classic'." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "AvailabilitySetUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AvailabilitySetProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "Sku of the availability set" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Only tags may be updated." + }, + "AvailabilitySetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailabilitySet" + }, + "description": "The list of availability sets" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of AvailabilitySets. Call ListNext() with this URI to fetch the next page of AvailabilitySets." + } + }, + "required": [ + "value" + ], + "description": "The List Availability Set operation response." + }, + "SubResourceWithColocationStatus": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "properties": { + "colocationStatus": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "Describes colocation status of a resource in the Proximity Placement Group." + } + } + }, + "ProximityPlacementGroupProperties": { + "properties": { + "proximityPlacementGroupType": { + "type": "string", + "description": "Specifies the type of the proximity placement group.

Possible values are:

**Standard** : Co-locate resources within an Azure region or Availability Zone.

**Ultra** : For future use.", + "enum": [ + "Standard", + "Ultra" + ], + "x-ms-enum": { + "name": "ProximityPlacementGroupType", + "modelAsString": true + } + }, + "virtualMachines": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all virtual machines in the proximity placement group." + }, + "virtualMachineScaleSets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all virtual machine scale sets in the proximity placement group." + }, + "availabilitySets": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceWithColocationStatus" + }, + "description": "A list of references to all availability sets in the proximity placement group." + }, + "colocationStatus": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "Describes colocation status of the Proximity Placement Group." + } + }, + "description": "Describes the properties of a Proximity Placement Group." + }, + "ProximityPlacementGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ProximityPlacementGroupProperties", + "description": "Describes the properties of a Proximity Placement Group." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupUpdate": { + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the proximity placement group." + }, + "ProximityPlacementGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ProximityPlacementGroup" + }, + "description": "The list of proximity placement groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of proximity placement groups." + } + }, + "required": [ + "value" + ], + "description": "The List Proximity Placement Group operation response." + }, + "DedicatedHostGroupInstanceView": { + "properties": { + "hosts": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostInstanceViewWithName" + }, + "description": "List of instance view of the dedicated hosts under the dedicated host group." + } + } + }, + "DedicatedHostGroupProperties": { + "properties": { + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "minimum": 1, + "maximum": 3, + "description": "Number of fault domains that the host group can span." + }, + "hosts": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all dedicated hosts in the dedicated host group." + }, + "instanceView": { + "$ref": "#/definitions/DedicatedHostGroupInstanceView", + "readOnly": true, + "description": "The dedicated host group instance view, which has the list of instance view of the dedicated hosts under the dedicated host group." + }, + "supportAutomaticPlacement": { + "type": "boolean", + "description": "Specifies whether virtual machines or virtual machine scale sets can be placed automatically on the dedicated host group. Automatic placement means resources are allocated on dedicated hosts, that are chosen by Azure, under the dedicated host group. The value is defaulted to 'true' when not provided.

Minimum api-version: 2020-06-01." + } + }, + "required": [ + "platformFaultDomainCount" + ], + "description": "Dedicated Host Group Properties." + }, + "DedicatedHostGroup": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated hosts should be assigned to.

Currently, a dedicated host can only be added to a dedicated host group at creation time. An existing dedicated host cannot be added to another dedicated host group." + }, + "DedicatedHostGroupUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostGroupProperties" + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Availability Zone to use for this host group. Only single zone is supported. The zone can be assigned only during creation. If not provided, the group supports all zones in the region. If provided, enforces each host in the group to be in the same zone." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host group that the dedicated host should be assigned to. Only tags may be updated." + }, + "DedicatedHostGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostGroup" + }, + "description": "The list of dedicated host groups" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Dedicated Host Groups. Call ListNext() with this URI to fetch the next page of Dedicated Host Groups." + } + }, + "required": [ + "value" + ], + "description": "The List Dedicated Host Group with resource group response." + }, + "DedicatedHostLicenseType": { + "type": "string", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

Possible values are:

**None**

**Windows_Server_Hybrid**

**Windows_Server_Perpetual**

Default: **None**", + "enum": [ + "None", + "Windows_Server_Hybrid", + "Windows_Server_Perpetual" + ], + "x-ms-enum": { + "name": "DedicatedHostLicenseTypes", + "modelAsString": false + } + }, + "DedicatedHostAllocatableVM": { + "properties": { + "vmSize": { + "type": "string", + "description": "VM size in terms of which the unutilized capacity is represented." + }, + "count": { + "type": "number", + "format": "double", + "description": "Maximum number of VMs of size vmSize that can fit in the dedicated host's remaining capacity." + } + }, + "description": "Represents the dedicated host unutilized capacity in terms of a specific VM size." + }, + "DedicatedHostAvailableCapacity": { + "properties": { + "allocatableVMs": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHostAllocatableVM" + }, + "description": "The unutilized capacity of the dedicated host represented in terms of each VM size that is allowed to be deployed to the dedicated host." + } + }, + "description": "Dedicated host unutilized capacity." + }, + "DedicatedHostInstanceView": { + "properties": { + "assetId": { + "readOnly": true, + "type": "string", + "description": "Specifies the unique id of the dedicated physical machine on which the dedicated host resides." + }, + "availableCapacity": { + "$ref": "#/definitions/DedicatedHostAvailableCapacity", + "description": "Unutilized capacity of the dedicated host." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a dedicated host." + }, + "DedicatedHostInstanceViewWithName": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the dedicated host." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DedicatedHostInstanceView" + } + ], + "description": "The instance view of a dedicated host that includes the name of the dedicated host. It is used for the response to the instance view of a dedicated host group." + }, + "DedicatedHostProperties": { + "properties": { + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 2, + "description": "Fault domain of the dedicated host within a dedicated host group." + }, + "autoReplaceOnFailure": { + "type": "boolean", + "description": "Specifies whether the dedicated host should be replaced automatically in case of a failure. The value is defaulted to 'true' when not provided." + }, + "hostId": { + "readOnly": true, + "type": "string", + "description": "A unique id generated and assigned to the dedicated host by the platform.

Does not change throughout the lifetime of the host." + }, + "virtualMachines": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResourceReadOnly" + }, + "readOnly": true, + "description": "A list of references to all virtual machines in the Dedicated Host." + }, + "licenseType": { + "$ref": "#/definitions/DedicatedHostLicenseType", + "description": "Specifies the software license type that will be applied to the VMs deployed on the dedicated host.

Possible values are:

**None**

**Windows_Server_Hybrid**

**Windows_Server_Perpetual**

Default: **None**" + }, + "provisioningTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The date when the host was first provisioned." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/DedicatedHostInstanceView", + "readOnly": true, + "description": "The dedicated host instance view." + } + }, + "description": "Properties of the dedicated host." + }, + "DedicatedHost": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "SKU of the dedicated host for Hardware Generation and VM family. Only name is required to be set. List Microsoft.Compute SKUs for a list of possible values." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "sku" + ], + "description": "Specifies information about the Dedicated host." + }, + "DedicatedHostUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DedicatedHostProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the dedicated host. Only tags, autoReplaceOnFailure and licenseType may be updated." + }, + "DedicatedHostListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DedicatedHost" + }, + "description": "The list of dedicated hosts" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of dedicated hosts. Call ListNext() with this URI to fetch the next page of dedicated hosts." + } + }, + "required": [ + "value" + ], + "description": "The list dedicated host operation response." + }, + "SshPublicKeyGenerateKeyPairResult": { + "properties": { + "privateKey": { + "type": "string", + "description": "Private key portion of the key pair used to authenticate to a virtual machine through ssh. The private key is returned in RFC3447 format and should be treated as a secret." + }, + "publicKey": { + "type": "string", + "description": "Public key portion of the key pair used to authenticate to a virtual machine through ssh. The public key is in ssh-rsa format." + }, + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/providers/Microsoft.Compute/sshPublicKeys/{SshPublicKeyName}" + } + }, + "required": [ + "privateKey", + "publicKey", + "id" + ], + "description": "Response from generation of an SSH key pair." + }, + "SshPublicKeyResourceProperties": { + "properties": { + "publicKey": { + "type": "string", + "description": "SSH public key used to authenticate to a virtual machine through ssh. If this property is not initially provided when the resource is created, the publicKey property will be populated when generateKeyPair is called. If the public key is provided upon resource creation, the provided public key needs to be at least 2048-bit and in ssh-rsa format." + } + }, + "description": "Properties of the SSH public key." + }, + "SshPublicKeyResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SshPublicKeyResourceProperties", + "description": "Properties of the SSH public key." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Specifies information about the SSH public key." + }, + "SshPublicKeyUpdateResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SshPublicKeyResourceProperties", + "description": "Properties of the SSH public key." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Specifies information about the SSH public key." + }, + "SshPublicKeysGroupListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKeyResource" + }, + "description": "The list of SSH public keys" + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of SSH public keys. Call ListNext() with this URI to fetch the next page of SSH public keys." + } + }, + "required": [ + "value" + ], + "description": "The list SSH public keys operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "description": "The name of the virtual machine size." + }, + "numberOfCores": { + "type": "integer", + "format": "int32", + "description": "The number of cores supported by the virtual machine size." + }, + "osDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The OS disk size, in MB, allowed by the virtual machine size." + }, + "resourceDiskSizeInMB": { + "type": "integer", + "format": "int32", + "description": "The resource disk size, in MB, allowed by the virtual machine size." + }, + "memoryInMB": { + "type": "integer", + "format": "int32", + "description": "The amount of memory, in MB, supported by the virtual machine size." + }, + "maxDataDiskCount": { + "type": "integer", + "format": "int32", + "description": "The maximum number of data disks that can be attached to the virtual machine size." + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "description": "The list of virtual machine sizes." + } + }, + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineExtensionImageProperties": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system this extension supports." + }, + "computeRole": { + "type": "string", + "description": "The type of role (IaaS or PaaS) this extension supports." + }, + "handlerSchema": { + "type": "string", + "description": "The schema defined by publisher, where extension consumers should provide settings in a matching schema." + }, + "vmScaleSetEnabled": { + "type": "boolean", + "description": "Whether the extension can be used on xRP VMScaleSets. By default existing extensions are usable on scalesets, but there might be cases where a publisher wants to explicitly indicate the extension is only enabled for CRP VMs but not VMSS." + }, + "supportsMultipleExtensions": { + "type": "boolean", + "description": "Whether the handler can support multiple extensions." + } + }, + "required": [ + "operatingSystem", + "computeRole", + "handlerSchema" + ], + "description": "Describes the properties of a Virtual Machine Extension Image." + }, + "VirtualMachineExtensionImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension Image." + }, + "VirtualMachineImageResource": { + "properties": { + "name": { + "type": "string", + "description": "The name of the resource." + }, + "location": { + "type": "string", + "description": "The supported Azure location of the resource." + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Specifies the tags that are assigned to the virtual machine. For more information about using tags, see [Using tags to organize your Azure resources](https://docs.microsoft.com/azure/azure-resource-manager/resource-group-using-tags.md)." + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Virtual machine image resource information." + }, + "VirtualMachineExtensionInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The virtual machine extension name." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "substatuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine extension." + }, + "VirtualMachineExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView", + "description": "The virtual machine extension instance view." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdateProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "How the extension handler should be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + } + }, + "description": "Describes the properties of a Virtual Machine Extension." + }, + "VirtualMachineExtension": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineExtensionUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Extension." + }, + "VirtualMachineExtensionsListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The list of extensions" + } + }, + "description": "The List Extension operation response" + }, + "VirtualMachineSoftwarePatchProperties": { + "properties": { + "patchId": { + "type": "string", + "readOnly": true, + "description": "A unique identifier for the patch." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The friendly name of the patch." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "The version number of the patch. This property applies only to Linux patches." + }, + "kbid": { + "type": "string", + "readOnly": true, + "description": "The KBID of the patch. Only applies to Windows patches." + }, + "classifications": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The classification(s) of the patch as provided by the patch publisher." + }, + "rebootBehavior": { + "type": "string", + "readOnly": true, + "description": "Describes the reboot requirements of the patch.", + "enum": [ + "NeverReboots", + "AlwaysRequiresReboot", + "CanRequestReboot" + ], + "x-ms-enum": { + "name": "SoftwareUpdateRebootBehavior", + "modelAsString": true + } + }, + "activityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "publishedDate": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the repository published this patch." + }, + "lastModifiedDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp of the last update to this patch record." + }, + "assessmentState": { + "type": "string", + "readOnly": true, + "description": "Describes the outcome of an install operation for a given patch.", + "enum": [ + "Installed", + "Failed", + "Excluded", + "NotSelected", + "Pending", + "Available" + ], + "x-ms-enum": { + "name": "PatchAssessmentState", + "modelAsString": true + } + } + }, + "description": "Describes the properties of a Virtual Machine software patch." + }, + "VirtualMachineAssessPatchesResult": { + "properties": { + "status": { + "type": "string", + "readOnly": true, + "description": "The overall success or failure status of the operation. It remains \"InProgress\" until the operation completes. At that point it will become \"Failed\", \"Succeeded\", or \"CompletedWithWarnings.\"", + "enum": [ + "InProgress", + "Failed", + "Succeeded", + "CompletedWithWarnings" + ], + "x-ms-enum": { + "name": "PatchOperationStatus", + "modelAsString": true + } + }, + "assessmentActivityId": { + "type": "string", + "readOnly": true, + "description": "The activity ID of the operation that produced this result. It is used to correlate across CRP and extension logs." + }, + "rebootPending": { + "type": "boolean", + "readOnly": true, + "description": "The overall reboot status of the VM. It will be true when partially installed patches require a reboot to complete installation but the reboot has not yet occurred." + }, + "criticalAndSecurityPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of critical or security patches that have been detected as available and not yet installed." + }, + "otherPatchCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "description": "The number of all available patches excluding critical and security." + }, + "startDateTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "description": "The UTC timestamp when the operation began." + }, + "patches": { + "type": "array", + "readOnly": true, + "items": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineSoftwarePatchProperties" + }, + "description": "The list of patches that have been detected as available for installation." + }, + "error": { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "The errors that were encountered during execution of the operation. The details array contains the list of them." + } + }, + "description": "Describes the properties of an AssessPatches result." + }, + "PurchasePlan": { + "properties": { + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "name": { + "type": "string", + "description": "The plan ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + } + }, + "required": [ + "publisher", + "name", + "product" + ], + "description": "Used for establishing the purchase context of any 3rd Party artifact through MarketPlace." + }, + "OSDiskImage": { + "properties": { + "operatingSystem": { + "type": "string", + "description": "The operating system of the osDiskImage.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + } + }, + "required": [ + "operatingSystem" + ], + "description": "Contains the os disk image information." + }, + "DataDiskImage": { + "properties": { + "lun": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "description": "Contains the data disk images information." + }, + "AutomaticOSUpgradeProperties": { + "properties": { + "automaticOSUpgradeSupported": { + "type": "boolean", + "description": "Specifies whether automatic OS upgrade is supported on the image." + } + }, + "required": [ + "automaticOSUpgradeSupported" + ], + "description": "Describes automatic OS upgrade properties on the image." + }, + "VirtualMachineImageProperties": { + "properties": { + "plan": { + "$ref": "#/definitions/PurchasePlan" + }, + "osDiskImage": { + "$ref": "#/definitions/OSDiskImage" + }, + "dataDiskImages": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDiskImage" + } + }, + "automaticOSUpgradeProperties": { + "$ref": "#/definitions/AutomaticOSUpgradeProperties" + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGenerationType" + }, + "disallowed": { + "$ref": "#/definitions/DisallowedConfiguration", + "description": "Specifies disallowed configuration for the VirtualMachine created from the image" + } + }, + "description": "Describes the properties of a Virtual Machine Image." + }, + "VirtualMachineImage": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineImageProperties" + } + }, + "required": [ + "name", + "location" + ], + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineImageResource" + } + ], + "description": "Describes a Virtual Machine Image." + }, + "UsageName": { + "properties": { + "value": { + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "properties": { + "unit": { + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": false + } + }, + "currentValue": { + "type": "integer", + "format": "int32", + "description": "The current usage of the resource." + }, + "limit": { + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "required": [ + "unit", + "currentValue", + "limit", + "name" + ], + "description": "Describes Compute Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of compute resource usages." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of compute resource usage information. Call ListNext() with this to fetch the next page of compute resource usage information." + } + }, + "required": [ + "value" + ], + "description": "The List Usages operation response." + }, + "VirtualMachineReimageParameters": { + "properties": { + "tempDisk": { + "type": "boolean", + "description": "Specifies whether to reimage temp disk. Default value: false. Note: This temp disk reimage parameter is only supported for VM/VMSS with Ephemeral OS disk." + } + }, + "description": "Parameters for Reimaging Virtual Machine. NOTE: Virtual Machine OS disk will always be reimaged" + }, + "VirtualMachineCaptureParameters": { + "properties": { + "vhdPrefix": { + "type": "string", + "description": "The captured virtual hard disk's name prefix." + }, + "destinationContainerName": { + "type": "string", + "description": "The destination container name." + }, + "overwriteVhds": { + "type": "boolean", + "description": "Specifies whether to overwrite the destination virtual hard disk, in case of conflict." + } + }, + "required": [ + "vhdPrefix", + "destinationContainerName", + "overwriteVhds" + ], + "description": "Capture Virtual Machine parameters." + }, + "VirtualMachineCaptureResult": { + "properties": { + "$schema": { + "readOnly": true, + "type": "string", + "description": "the schema of the captured virtual machine" + }, + "contentVersion": { + "readOnly": true, + "type": "string", + "description": "the version of the content" + }, + "parameters": { + "readOnly": true, + "type": "object", + "description": "parameters of the captured virtual machine" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "type": "object", + "description": "resource item" + }, + "description": "a list of resource items of the captured virtual machine" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Output of virtual machine capture operation." + }, + "Plan": { + "properties": { + "name": { + "type": "string", + "description": "The plan ID." + }, + "publisher": { + "type": "string", + "description": "The publisher ID." + }, + "product": { + "type": "string", + "description": "Specifies the product of the image from the marketplace. This is the same value as Offer under the imageReference element." + }, + "promotionCode": { + "type": "string", + "description": "The promotion code." + } + }, + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "HardwareProfile": { + "properties": { + "vmSize": { + "type": "string", + "description": "Specifies the size of the virtual machine. For more information about virtual machine sizes, see [Sizes for virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-sizes?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

The available VM sizes depend on region and availability set. For a list of available sizes use these APIs:

[List all available virtual machine sizes in an availability set](https://docs.microsoft.com/rest/api/compute/availabilitysets/listavailablesizes)

[List all available virtual machine sizes in a region](https://docs.microsoft.com/rest/api/compute/virtualmachinesizes/list)

[List all available virtual machine sizes for resizing](https://docs.microsoft.com/rest/api/compute/virtualmachines/listavailablesizes)", + "enum": [ + "Basic_A0", + "Basic_A1", + "Basic_A2", + "Basic_A3", + "Basic_A4", + "Standard_A0", + "Standard_A1", + "Standard_A2", + "Standard_A3", + "Standard_A4", + "Standard_A5", + "Standard_A6", + "Standard_A7", + "Standard_A8", + "Standard_A9", + "Standard_A10", + "Standard_A11", + "Standard_A1_v2", + "Standard_A2_v2", + "Standard_A4_v2", + "Standard_A8_v2", + "Standard_A2m_v2", + "Standard_A4m_v2", + "Standard_A8m_v2", + "Standard_B1s", + "Standard_B1ms", + "Standard_B2s", + "Standard_B2ms", + "Standard_B4ms", + "Standard_B8ms", + "Standard_D1", + "Standard_D2", + "Standard_D3", + "Standard_D4", + "Standard_D11", + "Standard_D12", + "Standard_D13", + "Standard_D14", + "Standard_D1_v2", + "Standard_D2_v2", + "Standard_D3_v2", + "Standard_D4_v2", + "Standard_D5_v2", + "Standard_D2_v3", + "Standard_D4_v3", + "Standard_D8_v3", + "Standard_D16_v3", + "Standard_D32_v3", + "Standard_D64_v3", + "Standard_D2s_v3", + "Standard_D4s_v3", + "Standard_D8s_v3", + "Standard_D16s_v3", + "Standard_D32s_v3", + "Standard_D64s_v3", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_D15_v2", + "Standard_DS1", + "Standard_DS2", + "Standard_DS3", + "Standard_DS4", + "Standard_DS11", + "Standard_DS12", + "Standard_DS13", + "Standard_DS14", + "Standard_DS1_v2", + "Standard_DS2_v2", + "Standard_DS3_v2", + "Standard_DS4_v2", + "Standard_DS5_v2", + "Standard_DS11_v2", + "Standard_DS12_v2", + "Standard_DS13_v2", + "Standard_DS14_v2", + "Standard_DS15_v2", + "Standard_DS13-4_v2", + "Standard_DS13-2_v2", + "Standard_DS14-8_v2", + "Standard_DS14-4_v2", + "Standard_E2_v3", + "Standard_E4_v3", + "Standard_E8_v3", + "Standard_E16_v3", + "Standard_E32_v3", + "Standard_E64_v3", + "Standard_E2s_v3", + "Standard_E4s_v3", + "Standard_E8s_v3", + "Standard_E16s_v3", + "Standard_E32s_v3", + "Standard_E64s_v3", + "Standard_E32-16_v3", + "Standard_E32-8s_v3", + "Standard_E64-32s_v3", + "Standard_E64-16s_v3", + "Standard_F1", + "Standard_F2", + "Standard_F4", + "Standard_F8", + "Standard_F16", + "Standard_F1s", + "Standard_F2s", + "Standard_F4s", + "Standard_F8s", + "Standard_F16s", + "Standard_F2s_v2", + "Standard_F4s_v2", + "Standard_F8s_v2", + "Standard_F16s_v2", + "Standard_F32s_v2", + "Standard_F64s_v2", + "Standard_F72s_v2", + "Standard_G1", + "Standard_G2", + "Standard_G3", + "Standard_G4", + "Standard_G5", + "Standard_GS1", + "Standard_GS2", + "Standard_GS3", + "Standard_GS4", + "Standard_GS5", + "Standard_GS4-8", + "Standard_GS4-4", + "Standard_GS5-16", + "Standard_GS5-8", + "Standard_H8", + "Standard_H16", + "Standard_H8m", + "Standard_H16m", + "Standard_H16r", + "Standard_H16mr", + "Standard_L4s", + "Standard_L8s", + "Standard_L16s", + "Standard_L32s", + "Standard_M64s", + "Standard_M64ms", + "Standard_M128s", + "Standard_M128ms", + "Standard_M64-32ms", + "Standard_M64-16ms", + "Standard_M128-64ms", + "Standard_M128-32ms", + "Standard_NC6", + "Standard_NC12", + "Standard_NC24", + "Standard_NC24r", + "Standard_NC6s_v2", + "Standard_NC12s_v2", + "Standard_NC24s_v2", + "Standard_NC24rs_v2", + "Standard_NC6s_v3", + "Standard_NC12s_v3", + "Standard_NC24s_v3", + "Standard_NC24rs_v3", + "Standard_ND6s", + "Standard_ND12s", + "Standard_ND24s", + "Standard_ND24rs", + "Standard_NV6", + "Standard_NV12", + "Standard_NV24" + ], + "x-ms-enum": { + "name": "VirtualMachineSizeTypes", + "modelAsString": true + } + } + }, + "description": "Specifies the hardware settings for the virtual machine." + }, + "ImageReference": { + "properties": { + "publisher": { + "type": "string", + "description": "The image publisher." + }, + "offer": { + "type": "string", + "description": "Specifies the offer of the platform image or marketplace image used to create the virtual machine." + }, + "sku": { + "type": "string", + "description": "The image SKU." + }, + "version": { + "type": "string", + "description": "Specifies the version of the platform image or marketplace image used to create the virtual machine. The allowed formats are Major.Minor.Build or 'latest'. Major, Minor, and Build are decimal numbers. Specify 'latest' to use the latest version of an image available at deploy time. Even if you use 'latest', the VM image will not automatically update after deploy time even if a new version becomes available." + }, + "exactVersion": { + "type": "string", + "readOnly": true, + "description": "Specifies in decimal numbers, the version of platform image or marketplace image used to create the virtual machine. This readonly field differs from 'version', only if the value specified in 'version' field is 'latest'." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations. NOTE: Image reference publisher and offer can only be set when you create the scale set." + }, + "KeyVaultSecretReference": { + "properties": { + "secretUrl": { + "type": "string", + "description": "The URL referencing a secret in a Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the secret." + } + }, + "required": [ + "secretUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Secret" + }, + "DiskEncryptionSetParameters": { + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes the parameter of customer managed disk encryption set resource id that can be specified for disk.

NOTE: The disk encryption set resource id can only be specified for managed disk. Please refer https://aka.ms/mdssewithcmkoverview for more details." + }, + "KeyVaultKeyReference": { + "properties": { + "keyUrl": { + "type": "string", + "description": "The URL referencing a key encryption key in Key Vault." + }, + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing the key." + } + }, + "required": [ + "keyUrl", + "sourceVault" + ], + "description": "Describes a reference to Key Vault Key" + }, + "DiskEncryptionSettings": { + "properties": { + "diskEncryptionKey": { + "$ref": "#/definitions/KeyVaultSecretReference", + "description": "Specifies the location of the disk encryption key, which is a Key Vault Secret." + }, + "keyEncryptionKey": { + "$ref": "#/definitions/KeyVaultKeyReference", + "description": "Specifies the location of the key encryption key in Key Vault." + }, + "enabled": { + "type": "boolean", + "description": "Specifies whether disk encryption should be enabled on the virtual machine." + } + }, + "description": "Describes a Encryption Settings for a Disk" + }, + "VirtualHardDisk": { + "properties": { + "uri": { + "type": "string", + "description": "Specifies the virtual hard disk's uri." + } + }, + "description": "Describes the uri of a disk." + }, + "Caching": { + "type": "string", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "CreateOption": { + "type": "string", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described.", + "enum": [ + "FromImage", + "Empty", + "Attach" + ], + "x-ms-enum": { + "name": "DiskCreateOptionTypes", + "modelAsString": true + } + }, + "StorageAccountType": { + "type": "string", + "description": "Specifies the storage account type for the managed disk. Managed OS disk storage account type can only be set when you create the scale set. NOTE: UltraSSD_LRS can only be used with data disks. It cannot be used with OS Disk. Standard_LRS uses Standard HDD. StandardSSD_LRS uses Standard SSD. Premium_LRS uses Premium SSD. UltraSSD_LRS uses Ultra disk. For more information regarding disks supported for Windows Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/windows/disks-types and, for Linux Virtual Machines, refer to https://docs.microsoft.com/en-us/azure/virtual-machines/linux/disks-types", + "enum": [ + "Standard_LRS", + "Premium_LRS", + "StandardSSD_LRS", + "UltraSSD_LRS" + ], + "x-ms-enum": { + "name": "StorageAccountTypes", + "modelAsString": true + } + }, + "DiffDiskOption": { + "type": "string", + "description": "Specifies the ephemeral disk option for operating system disk.", + "enum": [ + "Local" + ], + "x-ms-enum": { + "name": "DiffDiskOptions", + "modelAsString": true + } + }, + "DiffDiskPlacement": { + "type": "string", + "description": "Specifies the ephemeral disk placement for operating system disk. This property can be used by user in the request to choose the location i.e, cache disk or resource disk space for Ephemeral OS disk provisioning. For more information on Ephemeral OS disk size requirements, please refer Ephemeral OS disk size requirements for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/ephemeral-os-disks#size-requirements and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/ephemeral-os-disks#size-requirements", + "enum": [ + "CacheDisk", + "ResourceDisk" + ], + "x-ms-enum": { + "name": "DiffDiskPlacement", + "modelAsString": true + } + }, + "DiffDiskSettings": { + "properties": { + "option": { + "$ref": "#/definitions/DiffDiskOption", + "description": "Specifies the ephemeral disk settings for operating system disk." + }, + "placement": { + "$ref": "#/definitions/DiffDiskPlacement", + "description": "Specifies the ephemeral disk placement for operating system disk.

Possible values are:

**CacheDisk**

**ResourceDisk**

Default: **CacheDisk** if one is configured for the VM size otherwise **ResourceDisk** is used.

Refer to VM size documentation for Windows VM at https://docs.microsoft.com/en-us/azure/virtual-machines/windows/sizes and Linux VM at https://docs.microsoft.com/en-us/azure/virtual-machines/linux/sizes to check which VM sizes exposes a cache disk." + } + }, + "description": "Describes the parameters of ephemeral disk settings that can be specified for operating system disk.

NOTE: The ephemeral disk settings can only be specified for managed disk." + }, + "ManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "The parameters of a managed disk." + }, + "OSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

Possible values are:

**Windows**

**Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "encryptionSettings": { + "$ref": "#/definitions/DiskEncryptionSettings", + "description": "Specifies the encryption settings for the OS Disk.

Minimum api-version: 2015-06-15" + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None** for Standard storage. **ReadOnly** for Premium storage." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral Disk Settings for the operating system disk used by the virtual machine." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "DataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "name": { + "type": "string", + "description": "The disk name." + }, + "vhd": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The virtual hard disk." + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

Possible values are:

**None**

**ReadOnly**

**ReadWrite**

Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machine should be created.

Possible values are:

**Attach** \\u2013 This value is used when you are using a specialized disk to create the virtual machine.

**FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/ManagedDiskParameters" + }, + "toBeDetached": { + "type": "boolean", + "description": "Specifies whether the data disk is in process of detachment from the VirtualMachine/VirtualMachineScaleset" + }, + "diskIOPSReadWrite": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set." + }, + "diskMBpsReadWrite": { + "type": "integer", + "readOnly": true, + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk when StorageAccountType is UltraSSD_LRS. Returned only for VirtualMachine ScaleSet VM disks. Can be updated only via updates to the VirtualMachine Scale Set." + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a data disk." + }, + "StorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/OSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/DataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Specifies the storage settings for the virtual machine disks." + }, + "SecurityProfile": { + "properties": { + "encryptionAtHost": { + "type": "boolean", + "description": "This property can be used by user in the request to enable or disable the Host Encryption for the virtual machine or virtual machine scale set. This will enable the encryption for all the disks including Resource/Temp disk at host itself.

Default: The Encryption at host will be disabled unless this property is set to true for the resource." + } + }, + "description": "Specifies the Security profile settings for the virtual machine or virtual machine scale set." + }, + "AdditionalCapabilities": { + "properties": { + "ultraSSDEnabled": { + "type": "boolean", + "description": "The flag that enables or disables a capability to have one or more managed data disks with UltraSSD_LRS storage account type on the VM or VMSS. Managed disks with storage account type UltraSSD_LRS can be added to a virtual machine or virtual machine scale set only if this property is enabled." + } + }, + "description": "Enables or disables a capability on the virtual machine or virtual machine scale set." + }, + "AdditionalUnattendContent": { + "properties": { + "passName": { + "type": "string", + "description": "The pass name. Currently, the only allowable value is OobeSystem.", + "enum": [ + "OobeSystem" + ], + "x-ms-enum": { + "name": "PassNames", + "modelAsString": false + } + }, + "componentName": { + "type": "string", + "description": "The component name. Currently, the only allowable value is Microsoft-Windows-Shell-Setup.", + "enum": [ + "Microsoft-Windows-Shell-Setup" + ], + "x-ms-enum": { + "name": "ComponentNames", + "modelAsString": false + } + }, + "settingName": { + "type": "string", + "description": "Specifies the name of the setting to which the content applies. Possible values are: FirstLogonCommands and AutoLogon.", + "enum": [ + "AutoLogon", + "FirstLogonCommands" + ], + "x-ms-enum": { + "name": "SettingNames", + "modelAsString": false + } + }, + "content": { + "type": "string", + "description": "Specifies the XML formatted content that is added to the unattend.xml file for the specified path and component. The XML must be less than 4KB and must include the root element for the setting or feature that is being inserted." + } + }, + "description": "Specifies additional XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup. Contents are defined by setting name, component name, and the pass in which the content is applied." + }, + "WinRMListener": { + "properties": { + "protocol": { + "type": "string", + "description": "Specifies the protocol of WinRM listener.

Possible values are:
**http**

**https**", + "enum": [ + "Http", + "Https" + ], + "x-ms-enum": { + "name": "ProtocolTypes", + "modelAsString": false + } + }, + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + } + }, + "description": "Describes Protocol and thumbprint of Windows Remote Management listener" + }, + "WinRMConfiguration": { + "properties": { + "listeners": { + "type": "array", + "items": { + "$ref": "#/definitions/WinRMListener" + }, + "description": "The list of Windows Remote Management listeners" + } + }, + "description": "Describes Windows Remote Management configuration of the VM" + }, + "WindowsConfiguration": { + "properties": { + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + }, + "enableAutomaticUpdates": { + "type": "boolean", + "description": "Indicates whether Automatic Updates is enabled for the Windows virtual machine. Default value is true.

For virtual machine scale sets, this property can be updated and updates will take effect on OS reprovisioning." + }, + "timeZone": { + "type": "string", + "description": "Specifies the time zone of the virtual machine. e.g. \"Pacific Standard Time\".

Possible values can be [TimeZoneInfo.Id](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.id?#System_TimeZoneInfo_Id) value from time zones returned by [TimeZoneInfo.GetSystemTimeZones](https://docs.microsoft.com/en-us/dotnet/api/system.timezoneinfo.getsystemtimezones)." + }, + "additionalUnattendContent": { + "type": "array", + "items": { + "$ref": "#/definitions/AdditionalUnattendContent" + }, + "description": "Specifies additional base-64 encoded XML formatted information that can be included in the Unattend.xml file, which is used by Windows Setup." + }, + "patchSettings": { + "$ref": "#/definitions/PatchSettings", + "description": "Specifies settings related to in-guest patching (KBs)." + }, + "winRM": { + "$ref": "#/definitions/WinRMConfiguration", + "description": "Specifies the Windows Remote Management listeners. This enables remote Windows PowerShell." + } + }, + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "SshPublicKey": { + "properties": { + "path": { + "type": "string", + "description": "Specifies the full path on the created VM where ssh public key is stored. If the file already exists, the specified key is appended to the file. Example: /home/user/.ssh/authorized_keys" + }, + "keyData": { + "type": "string", + "description": "SSH public key certificate used to authenticate with the VM through ssh. The key needs to be at least 2048-bit and in ssh-rsa format.

For creating ssh keys, see [Create SSH keys on Linux and Mac for Linux VMs in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-mac-create-ssh-keys?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + } + }, + "description": "Contains information about SSH certificate public key and the path on the Linux VM where the public key is placed." + }, + "SshConfiguration": { + "properties": { + "publicKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/SshPublicKey" + }, + "description": "The list of SSH public keys used to authenticate with linux based VMs." + } + }, + "description": "SSH configuration for Linux based VMs running on Azure" + }, + "LinuxConfiguration": { + "properties": { + "disablePasswordAuthentication": { + "type": "boolean", + "description": "Specifies whether password authentication should be disabled." + }, + "ssh": { + "$ref": "#/definitions/SshConfiguration", + "description": "Specifies the ssh key configuration for a Linux OS." + }, + "provisionVMAgent": { + "type": "boolean", + "description": "Indicates whether virtual machine agent should be provisioned on the virtual machine.

When this property is not specified in the request body, default behavior is to set it to true. This will ensure that VM Agent is installed on the VM so that extensions can be added to the VM later." + } + }, + "description": "Specifies the Linux operating system settings on the virtual machine.

For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "VaultCertificate": { + "properties": { + "certificateUrl": { + "type": "string", + "description": "This is the URL of a certificate that has been uploaded to Key Vault as a secret. For adding a secret to the Key Vault, see [Add a key or secret to the key vault](https://docs.microsoft.com/azure/key-vault/key-vault-get-started/#add). In this case, your certificate needs to be It is the Base64 encoding of the following JSON Object which is encoded in UTF-8:

{
\"data\":\"\",
\"dataType\":\"pfx\",
\"password\":\"\"
}" + }, + "certificateStore": { + "type": "string", + "description": "For Windows VMs, specifies the certificate store on the Virtual Machine to which the certificate should be added. The specified certificate store is implicitly in the LocalMachine account.

For Linux VMs, the certificate file is placed under the /var/lib/waagent directory, with the file name <UppercaseThumbprint>.crt for the X509 certificate file and <UppercaseThumbprint>.prv for private key. Both of these files are .pem formatted." + } + }, + "description": "Describes a single certificate reference in a Key Vault, and where the certificate should reside on the VM." + }, + "VaultSecretGroup": { + "properties": { + "sourceVault": { + "$ref": "#/definitions/SubResource", + "description": "The relative URL of the Key Vault containing all of the certificates in VaultCertificates." + }, + "vaultCertificates": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultCertificate" + }, + "description": "The list of key vault references in SourceVault which contain certificates." + } + }, + "description": "Describes a set of certificates which are all in the same Key Vault." + }, + "OSProfile": { + "properties": { + "computerName": { + "type": "string", + "description": "Specifies the host OS name of the virtual machine.

This name cannot be updated after the VM is created.

**Max-length (Windows):** 15 characters

**Max-length (Linux):** 64 characters.

For naming conventions and restrictions see [Azure infrastructure services implementation guidelines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-infrastructure-subscription-accounts-guidelines?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#1-naming-conventions)." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

This property cannot be updated after the VM is created.

**Windows-only restriction:** Cannot end in \".\"

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

**Minimum-length (Linux):** 1 character

**Max-length (Linux):** 64 characters

**Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

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

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    **Note: Do not pass any secrets or passwords in customData property**

    This property cannot be updated after the VM is created.

    customData is passed to the VM to be saved as a file, for more information see [Custom Data on Azure VMs](https://azure.microsoft.com/en-us/blog/custom-data-and-cloud-init-on-windows-azure/)

    For using cloud-init for your Linux VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machine." + }, + "allowExtensionOperations": { + "type": "boolean", + "description": "Specifies whether extension operations should be allowed on the virtual machine.

    This may only be set to False when no extensions are present on the virtual machine." + }, + "requireGuestProvisionSignal": { + "type": "boolean", + "description": "Specifies whether the guest provision signal is required to infer provision success of the virtual machine." + } + }, + "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "AutomaticRepairsPolicy": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Specifies whether automatic repairs should be enabled on the virtual machine scale set. The default value is false." + }, + "gracePeriod": { + "type": "string", + "description": "The amount of time for which automatic repairs are suspended due to a state change on VM. The grace time starts after the state change has completed. This helps avoid premature or accidental repairs. The time duration should be specified in ISO 8601 format. The minimum allowed grace period is 30 minutes (PT30M), which is also the default value. The maximum allowed grace period is 90 minutes (PT90M)." + } + }, + "description": "Specifies the configuration parameters for automatic repairs on the virtual machine scale set." + }, + "NetworkInterfaceReferenceProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + } + }, + "description": "Describes a network interface reference properties." + }, + "NetworkInterfaceReference": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/NetworkInterfaceReferenceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a network interface reference." + }, + "NetworkProfile": { + "properties": { + "networkInterfaces": { + "type": "array", + "items": { + "$ref": "#/definitions/NetworkInterfaceReference" + }, + "description": "Specifies the list of resource Ids for the network interfaces associated with the virtual machine." + } + }, + "description": "Specifies the network interfaces of the virtual machine." + }, + "BootDiagnostics": { + "properties": { + "enabled": { + "type": "boolean", + "description": "Whether boot diagnostics should be enabled on the Virtual Machine." + }, + "storageUri": { + "type": "string", + "description": "Uri of the storage account to use for placing the console output and screenshot.

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

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "DiagnosticsProfile": { + "properties": { + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnostics", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + } + }, + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "priority": { + "type": "string", + "description": "Specifies the priority for a standalone virtual machine or the virtual machines in the scale set.

    'Low' enum will be deprecated in the future, please use 'Spot' as the enum to deploy Azure Spot VM/VMSS.", + "enum": [ + "Regular", + "Low", + "Spot" + ], + "x-ms-enum": { + "name": "VirtualMachinePriorityTypes", + "modelAsString": true + } + }, + "evictionPolicy": { + "type": "string", + "description": "Specifies the eviction policy for the Azure Spot VM/VMSS", + "enum": [ + "Deallocate", + "Delete" + ], + "x-ms-enum": { + "name": "VirtualMachineEvictionPolicyTypes", + "modelAsString": true + } + }, + "BillingProfile": { + "properties": { + "maxPrice": { + "type": "number", + "format": "double", + "description": "Specifies the maximum price you are willing to pay for a Azure Spot VM/VMSS. This price is in US Dollars.

    This price will be compared with the current Azure Spot price for the VM size. Also, the prices are compared at the time of create/update of Azure Spot VM/VMSS and the operation will only succeed if the maxPrice is greater than the current Azure Spot price.

    The maxPrice will also be used for evicting a Azure Spot VM/VMSS if the current Azure Spot price goes beyond the maxPrice after creation of VM/VMSS.

    Possible values are:

    - Any decimal value greater than zero. Example: 0.01538

    -1 – indicates default price to be up-to on-demand.

    You can set the maxPrice to -1 to indicate that the Azure Spot VM/VMSS should not be evicted for price reasons. Also, the default max price is -1 if it is not provided by you.

    Minimum api-version: 2019-03-01." + } + }, + "description": "Specifies the billing related details of a Azure Spot VM or VMSS.

    Minimum api-version: 2019-03-01." + }, + "VirtualMachineExtensionHandlerInstanceView": { + "properties": { + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "status": { + "$ref": "#/definitions/InstanceViewStatus", + "description": "The extension handler status." + } + }, + "description": "The instance view of a virtual machine extension handler." + }, + "VirtualMachineAgentInstanceView": { + "properties": { + "vmAgentVersion": { + "type": "string", + "description": "The VM Agent full version." + }, + "extensionHandlers": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionHandlerInstanceView" + }, + "description": "The virtual machine extension handler instance view." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the VM Agent running on the virtual machine." + }, + "DiskInstanceView": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "encryptionSettings": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskEncryptionSettings" + }, + "description": "Specifies the encryption settings for the OS Disk.

    Minimum api-version: 2015-06-15" + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of the disk." + }, + "BootDiagnosticsInstanceView": { + "properties": { + "consoleScreenshotBlobUri": { + "readOnly": true, + "type": "string", + "description": "The console screenshot blob URI.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage." + }, + "serialConsoleLogBlobUri": { + "readOnly": true, + "type": "string", + "description": "The serial console log blob Uri.

    NOTE: This will **not** be set if boot diagnostics is currently enabled with managed storage." + }, + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The boot diagnostics status information for the VM.

    NOTE: It will be set only if there are errors encountered in enabling boot diagnostics." + } + }, + "description": "The instance view of a virtual machine boot diagnostics." + }, + "VirtualMachineIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the Virtual Machine. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine." + }, + "MaintenanceRedeployStatus": { + "properties": { + "isCustomerInitiatedMaintenanceAllowed": { + "type": "boolean", + "description": "True, if customer is allowed to perform Maintenance." + }, + "preMaintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Pre Maintenance Window." + }, + "preMaintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Pre Maintenance Window." + }, + "maintenanceWindowStartTime": { + "type": "string", + "format": "date-time", + "description": "Start Time for the Maintenance Window." + }, + "maintenanceWindowEndTime": { + "type": "string", + "format": "date-time", + "description": "End Time for the Maintenance Window." + }, + "lastOperationResultCode": { + "type": "string", + "description": "The Last Maintenance Operation Result Code.", + "enum": [ + "None", + "RetryLater", + "MaintenanceAborted", + "MaintenanceCompleted" + ], + "x-ms-enum": { + "name": "MaintenanceOperationResultCodeTypes", + "modelAsString": false + } + }, + "lastOperationMessage": { + "type": "string", + "description": "Message returned for the last Maintenance Operation." + } + }, + "description": "Maintenance Operation Status." + }, + "VirtualMachineInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the update domain of the virtual machine." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "Specifies the fault domain of the virtual machine." + }, + "computerName": { + "type": "string", + "description": "The computer name assigned to the virtual machine." + }, + "osName": { + "type": "string", + "description": "The Operating System running on the virtual machine." + }, + "osVersion": { + "type": "string", + "description": "The version of Operating System running on the virtual machine." + }, + "hyperVGeneration": { + "type": "string", + "description": "Specifies the HyperVGeneration Type associated with a resource", + "enum": [ + "V1", + "V2" + ], + "x-ms-enum": { + "name": "HyperVGenerationType", + "modelAsString": true + } + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The virtual machine disk information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "assignedHost": { + "type": "string", + "readOnly": true, + "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + } + }, + "description": "The instance view of a virtual machine." + }, + "VirtualMachineProperties": { + "properties": { + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings used while creating the virtual machine. Some of the settings cannot be changed once VM is provisioned." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. The availability set to which the VM is being added should be under the same resource group as the availability set resource. An existing VM cannot be added to an availability set.

    This property cannot exist along with a non-null properties.virtualMachineScaleSet reference." + }, + "virtualMachineScaleSet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the virtual machine scale set that the virtual machine should be assigned to. Virtual machines specified in the same virtual machine scale set are allocated to different nodes to maximize availability. Currently, a VM can only be added to virtual machine scale set at creation time. An existing VM cannot be added to a virtual machine scale set.

    This property cannot exist along with a non-null properties.availabilitySet reference.

    Minimum api‐version: 2019‐03‐01" + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine should be assigned to.

    Minimum api-version: 2018-04-01." + }, + "priority": { + "$ref": "#/definitions/priority", + "description": "Specifies the priority for the virtual machine.

    Minimum api-version: 2019-03-01" + }, + "evictionPolicy": { + "$ref": "#/definitions/evictionPolicy", + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "billingProfile": { + "$ref": "#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot virtual machine.

    Minimum api-version: 2019-03-01." + }, + "host": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the dedicated host that the virtual machine resides in.

    Minimum api-version: 2018-10-01." + }, + "hostGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the dedicated host group that the virtual machine resides in.

    Minimum api-version: 2020-06-01.

    NOTE: User cannot specify both host and hostGroup properties." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Specifies the VM unique ID which is a 128-bits identifier that is encoded and stored in all Azure IaaS VMs SMBIOS and can be read using platform BIOS commands." + }, + "extensionsTimeBudget": { + "type": "string", + "description": "Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01" + } + }, + "description": "Describes the properties of a Virtual Machine." + }, + "VirtualMachine": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine." + }, + "VirtualMachineUpdate": { + "properties": { + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineIdentity", + "description": "The identity of the virtual machine, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Update." + }, + "VirtualMachineListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachine" + }, + "description": "The list of virtual machines." + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of VMs. Call ListNext() with this URI to fetch the next page of Virtual Machines." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "Sku": { + "properties": { + "name": { + "type": "string", + "description": "The sku name." + }, + "tier": { + "type": "string", + "description": "Specifies the tier of virtual machines in a scale set.

    Possible Values:

    **Standard**

    **Basic**" + }, + "capacity": { + "type": "integer", + "format": "int64", + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set sku. NOTE: If the new VM SKU is not supported on the hardware the scale set is currently on, you need to deallocate the VMs in the scale set before you modify the SKU name." + }, + "AutomaticOSUpgradePolicy": { + "properties": { + "enableAutomaticOSUpgrade": { + "type": "boolean", + "description": "Indicates whether OS upgrades should automatically be applied to scale set instances in a rolling fashion when a newer version of the OS image becomes available. Default value is false.

    If this is set to true for Windows based scale sets, [enableAutomaticUpdates](https://docs.microsoft.com/dotnet/api/microsoft.azure.management.compute.models.windowsconfiguration.enableautomaticupdates?view=azure-dotnet) is automatically set to false and cannot be set to true." + }, + "disableAutomaticRollback": { + "type": "boolean", + "description": "Whether OS image rollback feature should be disabled. Default value is false." + } + }, + "description": "The configuration parameters used for performing automatic OS upgrade." + }, + "UpgradePolicy": { + "properties": { + "mode": { + "type": "string", + "description": "Specifies the mode of an upgrade to virtual machines in the scale set.

    Possible values are:

    **Manual** - You control the application of updates to virtual machines in the scale set. You do this by using the manualUpgrade action.

    **Automatic** - All virtual machines in the scale set are automatically updated at the same time.", + "enum": [ + "Automatic", + "Manual", + "Rolling" + ], + "x-ms-enum": { + "name": "UpgradeMode", + "modelAsString": false + } + }, + "rollingUpgradePolicy": { + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "automaticOSUpgradePolicy": { + "$ref": "#/definitions/AutomaticOSUpgradePolicy", + "description": "Configuration parameters used for performing automatic OS Upgrade." + } + }, + "description": "Describes an upgrade policy - automatic, manual, or rolling." + }, + "RollingUpgradePolicy": { + "properties": { + "maxBatchInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percent of total virtual machine instances that will be upgraded simultaneously by the rolling upgrade in one batch. As this is a maximum, unhealthy instances in previous or future batches can cause the percentage of instances in a batch to decrease to ensure higher reliability. The default value for this parameter is 20%." + }, + "maxUnhealthyInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 5, + "maximum": 100, + "description": "The maximum percentage of the total virtual machine instances in the scale set that can be simultaneously unhealthy, either as a result of being upgraded, or by being found in an unhealthy state by the virtual machine health checks before the rolling upgrade aborts. This constraint will be checked prior to starting any batch. The default value for this parameter is 20%." + }, + "maxUnhealthyUpgradedInstancePercent": { + "type": "integer", + "format": "int32", + "minimum": 0, + "maximum": 100, + "description": "The maximum percentage of upgraded virtual machine instances that can be found to be in an unhealthy state. This check will happen after each batch is upgraded. If this percentage is ever exceeded, the rolling update aborts. The default value for this parameter is 20%." + }, + "pauseTimeBetweenBatches": { + "type": "string", + "description": "The wait time between completing the update for all virtual machines in one batch and starting the next batch. The time duration should be specified in ISO 8601 format. The default value is 0 seconds (PT0S)." + } + }, + "description": "The configuration parameters used while performing a rolling upgrade." + }, + "ScaleInPolicy": { + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Default", + "OldestVM", + "NewestVM" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetScaleInRules", + "modelAsString": true + } + }, + "description": "The rules to be followed when scaling-in a virtual machine scale set.

    Possible values are:

    **Default** When a virtual machine scale set is scaled in, the scale set will first be balanced across zones if it is a zonal scale set. Then, it will be balanced across Fault Domains as far as possible. Within each Fault Domain, the virtual machines chosen for removal will be the newest ones that are not protected from scale-in.

    **OldestVM** When a virtual machine scale set is being scaled-in, the oldest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the oldest virtual machines that are not protected will be chosen for removal.

    **NewestVM** When a virtual machine scale set is being scaled-in, the newest virtual machines that are not protected from scale-in will be chosen for removal. For zonal virtual machine scale sets, the scale set will first be balanced across zones. Within each zone, the newest virtual machines that are not protected will be chosen for removal.

    " + } + }, + "description": "Describes a scale-in policy for a virtual machine scale set." + }, + "ImageOSDisk": { + "properties": { + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from a custom image.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "osState": { + "type": "string", + "description": "The OS State.", + "enum": [ + "Generalized", + "Specialized" + ], + "x-ms-enum": { + "name": "OperatingSystemStateTypes", + "modelAsString": false, + "values": [ + { + "value": "Generalized", + "description": "Generalized image. Needs to be provisioned during deployment time." + }, + { + "value": "Specialized", + "description": "Specialized image. Contains already provisioned OS Disk." + } + ] + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageDisk" + } + ], + "required": [ + "osType", + "osState" + ], + "description": "Describes an Operating System disk." + }, + "ImageDataDisk": { + "properties": { + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ImageDisk" + } + ], + "required": [ + "lun" + ], + "description": "Describes a data disk." + }, + "ImageDisk": { + "properties": { + "snapshot": { + "$ref": "#/definitions/SubResource", + "description": "The snapshot." + }, + "managedDisk": { + "$ref": "#/definitions/SubResource", + "description": "The managedDisk." + }, + "blobUri": { + "type": "string", + "description": "The Virtual Hard Disk." + }, + "caching": { + "type": "string", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**", + "enum": [ + "None", + "ReadOnly", + "ReadWrite" + ], + "x-ms-enum": { + "name": "CachingTypes", + "modelAsString": false + } + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of empty data disks in gigabytes. This element can be used to overwrite the name of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed image disk." + } + }, + "description": "Describes a image disk." + }, + "ImageStorageProfile": { + "properties": { + "osDisk": { + "$ref": "#/definitions/ImageOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDataDisk" + }, + "description": "Specifies the parameters that are used to add a data disk to a virtual machine.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "zoneResilient": { + "type": "boolean", + "description": "Specifies whether an image is zone resilient or not. Default is false. Zone resilient images can be created only in regions that provide Zone Redundant Storage (ZRS)." + } + }, + "description": "Describes a storage profile." + }, + "ImageProperties": { + "properties": { + "sourceVirtualMachine": { + "$ref": "#/definitions/SubResource", + "description": "The source virtual machine from which Image is created." + }, + "storageProfile": { + "$ref": "#/definitions/ImageStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state." + }, + "hyperVGeneration": { + "$ref": "#/definitions/HyperVGenerationType", + "description": "Gets the HyperVGenerationType of the VirtualMachine created from the image" + } + }, + "description": "Describes the properties of an Image." + }, + "Image": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The source user image virtual hard disk. The virtual hard disk will be copied before being attached to the virtual machine. If SourceImage is provided, the destination virtual hard drive must not exist." + }, + "ImageUpdate": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ImageProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "The source user image virtual hard disk. Only tags may be updated." + }, + "ImageListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Image" + }, + "description": "The list of Images." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Images. Call ListNext() with this to fetch the next page of Images." + } + }, + "required": [ + "value" + ], + "description": "The List Image operation response." + }, + "VirtualMachineScaleSetIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of virtual machine scale set identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id associated with the virtual machine scale set. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the virtual machine scale set. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the virtual machine scale set.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the virtual machine scale set. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the virtual machine scale set." + }, + "VirtualMachineScaleSetOSProfile": { + "properties": { + "computerNamePrefix": { + "type": "string", + "description": "Specifies the computer name prefix for all of the virtual machines in the scale set. Computer name prefixes must be 1 to 15 characters long." + }, + "adminUsername": { + "type": "string", + "description": "Specifies the name of the administrator account.

    **Windows-only restriction:** Cannot end in \".\"

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

    **Minimum-length (Linux):** 1 character

    **Max-length (Linux):** 64 characters

    **Max-length (Windows):** 20 characters

  • For root access to the Linux VM, see [Using root privileges on Linux virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-use-root-privileges?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)
  • For a list of built-in system users on Linux that should not be used in this field, see [Selecting User Names for Linux on Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-usernames?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "adminPassword": { + "type": "string", + "description": "Specifies the password of the administrator account.

    **Minimum-length (Windows):** 8 characters

    **Minimum-length (Linux):** 6 characters

    **Max-length (Windows):** 123 characters

    **Max-length (Linux):** 72 characters

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

    **Disallowed values:** \"abc@123\", \"P@$$w0rd\", \"P@ssw0rd\", \"P@ssword123\", \"Pa$$word\", \"pass@word1\", \"Password!\", \"Password1\", \"Password22\", \"iloveyou!\"

    For resetting the password, see [How to reset the Remote Desktop service or its login password in a Windows VM](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-reset-rdp?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    For resetting root password, see [Manage users, SSH, and check or repair disks on Azure Linux VMs using the VMAccess Extension](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-vmaccess-extension?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json#reset-root-password)" + }, + "customData": { + "type": "string", + "description": "Specifies a base-64 encoded string of custom data. The base-64 encoded string is decoded to a binary array that is saved as a file on the Virtual Machine. The maximum length of the binary array is 65535 bytes.

    For using cloud-init for your VM, see [Using cloud-init to customize a Linux VM during creation](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-using-cloud-init?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)" + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "Specifies Windows operating system settings on the virtual machine." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "Specifies the Linux operating system settings on the virtual machine.

    For a list of supported Linux distributions, see [Linux on Azure-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-endorsed-distros?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)

    For running non-endorsed distributions, see [Information for Non-Endorsed Distributions](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-linux-create-upload-generic?toc=%2fazure%2fvirtual-machines%2flinux%2ftoc.json)." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "Specifies set of certificates that should be installed onto the virtual machines in the scale set." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetUpdateOSProfile": { + "properties": { + "customData": { + "type": "string", + "description": "A base-64 encoded string of custom data." + }, + "windowsConfiguration": { + "$ref": "#/definitions/WindowsConfiguration", + "description": "The Windows Configuration of the OS profile." + }, + "linuxConfiguration": { + "$ref": "#/definitions/LinuxConfiguration", + "description": "The Linux Configuration of the OS profile." + }, + "secrets": { + "type": "array", + "items": { + "$ref": "#/definitions/VaultSecretGroup" + }, + "description": "The List of certificates for addition to the VM." + } + }, + "description": "Describes a virtual machine scale set OS profile." + }, + "VirtualMachineScaleSetManagedDiskParameters": { + "properties": { + "storageAccountType": { + "$ref": "#/definitions/StorageAccountType", + "description": "Specifies the storage account type for the managed disk. NOTE: UltraSSD_LRS can only be used with data disks, it cannot be used with OS Disk." + }, + "diskEncryptionSet": { + "$ref": "#/definitions/DiskEncryptionSetParameters", + "description": "Specifies the customer managed disk encryption set resource id for the managed disk." + } + }, + "description": "Describes the parameters of a ScaleSet managed disk." + }, + "VirtualMachineScaleSetOSDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "Specifies how the virtual machines in the scale set should be created.

    The only allowed value is: **FromImage** \\u2013 This value is used when you are using an image to create the virtual machine. If you are using a platform image, you also use the imageReference element described above. If you are using a marketplace image, you also use the plan element previously described." + }, + "diffDiskSettings": { + "$ref": "#/definitions/DiffDiskSettings", + "description": "Specifies the ephemeral disk Settings for the operating system disk used by the virtual machine scale set." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "osType": { + "type": "string", + "description": "This property allows you to specify the type of the OS that is included in the disk if creating a VM from user-image or a specialized VHD.

    Possible values are:

    **Windows**

    **Linux**", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "Specifies information about the unmanaged user image to base the scale set on." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Specifies the container urls that are used to store operating system disks for the scale set." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "required": [ + "createOption" + ], + "description": "Describes a virtual machine scale set operating system disk." + }, + "VirtualMachineScaleSetUpdateOSDisk": { + "properties": { + "caching": { + "$ref": "#/definitions/Caching", + "description": "The caching type." + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of the operating system disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "image": { + "$ref": "#/definitions/VirtualHardDisk", + "description": "The Source User Image VirtualHardDisk. This VirtualHardDisk will be copied before using it to attach to the Virtual Machine. If SourceImage is provided, the destination VirtualHardDisk should not exist." + }, + "vhdContainers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of virtual hard disk container uris." + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + } + }, + "description": "Describes virtual machine scale set operating system disk Update Object. This should be used for Updating VMSS OS Disk." + }, + "VirtualMachineScaleSetDataDisk": { + "properties": { + "name": { + "type": "string", + "description": "The disk name." + }, + "lun": { + "type": "integer", + "format": "int32", + "description": "Specifies the logical unit number of the data disk. This value is used to identify data disks within the VM and therefore must be unique for each data disk attached to a VM." + }, + "caching": { + "$ref": "#/definitions/Caching", + "description": "Specifies the caching requirements.

    Possible values are:

    **None**

    **ReadOnly**

    **ReadWrite**

    Default: **None for Standard storage. ReadOnly for Premium storage**" + }, + "writeAcceleratorEnabled": { + "type": "boolean", + "description": "Specifies whether writeAccelerator should be enabled or disabled on the disk." + }, + "createOption": { + "$ref": "#/definitions/CreateOption", + "description": "The create option." + }, + "diskSizeGB": { + "type": "integer", + "format": "int32", + "description": "Specifies the size of an empty data disk in gigabytes. This element can be used to overwrite the size of the disk in a virtual machine image.

    This value cannot be larger than 1023 GB" + }, + "managedDisk": { + "description": "The managed disk parameters.", + "$ref": "#/definitions/VirtualMachineScaleSetManagedDiskParameters" + }, + "diskIOPSReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the Read-Write IOPS for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + }, + "diskMBpsReadWrite": { + "type": "integer", + "format": "int64", + "description": "Specifies the bandwidth in MB per second for the managed disk. Should be used only when StorageAccountType is UltraSSD_LRS. If not specified, a default value would be assigned based on diskSizeGB." + } + }, + "required": [ + "lun", + "createOption" + ], + "description": "Describes a virtual machine scale set data disk." + }, + "VirtualMachineScaleSetStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "Specifies information about the image to use. You can specify information about platform images, marketplace images, or virtual machine images. This element is required when you want to use a platform image, marketplace image, or virtual machine image, but is not used in other creation operations." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetOSDisk", + "description": "Specifies information about the operating system disk used by the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "Specifies the parameters that are used to add data disks to the virtual machines in the scale set.

    For more information about disks, see [About disks and VHDs for Azure virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-about-disks-vhds?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "VirtualMachineScaleSetUpdateStorageProfile": { + "properties": { + "imageReference": { + "$ref": "#/definitions/ImageReference", + "description": "The image reference." + }, + "osDisk": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSDisk", + "description": "The OS disk." + }, + "dataDisks": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetDataDisk" + }, + "description": "The data disks." + } + }, + "description": "Describes a virtual machine scale set storage profile." + }, + "ApiEntityReference": { + "properties": { + "id": { + "type": "string", + "description": "The ARM resource id in the form of /subscriptions/{SubscriptionId}/resourceGroups/{ResourceGroupName}/..." + } + }, + "description": "The API entity reference." + }, + "VirtualMachineScaleSetIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "Specifies the identifier of the subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of application gateways. A scale set can reference backend address pools of multiple application gateways. Multiple scale sets cannot use the same application gateway." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to backend address pools of load balancers. A scale set can reference backend address pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to inbound Nat pools of the load balancers. A scale set can reference inbound nat pools of one public and one internal load balancer. Multiple scale sets cannot use the same basic sku load balancer." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetUpdateIPConfigurationProperties": { + "properties": { + "subnet": { + "$ref": "#/definitions/ApiEntityReference", + "description": "The subnet." + }, + "primary": { + "type": "boolean", + "description": "Specifies the primary IP Configuration in case the network interface has more than one IP Configuration." + }, + "publicIPAddressConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfiguration", + "description": "The publicIPAddressConfiguration." + }, + "privateIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2017-03-30 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + }, + "applicationGatewayBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The application gateway backend address pools." + }, + "applicationSecurityGroups": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "Specifies an array of references to application security group." + }, + "loadBalancerBackendAddressPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer backend address pools." + }, + "loadBalancerInboundNatPools": { + "type": "array", + "items": { + "$ref": "#/definitions/SubResource" + }, + "description": "The load balancer inbound nat pools." + } + }, + "description": "Describes a virtual machine scale set network profile's IP configuration properties." + }, + "VirtualMachineScaleSetIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetIPConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateIPConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The IP configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's IP configuration. NOTE: The subnet of a scale set may be modified as long as the original subnet and the new subnet are in the same virtual network" + }, + "VirtualMachineScaleSetNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Specifies the primary network interface in case the virtual machine has more than 1 network interface." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIPConfiguration" + }, + "description": "Specifies the IP configurations of the network interface." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + } + }, + "required": [ + "ipConfigurations" + ], + "description": "Describes a virtual machine scale set network profile's IP configuration." + }, + "VirtualMachineScaleSetUpdateNetworkConfigurationProperties": { + "properties": { + "primary": { + "type": "boolean", + "description": "Whether this is a primary NIC on a virtual machine." + }, + "enableAcceleratedNetworking": { + "type": "boolean", + "description": "Specifies whether the network interface is accelerated networking-enabled." + }, + "networkSecurityGroup": { + "$ref": "#/definitions/SubResource", + "description": "The network security group." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationDnsSettings", + "description": "The dns settings to be applied on the network interfaces." + }, + "ipConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateIPConfiguration" + }, + "description": "The virtual machine scale set IP Configuration." + }, + "enableIPForwarding": { + "type": "boolean", + "description": "Whether IP forwarding enabled on this NIC." + } + }, + "description": "Describes a virtual machine scale set updatable network profile's IP configuration.Use this object for updating network profile's IP Configuration." + }, + "VirtualMachineScaleSetNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfigurationProperties" + } + }, + "required": [ + "name" + ], + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetUpdateNetworkConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The network configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResource" + } + ], + "description": "Describes a virtual machine scale set network profile's network configurations." + }, + "VirtualMachineScaleSetNetworkConfigurationDnsSettings": { + "properties": { + "dnsServers": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of DNS servers IP addresses" + } + }, + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings": { + "properties": { + "domainNameLabel": { + "type": "string", + "description": "The Domain name label.The concatenation of the domain name label and vm index will be the domain name labels of the PublicIPAddress resources that will be created" + } + }, + "required": [ + "domainNameLabel" + ], + "description": "Describes a virtual machines scale sets network configuration's DNS settings." + }, + "VirtualMachineScaleSetIpTag": { + "properties": { + "ipTagType": { + "type": "string", + "description": "IP tag type. Example: FirstPartyUsage." + }, + "tag": { + "type": "string", + "description": "IP tag associated with the public IP. Example: SQL, Storage etc." + } + }, + "description": "Contains the IP tag associated with the public IP address." + }, + "VirtualMachineScaleSetPublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationProperties" + } + }, + "required": [ + "name" + ], + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfiguration": { + "properties": { + "name": { + "type": "string", + "description": "The publicIP address configuration name." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties" + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetPublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + }, + "ipTags": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetIpTag" + }, + "description": "The list of IP tags associated with the public IP address." + }, + "publicIPPrefix": { + "$ref": "#/definitions/SubResource", + "description": "The PublicIPPrefix from which to allocate publicIP addresses." + }, + "publicIPAddressVersion": { + "type": "string", + "description": "Available from Api-Version 2019-07-01 onwards, it represents whether the specific ipconfiguration is IPv4 or IPv6. Default is taken as IPv4. Possible values are: 'IPv4' and 'IPv6'.", + "enum": [ + "IPv4", + "IPv6" + ], + "x-ms-enum": { + "name": "IPVersion", + "modelAsString": true + } + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetUpdatePublicIPAddressConfigurationProperties": { + "properties": { + "idleTimeoutInMinutes": { + "type": "integer", + "format": "int32", + "description": "The idle timeout of the public IP address." + }, + "dnsSettings": { + "$ref": "#/definitions/VirtualMachineScaleSetPublicIPAddressConfigurationDnsSettings", + "description": "The dns settings to be applied on the publicIP addresses ." + } + }, + "description": "Describes a virtual machines scale set IP Configuration's PublicIPAddress configuration" + }, + "VirtualMachineScaleSetNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetUpdateNetworkProfile": { + "properties": { + "healthProbe": { + "$ref": "#/definitions/ApiEntityReference", + "description": "A reference to a load balancer probe used to determine the health of an instance in the virtual machine scale set. The reference will be in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/loadBalancers/{loadBalancerName}/probes/{probeName}'." + }, + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set network profile." + }, + "VirtualMachineScaleSetExtensionProperties": { + "properties": { + "forceUpdateTag": { + "type": "string", + "description": "If a value is provided and is different from the previous value, the extension handler will be forced to update even if the extension configuration has not changed." + }, + "publisher": { + "type": "string", + "description": "The name of the extension handler publisher." + }, + "type": { + "type": "string", + "description": "Specifies the type of the extension; an example is \"CustomScriptExtension\"." + }, + "typeHandlerVersion": { + "type": "string", + "description": "Specifies the version of the script handler." + }, + "autoUpgradeMinorVersion": { + "type": "boolean", + "description": "Indicates whether the extension should use a newer minor version if one is available at deployment time. Once deployed, however, the extension will not upgrade minor versions unless redeployed, even with this property set to true." + }, + "settings": { + "type": "object", + "description": "Json formatted public settings for the extension." + }, + "protectedSettings": { + "type": "object", + "description": "The extension can contain either protectedSettings or protectedSettingsFromKeyVault or no protected settings at all." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "provisionAfterExtensions": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Collection of extension names after which this extension needs to be provisioned." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtension": { + "properties": { + "name": { + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionUpdate": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the extension." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/SubResourceReadOnly" + } + ], + "description": "Describes a Virtual Machine Scale Set Extension." + }, + "VirtualMachineScaleSetExtensionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The list of VM scale set extensions." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of VM scale set extensions. Call ListNext() with this to fetch the next page of VM scale set extensions." + } + }, + "required": [ + "value" + ], + "description": "The List VM scale set extension operation response." + }, + "VirtualMachineScaleSetExtensionProfile": { + "properties": { + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetExtension" + }, + "description": "The virtual machine scale set child extension resources." + }, + "extensionsTimeBudget": { + "type": "string", + "description": "Specifies the time alloted for all extensions to start. The time duration should be between 15 minutes and 120 minutes (inclusive) and should be specified in ISO 8601 format. The default value is 90 minutes (PT1H30M).

    Minimum api-version: 2020-06-01" + } + }, + "description": "Describes a virtual machine scale set extension profile." + }, + "VirtualMachineScaleSetVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetOSProfile", + "description": "Specifies the operating system settings for the virtual machines in the scale set." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetStorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkProfile", + "description": "Specifies properties of the network interfaces of the virtual machines in the scale set." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machines in the scale set." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "Specifies a collection of settings for extensions installed on virtual machines in the scale set." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "priority": { + "$ref": "#/definitions/priority", + "description": "Specifies the priority for the virtual machines in the scale set.

    Minimum api-version: 2017-10-30-preview" + }, + "evictionPolicy": { + "$ref": "#/definitions/evictionPolicy", + "description": "Specifies the eviction policy for the Azure Spot virtual machine and Azure Spot scale set.

    For Azure Spot virtual machines, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2019-03-01.

    For Azure Spot scale sets, both 'Deallocate' and 'Delete' are supported and the minimum api-version is 2017-10-30-preview." + }, + "billingProfile": { + "$ref": "#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot VMSS.

    Minimum api-version: 2019-03-01." + }, + "scheduledEventsProfile": { + "$ref": "#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetUpdateVMProfile": { + "properties": { + "osProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateOSProfile", + "description": "The virtual machine scale set OS profile." + }, + "storageProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateStorageProfile", + "description": "The virtual machine scale set storage profile." + }, + "networkProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateNetworkProfile", + "description": "The virtual machine scale set network profile." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "The virtual machine scale set Security profile" + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "The virtual machine scale set diagnostics profile." + }, + "extensionProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetExtensionProfile", + "description": "The virtual machine scale set extension profile." + }, + "licenseType": { + "type": "string", + "description": "The license type, which is for bring your own license scenario." + }, + "billingProfile": { + "$ref": "#/definitions/BillingProfile", + "description": "Specifies the billing related details of a Azure Spot VMSS.

    Minimum api-version: 2019-03-01." + }, + "scheduledEventsProfile": { + "$ref": "#/definitions/ScheduledEventsProfile", + "description": "Specifies Scheduled Event related configurations." + } + }, + "description": "Describes a virtual machine scale set virtual machine profile." + }, + "VirtualMachineScaleSetProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProfile", + "description": "The virtual machine profile." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "uniqueId": { + "readOnly": true, + "type": "string", + "description": "Specifies the ID which uniquely identifies a Virtual Machine Scale Set." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true." + }, + "zoneBalance": { + "type": "boolean", + "description": "Whether to force strictly even Virtual Machine distribution cross x-zones in case there is zone outage." + }, + "platformFaultDomainCount": { + "type": "integer", + "format": "int32", + "description": "Fault Domain count for each placement group." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

    Minimum api-version: 2018-04-01." + }, + "hostGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the dedicated host group that the virtual machine scale set resides in.

    Minimum api-version: 2020-06-01." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "scaleInPolicy": { + "$ref": "#/definitions/ScaleInPolicy", + "description": "Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetUpdateProperties": { + "properties": { + "upgradePolicy": { + "$ref": "#/definitions/UpgradePolicy", + "description": "The upgrade policy." + }, + "automaticRepairsPolicy": { + "$ref": "#/definitions/AutomaticRepairsPolicy", + "description": "Policy for automatic repairs." + }, + "virtualMachineProfile": { + "$ref": "#/definitions/VirtualMachineScaleSetUpdateVMProfile", + "description": "The virtual machine profile." + }, + "overprovision": { + "type": "boolean", + "description": "Specifies whether the Virtual Machine Scale Set should be overprovisioned." + }, + "doNotRunExtensionsOnOverprovisionedVMs": { + "type": "boolean", + "description": "When Overprovision is enabled, extensions are launched only on the requested number of VMs which are finally kept. This property will hence ensure that the extensions do not run on the extra overprovisioned VMs." + }, + "singlePlacementGroup": { + "type": "boolean", + "description": "When true this limits the scale set to a single placement group, of max size 100 virtual machines. NOTE: If singlePlacementGroup is true, it may be modified to false. However, if singlePlacementGroup is false, it may not be modified to true." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the Virtual Machines in the Virtual Machine Scale Set. For instance: whether the Virtual Machines have the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "scaleInPolicy": { + "$ref": "#/definitions/ScaleInPolicy", + "description": "Specifies the scale-in policy that decides which virtual machines are chosen for removal when a Virtual Machine Scale Set is scaled-in." + }, + "proximityPlacementGroup": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the proximity placement group that the virtual machine scale set should be assigned to.

    Minimum api-version: 2018-04-01." + } + }, + "description": "Describes the properties of a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSet": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + }, + "zones": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set zones. NOTE: Availability zones can only be set when you create the scale set" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMReimageParameters": { + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetReimageParameters": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "allOf": [ + { + "$ref": "#/definitions/VirtualMachineScaleSetVMReimageParameters" + } + ], + "description": "Describes a Virtual Machine Scale Set VM Reimage Parameters." + }, + "VirtualMachineScaleSetUpdate": { + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The virtual machine scale set sku." + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "The purchase plan when deploying a virtual machine scale set from VM Marketplace images." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetUpdateProperties" + }, + "identity": { + "$ref": "#/definitions/VirtualMachineScaleSetIdentity", + "description": "The identity of the virtual machine scale set, if configured." + } + }, + "allOf": [ + { + "$ref": "#/definitions/UpdateResource" + } + ], + "description": "Describes a Virtual Machine Scale Set." + }, + "VirtualMachineScaleSetVMInstanceIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids. Omitting the virtual machine scale set instance ids will result in the operation being performed on all virtual machines in the virtual machine scale set." + } + }, + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineScaleSetVMInstanceRequiredIDs": { + "properties": { + "instanceIds": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine scale set instance ids." + } + }, + "required": [ + "instanceIds" + ], + "description": "Specifies a list of virtual machine instance IDs from the VM scale set." + }, + "VirtualMachineStatusCodeCount": { + "properties": { + "code": { + "readOnly": true, + "type": "string", + "description": "The instance view status code." + }, + "count": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances having a particular status code." + } + }, + "description": "The status code and count of the virtual machine scale set instance view status summary." + }, + "VirtualMachineScaleSetInstanceViewStatusesSummary": { + "properties": { + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Instance view statuses summary for virtual machines of a virtual machine scale set." + }, + "VirtualMachineScaleSetVMExtensionsSummary": { + "properties": { + "name": { + "readOnly": true, + "type": "string", + "description": "The extension name." + }, + "statusesSummary": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineStatusCodeCount" + }, + "description": "The extensions information." + } + }, + "description": "Extensions summary for virtual machines of a virtual machine scale set." + }, + "OrchestrationServiceSummary": { + "properties": { + "serviceName": { + "type": "string", + "readOnly": true, + "description": "The name of the service.", + "enum": [ + "AutomaticRepairs" + ], + "x-ms-enum": { + "name": "OrchestrationServiceNames", + "modelAsString": true + } + }, + "serviceState": { + "type": "string", + "readOnly": true, + "description": "The current state of the service.", + "enum": [ + "NotRunning", + "Running", + "Suspended" + ], + "x-ms-enum": { + "name": "OrchestrationServiceState", + "modelAsString": true + } + } + }, + "description": "Summary for an orchestration service of a virtual machine scale set." + }, + "VirtualMachineScaleSetInstanceView": { + "properties": { + "virtualMachine": { + "$ref": "#/definitions/VirtualMachineScaleSetInstanceViewStatusesSummary", + "readOnly": true, + "description": "The instance view status summary for the virtual machine scale set." + }, + "extensions": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVMExtensionsSummary" + }, + "description": "The extensions information." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "orchestrationServices": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/OrchestrationServiceSummary" + }, + "description": "The orchestration services information." + } + }, + "description": "The instance view of a virtual machine scale set." + }, + "VirtualMachineScaleSetListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of VMSS." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetListWithLinkResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSet" + }, + "description": "The list of virtual machine scale sets." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Sets. Call ListNext() with this to fetch the next page of Virtual Machine Scale Sets." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "VirtualMachineScaleSetSkuCapacity": { + "properties": { + "minimum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The minimum capacity." + }, + "maximum": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum capacity that can be set." + }, + "defaultCapacity": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The default capacity." + }, + "scaleType": { + "readOnly": true, + "type": "string", + "description": "The scale type applicable to the sku.", + "enum": [ + "Automatic", + "None" + ], + "x-ms-enum": { + "name": "VirtualMachineScaleSetSkuScaleType", + "modelAsString": false + } + } + }, + "description": "Describes scaling information of a sku." + }, + "VirtualMachineScaleSetSku": { + "properties": { + "resourceType": { + "readOnly": true, + "type": "string", + "description": "The type of resource the sku applies to." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The Sku." + }, + "capacity": { + "$ref": "#/definitions/VirtualMachineScaleSetSkuCapacity", + "readOnly": true, + "description": "Specifies the number of virtual machines in the scale set." + } + }, + "description": "Describes an available virtual machine scale set sku." + }, + "VirtualMachineScaleSetListSkusResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetSku" + }, + "description": "The list of skus available for the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set Skus. Call ListNext() with this to fetch the next page of VMSS Skus." + } + }, + "required": [ + "value" + ], + "description": "The Virtual Machine Scale Set List Skus operation response." + }, + "RollbackStatusInfo": { + "properties": { + "successfullyRolledbackInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which have been successfully rolled back." + }, + "failedRolledbackInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances which failed to rollback." + }, + "rollbackError": { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error details if OS rollback failed." + } + }, + "description": "Information about rollback on failed VM instances after a OS Upgrade operation." + }, + "UpgradeOperationHistoryStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "UpgradeState", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "End time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "UpgradeOperationHistoricalStatusInfoProperties": { + "properties": { + "runningStatus": { + "$ref": "#/definitions/UpgradeOperationHistoryStatus", + "readOnly": true, + "description": "Information about the overall status of the upgrade operation." + }, + "progress": { + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "readOnly": true, + "description": "Counts of the VMs in each state." + }, + "error": { + "$ref": "#/definitions/ApiError", + "readOnly": true, + "description": "Error Details for this upgrade if there are any." + }, + "startedBy": { + "readOnly": true, + "type": "string", + "description": "Invoker of the Upgrade Operation", + "enum": [ + "Unknown", + "User", + "Platform" + ], + "x-ms-enum": { + "name": "UpgradeOperationInvoker", + "modelAsString": false + } + }, + "targetImageReference": { + "$ref": "#/definitions/ImageReference", + "readOnly": true, + "description": "Image Reference details" + }, + "rollbackInfo": { + "$ref": "#/definitions/RollbackStatusInfo", + "readOnly": true, + "description": "Information about OS rollback if performed" + } + }, + "description": "Describes each OS upgrade on the Virtual Machine Scale Set." + }, + "UpgradeOperationHistoricalStatusInfo": { + "properties": { + "properties": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfoProperties", + "readOnly": true, + "description": "Information about the properties of the upgrade operation." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "readOnly": true, + "type": "string", + "description": "Resource location" + } + }, + "description": "Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetListOSUpgradeHistory": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/UpgradeOperationHistoricalStatusInfo" + }, + "description": "The list of OS upgrades performed on the virtual machine scale set." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of OS Upgrade History. Call ListNext() with this to fetch the next page of history of upgrades." + } + }, + "required": [ + "value" + ], + "description": "List of Virtual Machine Scale Set OS Upgrade History operation response." + }, + "VirtualMachineScaleSetVMProperties": { + "properties": { + "latestModelApplied": { + "readOnly": true, + "type": "boolean", + "description": "Specifies whether the latest model has been applied to the virtual machine." + }, + "vmId": { + "readOnly": true, + "type": "string", + "description": "Azure VM unique ID." + }, + "instanceView": { + "$ref": "#/definitions/VirtualMachineScaleSetVMInstanceView", + "readOnly": true, + "description": "The virtual machine instance view." + }, + "hardwareProfile": { + "$ref": "#/definitions/HardwareProfile", + "description": "Specifies the hardware settings for the virtual machine." + }, + "storageProfile": { + "$ref": "#/definitions/StorageProfile", + "description": "Specifies the storage settings for the virtual machine disks." + }, + "additionalCapabilities": { + "$ref": "#/definitions/AdditionalCapabilities", + "description": "Specifies additional capabilities enabled or disabled on the virtual machine in the scale set. For instance: whether the virtual machine has the capability to support attaching managed data disks with UltraSSD_LRS storage account type." + }, + "osProfile": { + "$ref": "#/definitions/OSProfile", + "description": "Specifies the operating system settings for the virtual machine." + }, + "securityProfile": { + "$ref": "#/definitions/SecurityProfile", + "description": "Specifies the Security related profile settings for the virtual machine." + }, + "networkProfile": { + "$ref": "#/definitions/NetworkProfile", + "description": "Specifies the network interfaces of the virtual machine." + }, + "networkProfileConfiguration": { + "$ref": "#/definitions/VirtualMachineScaleSetVMNetworkProfileConfiguration", + "description": "Specifies the network profile configuration of the virtual machine." + }, + "diagnosticsProfile": { + "$ref": "#/definitions/DiagnosticsProfile", + "description": "Specifies the boot diagnostic settings state.

    Minimum api-version: 2015-06-15." + }, + "availabilitySet": { + "$ref": "#/definitions/SubResource", + "description": "Specifies information about the availability set that the virtual machine should be assigned to. Virtual machines specified in the same availability set are allocated to different nodes to maximize availability. For more information about availability sets, see [Manage the availability of virtual machines](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-manage-availability?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json).

    For more information on Azure planned maintenance, see [Planned maintenance for virtual machines in Azure](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-planned-maintenance?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Currently, a VM can only be added to availability set at creation time. An existing VM cannot be added to an availability set." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response." + }, + "licenseType": { + "type": "string", + "description": "Specifies that the image or disk that is being used was licensed on-premises. This element is only used for images that contain the Windows Server operating system.

    Possible values are:

    Windows_Client

    Windows_Server

    If this element is included in a request for an update, the value must match the initial value. This value cannot be updated.

    For more information, see [Azure Hybrid Use Benefit for Windows Server](https://docs.microsoft.com/azure/virtual-machines/virtual-machines-windows-hybrid-use-benefit-licensing?toc=%2fazure%2fvirtual-machines%2fwindows%2ftoc.json)

    Minimum api-version: 2015-06-15" + }, + "modelDefinitionApplied": { + "readOnly": true, + "type": "string", + "description": "Specifies whether the model applied to the virtual machine is the model of the virtual machine scale set or the customized model for the virtual machine." + }, + "protectionPolicy": { + "$ref": "#/definitions/VirtualMachineScaleSetVMProtectionPolicy", + "description": "Specifies the protection policy of the virtual machine." + } + }, + "description": "Describes the properties of a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVM": { + "properties": { + "instanceId": { + "readOnly": true, + "type": "string", + "description": "The virtual machine instance ID." + }, + "sku": { + "$ref": "#/definitions/Sku", + "readOnly": true, + "description": "The virtual machine SKU." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/VirtualMachineScaleSetVMProperties" + }, + "plan": { + "$ref": "#/definitions/Plan", + "description": "Specifies information about the marketplace image used to create the virtual machine. This element is only used for marketplace images. Before you can use a marketplace image from an API, you must enable the image for programmatic use. In the Azure portal, find the marketplace image that you want to use and then click **Want to deploy programmatically, Get Started ->**. Enter any required information and then click **Save**." + }, + "resources": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtension" + }, + "description": "The virtual machine child extension resources." + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The virtual machine zones." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Describes a virtual machine scale set virtual machine." + }, + "VirtualMachineScaleSetVMInstanceView": { + "properties": { + "platformUpdateDomain": { + "type": "integer", + "format": "int32", + "description": "The Update Domain count." + }, + "platformFaultDomain": { + "type": "integer", + "format": "int32", + "description": "The Fault Domain count." + }, + "rdpThumbPrint": { + "type": "string", + "description": "The Remote desktop certificate thumbprint." + }, + "vmAgent": { + "$ref": "#/definitions/VirtualMachineAgentInstanceView", + "description": "The VM Agent running on the virtual machine." + }, + "maintenanceRedeployStatus": { + "$ref": "#/definitions/MaintenanceRedeployStatus", + "description": "The Maintenance Operation status on the virtual machine." + }, + "disks": { + "type": "array", + "items": { + "$ref": "#/definitions/DiskInstanceView" + }, + "description": "The disks information." + }, + "extensions": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineExtensionInstanceView" + }, + "description": "The extensions information." + }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, + "bootDiagnostics": { + "$ref": "#/definitions/BootDiagnosticsInstanceView", + "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." + }, + "statuses": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "The resource status information." + }, + "assignedHost": { + "type": "string", + "readOnly": true, + "description": "Resource id of the dedicated host, on which the virtual machine is allocated through automatic placement, when the virtual machine is associated with a dedicated host group that has automatic placement enabled.

    Minimum api-version: 2020-06-01." + }, + "placementGroupId": { + "type": "string", + "description": "The placement group in which the VM is running. If the VM is deallocated it will not have a placementGroupId." + } + }, + "description": "The instance view of a virtual machine scale set VM." + }, + "VirtualMachineScaleSetVMNetworkProfileConfiguration": { + "properties": { + "networkInterfaceConfigurations": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetNetworkConfiguration" + }, + "description": "The list of network configurations." + } + }, + "description": "Describes a virtual machine scale set VM network profile." + }, + "VirtualMachineScaleSetVMProtectionPolicy": { + "properties": { + "protectFromScaleIn": { + "type": "boolean", + "description": "Indicates that the virtual machine scale set VM shouldn't be considered for deletion during a scale-in operation." + }, + "protectFromScaleSetActions": { + "type": "boolean", + "description": "Indicates that model updates or actions (including scale-in) initiated on the virtual machine scale set should not be applied to the virtual machine scale set VM." + } + }, + "description": "The protection policy of a virtual machine scale set VM." + }, + "ScheduledEventsProfile": { + "type": "object", + "properties": { + "terminateNotificationProfile": { + "$ref": "#/definitions/TerminateNotificationProfile", + "description": "Specifies Terminate Scheduled Event related configurations." + } + } + }, + "TerminateNotificationProfile": { + "type": "object", + "properties": { + "notBeforeTimeout": { + "type": "string", + "description": "Configurable length of time a Virtual Machine being deleted will have to potentially approve the Terminate Scheduled Event before the event is auto approved (timed out). The configuration must be specified in ISO 8601 format, the default value is 5 minutes (PT5M)" + }, + "enable": { + "type": "boolean", + "description": "Specifies whether the Terminate Scheduled event is enabled or disabled." + } + } + }, + "VirtualMachineHealthStatus": { + "properties": { + "status": { + "readOnly": true, + "$ref": "#/definitions/InstanceViewStatus", + "description": "The health status information for the VM." + } + }, + "description": "The health status of the VM." + }, + "VirtualMachineScaleSetVMListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineScaleSetVM" + }, + "description": "The list of virtual machine scale sets VMs." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of Virtual Machine Scale Set VMs. Call ListNext() with this to fetch the next page of VMSS VMs" + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine Scale Set VMs operation response." + }, + "RollingUpgradeStatusInfo": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RollingUpgradeStatusInfoProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeStatusInfoProperties": { + "properties": { + "policy": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradePolicy", + "description": "The rolling upgrade policies applied for this upgrade." + }, + "runningStatus": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeRunningStatus", + "description": "Information about the current running state of the overall upgrade." + }, + "progress": { + "readOnly": true, + "$ref": "#/definitions/RollingUpgradeProgressInfo", + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "error": { + "readOnly": true, + "$ref": "#/definitions/ApiError", + "description": "Error details for this upgrade, if there are any." + } + }, + "description": "The status of the latest virtual machine scale set rolling upgrade." + }, + "RollingUpgradeRunningStatus": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "Code indicating the current status of the upgrade.", + "enum": [ + "RollingForward", + "Cancelled", + "Completed", + "Faulted" + ], + "x-ms-enum": { + "name": "RollingUpgradeStatusCode", + "modelAsString": false + } + }, + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Start time of the upgrade." + }, + "lastAction": { + "type": "string", + "readOnly": true, + "description": "The last action performed on the rolling upgrade.", + "enum": [ + "Start", + "Cancel" + ], + "x-ms-enum": { + "name": "RollingUpgradeActionType", + "modelAsString": false + } + }, + "lastActionTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "Last action time of the upgrade." + } + }, + "description": "Information about the current running state of the overall upgrade." + }, + "RollingUpgradeProgressInfo": { + "properties": { + "successfulInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have been successfully upgraded." + }, + "failedInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have failed to be upgraded successfully." + }, + "inProgressInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that are currently being upgraded." + }, + "pendingInstanceCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "description": "The number of instances that have not yet begun to be upgraded." + } + }, + "description": "Information about the number of virtual machine instances in each upgrade state." + }, + "ApiErrorBase": { + "properties": { + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error base." + }, + "InnerError": { + "properties": { + "exceptiontype": { + "type": "string", + "description": "The exception type." + }, + "errordetail": { + "type": "string", + "description": "The internal error message or exception dump." + } + }, + "description": "Inner error details." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/ApiError" + } + }, + "description": "An error response from the Compute service." + }, + "ApiError": { + "properties": { + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ApiErrorBase" + }, + "description": "The Api error details" + }, + "innererror": { + "$ref": "#/definitions/InnerError", + "description": "The Api inner error" + }, + "code": { + "type": "string", + "description": "The error code." + }, + "target": { + "type": "string", + "description": "The target of the particular error." + }, + "message": { + "type": "string", + "description": "The error message." + } + }, + "description": "Api error." + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + }, + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "required": [ + "location" + ], + "x-ms-azure-resource": true + }, + "UpdateResource": { + "description": "The Update Resource model definition.", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + } + }, + "SubResource": { + "properties": { + "id": { + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "SubResourceReadOnly": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + } + }, + "x-ms-azure-resource": true + }, + "RecoveryWalkResponse": { + "properties": { + "walkPerformed": { + "type": "boolean", + "readOnly": true, + "description": "Whether the recovery walk was performed" + }, + "nextPlatformUpdateDomain": { + "type": "integer", + "readOnly": true, + "description": "The next update domain that needs to be walked. Null means walk spanning all update domains has been completed" + } + }, + "description": "Response after calling a manual recovery walk" + }, + "RequestRateByIntervalInput": { + "properties": { + "intervalLength": { + "type": "string", + "description": "Interval value in minutes used to create LogAnalytics call rate logs.", + "enum": [ + "ThreeMins", + "FiveMins", + "ThirtyMins", + "SixtyMins" + ], + "x-ms-enum": { + "name": "IntervalInMins", + "modelAsString": false + } + } + }, + "required": [ + "intervalLength" + ], + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getRequestRateByInterval Api." + }, + "ThrottledRequestsInput": { + "allOf": [ + { + "$ref": "#/definitions/LogAnalyticsInputBase" + } + ], + "description": "Api request input for LogAnalytics getThrottledRequests Api." + }, + "LogAnalyticsInputBase": { + "properties": { + "blobContainerSasUri": { + "type": "string", + "description": "SAS Uri of the logging blob container to which LogAnalytics Api writes output logs to." + }, + "fromTime": { + "type": "string", + "format": "date-time", + "description": "From time of the query" + }, + "toTime": { + "type": "string", + "format": "date-time", + "description": "To time of the query" + }, + "groupByThrottlePolicy": { + "type": "boolean", + "description": "Group query result by Throttle Policy applied." + }, + "groupByOperationName": { + "type": "boolean", + "description": "Group query result by Operation Name." + }, + "groupByResourceName": { + "type": "boolean", + "description": "Group query result by Resource Name." + } + }, + "required": [ + "blobContainerSasUri", + "fromTime", + "toTime" + ], + "description": "Api input base class for LogAnalytics Api." + }, + "LogAnalyticsOperationResult": { + "properties": { + "properties": { + "readOnly": true, + "$ref": "#/definitions/LogAnalyticsOutput", + "description": "LogAnalyticsOutput" + } + }, + "description": "LogAnalytics operation status response" + }, + "LogAnalyticsOutput": { + "properties": { + "output": { + "readOnly": true, + "type": "string", + "description": "Output file Uri path to blob container." + } + }, + "description": "LogAnalytics output properties" + }, + "VMScaleSetConvertToSinglePlacementGroupInput": { + "properties": { + "activePlacementGroupId": { + "type": "string", + "description": "Id of the placement group in which you want future virtual machine instances to be placed. To query placement group Id, please use Virtual Machine Scale Set VMs - Get API. If not provided, the platform will choose one with maximum number of virtual machine instances." + } + } + }, + "OrchestrationServiceStateInput": { + "properties": { + "serviceName": { + "type": "string", + "description": "The name of the service.", + "enum": [ + "AutomaticRepairs" + ], + "x-ms-enum": { + "name": "OrchestrationServiceNames", + "modelAsString": true + } + }, + "action": { + "type": "string", + "description": "The action to be performed.", + "enum": [ + "Resume", + "Suspend" + ], + "x-ms-enum": { + "name": "OrchestrationServiceStateAction", + "modelAsString": true + } + } + }, + "description": "The input for OrchestrationServiceState", + "required": [ + "serviceName", + "action" + ] + }, + "PatchSettings": { + "properties": { + "patchMode": { + "type": "string", + "description": "Specifies the mode of in-guest patching to IaaS virtual machine.

    Possible values are:

    **Manual** - You control the application of patches to a virtual machine. You do this by applying patches manually inside the VM. In this mode, automatic updates are disabled; the property WindowsConfiguration.enableAutomaticUpdates must be false

    **AutomaticByOS** - The virtual machine will automatically be updated by the OS. The property WindowsConfiguration.enableAutomaticUpdates must be true.

    ** AutomaticByPlatform** - the virtual machine will automatically updated by the OS. The properties provisionVMAgent and WindowsConfiguration.enableAutomaticUpdates must be true ", + "enum": [ + "Manual", + "AutomaticByOS", + "AutomaticByPlatform" + ], + "x-ms-enum": { + "name": "InGuestPatchMode", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..a7f0a758cb5c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateACustomImageScaleSetFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,202 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "caching": "ReadWrite", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17", + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d6e9ab29-f8c9-4792-978c-ae2c07b98f17", + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "createOption": "FromImage", + "name": "osDisk" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json new file mode 100644 index 000000000000..fcd7e33b0c0e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateACustomImageVmFromAnUnmanagedGeneralizedOsImage.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/{existing-generalized-os-image-blob-name}.vhd" + }, + "osType": "Windows", + "createOption": "FromImage", + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + } + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "osDisk": { + "name": "myVMosdisk", + "image": { + "uri": "https://{existing-storage-account-name}.blob.core.windows.net/system/Microsoft.Compute/Images/vhds/{existing-generalized-os-image-blob-name}.vhd" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + } + }, + "dataDisks": [] + }, + "vmId": "926cd555-a07c-4ff5-b214-4aa4dd09d79b", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json new file mode 100644 index 000000000000..8063a2fbb9d3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAPlatformImageScaleSetWithUnmanagedOsDisks.json @@ -0,0 +1,222 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "osDisk", + "vhdContainers": [ + "http://{existing-storage-account-name-0}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-1}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-2}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-3}.blob.core.windows.net/vhdContainer", + "http://{existing-storage-account-name-4}.blob.core.windows.net/vhdContainer" + ] + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "77b7df9a-32fe-45e3-8911-60ac9c9b9c64", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhdContainers": [ + "http://{existing-storage-account-name}.blob.core.windows.net/vhds" + ], + "name": "osDisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json new file mode 100644 index 000000000000..9f18e0b3ee35 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAPlatformImageVmWithUnmanagedOsAndDataDisks.json @@ -0,0 +1,213 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "{vm-name}", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk0.vhd" + } + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/{existing-container-name}/myDisk1.vhd" + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk.vhd" + }, + "createOption": "FromImage", + "name": "myVMosdisk", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "name": "dataDisk0", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk0.vhd" + }, + "lun": 0 + }, + { + "name": "dataDisk1", + "diskSizeGB": 1023, + "createOption": "Empty", + "caching": "None", + "vhd": { + "uri": "http://{existing-storage-account-name}.blob.core.windows.net/vhds/myDisk1.vhd" + }, + "lun": 1 + } + ] + }, + "vmId": "5230a749-2f68-4830-900b-702182d32e63", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetFromACustomImage.json new file mode 100644 index 000000000000..8e87f76af138 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetFromACustomImage.json @@ -0,0 +1,204 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..247e9b7b4616 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAMarketplaceImagePlan.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json new file mode 100644 index 000000000000..44f20bbb8f62 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAnAzureApplicationGateway.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/{existing-application-gateway-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "a0134477-b9d9-484b-b0e3-205c1c089ffa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "applicationGatewayBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/applicationGateways/nsgExistingAppGw/backendAddressPools/appGatewayBackendPool" + } + ], + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json new file mode 100644 index 000000000000..85e729cbe5be --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAnAzureLoadBalancer.json @@ -0,0 +1,251 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + }, + "publicIPAddressConfiguration": { + "name": "{vmss-name}", + "properties": { + "publicIPAddressVersion": "IPv4" + } + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/inboundNatPools/{existing-nat-pool-name}" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/{existing-load-balancer-name}/backendAddressPools/{existing-backend-address-pool-name}" + } + ] + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ec0b21ca-51ec-414b-9323-f236ffc21479", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "loadBalancerInboundNatPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/inboundNatPools/lbNatPool" + } + ], + "loadBalancerBackendAddressPools": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/loadBalancers/myLb/backendAddressPools/lbBackendPool" + } + ], + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAutomaticRepairs.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAutomaticRepairs.json new file mode 100644 index 000000000000..a507143e62ac --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithAutomaticRepairs.json @@ -0,0 +1,227 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "automaticRepairsPolicy": { + "enabled": true, + "gracePeriod": "PT30M" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithBootDiagnostics.json new file mode 100644 index 000000000000..67cba225a1b8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithBootDiagnostics.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithDiffOsDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithDiffOsDisk.json new file mode 100644 index 000000000000..b9b88a727dbf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithDiffOsDisk.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithDiffOsDiskUsingDiffDiskPlacement.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithDiffOsDiskUsingDiffDiskPlacement.json new file mode 100644 index 000000000000..43853d85665a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithDiffOsDiskUsingDiffDiskPlacement.json @@ -0,0 +1,242 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json new file mode 100644 index 000000000000..875ba16636a6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithEmptyDataDisksOnEachVm.json @@ -0,0 +1,270 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Succeeded" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D2_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithEncryptionAtHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithEncryptionAtHost.json new file mode 100644 index 000000000000..3b7b6beba957 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithEncryptionAtHost.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "encryptionAtHost": true + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "encryptionAtHost": true + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}", + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachineScaleSets", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "b9e23088-6ffc-46e0-9e02-b0a6eeef47db", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "securityProfile": { + "encryptionAtHost": true + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithExtensionsTimeBudget.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithExtensionsTimeBudget.json new file mode 100644 index 000000000000..42d3c4a6bb25 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithExtensionsTimeBudget.json @@ -0,0 +1,278 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {} + } + } + ], + "extensionsTimeBudget": "PT1H20M" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {} + } + } + ], + "extensionsTimeBudget": "PT1H20M" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "extensionProfile": { + "extensions": [ + { + "name": "{extension-name}", + "properties": { + "autoUpgradeMinorVersion": false, + "publisher": "{extension-Publisher}", + "type": "{extension-Type}", + "typeHandlerVersion": "{handler-version}", + "settings": {} + } + } + ], + "extensionsTimeBudget": "PT1H20M" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithManagedBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithManagedBootDiagnostics.json new file mode 100644 index 000000000000..5553d72e053c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithManagedBootDiagnostics.json @@ -0,0 +1,230 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithPasswordAuthentication.json new file mode 100644 index 000000000000..fd0f33b9e0e1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithPasswordAuthentication.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "ffb27c5c-39a5-4d4e-b307-b32598689813", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithPremiumStorage.json new file mode 100644 index 000000000000..0b54b8ea2ace --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithPremiumStorage.json @@ -0,0 +1,215 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "19fd38a2-f50a-42c6-9dc7-3f9cf3791225", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithSshAuthentication.json new file mode 100644 index 000000000000..4c6f701615cf --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithSshAuthentication.json @@ -0,0 +1,239 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "fb73af19-0090-467c-9ced-b00bceab1c45", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json new file mode 100644 index 000000000000..baefdffe161c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithTerminateScheduledEventEnabled.json @@ -0,0 +1,233 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "location": "westus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT5M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + } + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT5M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "d053ec5a-8da6-495f-ab13-38216503c6d7", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage" + } + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + }, + "scheduledEventsProfile": { + "terminateNotificationProfile": { + "enable": true, + "notBeforeTimeout": "PT5M" + } + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithVMsInDifferentZones.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithVMsInDifferentZones.json new file mode 100644 index 000000000000..3784e146453d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScaleSetWithVMsInDifferentZones.json @@ -0,0 +1,284 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "location": "centralus", + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + } + }, + "zones": [ + "1", + "3" + ] + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "zoneBalance": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + }, + "provisioningState": "Succeeded" + }, + "zones": [ + "1", + "3" + ], + "location": "centralus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 2, + "name": "Standard_A1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": false, + "overprovision": true, + "uniqueId": "8042c376-4690-4c47-9fa2-fbdad70e32fa", + "zoneBalance": false, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "diskSizeGB": 512 + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Automatic" + }, + "provisioningState": "Creating" + }, + "zones": [ + "1", + "3" + ], + "location": "centralus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScalesetWithDiskEncryptionSetResource.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScalesetWithDiskEncryptionSetResource.json new file mode 100644 index 000000000000..b4e954f22642 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAScalesetWithDiskEncryptionSetResource.json @@ -0,0 +1,255 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_DS1_v2" + }, + "properties": { + "overprovision": true, + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/{existing-virtual-network-name}/subnets/{existing-subnet-name}" + } + } + } + ] + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + }, + "201": { + "body": { + "sku": { + "tier": "Standard", + "capacity": 3, + "name": "Standard_D1_v2" + }, + "name": "{vmss-name}", + "properties": { + "singlePlacementGroup": true, + "overprovision": true, + "uniqueId": "afa2afa8-9e49-48fb-9d18-c86323b5d064", + "virtualMachineProfile": { + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + } + ] + }, + "osProfile": { + "computerNamePrefix": "{vmss-name}", + "adminUsername": "{your-username}", + "secrets": [], + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "dnsSettings": { + "dnsServers": [] + }, + "primary": true, + "enableIPForwarding": true, + "ipConfigurations": [ + { + "name": "{vmss-name}", + "properties": { + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/nsgExistingVnet/subnets/nsgExistingSubnet" + }, + "privateIPAddressVersion": "IPv4" + } + } + ], + "enableAcceleratedNetworking": false + } + } + ] + } + }, + "upgradePolicy": { + "mode": "Manual" + }, + "provisioningState": "Creating" + }, + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/{vmss-name}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmFromACustomImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmFromACustomImage.json new file mode 100644 index 000000000000..2442f6b75915 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmFromACustomImage.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmInAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmInAnAvailabilitySet.json new file mode 100644 index 000000000000..096334bc8b9d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmInAnAvailabilitySet.json @@ -0,0 +1,162 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/{existing-availability-set-name}" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b7a098cc-b0b8-46e8-a205-62f301a62a8f", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/NSGEXISTINGAS" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDisk.json new file mode 100644 index 000000000000..16c03f72a8c9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDisk.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json new file mode 100644 index 000000000000..7eb93e9b19b5 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsCacheDisk.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "CacheDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json new file mode 100644 index 000000000000..22124e97660a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithADiffOsDiskUsingDiffDiskPlacementAsResourceDisk.json @@ -0,0 +1,180 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "diffDiskSettings": { + "option": "Local", + "placement": "ResourceDisk" + }, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithAMarketplaceImagePlan.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithAMarketplaceImagePlan.json new file mode 100644 index 000000000000..351bd0c78dc6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithAMarketplaceImagePlan.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithBootDiagnostics.json new file mode 100644 index 000000000000..9bcd58f56b94 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithBootDiagnostics.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithDiskEncryptionSetResource.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithDiskEncryptionSetResource.json new file mode 100644 index 000000000000..70efb25b22a1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithDiskEncryptionSetResource.json @@ -0,0 +1,229 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/{existing-custom-image-name}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "caching": "ReadWrite", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}", + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Attach", + "lun": 1 + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskencryptionset-name}" + } + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "caching": "ReadWrite", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}", + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Attach", + "lun": 1 + } + ] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/nsgcustom" + }, + "osDisk": { + "name": "myVMosdisk", + "diskSizeGB": 30, + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "caching": "ReadWrite", + "createOption": "FromImage", + "osType": "Linux" + }, + "dataDisks": [ + { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "caching": "ReadWrite", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/{existing-managed-disk-name}", + "storageAccountType": "Standard_LRS", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + } + }, + "diskSizeGB": 1023, + "createOption": "Attach", + "lun": 1 + } + ] + }, + "vmId": "71aa3d5a-d73d-4970-9182-8580433b2865", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithEmptyDataDisks.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithEmptyDataDisks.json new file mode 100644 index 000000000000..6c11b253497a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithEmptyDataDisks.json @@ -0,0 +1,205 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0 + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1 + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023 + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023 + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023, + "toBeDetached": false + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023, + "toBeDetached": false + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithEncryptionAtHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithEncryptionAtHost.json new file mode 100644 index 000000000000..7f9dcac22865 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithEncryptionAtHost.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "plan": { + "publisher": "microsoft-ads", + "product": "windows-data-science-vm", + "name": "windows2016" + }, + "properties": { + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "securityProfile": { + "encryptionAtHost": true + }, + "storageProfile": { + "imageReference": { + "sku": "windows2016", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "windows-data-science-vm" + }, + "osDisk": { + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "encryptionAtHost": true + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + }, + "201": { + "body": { + "name": "myVM", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "standard-data-science-vm", + "publisher": "microsoft-ads", + "version": "latest", + "offer": "standard-data-science-vm" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadOnly", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "FromImage", + "name": "myVMosdisk" + }, + "dataDisks": [] + }, + "securityProfile": { + "encryptionAtHost": true + }, + "vmId": "5c0d55a7-c407-4ed6-bf7d-ddb810267c85", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "plan": { + "publisher": "microsoft-ads", + "product": "standard-data-science-vm", + "name": "standard-data-science-vm" + }, + "type": "Microsoft.Compute/virtualMachines", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithExtensionsTimeBudget.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithExtensionsTimeBudget.json new file mode 100644 index 000000000000..4077f1678974 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithExtensionsTimeBudget.json @@ -0,0 +1,174 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://{existing-storage-account-name}.blob.core.windows.net", + "enabled": true + } + }, + "extensionsTimeBudget": "PT30M" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "extensionsTimeBudget": "PT30M", + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "storageUri": "http://nsgdiagnostic.blob.core.windows.net", + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "extensionsTimeBudget": "PT30M", + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithManagedBootDiagnostics.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithManagedBootDiagnostics.json new file mode 100644 index 000000000000..dd09e24daf77 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithManagedBootDiagnostics.json @@ -0,0 +1,168 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true + } + }, + "vmId": "676420ba-7a24-4bfe-80bd-9c841ee184fa", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPasswordAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPasswordAuthentication.json new file mode 100644 index 000000000000..7e848658b4dd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPasswordAuthentication.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "b248db33-62ba-4d2d-b791-811e075ee0f5", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfAutomaticByOS.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfAutomaticByOS.json new file mode 100644 index 000000000000..d21b36ff8198 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfAutomaticByOS.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByOS" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByOS" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByOS" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfAutomaticByPlatform.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfAutomaticByPlatform.json new file mode 100644 index 000000000000..63f8431a61f7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfAutomaticByPlatform.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "AutomaticByPlatform" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfManual.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfManual.json new file mode 100644 index 000000000000..918e64e70823 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPatchSettingModeOfManual.json @@ -0,0 +1,166 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "Manual" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true, + "patchSettings": { + "patchMode": "Manual" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": false, + "patchSettings": { + "patchMode": "Manual" + } + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPremiumStorage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPremiumStorage.json new file mode 100644 index 000000000000..40dda0e368b3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithPremiumStorage.json @@ -0,0 +1,153 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Premium_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "a149cd25-409f-41af-8088-275f5486bc93", + "hardwareProfile": { + "vmSize": "Standard_DS1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithSshAuthentication.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithSshAuthentication.json new file mode 100644 index 000000000000..1bdb1152896b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAVmWithSshAuthentication.json @@ -0,0 +1,177 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "location": "westus", + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "{image_sku}", + "publisher": "{image_publisher}", + "version": "latest", + "offer": "{image_offer}" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + } + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "linuxConfiguration": { + "ssh": { + "publicKeys": [ + { + "path": "/home/{your-username}/.ssh/authorized_keys", + "keyData": "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQCeClRAk2ipUs/l5voIsDC5q9RI+YSRd1Bvd/O+axgY4WiBzG+4FwJWZm/mLLe5DoOdHQwmU2FrKXZSW4w2sYE70KeWnrFViCOX5MTVvJgPE8ClugNl8RWth/tU849DvM9sT7vFgfVSHcAS2yDRyDlueii+8nF2ym8XWAPltFVCyLHRsyBp5YPqK8JFYIa1eybKsY3hEAxRCA+/7bq8et+Gj3coOsuRmrehav7rE6N12Pb80I6ofa6SM5XNYq4Xk0iYNx7R3kdz0Jj9XgZYWjAHjJmT0gTRoOnt6upOuxK7xI/ykWrllgpXrCPu3Ymz+c+ujaqcxDopnAl2lmf69/J1" + } + ] + }, + "disablePasswordAuthentication": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "16.04-LTS", + "publisher": "Canonical", + "version": "latest", + "offer": "UbuntuServer" + }, + "osDisk": { + "osType": "Linux", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [] + }, + "vmId": "e0de9b84-a506-4b95-9623-00a425d05c90", + "hardwareProfile": { + "vmSize": "Standard_D1_v2" + }, + "provisioningState": "Creating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnAvailabilitySet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnAvailabilitySet.json new file mode 100644 index 000000000000..196a620eb9a3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnAvailabilitySet.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "availabilitySetName": "myAvailabilitySet", + "parameters": { + "location": "westus", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + } + } + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Classic" + }, + "name": "myAvailabilitySet", + "properties": { + "platformFaultDomainCount": 2, + "platformUpdateDomainCount": 20 + }, + "location": "westus", + "type": "Microsoft.Compute/availabilitySets", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/myAvailabilitySet" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromABlob.json new file mode 100644 index 000000000000..bb69c5642d9d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromABlob.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + }, + "zoneResilient": true + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromABlobWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromABlobWithDiskEncryptionSet.json new file mode 100644 index 000000000000..88d29edc5108 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromABlobWithDiskEncryptionSet.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAManagedDisk.json new file mode 100644 index 000000000000..1aeedab52741 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAManagedDisk.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + }, + "zoneResilient": true + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json new file mode 100644 index 000000000000..f248d31771d4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAManagedDiskWithDiskEncryptionSet.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromASnapshot.json new file mode 100644 index 000000000000..04d97c3b696a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromASnapshot.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + }, + "zoneResilient": false + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json new file mode 100644 index 000000000000..94e672bb3990 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromASnapshotWithDiskEncryptionSet.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "diskEncryptionSet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/diskEncryptionSets/{existing-diskEncryptionSet-name}" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [] + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAVM.json new file mode 100644 index 000000000000..846f76b3341e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageFromAVM.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "managedDisk": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myVM_OsDisk_1_6dc293b7d811433196903acf92665022" + }, + "caching": "ReadWrite" + }, + "dataDisks": [], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json new file mode 100644 index 000000000000..10d4b80694ff --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromABlob.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ], + "zoneResilient": false + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "osState": "Generalized", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd" + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json new file mode 100644 index 000000000000..8ce291fd2cd9 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromAManagedDisk.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ], + "zoneResilient": false + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "managedDisk": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + } + } + ], + "zoneResilient": false + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json new file mode 100644 index 000000000000..9d086c83d0ef --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnImageThatIncludesADataDiskFromASnapshot.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ], + "zoneResilient": true + } + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + }, + "201": { + "body": { + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Linux", + "snapshot": { + "id": "subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot" + }, + "osState": "Generalized", + "caching": "ReadWrite" + }, + "dataDisks": [ + { + "lun": 1, + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + } + } + ], + "zoneResilient": true + }, + "provisioningState": "Creating" + }, + "type": "Microsoft.Compute/images", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/disk/providers/Microsoft.Compute/images/myImage", + "name": "myImage" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnSshPublicKey.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnSshPublicKey.json new file mode 100644 index 000000000000..c957c530c252 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateAnSshPublicKey.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "sshPublicKeyName": "mySshPublicKeyName", + "parameters": { + "location": "westus", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mySshPublicKeyName", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + }, + "201": { + "body": { + "name": "mySshPublicKeyName", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/sshPublicKeys/mySshPublicKeyName", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateADedicatedHost.json new file mode 100644 index 000000000000..be99526847e4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateADedicatedHost.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "parameters": { + "location": "westus", + "tags": { + "department": "HR" + }, + "properties": { + "platformFaultDomain": 1 + }, + "sku": { + "name": "DSv3-Type1" + } + }, + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myDedicatedHost" + }, + "responses": { + "201": { + "body": { + "name": "myDedicatedHost", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}" + } + } + }, + "200": { + "body": { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": false, + "licenseType": "Windows_Server_Hybrid", + "hostId": "{GUID}" + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "name": "myDedicatedHost", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup/hosts/myDedicatedHost", + "sku": { + "name": "DSv3-Type1" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateADedicatedHostGroup.json new file mode 100644 index 000000000000..7d6e5d145fd1 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateADedicatedHostGroup.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "hostGroupName": "myDedicatedHostGroup", + "parameters": { + "location": "westus", + "tags": { + "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true + } + } + }, + "responses": { + "201": { + "body": { + "name": "myDedicatedHostGroup", + "location": "westus", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "tags": { + "department": "finance" + }, + "zones": [ + "1" + ], + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true + } + } + }, + "200": { + "body": { + "properties": { + "platformFaultDomainCount": 3, + "supportAutomaticPlacement": true + }, + "location": "westus", + "tags": { + "department": "finance", + "owner": "myCompany" + }, + "name": "myDedicatedHostGroup", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/HostGroups/myDedicatedHostGroup", + "zones": [ + "1" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateAProximityPlacementGroup.json new file mode 100644 index 000000000000..86b30128ba17 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateAProximityPlacementGroup.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": { + "location": "westus", + "properties": { + "proximityPlacementGroupType": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard" + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + }, + "201": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard" + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..5e3dbf00975a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/CreateOrUpdateVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2020-06-01", + "extensionParameters": { + "location": "westus", + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "myVMExtension", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + }, + "200": { + "body": { + "name": "myVMExtension", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteAProximityPlacementGroup.json new file mode 100644 index 000000000000..b92729922d3b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteAProximityPlacementGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": {} + }, + "responses": { + "200": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..08064356a7c6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/DeleteVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2020-06-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GeneralizeVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GeneralizeVirtualMachine.json new file mode 100644 index 000000000000..45c4b2a99f50 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GeneralizeVirtualMachine.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "vmName": "myVMName" + }, + "responses": { + "200": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GenerateSshKeyPair.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GenerateSshKeyPair.json new file mode 100644 index 000000000000..3d3a18bd65d6 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GenerateSshKeyPair.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "sshPublicKeyName": "mySshPublicKeyName" + }, + "responses": { + "200": { + "body": { + "privateKey": "{ssh private key}", + "publicKey": "{ssh-rsa public key}", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetADedicatedHost.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetADedicatedHost.json new file mode 100644 index 000000000000..0da47da294d4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetADedicatedHost.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2018-10-01", + "hostGroupName": "myDedicatedHostGroup", + "hostName": "myHost" + }, + "responses": { + "200": { + "body": { + "properties": { + "platformFaultDomain": 1, + "autoReplaceOnFailure": true, + "hostId": "{GUID}", + "provisioningTime": "2019-06-27T01:02:38.3138469+00:00", + "virtualMachines": [ + { + "id": "/subscriptions/subId/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/vm1" + } + ], + "provisioningState": "Succeeded", + "instanceView": { + "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + } + }, + "location": "westus", + "tags": { + "department": "HR" + }, + "sku": { + "name": "DSv3-Type1" + }, + "name": "myHost" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetADedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetADedicatedHostGroup.json new file mode 100644 index 000000000000..cdd201b86023 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetADedicatedHostGroup.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "hostGroupName": "myDedicatedHostGroup", + "expand": "instanceView" + }, + "responses": { + "200": { + "body": { + "properties": { + "platformFaultDomainCount": 3, + "hosts": [ + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost1" + }, + { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/myDedicatedHostGroup/myHostGroup/Hosts/myHost2" + } + ], + "supportAutomaticPlacement": true, + "instanceView": { + "hosts": [ + { + "name": "myHost1", + "assetId": "eb3f58b8-b4e8-4882-b69f-301a01812407", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + }, + { + "name": "myHost2", + "assetId": "f293d4ac-5eea-4be2-b0c0-0fcaa09aebf8", + "availableCapacity": { + "allocatableVMs": [ + { + "vmSize": "Standard_A1", + "count": 10 + } + ] + }, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded" + }, + { + "code": "HealthState/available", + "level": "Info", + "displayStatus": "Host available" + } + ] + } + ] + } + }, + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "name": "myDedicatedHostGroup", + "zones": [ + "3" + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetAProximityPlacementGroup.json new file mode 100644 index 000000000000..b3088fb6cdfe --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetAProximityPlacementGroup.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetAnSshPublicKey.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetAnSshPublicKey.json new file mode 100644 index 000000000000..4a483fc8fd1a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetAnSshPublicKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "sshPublicKeyName": "mySshPublicKeyName" + }, + "responses": { + "200": { + "body": { + "name": "mySshPublicKeyName", + "location": "westus", + "tags": { + "{tagName}": "{tagValue}" + }, + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/SshPublicKeys/mySshPublicKeyName", + "properties": { + "publicKey": "{ssh-rsa public key}" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetInformationAboutAnImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetInformationAboutAnImage.json new file mode 100644 index 000000000000..5560fc29033d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetInformationAboutAnImage.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachine.json new file mode 100644 index 000000000000..693204398233 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachine.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "location": "West US", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1", + "availabilitySet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/availabilitySets/my-AvailabilitySet" + }, + "proximityPlacementGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/my-ppg01" + }, + "hardwareProfile": { + "vmSize": "Standard_DS3_v2" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [ + { + "lun": 0, + "name": "myDataDisk0", + "createOption": "Empty", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk0" + }, + "diskSizeGB": 30 + }, + { + "lun": 1, + "name": "myDataDisk1", + "createOption": "Attach", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myDataDisk1" + }, + "diskSizeGB": 100 + } + ] + }, + "osProfile": { + "computerName": "myVM", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": false + }, + "secrets": [] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}" + } + ] + }, + "diagnosticsProfile": { + "bootDiagnostics": { + "enabled": true, + "storageUri": "http://{myStorageAccount}.blob.core.windows.net" + } + }, + "extensionsTimeBudget": "PT50M", + "provisioningState": "Succeeded" + }, + "resources": [ + { + "name": "CustomScriptExtension-DSC", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM/extensions/CustomScriptExtension-DSC", + "type": "Microsoft.Compute/virtualMachines/extensions", + "location": "west us", + "tags": { + "displayName": "CustomScriptExtension-DSC" + }, + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "Microsoft.Compute", + "type": "CustomScriptExtension", + "typeHandlerVersion": "1.9", + "settings": {} + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineAutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..f8f243a0a90e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineAutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "name": "myVM", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "location": "West US", + "tags": { + "myTag1": "tagValue1" + }, + "properties": { + "vmId": "0f47b100-583c-48e3-a4c0-aefc2c9bbcc1", + "hostGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup" + }, + "hardwareProfile": { + "vmSize": "Standard_D2s_v3" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2016-Datacenter", + "version": "latest" + }, + "osDisk": { + "osType": "Windows", + "name": "myOsDisk", + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myOsDisk" + }, + "diskSizeGB": 30 + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "myVM", + "adminUsername": "admin", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": false + }, + "secrets": [] + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{myNIC}" + } + ] + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineInstanceView.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineInstanceView.json new file mode 100644 index 000000000000..d01a86c4c1ab --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineInstanceView.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "vmName": "myVM" + }, + "responses": { + "200": { + "body": { + "platformUpdateDomain": 1, + "platformFaultDomain": 1, + "computerName": "myVM", + "osName": "Windows Server 2016 Datacenter", + "osVersion": "Microsoft Windows NT 10.0.14393.0", + "vmAgent": { + "vmAgentVersion": "2.7.41491.949", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Ready", + "message": "GuestAgent is running and accepting new configurations.", + "time": "2019-10-14T23:11:22+00:00" + } + ], + "extensionHandlers": [ + { + "type": "Microsoft.Azure.Security.IaaSAntimalware", + "typeHandlerVersion": "1.5.5.9", + "status": { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Ready" + } + } + ] + }, + "disks": [ + { + "name": "myOsDisk", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2019-10-14T21:29:47.477089+00:00" + } + ] + }, + { + "name": "myDataDisk0", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2019-10-14T21:29:47.461517+00:00" + } + ] + } + ], + "bootDiagnostics": { + "consoleScreenshotBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.screenshot.bmp", + "serialConsoleLogBlobUri": "https://{myStorageAccount}.blob.core.windows.net/bootdiagnostics-myOsDisk/myOsDisk.serialconsole.log" + }, + "extensions": [ + { + "name": "IaaSAntiMalware-ext0", + "type": "Microsoft.Azure.Security.IaaSAntimalware", + "typeHandlerVersion": "1.5.5.9", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Microsoft Antimalware enabled" + } + ] + } + ], + "hyperVGeneration": "V1", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2019-10-14T21:30:12.8051917+00:00" + }, + { + "code": "PowerState/running", + "level": "Info", + "displayStatus": "VM running" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineInstanceViewAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineInstanceViewAutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..753e36339bd3 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineInstanceViewAutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "vmName": "myVM" + }, + "responses": { + "200": { + "body": { + "computerName": "myVM", + "osName": "Windows Server 2016 Datacenter", + "osVersion": "Microsoft Windows NT 10.0.14393.0", + "vmAgent": { + "vmAgentVersion": "2.7.41491.949", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Ready", + "message": "GuestAgent is running and accepting new configurations.", + "time": "2020-06-01T23:11:22+00:00" + } + ] + }, + "disks": [ + { + "name": "myOsDisk", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2020-06-01T21:29:47.477089+00:00" + } + ] + } + ], + "hyperVGeneration": "V1", + "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost", + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "time": "2020-06-01T21:30:12.8051917+00:00" + }, + { + "code": "PowerState/running", + "level": "Info", + "displayStatus": "VM running" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetAutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..1e18a2445395 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetAutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,92 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "name": "myVirtualMachineScaleSet", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myVirtualMachineScaleSet", + "type": "Microsoft.Compute/virtualMachineScaleSets", + "location": "West US", + "tags": { + "myTag1": "tagValue1" + }, + "sku": { + "name": "Standard_D2s_v3", + "tier": "Standard", + "capacity": 4 + }, + "properties": { + "singlePlacementGroup": false, + "upgradePolicy": { + "mode": "Automatic", + "automaticOSUpgradePolicy": { + "enableAutomaticOSUpgrade": false + } + }, + "virtualMachineProfile": { + "storageProfile": { + "osDisk": { + "createOption": "FromImage", + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Premium_LRS" + }, + "diskSizeGB": 30 + }, + "imageReference": { + "publisher": "azuredatabricks", + "offer": "databricks", + "sku": "databricksworker", + "version": "3.15.2" + }, + "dataDisks": [] + }, + "osProfile": { + "computerNamePrefix": "myVirtualMachineScaleSet", + "adminUsername": "admin", + "linuxConfiguration": { + "disablePasswordAuthentication": false + } + }, + "networkProfile": { + "networkInterfaceConfigurations": [ + { + "name": "myNic", + "properties": { + "primary": true, + "ipConfigurations": [ + { + "name": "myIPConfig", + "properties": { + "primary": true, + "subnet": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/virtualNetworks/myVNet/subnets/mySubnet" + } + } + } + ], + "networkSecurityGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkSecurityGroups/myNetworkSecurityGroup" + } + } + } + ] + } + }, + "provisioningState": "succeeded", + "overprovision": false, + "doNotRunExtensionsOnOverprovisionedVMs": false, + "platformFaultDomainCount": 1, + "hostGroup": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..2c27ae1e263c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + }, + "name": "myVMExtension", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetVMInstanceViewAutoPlacedOnDedicatedHostGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetVMInstanceViewAutoPlacedOnDedicatedHostGroup.json new file mode 100644 index 000000000000..bd6489768829 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/GetVirtualMachineScaleSetVMInstanceViewAutoPlacedOnDedicatedHostGroup.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "instanceId": "0", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "platformUpdateDomain": 0, + "platformFaultDomain": 0, + "rdpThumbPrint": null, + "vmAgent": { + "vmAgentVersion": "Unknown", + "statuses": [ + { + "code": "ProvisioningState/Unavailable", + "level": "Warning", + "displayStatus": "Not Ready", + "message": "VM status blob is found but not yet populated.", + "time": "2020-06-01T05:00:32+00:00" + } + ], + "extensionHandlers": null + }, + "disks": [ + { + "name": "myOSDisk", + "encryptionSettings": null, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": null, + "time": "2020-06-01T04:58:58.0882815+00:00" + } + ] + } + ], + "extensions": null, + "assignedHost": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/hostGroups/myHostGroup/hosts/myHost", + "bootDiagnostics": null, + "statuses": [ + { + "code": "ProvisioningState/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": null, + "time": "2020-06-05T04:59:58.1852966+00:00" + }, + { + "code": "PowerState/running", + "level": "Info", + "displayStatus": "VM running", + "message": null, + "time": null + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListAvailabilitySetsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListAvailabilitySetsInASubscription.json new file mode 100644 index 000000000000..4810b2d7dcc7 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListAvailabilitySetsInASubscription.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "api-version": "2020-06-01", + "$expand": "virtualMachines\\$ref" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] + }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "australiasoutheast", + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}" + } + ] + }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": { + "{tagName}": "{tagValue}" + }, + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] + }, + "sku": { + "name": "Classic" + } + }, + { + "name": "{availabilitySetName}", + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}", + "type": "Microsoft.Compute/availabilitySets", + "location": "westcentralus", + "tags": { + "{tagName}": "{tagValue}" + }, + "properties": { + "platformUpdateDomainCount": 5, + "platformFaultDomainCount": 3, + "virtualMachines": [] + }, + "sku": { + "name": "Classic" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListAvailableVmSizes_VirtualMachines.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListAvailableVmSizes_VirtualMachines.json new file mode 100644 index 000000000000..40ee856d726f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListAvailableVmSizes_VirtualMachines.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVmName", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_A1_V2", + "numberOfCores": 1, + "osDiskSizeInMB": 1047552, + "resourceDiskSizeInMB": 10240, + "memoryInMB": 2048, + "maxDataDiskCount": 2 + }, + { + "name": "Standard_A2_V2", + "numberOfCores": 2, + "osDiskSizeInMB": 1047552, + "resourceDiskSizeInMB": 20480, + "memoryInMB": 4096, + "maxDataDiskCount": 4 + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListImagesInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListImagesInAResourceGroup.json new file mode 100644 index 000000000000..67de59c99cb2 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListImagesInAResourceGroup.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListImagesInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListImagesInASubscription.json new file mode 100644 index 000000000000..24e22bc92341 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListImagesInASubscription.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS" + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ] + }, + "provisioningState": "created" + } + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListProximityPlacementGroupsInAResourceGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListProximityPlacementGroupsInAResourceGroup.json new file mode 100644 index 000000000000..90f25ed0875f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListProximityPlacementGroupsInAResourceGroup.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListProximityPlacementGroupsInASubscription.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListProximityPlacementGroupsInASubscription.json new file mode 100644 index 000000000000..1a5b5220943d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListProximityPlacementGroupsInASubscription.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-06-01", + "parameters": {} + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard", + "virtualMachines": [ + { + "id": "string" + } + ], + "virtualMachineScaleSets": [ + { + "id": "string" + } + ], + "availabilitySets": [ + { + "id": "string" + } + ] + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + ], + "nextLink": "string" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..f2120acb750a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + }, + "name": "myVMExtension", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension" + }, + { + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Succeeded", + "publisher": "extPublisher1", + "type": "extType1", + "typeHandlerVersion": "1.0", + "settings": { + "UserName": "xyz@microsoft.com" + } + }, + "name": "myVMExtension1", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension1" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListVirtualMachinesInASubscriptionByLocation.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListVirtualMachinesInASubscriptionByLocation.json new file mode 100644 index 000000000000..861938ede97e --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ListVirtualMachinesInASubscriptionByLocation.json @@ -0,0 +1,127 @@ +{ + "parameters": { + "subscriptionId": "{subscriptionId}", + "location": "eastus", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "vmId": "{vmId}", + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hardwareProfile": { + "vmSize": "Standard_A0" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20170406" + }, + "osDisk": { + "osType": "Windows", + "name": "test", + "createOption": "FromImage", + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "caching": "None", + "diskSizeGB": 127 + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "Test", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}" + } + ] + }, + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/virtualMachines", + "location": "eastus", + "tags": { + "RG": "rg", + "testTag": "1" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}", + "name": "{virtualMachineName}" + }, + { + "properties": { + "vmId": "{vmId}", + "availabilitySet": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/availabilitySets/{availabilitySetName}" + }, + "hardwareProfile": { + "vmSize": "Standard_A0" + }, + "storageProfile": { + "imageReference": { + "publisher": "MicrosoftWindowsServer", + "offer": "WindowsServer", + "sku": "2012-R2-Datacenter", + "version": "4.127.20170406" + }, + "osDisk": { + "osType": "Windows", + "name": "test", + "createOption": "FromImage", + "vhd": { + "uri": "https://{storageAccountName}.blob.core.windows.net/{containerName}/{vhdName}.vhd" + }, + "caching": "None", + "diskSizeGB": 127 + }, + "dataDisks": [] + }, + "osProfile": { + "computerName": "Test", + "adminUsername": "Foo12", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + }, + "secrets": [], + "allowExtensionOperations": true + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/networkInterfaces/{networkInterfaceName}" + } + ] + }, + "provisioningState": "Succeeded" + }, + "type": "Microsoft.Compute/virtualMachines", + "location": "eastus", + "tags": { + "RG": "rg", + "testTag": "1" + }, + "id": "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{virtualMachineName}", + "name": "{virtualMachineName}" + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/LogAnalyticsRequestRateByInterval.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/LogAnalyticsRequestRateByInterval.json new file mode 100644 index 000000000000..cd03d47f52b4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/LogAnalyticsRequestRateByInterval.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2020-06-01", + "parameters": { + "intervalLength": "FiveMins", + "blobContainerSasUri": "https://somesasuri", + "fromTime": "2018-01-21T01:54:06.862601Z", + "toTime": "2018-01-23T01:54:06.862601Z", + "groupByResourceName": true + } + }, + "responses": { + "200": { + "body": { + "properties": { + "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/RequestRateByInterval_20180121-0154_20180123-0154.csv" + } + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/LogAnalyticsThrottledRequests.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/LogAnalyticsThrottledRequests.json new file mode 100644 index 000000000000..b45c9facafdd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/LogAnalyticsThrottledRequests.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "location": "westus", + "api-version": "2020-06-01", + "parameters": { + "blobContainerSasUri": "https://somesasuri", + "fromTime": "2018-01-21T01:54:06.862601Z", + "toTime": "2018-01-23T01:54:06.862601Z", + "groupByOperationName": true, + "groupByResourceName": false + } + }, + "responses": { + "200": { + "body": { + "properties": { + "output": "https://crptestar4227.blob.core.windows.net:443/sascontainer/ThrottledRequests_20180121-0154_20180123-0154.csv" + } + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/PatchAProximityPlacementGroup.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/PatchAProximityPlacementGroup.json new file mode 100644 index 000000000000..ae5e9227525c --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/PatchAProximityPlacementGroup.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "proximityPlacementGroupName": "myProximityPlacementGroup", + "parameters": { + "tags": { + "additionalProp1": "string" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myProximityPlacementGroup", + "properties": { + "proximityPlacementGroupType": "Standard" + }, + "location": "westus", + "type": "Microsoft.Compute/proximityPlacementGroups", + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/proximityPlacementGroups/myProximityPlacementGroup" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ReapplyVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ReapplyVirtualMachine.json new file mode 100644 index 000000000000..7e49a5e58d4a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ReapplyVirtualMachine.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2020-06-01", + "vmName": "VMName" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ReimageVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ReimageVirtualMachine.json new file mode 100644 index 000000000000..bc4a86a55a5f --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/ReimageVirtualMachine.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "vmName": "myVMName", + "parameters": { + "tempDisk": true + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/RetrieveBootDiagnosticsDataVMScaleSetVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/RetrieveBootDiagnosticsDataVMScaleSetVM.json new file mode 100644 index 000000000000..32e8ac4913ed --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/RetrieveBootDiagnosticsDataVMScaleSetVM.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2020-06-01", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "sasUriExpirationTimeInMinutes": 60 + }, + "responses": { + "200": { + "body": { + "consoleScreenshotBlobUri": "https://storageuri/myvmScaleSetinstance.screenshot.bmp?{saskey}", + "serialConsoleLogBlobUri": "https://storageuri/myvmScaleSetinstance.serialconsole.log?{saskey}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/RetrieveBootDiagnosticsDataVirtualMachine.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/RetrieveBootDiagnosticsDataVirtualMachine.json new file mode 100644 index 000000000000..14a63f37324a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/RetrieveBootDiagnosticsDataVirtualMachine.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2020-06-01", + "vmName": "VMName", + "sasUriExpirationTimeInMinutes": 60 + }, + "responses": { + "200": { + "body": { + "consoleScreenshotBlobUri": "https://storageuri/vm.screenshot.bmp?{sasKey}", + "serialConsoleLogBlobUri": "https://storageuri/vm.serialconsole.log?{sasKey}" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/SimulateEvictionOfVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/SimulateEvictionOfVM.json new file mode 100644 index 000000000000..94d491037c16 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/SimulateEvictionOfVM.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "api-version": "2020-06-01", + "vmName": "VMName" + }, + "responses": { + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/SimulateEvictionOfVmssVM.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/SimulateEvictionOfVmssVM.json new file mode 100644 index 000000000000..1fbad058e86b --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/SimulateEvictionOfVmssVM.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "ResourceGroup", + "vmScaleSetName": "VmScaleSetName", + "api-version": "2020-06-01", + "instanceId": "InstanceId" + }, + "responses": { + "204": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateImage.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateImage.json new file mode 100644 index 000000000000..399bda89d3c0 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateImage.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01", + "imageName": "myImage", + "parameters": { + "properties": { + "sourceVirtualMachine": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM" + }, + "hyperVGeneration": "V1" + }, + "tags": { + "department": "HR" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "tags": { + "department": "HR" + }, + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/images/myImage", + "name": "myImage", + "type": "Microsoft.Compute/images", + "location": "West US", + "tags": { + "department": "HR" + }, + "properties": { + "storageProfile": { + "osDisk": { + "osType": "Windows", + "blobUri": "https://mystorageaccount.blob.core.windows.net/osimages/osimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot1" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk1" + }, + "osState": "Generalized", + "storageAccountType": "Standard_LRS", + "diskSizeGB": 20 + }, + "dataDisks": [ + { + "lun": 1, + "blobUri": "https://mystorageaccount.blob.core.windows.net/dataimages/dataimage.vhd", + "snapshot": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/snapshots/mySnapshot2" + }, + "managedDisk": { + "id": "subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/disks/myManagedDisk2" + }, + "storageAccountType": "Standard_LRS" + } + ], + "zoneResilient": true + }, + "provisioningState": "created" + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json new file mode 100644 index 000000000000..65baf29efcbd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateVMDetachDataDiskUsingToBeDetachedProperty.json @@ -0,0 +1,208 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmName": "myVM", + "api-version": "2020-06-01", + "parameters": { + "properties": { + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "caching": "ReadWrite", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "name": "myVMosdisk", + "createOption": "FromImage" + }, + "dataDisks": [ + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 0, + "toBeDetached": true + }, + { + "diskSizeGB": 1023, + "createOption": "Empty", + "lun": 1, + "toBeDetached": false + } + ] + }, + "osProfile": { + "adminUsername": "{your-username}", + "computerName": "myVM", + "adminPassword": "{your-password}" + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/{existing-nic-name}", + "properties": { + "primary": true + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023, + "toBeDetached": true + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023, + "toBeDetached": false + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Updating" + }, + "name": "myVM", + "location": "westus" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachines/myVM", + "type": "Microsoft.Compute/virtualMachines", + "properties": { + "osProfile": { + "adminUsername": "{your-username}", + "secrets": [], + "computerName": "myVM", + "windowsConfiguration": { + "provisionVMAgent": true, + "enableAutomaticUpdates": true + } + }, + "networkProfile": { + "networkInterfaces": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/myResourceGroup/providers/Microsoft.Network/networkInterfaces/nsgExistingNic", + "properties": { + "primary": true + } + } + ] + }, + "storageProfile": { + "imageReference": { + "sku": "2016-Datacenter", + "publisher": "MicrosoftWindowsServer", + "version": "latest", + "offer": "WindowsServer" + }, + "osDisk": { + "osType": "Windows", + "caching": "ReadWrite", + "createOption": "FromImage", + "name": "myVMosdisk", + "managedDisk": { + "storageAccountType": "Standard_LRS" + } + }, + "dataDisks": [ + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 0, + "diskSizeGB": 1023, + "toBeDetached": true + }, + { + "caching": "None", + "managedDisk": { + "storageAccountType": "Standard_LRS" + }, + "createOption": "Empty", + "lun": 1, + "diskSizeGB": 1023, + "toBeDetached": false + } + ] + }, + "vmId": "3906fef9-a1e5-4b83-a8a8-540858b41df0", + "hardwareProfile": { + "vmSize": "Standard_D2_v2" + }, + "provisioningState": "Updating" + }, + "name": "myVM", + "location": "westus" + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateVirtualMachineScaleSetVMExtensions.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateVirtualMachineScaleSetVMExtensions.json new file mode 100644 index 000000000000..659ea562168a --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/UpdateVirtualMachineScaleSetVMExtensions.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myvmScaleSet", + "instanceId": "0", + "vmExtensionName": "myVMExtension", + "api-version": "2020-06-01", + "extensionParameters": { + "properties": { + "autoUpgradeMinorVersion": true, + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myVMExtension", + "location": "westus", + "type": "Microsoft.Compute/virtualMachineScaleSets/virtualMachines/extensions", + "id": "/subscriptions/{subscriptionId}/resourceGroups/myResourceGroup/providers/Microsoft.Compute/virtualMachineScaleSets/myvmScaleSet/virtualMachines/0/extensions/myVMExtension", + "properties": { + "autoUpgradeMinorVersion": true, + "provisioningState": "Creating", + "publisher": "extPublisher", + "type": "extType", + "typeHandlerVersion": "1.2", + "settings": { + "UserName": "xyz@microsoft.com" + } + } + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VMScaleSetExtensionRollingUpgrade.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VMScaleSetExtensionRollingUpgrade.json new file mode 100644 index 000000000000..73f6686c3ffb --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VMScaleSetExtensionRollingUpgrade.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "{vmss-name}", + "api-version": "2020-06-01" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VMScaleSetRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VMScaleSetRunCommand.json new file mode 100644 index 000000000000..536c75dd60f4 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VMScaleSetRunCommand.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroup", + "vmScaleSetName": "myVirtualMachineScaleSet", + "instanceId": "0", + "api-version": "2020-06-01", + "parameters": { + "commandId": "RunPowerShellScript", + "script": [ + "Write-Host Hello World!" + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "ComponentStatus/StdOut/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "Hello World!" + }, + { + "code": "ComponentStatus/StdErr/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineAssessPatches.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineAssessPatches.json new file mode 100644 index 000000000000..7c0bd491c975 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineAssessPatches.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "assessmentActivityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "rebootPending": true, + "criticalAndSecurityPatchCount": 1, + "otherPatchCount": 2, + "startDateTime": "2020-04-24T21:02:04.2556154Z", + "patches": [ + { + "patchId": "35428702-5784-4ba4-a6e0-5222258b5411", + "name": "Definition Update for Windows Defender Antivirus - KB2267602 (Definition 1.279.1373.0)", + "version": "", + "kbid": "2267602", + "classifications": [ + "Definition Updates" + ], + "rebootBehavior": "NeverReboots", + "activityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "publishedDate": "2018-11-07T00:00:00Z", + "lastModifiedDateTime": "2020-04-24T21:18:45.2830263Z", + "assessmentState": "Available" + }, + { + "patchId": "39f9cdd1-795c-4d0e-8c0a-73ab3f31746d", + "name": "Windows Malicious Software Removal Tool x64 - October 2018 (KB890830)", + "version": "", + "kbid": "890830", + "classifications": [ + "Update Rollups" + ], + "rebootBehavior": "CanRequestReboot", + "activityId": "68f8b292-dfc2-4646-9781-33cc88631968", + "publishedDate": "2018-11-07T00:00:00Z", + "lastModifiedDateTime": "2020-04-24T21:18:45.2830263Z", + "assessmentState": "Available" + } + ], + "error": null + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommand.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommand.json new file mode 100644 index 000000000000..e4be08a561be --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommand.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "resourceGroupName": "crptestar98131", + "vmName": "vm3036", + "$top": 1, + "api-version": "2020-06-01", + "monitor": "true", + "parameters": { + "commandId": "RunPowerShellScript" + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "code": "ComponentStatus/StdOut/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "This is a sample script with parameters value1 value2" + }, + { + "code": "ComponentStatus/StdErr/succeeded", + "level": "Info", + "displayStatus": "Provisioning succeeded", + "message": "" + } + ] + } + }, + "202": {} + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommandGet.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommandGet.json new file mode 100644 index 000000000000..c2a33e7a7bfd --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommandGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "24fb23e3-6ba3-41f0-9b6e-e41131d5d61e", + "location": "SoutheastAsia", + "commandId": "RunPowerShellScript", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "script": [ + "param(", + " [string]$arg1,", + " [string]$arg2", + ")", + "Write-Host This is a sample script with parameters $arg1 $arg2" + ], + "parameters": [ + { + "name": "arg1", + "type": "string", + "defaultValue": "value1" + }, + { + "name": "arg2", + "type": "string", + "defaultValue": "value2" + } + ], + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunPowerShellScript", + "osType": "Windows", + "label": "Executes a PowerShell script", + "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommandList.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommandList.json new file mode 100644 index 000000000000..890839b1960d --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/examples/VirtualMachineRunCommandList.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "subscriptionId": "subid", + "location": "SoutheastAsia", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "EnableRemotePS", + "osType": "Windows", + "label": "Enable remote PowerShell", + "description": "Configure the machine to enable remote PowerShell." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "IPConfig", + "osType": "Windows", + "label": "List IP configuration", + "description": "Shows detailed information for the IP address, subnet mask and default gateway for each adapter bound to TCP/IP." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunPowerShellScript", + "osType": "Windows", + "label": "Executes a PowerShell script", + "description": "Custom multiline PowerShell script should be defined in script property. Optional parameters can be set in parameters property." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RunShellScript", + "osType": "Linux", + "label": "Executes a Linux shell script", + "description": "Custom multiline shell script should be defined in script property. Optional parameters can be set in parameters property." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ifconfig", + "osType": "Linux", + "label": "List network configuration", + "description": "Get the configuration of all network interfaces." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "EnableAdminAccount", + "osType": "Windows", + "label": "Enable administrator account", + "description": "Checks if the local Administrator account is disabled, and if so enables it." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ResetAccountPassword", + "osType": "Windows", + "label": "Reset built-in Administrator account password", + "description": "Reset built-in Administrator account password." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "RDPSettings", + "osType": "Windows", + "label": "Verify RDP Listener Settings", + "description": "Checks registry settings and domain policy settings. Suggests policy actions if machine is part of a domain or modifies the settings to default values." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "SetRDPPort", + "osType": "Windows", + "label": "Set Remote Desktop port", + "description": "Sets the default or user specified port number for Remote Desktop connections. Enables firewall rule for inbound access to the port." + }, + { + "$schema": "http://schema.management.azure.com/schemas/2016-11-17/runcommands.json", + "id": "ResetRDPCert", + "osType": "Windows", + "label": "Restore RDP Authentication mode to defaults", + "description": "Removes the SSL certificate tied to the RDP listener and restores the RDP listerner security to default. Use this script if you see any issues with the certificate." + } + ] + } + } + } +} diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/runCommands.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/runCommands.json new file mode 100644 index 000000000000..9759cd8205e8 --- /dev/null +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/runCommands.json @@ -0,0 +1,472 @@ +{ + "swagger": "2.0", + "info": { + "title": "RunCommandsClient", + "description": "The Run Commands Client.", + "version": "2020-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json", + "text/json" + ], + "produces": [ + "application/json", + "text/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_List", + "x-ms-examples": { + "VirtualMachineRunCommandList": { + "$ref": "./examples/VirtualMachineRunCommandList.json" + } + }, + "description": "Lists all available run commands for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Compute/locations/{location}/runCommands/{commandId}": { + "get": { + "tags": [ + "VirtualMachineRunCommands" + ], + "operationId": "VirtualMachineRunCommands_Get", + "x-ms-examples": { + "VirtualMachineRunCommandGet": { + "$ref": "./examples/VirtualMachineRunCommandGet.json" + } + }, + "description": "Gets specific run command for a subscription in a location.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which run commands is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "commandId", + "in": "path", + "required": true, + "type": "string", + "description": "The command id." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandDocument" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/runCommand": { + "post": { + "tags": [ + "VirtualMachines" + ], + "operationId": "VirtualMachines_RunCommand", + "x-ms-examples": { + "VirtualMachineRunCommand": { + "$ref": "./examples/VirtualMachineRunCommand.json" + } + }, + "description": "Run command on the VM.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachineScaleSets/{vmScaleSetName}/virtualmachines/{instanceId}/runCommand": { + "post": { + "tags": [ + "VirtualMachineScaleSetVMs" + ], + "operationId": "VirtualMachineScaleSetVMs_RunCommand", + "x-ms-examples": { + "VirtualMachineScaleSetVMs_RunCommand": { + "$ref": "./examples/VMScaleSetRunCommand.json" + } + }, + "description": "Run command on a virtual machine in a VM scale set.", + "parameters": [ + { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group." + }, + { + "name": "vmScaleSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the VM scale set." + }, + { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "description": "The instance ID of the virtual machine." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RunCommandInput" + }, + "description": "Parameters supplied to the Run command operation." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/RunCommandResult" + } + }, + "202": { + "description": "Accepted" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + } + }, + "definitions": { + "RunCommandInputParameter": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "value": { + "type": "string", + "description": "The run command parameter value." + } + }, + "required": [ + "name", + "value" + ], + "description": "Describes the properties of a run command parameter." + }, + "RunCommandInput": { + "properties": { + "commandId": { + "type": "string", + "description": "The run command id." + }, + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Optional. The script to be executed. When this value is given, the given script will override the default script of the command." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandInputParameter" + }, + "description": "The run command parameters." + } + }, + "required": [ + "commandId" + ], + "description": "Capture Virtual Machine parameters." + }, + "RunCommandParameterDefinition": { + "properties": { + "name": { + "type": "string", + "description": "The run command parameter name." + }, + "type": { + "type": "string", + "description": "The run command parameter type." + }, + "defaultValue": { + "type": "string", + "description": "The run command parameter default value." + }, + "required": { + "type": "boolean", + "description": "The run command parameter required.", + "default": false + } + }, + "required": [ + "name", + "type" + ], + "description": "Describes the properties of a run command parameter." + }, + "RunCommandDocumentBase": { + "properties": { + "$schema": { + "type": "string", + "description": "The VM run command schema." + }, + "id": { + "type": "string", + "description": "The VM run command id." + }, + "osType": { + "type": "string", + "description": "The Operating System type.", + "enum": [ + "Windows", + "Linux" + ], + "x-ms-enum": { + "name": "OperatingSystemTypes", + "modelAsString": false + } + }, + "label": { + "type": "string", + "description": "The VM run command label." + }, + "description": { + "type": "string", + "description": "The VM run command description." + } + }, + "required": [ + "$schema", + "id", + "osType", + "label", + "description" + ], + "description": "Describes the properties of a Run Command metadata." + }, + "RunCommandDocument": { + "allOf": [ + { + "$ref": "#/definitions/RunCommandDocumentBase" + } + ], + "properties": { + "script": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The script to be executed." + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandParameterDefinition" + }, + "description": "The parameters used by the script." + } + }, + "required": [ + "script" + ], + "description": "Describes the properties of a Run Command." + }, + "RunCommandListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RunCommandDocumentBase" + }, + "description": "The list of virtual machine run commands." + }, + "nextLink": { + "type": "string", + "description": "The uri to fetch the next page of run commands. Call ListNext() with this to fetch the next page of run commands." + } + }, + "required": [ + "value" + ], + "description": "The List Virtual Machine operation response." + }, + "InstanceViewStatus": { + "properties": { + "code": { + "type": "string", + "description": "The status code." + }, + "level": { + "type": "string", + "description": "The level code.", + "enum": [ + "Info", + "Warning", + "Error" + ], + "x-ms-enum": { + "name": "StatusLevelTypes", + "modelAsString": false + } + }, + "displayStatus": { + "type": "string", + "description": "The short localizable label for the status." + }, + "message": { + "type": "string", + "description": "The detailed status message, including for alerts and error messages." + }, + "time": { + "type": "string", + "format": "date-time", + "description": "The time of the status." + } + }, + "description": "Instance view status." + }, + "RunCommandResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/InstanceViewStatus" + }, + "description": "Run command operation response." + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + } + } +} diff --git a/specification/compute/resource-manager/readme.md b/specification/compute/resource-manager/readme.md index 06d1324050ed..a22faa6abe1f 100644 --- a/specification/compute/resource-manager/readme.md +++ b/specification/compute/resource-manager/readme.md @@ -34,7 +34,7 @@ These are the global settings for the Compute API. title: ComputeManagementClient description: Compute Client openapi-type: arm -tag: package-2020-05-01 +tag: package-2020-06-01 directive: - where: @@ -61,7 +61,6 @@ directive: - $.definitions.Snapshot.properties suppress: - BodyTopLevelProperties - - where: - $.definitions.VirtualMachineScaleSetExtension suppress: @@ -138,7 +137,6 @@ directive: - $.definitions.DiskEncryptionSetParameters suppress: - RequiredPropertiesMissingInResourceModel - - where: - $.definitions.VirtualMachineScaleSetVM suppress: @@ -171,12 +169,10 @@ directive: - $.definitions.GalleryImageVersion suppress: - TrackedResourcePatchOperation - - where: - $.definitions.VirtualMachineImageResource suppress: - TrackedResourceGetOperation - - where: - $.definitions.AdditionalCapabilities.properties.ultraSSDEnabled suppress: @@ -205,7 +201,6 @@ directive: - $.definitions.VirtualMachineScaleSetDataDisk.properties.diskIOPSReadWrite suppress: - DefinitionsPropertiesNamesCamelCase - - where: - $.definitions.ContainerService suppress: @@ -215,6 +210,30 @@ directive: ``` +### Tag: package-2020-06-01 + +These settings apply only when `--tag=package-2020-06-01` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06-01' +input-file: +- Microsoft.Compute/stable/2020-06-01/compute.json +- Microsoft.Compute/stable/2020-06-01/runCommands.json +- Microsoft.Compute/stable/2019-04-01/skus.json +- Microsoft.Compute/stable/2020-05-01/disk.json +- Microsoft.Compute/stable/2019-12-01/gallery.json +- Microsoft.ContainerService/stable/2017-01-31/containerService.json +``` + +### Tag: package-2020-06-01-only + +These settings apply only when `--tag=package-2020-06-01-only` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06-01-only' +input-file: +- Microsoft.Compute/stable/2020-06-01/compute.json +- Microsoft.Compute/stable/2020-06-01/runCommands.json +``` + ### Tag: package-2020-05-01 These settings apply only when `--tag=package-2020-05-01` is specified on the command line. From 47704afe8534da44f8a34f1f99d82c72cf3158b1 Mon Sep 17 00:00:00 2001 From: Tanyi Chen Date: Tue, 23 Jun 2020 13:49:44 +0800 Subject: [PATCH 185/318] update java md (#9923) --- .../resource-manager/readme.java.md | 22 ++++++++++++++++++- .../resource-manager/readme.md | 1 + 2 files changed, 22 insertions(+), 1 deletion(-) diff --git a/specification/operationalinsights/resource-manager/readme.java.md b/specification/operationalinsights/resource-manager/readme.java.md index 2c18db3f6a0d..224d9e3faf84 100644 --- a/specification/operationalinsights/resource-manager/readme.java.md +++ b/specification/operationalinsights/resource-manager/readme.java.md @@ -11,15 +11,35 @@ license-header: MICROSOFT_MIT_NO_CODEGEN payload-flattening-threshold: 1 output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-loganalytics service-name: LogAnalytics +directive: + - rename-operation: + from: SharedKeys_Regenerate + to: SharedKeysOperation_Regenerate + - rename-operation: + from: SharedKeys_GetSharedKeys + to: SharedKeysOperation_GetSharedKeys ``` - ### Java multi-api ``` yaml $(java) && $(multiapi) batch: - tag: package-2015-03 - tag: package-2015-11-preview + - tag: package-2020-03-preview +``` + +### Tag: package-2020-03-preview and java + +These settings apply only when `--tag=package-2020-03-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-03-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.loganalytics.v2020_03_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/loganalytics/mgmt-v2020_03_01_preview +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2015-03 and java diff --git a/specification/operationalinsights/resource-manager/readme.md b/specification/operationalinsights/resource-manager/readme.md index 738ae481fc00..61da647eac21 100644 --- a/specification/operationalinsights/resource-manager/readme.md +++ b/specification/operationalinsights/resource-manager/readme.md @@ -107,6 +107,7 @@ swagger-to-sdk: - repo: azure-sdk-for-js - repo: azure-sdk-for-node - repo: azure-sdk-for-ruby + - repo: azure-sdk-for-java after_scripts: - bundle install && rake arm:regen_all_profiles['azure_mgmt_operational_insights'] ``` From bf34344ef2eeef2be0b15823ebb7ddb5913dc880 Mon Sep 17 00:00:00 2001 From: Gokul Premraj Date: Tue, 23 Jun 2020 09:26:20 -0400 Subject: [PATCH 186/318] Xynoclafe/2020 06 version (#9888) * Update Resources 2020-06 to include changes from 2019-10 (From PR - #9441) * Update Resources 2020-06 to include changes from 2019-10 (From PR - #9580) * Rollback java support for Resources API version 2020-06-01 --- .../stable/2020-06-01/resources.json | 57 ++++++++++--------- .../resources/resource-manager/readme.java.md | 14 ----- 2 files changed, 30 insertions(+), 41 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json index 7568710e3c8c..70bfb6588665 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json @@ -2628,7 +2628,7 @@ "$ref": "#/parameters/ApiVersionParameter" }, { - "$ref": "#/parameters/SourceSubscriptionIdParameter" + "$ref": "#/parameters/SubscriptionIdParameter" } ], "responses": { @@ -2758,7 +2758,8 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for the operation." + "description": "The API version to use for the operation.", + "x-ms-api-version": false }, { "$ref": "#/parameters/SubscriptionIdParameter" @@ -2831,7 +2832,8 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for the operation." + "description": "The API version to use for the operation.", + "x-ms-api-version": false }, { "$ref": "#/parameters/SubscriptionIdParameter" @@ -2908,7 +2910,8 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for the operation." + "description": "The API version to use for the operation.", + "x-ms-api-version": false }, { "name": "parameters", @@ -3000,7 +3003,8 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for the operation." + "description": "The API version to use for the operation.", + "x-ms-api-version": false }, { "name": "parameters", @@ -3086,7 +3090,8 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for the operation." + "description": "The API version to use for the operation.", + "x-ms-api-version": false }, { "$ref": "#/parameters/SubscriptionIdParameter" @@ -3129,7 +3134,8 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for the operation." + "description": "The API version to use for the operation.", + "x-ms-api-version": false } ], "responses": { @@ -3167,7 +3173,8 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for the operation." + "description": "The API version to use for the operation.", + "x-ms-api-version": false } ], "responses": { @@ -3209,7 +3216,8 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for the operation." + "description": "The API version to use for the operation.", + "x-ms-api-version": false }, { "name": "parameters", @@ -3266,7 +3274,8 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for the operation." + "description": "The API version to use for the operation.", + "x-ms-api-version": false }, { "name": "parameters", @@ -3317,7 +3326,8 @@ "in": "query", "required": true, "type": "string", - "description": "The API version to use for the operation." + "description": "The API version to use for the operation.", + "x-ms-api-version": false } ], "responses": { @@ -3341,7 +3351,7 @@ "tags": [ "Tags" ], - "operationId": "TagsOperation_DeleteValue", + "operationId": "Tags_DeleteValue", "summary": "Deletes a predefined tag value for a predefined tag name.", "description": "This operation allows deleting a value from the list of predefined values for an existing predefined tag name. The value being deleted must not be in use as a tag value for the given tag name for any resource.", "parameters": [ @@ -3385,7 +3395,7 @@ "tags": [ "Tags" ], - "operationId": "TagsOperation_CreateOrUpdateValue", + "operationId": "Tags_CreateOrUpdateValue", "summary": "Creates a predefined value for a predefined tag name.", "description": "This operation allows adding a value to the list of predefined values for an existing predefined tag name. A tag value can have a maximum of 256 characters.", "parameters": [ @@ -3437,7 +3447,7 @@ "tags": [ "Tags" ], - "operationId": "TagsOperation_CreateOrUpdate", + "operationId": "Tags_CreateOrUpdate", "summary": "Creates a predefined tag name.", "description": "This operation allows adding a name to the list of predefined tag names for the given subscription. A tag name can have a maximum of 512 characters and is case-insensitive. Tag names cannot have the following prefixes which are reserved for Azure use: 'microsoft', 'azure', 'windows'.", "parameters": [ @@ -3480,7 +3490,7 @@ "tags": [ "Tags" ], - "operationId": "TagsOperation_Delete", + "operationId": "Tags_Delete", "summary": "Deletes a predefined tag name.", "description": "This operation allows deleting a name from the list of predefined tag names for the given subscription. The name being deleted must not be in use as a tag name for any resource. All predefined values for the given name must have already been deleted.", "parameters": [ @@ -3519,7 +3529,7 @@ "tags": [ "Tags" ], - "operationId": "TagsOperation_List", + "operationId": "Tags_List", "summary": "Gets a summary of tag usage under the subscription.", "description": "This operation performs a union of predefined tags, resource tags, resource group tags and subscription tags, and returns a summary of usage for each tag name and value under the given subscription. In case of a large number of tags, this operation may return a previously cached result.", "parameters": [ @@ -4040,7 +4050,7 @@ "tags": [ "Tags" ], - "operationId": "TagsOperation_CreateOrUpdateAtScope", + "operationId": "Tags_CreateOrUpdateAtScope", "summary": "Creates or updates the entire set of tags on a resource or subscription.", "description": "This operation allows adding or replacing the entire set of tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags.", "parameters": [ @@ -4086,7 +4096,7 @@ "tags": [ "Tags" ], - "operationId": "TagsOperation_UpdateAtScope", + "operationId": "Tags_UpdateAtScope", "summary": "Selectively updates the set of tags on a resource or subscription.", "description": "This operation allows replacing, merging or selectively deleting tags on the specified resource or subscription. The specified entity can have a maximum of 50 tags at the end of the operation. The 'replace' option replaces the entire set of existing tags with a new set. The 'merge' option allows adding tags with new names and updating the values of tags with existing names. The 'delete' option allows selectively deleting tags based on given names or name/value pairs.", "parameters": [ @@ -4124,7 +4134,7 @@ "tags": [ "Tags" ], - "operationId": "TagsOperation_GetAtScope", + "operationId": "Tags_GetAtScope", "summary": "Gets the entire set of tags on a resource or subscription.", "parameters": [ { @@ -4161,7 +4171,7 @@ "tags": [ "Tags" ], - "operationId": "TagsOperation_DeleteAtScope", + "operationId": "Tags_DeleteAtScope", "summary": "Deletes the entire set of tags on a resource or subscription.", "parameters": [ { @@ -5884,13 +5894,6 @@ "type": "string", "description": "The ID of the target subscription." }, - "SourceSubscriptionIdParameter": { - "name": "subscriptionId", - "in": "path", - "required": true, - "type": "string", - "description": "The ID of the source subscription." - }, "DeploymentNameParameter": { "name": "deploymentName", "in": "path", diff --git a/specification/resources/resource-manager/readme.java.md b/specification/resources/resource-manager/readme.java.md index 5e5e0d5c92b8..c8705dc8d7f5 100644 --- a/specification/resources/resource-manager/readme.java.md +++ b/specification/resources/resource-manager/readme.java.md @@ -27,7 +27,6 @@ batch: - tag: package-policy-2018-05 - tag: package-policy-2018-03 - tag: package-policy-2016-12 - - tag: package-resources-2020-06 - tag: package-resources-2019-08 - tag: package-resources-2019-07 - tag: package-resources-2019-0510 @@ -190,19 +189,6 @@ directive: transform: $['x-ms-client-name'] = 'scopeProperty' ``` -### Tag: package-resources-2020-06 and java - -These settings apply only when `--tag=package-resources-2020-06 --java` is specified on the command line. -Please also specify `--azure-libraries-for-java-folder=`. - -``` yaml $(tag) == 'package-resources-2020-06' && $(java) && $(multiapi) -java: - namespace: com.microsoft.azure.management.resources.v2020_06_01 - output-folder: $(azure-libraries-for-java-folder)/resources/resource-manager/v2020_06_01 -regenerate-manager: true -generate-interface: true -``` - ### Tag: package-resources-2019-08 and java These settings apply only when `--tag=package-resources-2019-08 --java` is specified on the command line. From acc3d6c177e79ef474bda9ec2466dd89dd635ba0 Mon Sep 17 00:00:00 2001 From: t-arjkas <67292107+t-arjkas@users.noreply.github.com> Date: Tue, 23 Jun 2020 09:29:20 -0400 Subject: [PATCH 187/318] Updating operations API to enable metrics via public metrics REST API. (#9918) --- .../examples/Operations_List.json | 231 +++++++++++++++++- 1 file changed, 220 insertions(+), 11 deletions(-) diff --git a/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/examples/Operations_List.json b/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/examples/Operations_List.json index be04943780f8..6f4f28c7ce33 100644 --- a/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/examples/Operations_List.json +++ b/specification/vmware/resource-manager/Microsoft.AVS/preview/2019-08-09-preview/examples/Operations_List.json @@ -4,18 +4,227 @@ }, "responses": { "200": { - "body": [ - { - "display": { - "description": "Creates a private cloud", - "operation": "Create Private Cloud", - "provider": "Azure VMware Solution", - "resource": "Private Cloud" + "body": { + "value": [ + { + "display": { + "description": "Creates a private cloud", + "operation": "Create Private Cloud", + "provider": "Azure VMware Solution", + "resource": "Private Cloud" + }, + "name": "Microsoft.AVS/privateClouds/create", + "origin": "user,system" }, - "name": "Microsoft.AVS/privateClouds/create", - "origin": "user,system" - } - ], + { + "origin": "system", + "name": "Microsoft.AVS/privateClouds/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Azure Dedicated", + "resource": "Private Cloud", + "operation": "Read Private Cloud metric definitions", + "description": "Gets the available metrics for Private Cloud" + }, + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "UsedLatest", + "displayName": "Datastore disk used", + "displayDescription": "The total amount of disk used in SDDC", + "unit": "Average", + "aggregationType": "Total", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "AVSShoebox2WestEurope", + "sourceMdmNamespace": "Vsphere.Datastore.Disk" + }, + { + "name": "CapacityLatest", + "displayName": "Datastore disk total capacity", + "displayDescription": "The total capacity of disk in SDDC", + "unit": "Average", + "aggregationType": "Total", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "AVSShoebox2WestEurope", + "sourceMdmNamespace": "Vsphere.Datastore.Disk" + }, + { + "name": "EffectiveMemAverage", + "displayName": "Average Effective Memory", + "displayDescription": "Total amount of machine memory in cluster that is available", + "unit": "Average", + "aggregationType": "Total", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "AVSShoebox2WestEurope", + "sourceMdmNamespace": "Vsphere.Cluster.ClusterServices" + }, + { + "name": "EffectiveCpuAverage", + "displayName": "Average Effective CPU", + "displayDescription": "Total available CPU resources in cluster", + "unit": "Average", + "aggregationType": "Total", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "AVSShoebox2WestEurope", + "sourceMdmNamespace": "Vsphere.Cluster.ClusterServices" + }, + { + "name": "FailoverLatest", + "displayName": "Failover", + "displayDescription": "vSphere HA number of failures that can be tolerated", + "unit": "Average", + "aggregationType": "Total", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "AVSShoebox2WestEurope", + "sourceMdmNamespace": "Vsphere.Cluster.ClusterServices" + }, + { + "name": "TotalMhzAverage", + "displayName": "Average Total CPU", + "displayDescription": "Total CPU resources in cluster", + "unit": "Average", + "aggregationType": "Total", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "AVSShoebox2WestEurope", + "sourceMdmNamespace": "Vsphere.Cluster.Cpu" + }, + { + "name": "TotalMbAverage", + "displayName": "Average Total Memory", + "displayDescription": "Total memory in cluster", + "unit": "Average", + "aggregationType": "Total", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "AVSShoebox2WestEurope", + "sourceMdmNamespace": "Vsphere.Cluster.Mem" + }, + { + "name": "OverheadAverage", + "displayName": "Average Memory Overhead", + "displayDescription": "Host physical memory consumed by the virtualization infrastructure", + "unit": "Average", + "aggregationType": "Total", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "AVSShoebox2WestEurope", + "sourceMdmNamespace": "Vsphere.Cluster.Mem" + }, + { + "name": "UsageAverage", + "displayName": "Average Memory Usage", + "displayDescription": "Memory usage as percentage of total configured or available memory", + "unit": "Average", + "aggregationType": "Total", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "P1D" + ], + "enableRegionalMdmAccount": "false", + "sourceMdmAccount": "AVSShoebox2WestEurope", + "sourceMdmNamespace": "Vsphere.Cluster.Mem" + } + ] + } + } + }, + { + "origin": "system", + "name": "Microsoft.AVS/privateClouds/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.AVS", + "resource": "Private Cloud", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + } + }, + { + "origin": "system", + "name": "Microsoft.AVS/privateClouds/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.AVS", + "resource": "Private Cloud", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + } + } + ] + }, "nextLink": "string" } } From f9caf92527ccff06c5b66380e6f2b4f50f5e82b3 Mon Sep 17 00:00:00 2001 From: Jack Lichwa <52512203+jlichwa@users.noreply.github.com> Date: Tue, 23 Jun 2020 09:15:14 -0700 Subject: [PATCH 188/318] Update DeletionRecovery Level (#9895) * Update description for certificate type * update description for certificate type * Revert "update description for certificate type" This reverts commit 3093d69a736df92d9e74fdb7c1d4857e7575c3cc. * Revert "Update description for certificate type" This reverts commit 83c4922b3f694c7c6366e7c52dcd7d8222240d70. * Update description for certificate type * Update * Update DeletionRecoveryLevel * Update keyvault.json * Update RecoveryLevel * Update Recovery Level description * Update Deletion Recovery Level --- .../preview/7.1/certificates.json | 32 ++- .../Microsoft.KeyVault/preview/7.1/keys.json | 32 ++- .../preview/7.1/secrets.json | 32 ++- .../preview/7.1/storage.json | 32 ++- .../preview/7.2-preview/certificates.json | 32 ++- .../preview/7.2-preview/keys.json | 32 ++- .../preview/7.2-preview/secrets.json | 32 ++- .../preview/7.2-preview/storage.json | 32 ++- .../stable/7.0/keyvault.json | 185 +++++++++++++++++- 9 files changed, 423 insertions(+), 18 deletions(-) diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/certificates.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/certificates.json index 5a0bfa70211d..a49f3e8f0b40 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/certificates.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/certificates.json @@ -1271,7 +1271,37 @@ ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/keys.json index 0bb932484ef9..c17fb4bfb725 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/keys.json @@ -1151,7 +1151,37 @@ ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/secrets.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/secrets.json index 60d8f7d5deb3..6ab02295424c 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/secrets.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/secrets.json @@ -721,7 +721,37 @@ ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/storage.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/storage.json index 161b39a01a37..c112fb24af56 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/storage.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.1/storage.json @@ -1028,7 +1028,37 @@ ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/certificates.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/certificates.json index 68088de0eede..8b4fcb949d3d 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/certificates.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/certificates.json @@ -1271,7 +1271,37 @@ ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json index 19218ec417ae..ad468d0f250f 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/keys.json @@ -1291,7 +1291,37 @@ ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/secrets.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/secrets.json index a8e201aa184d..eca4bd96f3a3 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/secrets.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/secrets.json @@ -721,7 +721,37 @@ ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/storage.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/storage.json index 39e250bafe15..a8c4b113464c 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/storage.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/storage.json @@ -1028,7 +1028,37 @@ ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json index 25a2ceab1a35..e7394ee8cb47 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/stable/7.0/keyvault.json @@ -3879,11 +3879,44 @@ "Purgeable", "Recoverable+Purgeable", "Recoverable", - "Recoverable+ProtectedSubscription" + "Recoverable+ProtectedSubscription", + "CustomizedRecoverable+Purgeable", + "CustomizedRecoverable", + "CustomizedRecoverable+ProtectedSubscription" ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false @@ -4126,11 +4159,44 @@ "Purgeable", "Recoverable+Purgeable", "Recoverable", - "Recoverable+ProtectedSubscription" + "Recoverable+ProtectedSubscription", + "CustomizedRecoverable+Purgeable", + "CustomizedRecoverable", + "CustomizedRecoverable+ProtectedSubscription" ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false @@ -4180,11 +4246,44 @@ "Purgeable", "Recoverable+Purgeable", "Recoverable", - "Recoverable+ProtectedSubscription" + "Recoverable+ProtectedSubscription", + "CustomizedRecoverable+Purgeable", + "CustomizedRecoverable", + "CustomizedRecoverable+ProtectedSubscription" ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false @@ -5497,11 +5596,44 @@ "Purgeable", "Recoverable+Purgeable", "Recoverable", - "Recoverable+ProtectedSubscription" + "Recoverable+ProtectedSubscription", + "CustomizedRecoverable+Purgeable", + "CustomizedRecoverable", + "CustomizedRecoverable+ProtectedSubscription" ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false @@ -5772,11 +5904,44 @@ "Purgeable", "Recoverable+Purgeable", "Recoverable", - "Recoverable+ProtectedSubscription" + "Recoverable+ProtectedSubscription", + "CustomizedRecoverable+Purgeable", + "CustomizedRecoverable", + "CustomizedRecoverable+ProtectedSubscription" ], "x-ms-enum": { "name": "DeletionRecoveryLevel", - "modelAsString": true + "modelAsString": true, + "values": [ + { + "value": "Purgeable", + "description": "Denotes a vault state in which deletion is an irreversible operation, without the possibility for recovery. This level corresponds to no protection being available against a Delete operation; the data is irretrievably lost upon accepting a Delete operation at the entity level or higher (vault, resource group, subscription etc.)" + }, + { + "value": "Recoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval (90 days), unless a Purge operation is requested, or the subscription is cancelled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge). This level guarantees the recoverability of the deleted entity during the retention interval(90 days) and while the subscription is still available. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "Recoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable within retention interval (90 days), immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled. System wil permanently delete it after 90 days, if not recovered" + }, + { + "value": "CustomizedRecoverable+Purgeable", + "description": "Denotes a vault state in which deletion is recoverable, and which also permits immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90). This level guarantees the recoverability of the deleted entity during the retention interval, unless a Purge operation is requested, or the subscription is cancelled." + }, + { + "value": "CustomizedRecoverable", + "description": "Denotes a vault state in which deletion is recoverable without the possibility for immediate and permanent deletion (i.e. purge when 7<= SoftDeleteRetentionInDays < 90).This level guarantees the recoverability of the deleted entity during the retention interval and while the subscription is still available." + }, + { + "value": "CustomizedRecoverable+ProtectedSubscription", + "description": "Denotes a vault and subscription state in which deletion is recoverable, immediate and permanent deletion (i.e. purge) is not permitted, and in which the subscription itself cannot be permanently canceled when 7<= SoftDeleteRetentionInDays < 90. This level guarantees the recoverability of the deleted entity during the retention interval, and also reflects the fact that the subscription itself cannot be cancelled." + } + ] }, "readOnly": true, "x-nullable": false From 779901887270ddc63e179c327094ce132e1e0326 Mon Sep 17 00:00:00 2001 From: Ryan K Date: Tue, 23 Jun 2020 18:20:36 -0700 Subject: [PATCH 189/318] DigitalTwins - Update Typescript readme for SDK generation (#9935) Co-authored-by: Ryan Kelly --- .../digitaltwins/resource-manager/readme.typescript.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/digitaltwins/resource-manager/readme.typescript.md b/specification/digitaltwins/resource-manager/readme.typescript.md index 3154decaf68e..f47cbf0161ed 100644 --- a/specification/digitaltwins/resource-manager/readme.typescript.md +++ b/specification/digitaltwins/resource-manager/readme.typescript.md @@ -6,8 +6,8 @@ Please also specify `--typescript-sdks-folder= Date: Wed, 24 Jun 2020 10:06:27 +0800 Subject: [PATCH 190/318] update imagebuilder typescript readme for release (#9944) Co-authored-by: Shixun Guan --- .../imagebuilder/resource-manager/readme.typescript.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/imagebuilder/resource-manager/readme.typescript.md b/specification/imagebuilder/resource-manager/readme.typescript.md index 8e1c3fa62e96..2745da3778ab 100644 --- a/specification/imagebuilder/resource-manager/readme.typescript.md +++ b/specification/imagebuilder/resource-manager/readme.typescript.md @@ -7,7 +7,7 @@ Please also specify `--typescript-sdks-folder= Date: Tue, 23 Jun 2020 23:07:07 -0700 Subject: [PATCH 191/318] Add new parameters (#9415) * preferred type and vm resoure id * spelling * remove get activeApp, get appGroupAssignments * pr comments * fix example --- .../desktopvirtualization.json | 142 +++++------------- .../ActiveApplication_ListBySessionHost.json | 52 ------- ...ionGroupAssignment_WorkspaceLevelList.json | 51 ------- .../examples/HostPool_Create.json | 9 +- .../examples/HostPool_Get.json | 3 +- .../examples/HostPool_List.json | 6 +- .../HostPool_ListByResourceGroup.json | 6 +- .../examples/HostPool_Update.json | 3 +- .../examples/SessionHost_Delete.json | 3 +- .../examples/SessionHost_Get.json | 3 +- .../examples/SessionHost_List.json | 6 +- .../examples/SessionHost_Update.json | 3 +- .../desktopvirtualization.json | 142 +++++------------- .../ActiveApplication_ListBySessionHost.json | 52 ------- ...ionGroupAssignment_WorkspaceLevelList.json | 51 ------- .../examples/HostPool_Create.json | 9 +- .../examples/HostPool_Get.json | 3 +- .../examples/HostPool_List.json | 6 +- .../HostPool_ListByResourceGroup.json | 6 +- .../examples/HostPool_Update.json | 3 +- .../desktopvirtualization.json | 142 +++++------------- .../ActiveApplication_ListBySessionHost.json | 52 ------- ...ionGroupAssignment_WorkspaceLevelList.json | 51 ------- .../examples/HostPool_Create.json | 9 +- .../examples/HostPool_Get.json | 3 +- .../examples/HostPool_List.json | 6 +- .../HostPool_ListByResourceGroup.json | 6 +- .../examples/HostPool_Update.json | 3 +- .../examples/SessionHost_Delete.json | 3 +- .../examples/SessionHost_Get.json | 3 +- .../examples/SessionHost_List.json | 6 +- .../examples/SessionHost_Update.json | 3 +- 32 files changed, 176 insertions(+), 670 deletions(-) delete mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ActiveApplication_ListBySessionHost.json delete mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json delete mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ActiveApplication_ListBySessionHost.json delete mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json delete mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ActiveApplication_ListBySessionHost.json delete mode 100644 specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json index 461026a2fdfa..35d3387dcbf0 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json @@ -320,58 +320,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/userApplicationGroupAssignments": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroupAssignments_WorkspaceLevelList", - "description": "List application group that user can use.", - "x-ms-examples": { - "ApplicationGroupAssignment_WorkspaceLevelList": { - "$ref": "./examples/ApplicationGroupAssignment_WorkspaceLevelList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are applicationGroupType." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user application group assignments in workspace.", - "schema": { - "$ref": "#/definitions/ApplicationGroupList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { "get": { "tags": [ @@ -1598,61 +1546,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/activeApplications": { - "get": { - "tags": [ - "Application" - ], - "operationId": "ActiveApplications_ListBySessionHost", - "description": "List applications for the given session host.", - "x-ms-examples": { - "ActiveApplications_List": { - "$ref": "./examples/ActiveApplication_ListBySessionHost.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved active applications in session host.", - "schema": { - "$ref": "#/definitions/ApplicationList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { "get": { "tags": [ @@ -2191,7 +2084,8 @@ "required": [ "hostPoolType", "personalDesktopAssignmentType", - "loadBalancerType" + "loadBalancerType", + "preferredAppGroupType" ], "properties": { "friendlyName": { @@ -2277,6 +2171,20 @@ "ssoContext": { "type": "string", "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "x-nullable": false } } }, @@ -2360,6 +2268,19 @@ "ssoContext": { "type": "string", "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group" } } }, @@ -2778,6 +2699,11 @@ "type": "boolean", "description": "Allow a new session." }, + "virtualMachineId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, "assignedUser": { "type": "string", "description": "User assigned to SessionHost." diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ActiveApplication_ListBySessionHost.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ActiveApplication_ListBySessionHost.json deleted file mode 100644 index 5df22a508d50..000000000000 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ActiveApplication_ListBySessionHost.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-01-23-preview", - "$filter": "userPrincipalName eq 'user1@microsoft.com'" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - }, - { - "name": "applicationGroup1/application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des2", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - ] - } - } - } -} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json deleted file mode 100644 index 9846c97f6936..000000000000 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-01-23-preview", - "$filter": "userPrincipalName eq 'user1@microsoft.com'" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - }, - { - "name": "applicationGroup2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - ] - } - } - } -} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Create.json index 1aa50229fc28..3c08b9ce934b 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Create.json @@ -22,7 +22,8 @@ "expirationTime": "2008-09-22T14:01:54.9571247Z", "resetToken": true }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } }, @@ -52,7 +53,8 @@ "token": "token", "resetToken": true }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } }, @@ -81,7 +83,8 @@ "token": "token", "resetToken": true }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Get.json index 83915696ba13..d286a94ffd5c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Get.json @@ -31,7 +31,8 @@ "token": "token", "resetToken": false }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_List.json index 3b8929f94dd4..ae01bb585437 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_List.json @@ -31,7 +31,8 @@ "token": "token", "resetToken": false }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } }, { @@ -58,7 +59,8 @@ "token": "token", "resetToken": false }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_ListByResourceGroup.json index e8ad41224d96..9b804e395c6a 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_ListByResourceGroup.json @@ -32,7 +32,8 @@ "token": "token", "resetToken": false }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } }, { @@ -59,7 +60,8 @@ "token": "token", "resetToken": false }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Update.json index f82f0feaea5b..6593f5e1cb0a 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/HostPool_Update.json @@ -49,7 +49,8 @@ "token": "token", "resetToken": false }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json index 6d95001e8311..864b4679d0dd 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json @@ -24,7 +24,8 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, "204": {} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json index 07246deb3a64..b7479a52e40c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json @@ -24,7 +24,8 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json index 2618ca58698c..d3785e2a04da 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json @@ -25,7 +25,8 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, { @@ -44,7 +45,8 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json index 794cb51fc0c5..199ee8fb5420 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json @@ -30,7 +30,8 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json index d75ddf4291a2..ebef3d61d55a 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json @@ -320,58 +320,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/userApplicationGroupAssignments": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroupAssignments_WorkspaceLevelList", - "description": "List application group that user can use.", - "x-ms-examples": { - "ApplicationGroupAssignment_WorkspaceLevelList": { - "$ref": "./examples/ApplicationGroupAssignment_WorkspaceLevelList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are applicationGroupType." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user application group assignments in workspace.", - "schema": { - "$ref": "#/definitions/ApplicationGroupList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { "get": { "tags": [ @@ -1598,61 +1546,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/activeApplications": { - "get": { - "tags": [ - "Application" - ], - "operationId": "ActiveApplications_ListBySessionHost", - "description": "List applications for the given session host.", - "x-ms-examples": { - "ActiveApplications_List": { - "$ref": "./examples/ActiveApplication_ListBySessionHost.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved active applications in session host.", - "schema": { - "$ref": "#/definitions/ApplicationList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { "get": { "tags": [ @@ -2191,7 +2084,8 @@ "required": [ "hostPoolType", "personalDesktopAssignmentType", - "loadBalancerType" + "loadBalancerType", + "preferredAppGroupType" ], "properties": { "friendlyName": { @@ -2277,6 +2171,20 @@ "ssoContext": { "type": "string", "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "x-nullable": false } } }, @@ -2360,6 +2268,19 @@ "ssoContext": { "type": "string", "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group" } } }, @@ -2797,6 +2718,11 @@ "type": "boolean", "description": "Allow a new session." }, + "virtualMachineId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, "assignedUser": { "type": "string", "description": "User assigned to SessionHost." diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ActiveApplication_ListBySessionHost.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ActiveApplication_ListBySessionHost.json deleted file mode 100644 index 9f1476eecd78..000000000000 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ActiveApplication_ListBySessionHost.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-09-24-preview", - "$filter": "userPrincipalName eq 'user1@microsoft.com'" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - }, - { - "name": "applicationGroup1/application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des2", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - ] - } - } - } -} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json deleted file mode 100644 index 0ff08ef95927..000000000000 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-09-24-preview", - "$filter": "userPrincipalName eq 'user1@microsoft.com'" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - }, - { - "name": "applicationGroup2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - ] - } - } - } -} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Create.json index daf9dee27580..269f61ac668d 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Create.json @@ -22,7 +22,8 @@ "expirationTime": "2008-09-22T14:01:54.9571247Z", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } }, @@ -52,7 +53,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } }, @@ -81,7 +83,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Get.json index 10e6a4a383ac..6e71147a4055 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Get.json @@ -31,7 +31,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_List.json index f29f8537eb5a..d19d95f0785c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_List.json @@ -31,7 +31,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } }, { @@ -58,7 +59,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_ListByResourceGroup.json index 1dec6d177630..3aa6110aa76f 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_ListByResourceGroup.json @@ -32,7 +32,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } }, { @@ -59,7 +60,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Update.json index 18d1ca279723..d13bcaee2943 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/HostPool_Update.json @@ -49,7 +49,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json index 0948a6244957..4e3df1be3b22 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json @@ -320,58 +320,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/workspaces/{workspaceName}/userApplicationGroupAssignments": { - "get": { - "tags": [ - "ApplicationGroup" - ], - "operationId": "ApplicationGroupAssignments_WorkspaceLevelList", - "description": "List application group that user can use.", - "x-ms-examples": { - "ApplicationGroupAssignment_WorkspaceLevelList": { - "$ref": "./examples/ApplicationGroupAssignment_WorkspaceLevelList.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/WorkspaceNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are applicationGroupType." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved user application group assignments in workspace.", - "schema": { - "$ref": "#/definitions/ApplicationGroupList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/applicationGroups/{applicationGroupName}": { "get": { "tags": [ @@ -1598,61 +1546,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/activeApplications": { - "get": { - "tags": [ - "Application" - ], - "operationId": "ActiveApplications_ListBySessionHost", - "description": "List applications for the given session host.", - "x-ms-examples": { - "ActiveApplications_List": { - "$ref": "./examples/ActiveApplication_ListBySessionHost.json" - } - }, - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/HostPoolNameParameter" - }, - { - "$ref": "#/parameters/SessionHostNameParameter" - }, - { - "name": "$filter", - "in": "query", - "required": false, - "type": "string", - "description": "OData filter expression. Valid properties for filtering are userprincipalname and sessionstate." - } - ], - "responses": { - "200": { - "description": "Successfully retrieved active applications in session host.", - "schema": { - "$ref": "#/definitions/ApplicationList" - } - }, - "default": { - "description": "Automation error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DesktopVirtualization/hostPools/{hostPoolName}/sessionHosts/{sessionHostName}/userSessions/{userSessionId}": { "get": { "tags": [ @@ -2199,7 +2092,8 @@ "required": [ "hostPoolType", "personalDesktopAssignmentType", - "loadBalancerType" + "loadBalancerType", + "preferredAppGroupType" ], "properties": { "friendlyName": { @@ -2285,6 +2179,20 @@ "ssoContext": { "type": "string", "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group", + "x-nullable": false } } }, @@ -2371,6 +2279,19 @@ "ssoContext": { "type": "string", "description": "Path to keyvault containing ssoContext secret." + }, + "preferredAppGroupType": { + "enum": [ + "None", + "Desktop", + "RailApplications" + ], + "x-ms-enum": { + "name": "PreferredAppGroupType", + "modelAsString": true + }, + "type": "string", + "description": "The type of preferred application group type, default to Desktop Application Group" } } }, @@ -2820,6 +2741,11 @@ "type": "boolean", "description": "Allow a new session." }, + "virtualMachineId": { + "type": "string", + "description": "Resource Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, "assignedUser": { "type": "string", "description": "User assigned to SessionHost." diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ActiveApplication_ListBySessionHost.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ActiveApplication_ListBySessionHost.json deleted file mode 100644 index 973e60d06849..000000000000 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ActiveApplication_ListBySessionHost.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "hostPoolName": "hostPool1", - "sessionHostName": "sessionHost1.microsoft.com", - "api-version": "2019-12-10-preview", - "$filter": "userPrincipalName eq 'user1@microsoft.com'" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1/application1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application1", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des1", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - }, - { - "name": "applicationGroup1/application2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1/applications/application2", - "type": "Microsoft.DesktopVirtualization/applicationGroups/applications", - "properties": { - "description": "des2", - "friendlyName": "friendly", - "filePath": "path", - "commandLineSetting": "Allow", - "commandLineArguments": "arguments", - "showInPortal": true, - "iconPath": "icon", - "iconIndex": 1, - "iconHash": "bEQ1n2HysrGxCDvgt4bfOtkET8ydzh5SXGM0KGTBPVc", - "iconContent": "AAABAAgAAAAAAAEAIAA7MwAAhgAAAEBAAAABACAAKEIAAMEzAAAwMAAAAQAgAKglAADpdQAAKCgAAAEA..." - } - } - ] - } - } - } -} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json deleted file mode 100644 index c2ee315a000d..000000000000 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/ApplicationGroupAssignment_WorkspaceLevelList.json +++ /dev/null @@ -1,51 +0,0 @@ -{ - "parameters": { - "subscriptionId": "daefabc0-95b4-48b3-b645-8a753a63c4fa", - "resourceGroupName": "resourceGroup1", - "workspaceName": "workspace1", - "api-version": "2019-12-10-preview", - "$filter": "userPrincipalName eq 'user1@microsoft.com'" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "applicationGroup1", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup1", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - }, - { - "name": "applicationGroup2", - "id": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/applicationGroups/applicationGroup2", - "type": "Microsoft.DesktopVirtualization/applicationGroups", - "location": "centralus", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "properties": { - "description": "des1", - "friendlyName": "friendly", - "hostPoolArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/hostPools/hostPool1", - "workspaceArmPath": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.DesktopVirtualization/workspaces/workspace1", - "applicationGroupType": "RemoteApp" - } - } - ] - } - } - } -} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json index 66b79818e853..12ea67762e9d 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Create.json @@ -22,7 +22,8 @@ "expirationTime": "2020-10-01T14:01:54.9571247Z", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } }, @@ -52,7 +53,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } }, @@ -81,7 +83,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json index 73d515fb1992..fb86c3da15ee 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Get.json @@ -31,7 +31,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json index e20d8baf3afb..69ef8301a370 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_List.json @@ -31,7 +31,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } }, { @@ -58,7 +59,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json index 02e45253849c..933bf9839591 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_ListByResourceGroup.json @@ -32,7 +32,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } }, { @@ -59,7 +60,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json index 0993e2d985a4..833bf8716bbf 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/HostPool_Update.json @@ -50,7 +50,8 @@ "token": "token", "registrationTokenOperation": "Update" }, - "ssoContext": "KeyVaultPath" + "ssoContext": "KeyVaultPath", + "preferredAppGroupType": "Desktop" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json index 3755a7e1ce7f..38eb21d3c27d 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json @@ -24,7 +24,8 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, "204": {} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json index d0372897c33e..b573d742ae87 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json @@ -24,7 +24,8 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json index e00397e9da1f..ccd0e643edf1 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json @@ -25,7 +25,8 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, { @@ -44,7 +45,8 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json index 6b4d3500d06d..f97b52c68eb4 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json @@ -30,7 +30,8 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } From 37a9ad811219323006f37f4a3649e81188f2f1cc Mon Sep 17 00:00:00 2001 From: Subrahmanyam Mandavilli Date: Wed, 24 Jun 2020 01:56:46 -0700 Subject: [PATCH 192/318] CMK Support for Databricks (#9869) --- .../stable/2018-04-01/databricks.json | 91 +++++++++++- .../examples/DisableEncryption.json | 130 ++++++++++++++++ .../2018-04-01/examples/EnableEncryption.json | 139 ++++++++++++++++++ .../examples/PrepareEncryption.json | 100 +++++++++++++ 4 files changed, 459 insertions(+), 1 deletion(-) create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/DisableEncryption.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/EnableEncryption.json create mode 100644 specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/PrepareEncryption.json diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json index 26055abe6cff..3c76405d3f4f 100644 --- a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/databricks.json @@ -134,6 +134,15 @@ }, "Create or update workspace with custom parameters": { "$ref": "./examples/WorkspaceCreateWithParameters.json" + }, + "Create a workspace which is ready for Customer-Managed Key (CMK) encryption": { + "$ref": "./examples/PrepareEncryption.json" + }, + "Enable Customer-Managed Key (CMK) encryption on a workspace which is prepared for encryption": { + "$ref": "./examples/EnableEncryption.json" + }, + "Revert Customer-Managed Key (CMK) encryption to Microsoft Managed Keys encryption on a workspace": { + "$ref": "./examples/DisableEncryption.json" } }, "parameters": [ @@ -466,7 +475,8 @@ "$ref": "#/definitions/ErrorResponse" } } - } + }, + "x-ms-long-running-operation": true } }, "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Databricks/workspaces/{workspaceName}/virtualNetworkPeerings": { @@ -621,6 +631,10 @@ "readOnly": true, "description": "The workspace URL which is of the format 'adb-{workspaceId}.{random}.azuredatabricks.net'", "type": "string" + }, + "storageAccountIdentity": { + "description": "The details of Managed Identity of Storage Account", + "$ref": "#/definitions/ManagedIdentityConfiguration" } }, "required": [ @@ -735,6 +749,28 @@ "modelAsString": true } }, + "ManagedIdentityConfiguration": { + "description": "The Managed Identity details for storage account.", + "properties": { + "principalId": { + "type": "string", + "format": "uuid", + "description": "The objectId of the Managed Identity that is linked to the Managed Storage account.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "format": "uuid", + "description": "The tenant Id where the Managed Identity is created.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "The type of Identity created. It can be either SystemAssigned or UserAssigned.", + "readOnly": true + } + } + }, "WorkspaceCustomParameterType": { "description": "Provisioning status of the workspace.", "readOnly": true, @@ -814,6 +850,14 @@ "enableNoPublicIp": { "$ref": "#/definitions/WorkspaceCustomBooleanParameter", "description": "Should the Public IP be Disabled?" + }, + "prepareEncryption": { + "$ref": "#/definitions/WorkspaceCustomBooleanParameter", + "description": "Prepare the workspace for encryption. Enables the Managed Identity for managed storage account." + }, + "encryption": { + "$ref": "#/definitions/WorkspaceEncryptionParameter", + "description": "Contains the encryption details for Customer-Managed Key (CMK) enabled workspace." } }, "description": "Custom Parameters used for Cluster Creation." @@ -846,6 +890,51 @@ }, "description": "Provides details of the entity that created/updated the workspace." }, + "WorkspaceEncryptionParameter": { + "properties": { + "type": { + "$ref": "#/definitions/WorkspaceCustomParameterType", + "description": "The type of variable that this is" + }, + "value": { + "$ref": "#/definitions/Encryption", + "description": "The value which should be used for this field." + } + }, + "description": "The object that contains details of encryption used on the workspace." + }, + "Encryption": { + "properties": { + "keySource": { + "type": "string", + "description": "The encryption keySource (provider). Possible values (case-insensitive): Default, Microsoft.Keyvault", + "enum": [ + "Default", + "Microsoft.Keyvault" + ], + "x-ms-enum": { + "name": "KeySource", + "modelAsString": true + }, + "default": "Default" + }, + "KeyName": { + "type": "string", + "description": "The name of KeyVault key." + }, + "keyversion": { + "type": "string", + "description": "The version of KeyVault key.", + "x-ms-client-name": "KeyVersion" + }, + "keyvaulturi": { + "type": "string", + "description": "The Uri of KeyVault.", + "x-ms-client-name": "KeyVaultUri" + } + }, + "description": "The object that contains details of encryption used on the workspace." + }, "WorkspaceProviderAuthorization": { "properties": { "principalId": { diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/DisableEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/DisableEncryption.json new file mode 100644 index 000000000000..18b5d4db6e79 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/DisableEncryption.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2018-04-01", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "encryption": { + "value": { + "keySource": "Default" + } + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "prepareEncryption": { + "type": "Bool", + "value": true + }, + "encryption": { + "type": "Object", + "value": { + "keySource": "Default" + } + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + } + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/EnableEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/EnableEncryption.json new file mode 100644 index 000000000000..efad023312fe --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/EnableEncryption.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2018-04-01", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "prepareEncryption": { + "value": true + }, + "encryption": { + "value": { + "keySource": "Microsoft.Keyvault", + "keyvaulturi": "https://myKeyVault.vault.azure.net/", + "KeyName": "myKeyName", + "keyversion": "00000000000000000000000000000000" + } + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "customPrivateSubnetName": { + "type": "String", + "value": "PrivateBob" + }, + "customPublicSubnetName": { + "type": "String", + "value": "PublicSarah" + }, + "customVirtualNetworkId": { + "type": "String", + "value": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/myNetwork" + }, + "prepareEncryption": { + "type": "Bool", + "value": true + }, + "encryption": { + "type": "Object", + "value": { + "keySource": "Microsoft.Keyvault", + "keyvaulturi": "https://myKeyVault.vault.azure.net/", + "KeyName": "myKeyName", + "keyversion": "00000000000000000000000000000000" + } + } + }, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + }, + "201": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + } + } + } + } + } +} diff --git a/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/PrepareEncryption.json b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/PrepareEncryption.json new file mode 100644 index 000000000000..f9b891f1d616 --- /dev/null +++ b/specification/databricks/resource-manager/Microsoft.Databricks/stable/2018-04-01/examples/PrepareEncryption.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg", + "workspaceName": "myWorkspace", + "api-version": "2018-04-01", + "parameters": { + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": { + "prepareEncryption": { + "value": true + } + } + }, + "location": "westus" + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "sku": { + "name": "premium" + }, + "location": "East US 2", + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Succeeded", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "storageAccountIdentity": { + "principalId": "55555555-5555-5555-5555-555555555555", + "tenantId": "66666666-6666-6666-6666-666666666666", + "type": "SystemAssigned" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z", + "workspaceId": "5555555555555555", + "workspaceUrl": "adb-5555555555555555.19.azuredatabricks.net" + } + } + }, + "201": { + "body": { + "name": "myWorkspace", + "id": "/subscriptions/subid/resourceGroups/rg/providers/Microsoft.Databricks/workspaces/myWorkspace", + "type": "Microsoft.Databricks/workspaces", + "location": "East US 2", + "tags": { + "environment": "dev" + }, + "sku": { + "name": "premium" + }, + "properties": { + "managedResourceGroupId": "/subscriptions/subid/resourceGroups/myManagedRG", + "parameters": null, + "provisioningState": "Accepted", + "uiDefinitionUri": "https://path/to/workspaceCreateUiDefinition.json", + "authorizations": [ + { + "principalId": "00000000-0000-0000-0000-000000000000", + "roleDefinitionId": "11111111-1111-1111-1111-111111111111" + } + ], + "createdBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "updatedBy": { + "oid": "22222222-2222-2222-2222-222222222222", + "puid": "33333333", + "applicationId": "44444444-4444-4444-4444-444444444444" + }, + "createdDateTime": "2020-02-20T00:10:29.2858439Z" + } + } + } + } +} From bd1854c16aa96980fa7cc520cd49e0e36e2f9ac2 Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Wed, 24 Jun 2020 18:22:23 +0800 Subject: [PATCH 193/318] disable create/delete/update (#9950) --- .../guestconfiguration/resource-manager/readme.az.md | 4 +++- 1 file changed, 3 insertions(+), 1 deletion(-) diff --git a/specification/guestconfiguration/resource-manager/readme.az.md b/specification/guestconfiguration/resource-manager/readme.az.md index 319a17cc5022..3041965528d8 100644 --- a/specification/guestconfiguration/resource-manager/readme.az.md +++ b/specification/guestconfiguration/resource-manager/readme.az.md @@ -17,5 +17,7 @@ cli: prop: 'properties' flatten: true - + - where: + op: 'CreateOrUpdate#Create|Delete|CreateOrUpdate#Update' + hidden: true ``` From e3649e8df7877a6d01f67f673254b6cb75d26d81 Mon Sep 17 00:00:00 2001 From: giakas Date: Wed, 24 Jun 2020 10:57:51 -0700 Subject: [PATCH 194/318] Microsoft.media new version 2020 05 01 (#9889) * Adds base for updating Microsoft.Media from version stable/2018-07-01 to version 2020-05-01 * Updates readme * Updates API version in new specs and examples * Updating the some swagger files to new version. * Update to latest swaggers and fix some examples. * fix prettier issue * fix some linter issues * fix spell check. * Add a supression for R2016 linter rule, which was failing for "Properties of a PATCH request body must not be required. PATCH operation: 'LiveEvents_Update' Model Definition: 'TrackedResource' Property: 'location'" * Fix a validation error * add 204 for the delete account. * Move ApiError and ODataError to a different file, as autorest v3 is complaining about duplicate --- custom-words.txt | 3 + .../stable/2020-05-01/AccountFilters.json | 514 ++++ .../stable/2020-05-01/Accounts.json | 1410 ++++++++++ .../2020-05-01/AssetsAndAssetFilters.json | 1238 +++++++++ .../stable/2020-05-01/Common.json | 56 + .../stable/2020-05-01/ContentKeyPolicies.json | 1169 ++++++++ .../stable/2020-05-01/Encoding.json | 2445 +++++++++++++++++ ...StreamingPoliciesAndStreamingLocators.json | 1254 +++++++++ .../examples/accountFilters-create.json | 171 ++ .../examples/accountFilters-delete.json | 13 + .../examples/accountFilters-get-by-name.json | 56 + .../examples/accountFilters-list-all.json | 111 + .../examples/accountFilters-update.json | 81 + .../accounts-check-name-availability.json | 20 + .../2020-05-01/examples/accounts-create.json | 67 + .../2020-05-01/examples/accounts-delete.json | 12 + .../examples/accounts-get-by-name.json | 31 + .../examples/accounts-list-all-accounts.json | 53 + .../accounts-list-media-edge-policies.json | 27 + .../accounts-subscription-get-by-name.json | 31 + ...counts-subscription-list-all-accounts.json | 72 + .../examples/accounts-sync-storage-keys.json | 14 + .../2020-05-01/examples/accounts-update.json | 36 + .../examples/assetFilters-create.json | 172 ++ .../examples/assetFilters-delete.json | 14 + .../examples/assetFilters-get-by-name.json | 68 + .../examples/assetFilters-list-all.json | 131 + .../examples/assetFilters-update.json | 82 + .../2020-05-01/examples/assets-create.json | 49 + .../2020-05-01/examples/assets-delete.json | 13 + .../examples/assets-get-by-name.json | 28 + .../examples/assets-get-encryption-keys.json | 33 + .../2020-05-01/examples/assets-list-all.json | 101 + .../examples/assets-list-by-date.json | 102 + .../examples/assets-list-in-date-range.json | 60 + .../examples/assets-list-sas-urls.json | 23 + .../assets-list-streaming-locators.json | 33 + .../2020-05-01/examples/assets-update.json | 32 + ...-key-policies-create-multiple-options.json | 134 + ...ntent-key-policies-create-nodrm-token.json | 102 + ...nt-key-policies-create-playready-open.json | 131 + ...nt-key-policies-create-widevine-token.json | 124 + .../examples/content-key-policies-delete.json | 13 + .../content-key-policies-get-by-name.json | 63 + ...content-key-policies-get-with-secrets.json | 58 + .../content-key-policies-list-all.json | 165 ++ ...ent-key-policies-list-by-lastModified.json | 144 + ...ntent-key-policies-list-in-date-range.json | 16 + .../examples/content-key-policies-update.json | 52 + .../2020-05-01/examples/jobs-cancel.json | 13 + .../2020-05-01/examples/jobs-create.json | 61 + .../2020-05-01/examples/jobs-delete.json | 14 + .../2020-05-01/examples/jobs-get-by-name.json | 46 + .../jobs-list-all-filter-by-created.json | 87 + .../jobs-list-all-filter-by-lastmodified.json | 87 + ...obs-list-all-filter-by-name-and-state.json | 53 + .../jobs-list-all-filter-by-name.json | 83 + .../jobs-list-all-filter-by-state-eq.json | 84 + .../jobs-list-all-filter-by-state-ne.json | 84 + .../2020-05-01/examples/jobs-list-all.json | 116 + .../2020-05-01/examples/jobs-update.json | 69 + .../2020-05-01/examples/liveevent-create.json | 140 + .../2020-05-01/examples/liveevent-delete.json | 62 + .../examples/liveevent-list-all.json | 75 + .../examples/liveevent-list-by-name.json | 72 + .../2020-05-01/examples/liveevent-reset.json | 13 + .../2020-05-01/examples/liveevent-start.json | 13 + .../2020-05-01/examples/liveevent-stop.json | 16 + .../2020-05-01/examples/liveevent-update.json | 134 + .../examples/liveoutput-create.json | 65 + .../examples/liveoutput-delete.json | 15 + .../examples/liveoutput-list-all.json | 36 + .../examples/liveoutput-list-by-name.json | 34 + .../examples/operations-list-all.json | 589 ++++ .../private-endpoint-connection-delete.json | 12 + ...ivate-endpoint-connection-get-by-name.json | 28 + .../private-endpoint-connection-list.json | 46 + .../private-endpoint-connection-put.json | 36 + .../private-link-resources-get-by-name.json | 24 + .../examples/private-link-resources-list.json | 27 + .../streaming-locators-create-clear.json | 32 + ...-create-secure-userDefinedContentKeys.json | 69 + .../streaming-locators-create-secure.json | 54 + .../examples/streaming-locators-delete.json | 13 + .../streaming-locators-get-by-name.json | 27 + .../streaming-locators-list-content-keys.json | 41 + ...ors-list-paths-streaming-and-download.json | 50 + ...ng-locators-list-paths-streaming-only.json | 72 + .../examples/streaming-locators-list.json | 42 + .../streaming-policies-create-clear.json | 41 + ...cies-create-commonEncryptionCbcs-only.json | 67 + ...cies-create-commonEncryptionCenc-only.json | 94 + ...licies-create-envelopeEncryption-only.json | 57 + ...ming-policies-create-secure-streaming.json | 164 ++ .../examples/streaming-policies-delete.json | 13 + .../examples/streaming-policies-list.json | 211 ++ .../streaming-policy-get-by-name.json | 30 + .../examples/streamingendpoint-create.json | 155 ++ .../examples/streamingendpoint-delete.json | 44 + .../examples/streamingendpoint-list-all.json | 65 + .../streamingendpoint-list-by-name.json | 40 + .../examples/streamingendpoint-scale.json | 16 + .../examples/streamingendpoint-start.json | 13 + .../examples/streamingendpoint-stop.json | 13 + .../examples/streamingendpoint-update.json | 80 + .../examples/transforms-create.json | 68 + .../examples/transforms-delete.json | 13 + .../examples/transforms-get-by-name.json | 34 + ...transforms-list-all-filter-by-created.json | 38 + ...forms-list-all-filter-by-lastmodified.json | 38 + .../transforms-list-all-filter-by-name.json | 66 + .../examples/transforms-list-all.json | 64 + .../examples/transforms-update.json | 47 + .../stable/2020-05-01/streamingservice.json | 1757 ++++++++++++ .../mediaservices/resource-manager/readme.md | 28 +- 115 files changed, 16712 insertions(+), 5 deletions(-) create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AccountFilters.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Accounts.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AssetsAndAssetFilters.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Common.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/ContentKeyPolicies.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Encoding.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/StreamingPoliciesAndStreamingLocators.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-create.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-list-all.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-update.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-check-name-availability.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-create.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-list-all-accounts.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-list-media-edge-policies.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-subscription-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-subscription-list-all-accounts.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-sync-storage-keys.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-update.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-create.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-list-all.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-update.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-create.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-get-encryption-keys.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-all.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-by-date.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-in-date-range.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-sas-urls.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-streaming-locators.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-update.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-multiple-options.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-nodrm-token.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-playready-open.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-widevine-token.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-get-with-secrets.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-all.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-by-lastModified.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-in-date-range.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-update.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-cancel.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-create.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-created.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-lastmodified.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name-and-state.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-eq.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-ne.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-update.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-create.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-list-all.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-list-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-reset.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-start.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-stop.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-update.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-create.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-list-all.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-list-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/operations-list-all.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-list.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-put.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-link-resources-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-link-resources-list.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-clear.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-secure-userDefinedContentKeys.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-secure.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-content-keys.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-paths-streaming-and-download.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-paths-streaming-only.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-clear.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-commonEncryptionCbcs-only.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-commonEncryptionCenc-only.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-envelopeEncryption-only.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-secure-streaming.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-list.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policy-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-create.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-list-all.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-list-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-scale.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-start.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-stop.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-update.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-create.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-delete.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-get-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-created.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-lastmodified.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-name.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-update.json create mode 100644 specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/streamingservice.json diff --git a/custom-words.txt b/custom-words.txt index 6330b73c3ebd..ebb305ade177 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -946,6 +946,7 @@ multistep multivalued muxed MUXes +muxer muxing mware myanalytics @@ -1154,6 +1155,7 @@ Protectable provisioner provisioningservices Psec +PSNR ptrdname publicipaddresses publicpreview @@ -1572,6 +1574,7 @@ trafficmanageranalytics trafficmanagerprofiles tráfico transcoding +transcodes transcriptmoderationresult translatortext trendingtopics diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AccountFilters.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AccountFilters.json new file mode 100644 index 000000000000..af15b438982e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AccountFilters.json @@ -0,0 +1,514 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "PresentationTimeRange": { + "properties": { + "startTimestamp": { + "type": "integer", + "format": "int64", + "description": "The absolute start time boundary." + }, + "endTimestamp": { + "type": "integer", + "format": "int64", + "description": "The absolute end time boundary." + }, + "presentationWindowDuration": { + "type": "integer", + "format": "int64", + "description": "The relative to end sliding window." + }, + "liveBackoffDuration": { + "type": "integer", + "format": "int64", + "description": "The relative to end right edge." + }, + "timescale": { + "type": "integer", + "format": "int64", + "description": "The time scale of time stamps." + }, + "forceEndTimestamp": { + "type": "boolean", + "description": "The indicator of forcing existing of end time stamp." + } + }, + "type": "object", + "description": "The presentation time range, this is asset related and not recommended for Account Filter." + }, + "FilterTrackPropertyCondition": { + "properties": { + "property": { + "type": "string", + "enum": [ + "Unknown", + "Type", + "Name", + "Language", + "FourCC", + "Bitrate" + ], + "x-ms-enum": { + "name": "FilterTrackPropertyType", + "values": [ + { + "value": "Unknown", + "description": "The unknown track property type." + }, + { + "value": "Type", + "description": "The type." + }, + { + "value": "Name", + "description": "The name." + }, + { + "value": "Language", + "description": "The language." + }, + { + "value": "FourCC", + "description": "The fourCC." + }, + { + "value": "Bitrate", + "description": "The bitrate." + } + ], + "modelAsString": true + }, + "description": "The track property type." + }, + "value": { + "type": "string", + "description": "The track property value." + }, + "operation": { + "type": "string", + "enum": [ + "Equal", + "NotEqual" + ], + "x-ms-enum": { + "name": "FilterTrackPropertyCompareOperation", + "values": [ + { + "value": "Equal", + "description": "The equal operation." + }, + { + "value": "NotEqual", + "description": "The not equal operation." + } + ], + "modelAsString": true + }, + "description": "The track property condition operation." + } + }, + "type": "object", + "required": [ + "property", + "value", + "operation" + ], + "description": "The class to specify one track property condition." + }, + "FirstQuality": { + "properties": { + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The first quality bitrate." + } + }, + "type": "object", + "required": [ + "bitrate" + ], + "description": "Filter First Quality" + }, + "FilterTrackSelection": { + "properties": { + "trackSelections": { + "type": "array", + "items": { + "$ref": "#/definitions/FilterTrackPropertyCondition" + }, + "description": "The track selections." + } + }, + "type": "object", + "required": [ + "trackSelections" + ], + "description": "Representing a list of FilterTrackPropertyConditions to select a track. The filters are combined using a logical AND operation." + }, + "MediaFilterProperties": { + "properties": { + "presentationTimeRange": { + "$ref": "#/definitions/PresentationTimeRange", + "description": "The presentation time range." + }, + "firstQuality": { + "$ref": "#/definitions/FirstQuality", + "description": "The first quality." + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/FilterTrackSelection" + }, + "description": "The tracks selection conditions." + } + }, + "type": "object", + "description": "The Media Filter properties." + }, + "AccountFilter": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MediaFilterProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "An Account Filter." + }, + "AccountFilterCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccountFilter" + }, + "description": "A collection of AccountFilter items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of AccountFilter items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/accountFilters": { + "get": { + "summary": "List Account Filters", + "description": "List Account Filters in the Media Services account.", + "operationId": "AccountFilters_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountFilterCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Account Filters": { + "$ref": "examples/accountFilters-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/accountFilters/{filterName}": { + "get": { + "summary": "Get an Account Filter.", + "description": "Get the details of an Account Filter in the Media Services account.", + "operationId": "AccountFilters_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountFilter" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Account Filter name" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Account Filter by name": { + "$ref": "examples/accountFilters-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Account Filter", + "description": "Creates or updates an Account Filter in the Media Services account.", + "operationId": "AccountFilters_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountFilter" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AccountFilter" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Account Filter name" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountFilter" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create an Account Filter": { + "$ref": "examples/accountFilters-create.json" + } + } + }, + "delete": { + "summary": "Delete an Account Filter.", + "description": "Deletes an Account Filter in the Media Services account.", + "operationId": "AccountFilters_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Account Filter name" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete an Account Filter": { + "$ref": "examples/accountFilters-delete.json" + } + } + }, + "patch": { + "summary": "Update an Account Filter", + "description": "Updates an existing Account Filter in the Media Services account.", + "operationId": "AccountFilters_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AccountFilter" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Account Filter name" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccountFilter" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update an Account Filter": { + "$ref": "examples/accountFilters-update.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Accounts.json new file mode 100644 index 000000000000..97965f6cbc65 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Accounts.json @@ -0,0 +1,1410 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "Provider": { + "description": "A resource provider.", + "properties": { + "providerName": { + "description": "The provider name.", + "type": "string" + } + }, + "type": "object", + "required": [ + "providerName" + ] + }, + "OperationDisplay": { + "properties": { + "provider": { + "type": "string", + "description": "The service provider." + }, + "resource": { + "type": "string", + "description": "Resource on which the operation is performed." + }, + "operation": { + "type": "string", + "description": "The operation type." + }, + "description": { + "type": "string", + "description": "The operation description." + } + }, + "type": "object", + "description": "Operation details." + }, + "MetricDimension": { + "properties": { + "name": { + "type": "string", + "description": "The metric dimension name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The display name for the dimension.", + "readOnly": true + }, + "toBeExportedForShoebox": { + "type": "boolean", + "description": "Whether to export metric to shoebox.", + "readOnly": true, + "x-nullable": false + } + }, + "type": "object", + "description": "A metric dimension." + }, + "MetricSpecification": { + "properties": { + "name": { + "type": "string", + "description": "The metric name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The metric display name.", + "readOnly": true + }, + "displayDescription": { + "type": "string", + "description": "The metric display description.", + "readOnly": true + }, + "unit": { + "type": "string", + "enum": [ + "Bytes", + "Count", + "Milliseconds" + ], + "x-ms-enum": { + "name": "MetricUnit", + "values": [ + { + "value": "Bytes", + "description": "The number of bytes." + }, + { + "value": "Count", + "description": "The count." + }, + { + "value": "Milliseconds", + "description": "The number of milliseconds." + } + ], + "modelAsString": true + }, + "description": "The metric unit", + "readOnly": true, + "x-nullable": false + }, + "aggregationType": { + "type": "string", + "enum": [ + "Average", + "Count", + "Total" + ], + "x-ms-enum": { + "name": "MetricAggregationType", + "values": [ + { + "value": "Average", + "description": "The average." + }, + { + "value": "Count", + "description": "The count of a number of items, usually requests." + }, + { + "value": "Total", + "description": "The sum." + } + ], + "modelAsString": true + }, + "description": "The metric aggregation type", + "readOnly": true, + "x-nullable": false + }, + "supportedAggregationTypes": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Supported aggregation types." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension" + }, + "description": "The metric dimensions.", + "readOnly": true + } + }, + "type": "object", + "description": "A metric emitted by service." + }, + "Properties": { + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications.", + "readOnly": true + } + }, + "type": "object", + "description": "The service specification property." + }, + "ServiceSpecification": { + "properties": { + "logSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + }, + "description": "List of log specifications.", + "readOnly": true + }, + "metricSpecifications": { + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + }, + "description": "List of metric specifications.", + "readOnly": true + } + }, + "type": "object", + "description": "The service metric specifications." + }, + "LogSpecification": { + "properties": { + "name": { + "type": "string", + "description": "The diagnostic log category name.", + "readOnly": true + }, + "displayName": { + "type": "string", + "description": "The diagnostic log category display name.", + "readOnly": true + }, + "blobDuration": { + "type": "string", + "description": "The time range for requests in each blob.", + "readOnly": true + } + }, + "type": "object", + "description": "A diagnostic log emitted by service." + }, + "Operation": { + "description": "An operation.", + "properties": { + "name": { + "type": "string", + "description": "The operation name." + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The operation display name." + }, + "origin": { + "type": "string", + "description": "Origin of the operation." + }, + "properties": { + "$ref": "#/definitions/Properties", + "description": "Operation properties format." + } + }, + "type": "object", + "required": [ + "name" + ] + }, + "Location": { + "properties": { + "name": { + "type": "string" + } + }, + "type": "object", + "required": [ + "name" + ] + }, + "EntityNameAvailabilityCheckOutput": { + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Specifies if the name is available." + }, + "reason": { + "type": "string", + "description": "Specifies the reason if the name is not available." + }, + "message": { + "type": "string", + "description": "Specifies the detailed reason if the name is not available." + } + }, + "type": "object", + "required": [ + "nameAvailable" + ], + "description": "The response from the check name availability request." + }, + "StorageAccount": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the storage account resource. Media Services relies on tables and queues as well as blobs, so the primary storage account must be a Standard Storage account (either Microsoft.ClassicStorage or Microsoft.Storage). Blob only storage accounts can be added as secondary storage accounts." + }, + "type": { + "type": "string", + "enum": [ + "Primary", + "Secondary" + ], + "x-ms-enum": { + "name": "StorageAccountType", + "values": [ + { + "value": "Primary", + "description": "The primary storage account for the Media Services account." + }, + { + "value": "Secondary", + "description": "A secondary storage account for the Media Services account." + } + ], + "modelAsString": true + }, + "description": "The type of the storage account." + } + }, + "type": "object", + "required": [ + "type" + ], + "description": "The storage account details." + }, + "SyncStorageKeysInput": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the storage account resource." + } + }, + "type": "object", + "description": "The input to the sync storage keys request." + }, + "MediaServiceProperties": { + "properties": { + "mediaServiceId": { + "type": "string", + "format": "uuid", + "description": "The Media Services account ID.", + "readOnly": true, + "x-nullable": false + }, + "storageAccounts": { + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "description": "The storage accounts for this resource." + }, + "storageAuthentication": { + "type": "string", + "enum": [ + "System", + "ManagedIdentity" + ], + "x-ms-enum": { + "name": "StorageAuthentication", + "values": [ + { + "value": "System", + "description": "System authentication." + }, + { + "value": "ManagedIdentity", + "description": "Managed Identity authentication." + } + ], + "modelAsString": true + }, + "x-nullable": true + }, + "encryption": { + "$ref": "#/definitions/AccountEncryption", + "description": "The account encryption properties." + } + }, + "type": "object", + "description": "Properties of the Media Services account." + }, + "MediaService": { + "description": "A Media Services account.", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MediaServiceProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/MediaServiceIdentity", + "description": "The Managed Identity for the Media Services account." + } + }, + "type": "object" + }, + "ListEdgePoliciesInput": { + "properties": { + "deviceId": { + "type": "string", + "description": "Unique identifier of the edge device." + } + }, + "type": "object" + }, + "EdgeUsageDataEventHub": { + "properties": { + "name": { + "type": "string", + "description": "Name of the Event Hub where usage will be reported." + }, + "namespace": { + "type": "string", + "description": "Namespace of the Event Hub where usage will be reported." + }, + "token": { + "type": "string", + "description": "SAS token needed to interact with Event Hub." + } + }, + "type": "object" + }, + "EdgeUsageDataCollectionPolicy": { + "properties": { + "dataCollectionFrequency": { + "type": "string", + "description": "Usage data collection frequency in ISO 8601 duration format e.g. PT10M , PT5H." + }, + "dataReportingFrequency": { + "type": "string", + "description": "Usage data reporting frequency in ISO 8601 duration format e.g. PT10M , PT5H." + }, + "maxAllowedUnreportedUsageDuration": { + "type": "string", + "description": "Maximum time for which the functionality of the device will not be hampered for not reporting the usage data." + }, + "eventHubDetails": { + "$ref": "#/definitions/EdgeUsageDataEventHub", + "description": "Details of Event Hub where the usage will be reported." + } + }, + "type": "object" + }, + "EdgePolicies": { + "properties": { + "usageDataCollectionPolicy": { + "$ref": "#/definitions/EdgeUsageDataCollectionPolicy" + } + }, + "type": "object" + }, + "MediaServiceIdentity": { + "properties": { + "type": { + "type": "string", + "enum": [ + "SystemAssigned", + "None" + ], + "x-ms-enum": { + "name": "ManagedIdentityType", + "values": [ + { + "value": "SystemAssigned", + "description": "A system-assigned managed identity." + }, + { + "value": "None", + "description": "No managed identity." + } + ], + "modelAsString": true + }, + "description": "The identity type." + }, + "principalId": { + "type": "string", + "description": "The Principal ID of the identity.", + "readOnly": true + }, + "tenantId": { + "type": "string", + "description": "The Tenant ID of the identity.", + "readOnly": true + } + }, + "type": "object", + "required": [ + "type" + ] + }, + "KeyVaultProperties": { + "properties": { + "keyIdentifier": { + "type": "string", + "description": "The URL of the Key Vault key used to encrypt the account. The key may either be versioned (for example https://vault/keys/mykey/version1) or reference a key without a version (for example https://vault/keys/mykey)." + }, + "currentKeyIdentifier": { + "type": "string", + "description": "The current key used to encrypt the Media Services account, including the key version.", + "readOnly": true + } + }, + "type": "object" + }, + "AccountEncryption": { + "properties": { + "type": { + "type": "string", + "enum": [ + "SystemKey", + "CustomerKey" + ], + "x-ms-enum": { + "name": "AccountEncryptionKeyType", + "values": [ + { + "value": "SystemKey", + "description": "The Account Key is encrypted with a System Key." + }, + { + "value": "CustomerKey", + "description": "The Account Key is encrypted with a Customer Key." + } + ], + "modelAsString": true + }, + "description": "The type of key used to encrypt the Account Key." + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "The properties of the key used to encrypt the account." + } + }, + "type": "object", + "required": [ + "type" + ] + }, + "OperationCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "A collection of Operation items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Operation items." + }, + "MediaServiceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/MediaService" + }, + "description": "A collection of MediaService items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of MediaService items." + }, + "CheckNameAvailabilityInput": { + "description": "The input to the check name availability request.", + "properties": { + "name": { + "description": "The account name.", + "type": "string" + }, + "type": { + "description": "The account type. For a Media Services account, this should be 'MediaServices'.", + "type": "string" + } + }, + "type": "object" + } + }, + "paths": { + "/providers/Microsoft.Media/operations": { + "get": { + "summary": "List Operations", + "description": "Lists all the Media Services operations.", + "operationId": "Operations_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List Operations": { + "$ref": "examples/operations-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices": { + "get": { + "summary": "List Media Services accounts", + "description": "List Media Services accounts in the resource group", + "operationId": "Mediaservices_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaServiceCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Media Services accounts": { + "$ref": "examples/accounts-list-all-accounts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}": { + "get": { + "summary": "Get a Media Services account", + "description": "Get the details of a Media Services account", + "operationId": "Mediaservices_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Media Services account by name": { + "$ref": "examples/accounts-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update a Media Services account", + "description": "Creates or updates a Media Services account", + "operationId": "Mediaservices_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MediaService" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create a Media Services account": { + "$ref": "examples/accounts-create.json" + } + } + }, + "delete": { + "summary": "Delete a Media Services account.", + "description": "Deletes a Media Services account", + "operationId": "Mediaservices_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Media Services account": { + "$ref": "examples/accounts-delete.json" + } + } + }, + "patch": { + "summary": "Update a Media Services account", + "description": "Updates an existing Media Services account", + "operationId": "Mediaservices_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MediaService" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Media Services accounts": { + "$ref": "examples/accounts-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/syncStorageKeys": { + "post": { + "summary": "Synchronizes Storage Account Keys", + "description": "Synchronizes storage account keys for a storage account associated with the Media Service account.", + "operationId": "Mediaservices_SyncStorageKeys", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SyncStorageKeysInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Synchronizes Storage Account Keys": { + "$ref": "examples/accounts-sync-storage-keys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/listEdgePolicies": { + "post": { + "summary": "List the media edge policies associated with the Media Services account.", + "description": "List the media edge policies associated with the Media Services account.", + "operationId": "Mediaservices_ListEdgePolicies", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EdgePolicies" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ListEdgePoliciesInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List the media edge policies.": { + "$ref": "examples/accounts-list-media-edge-policies.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateLinkResources": { + "get": { + "summary": "Get list of group IDs.", + "description": "Get list of group IDs.", + "operationId": "PrivateLinkResources_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get list of all group IDs.": { + "$ref": "examples/private-link-resources-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateLinkResources/{name}": { + "get": { + "summary": "Get group ID.", + "description": "Get group ID.", + "operationId": "PrivateLinkResources_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get details of a group ID.": { + "$ref": "examples/private-link-resources-get-by-name.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateEndpointConnections": { + "get": { + "summary": "Get all private endpoint connections.", + "description": "Get all private endpoint connections.", + "operationId": "PrivateEndpointConnections_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get all private endpoint connections.": { + "$ref": "examples/private-endpoint-connection-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/privateEndpointConnections/{name}": { + "get": { + "summary": "Get private endpoint connection.", + "description": "Get private endpoint connection.", + "operationId": "PrivateEndpointConnections_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get private endpoint connection.": { + "$ref": "examples/private-endpoint-connection-get-by-name.json" + } + } + }, + "put": { + "summary": "Update private endpoint connection.", + "description": "Update private endpoint connection.", + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "../../../../../common-types/resource-management/v1/privatelinks.json#/definitions/PrivateEndpointConnection" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update private endpoint connection.": { + "$ref": "examples/private-endpoint-connection-put.json" + } + } + }, + "delete": { + "summary": "Delete private endpoint connection.", + "description": "Delete private endpoint connection.", + "operationId": "PrivateEndpointConnections_Delete", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name." + }, + { + "name": "name", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete private endpoint connection.": { + "$ref": "examples/private-endpoint-connection-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/locations/{locationName}/checkNameAvailability": { + "post": { + "summary": "Check Name Availability", + "description": "Checks whether the Media Service resource name is available.", + "operationId": "Locations_CheckNameAvailability", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/EntityNameAvailabilityCheckOutput" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "name": "locationName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the location" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Check Name Availability": { + "$ref": "examples/accounts-check-name-availability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/mediaservices": { + "get": { + "summary": "List Media Services accounts", + "description": "List Media Services accounts in the subscription.", + "operationId": "Mediaservices_ListBySubscription", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaServiceCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Media Services accounts": { + "$ref": "examples/accounts-subscription-list-all-accounts.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Media/mediaservices/{accountName}": { + "get": { + "summary": "Get a Media Services account", + "description": "Get the details of a Media Services account", + "operationId": "Mediaservices_GetBySubscription", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/MediaService" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "description": "The Media Services account name.", + "name": "accountName", + "in": "path", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Media Services account by name": { + "$ref": "examples/accounts-subscription-get-by-name.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AssetsAndAssetFilters.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AssetsAndAssetFilters.json new file mode 100644 index 000000000000..434cb58d9fe2 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/AssetsAndAssetFilters.json @@ -0,0 +1,1238 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "AssetProperties": { + "properties": { + "assetId": { + "type": "string", + "format": "uuid", + "description": "The Asset ID.", + "readOnly": true, + "x-nullable": false + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation date of the Asset.", + "readOnly": true, + "x-nullable": false + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified date of the Asset.", + "readOnly": true, + "x-nullable": false + }, + "alternateId": { + "type": "string", + "description": "The alternate ID of the Asset." + }, + "description": { + "type": "string", + "description": "The Asset description." + }, + "container": { + "type": "string", + "description": "The name of the asset blob container." + }, + "storageAccountName": { + "type": "string", + "description": "The name of the storage account." + }, + "storageEncryptionFormat": { + "type": "string", + "enum": [ + "None", + "MediaStorageClientEncryption" + ], + "x-ms-enum": { + "name": "AssetStorageEncryptionFormat", + "values": [ + { + "value": "None", + "description": "The Asset does not use client-side storage encryption (this is the only allowed value for new Assets)." + }, + { + "value": "MediaStorageClientEncryption", + "description": "The Asset is encrypted with Media Services client-side encryption." + } + ], + "modelAsString": true + }, + "description": "The Asset encryption format. One of None or MediaStorageEncryption.", + "readOnly": true, + "x-nullable": false + } + }, + "type": "object", + "description": "The Asset properties." + }, + "AssetContainerSas": { + "properties": { + "assetContainerSasUrls": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of Asset container SAS URLs." + } + }, + "type": "object", + "description": "The Asset Storage container SAS URLs." + }, + "AssetFileEncryptionMetadata": { + "properties": { + "initializationVector": { + "type": "string", + "description": "The Asset File initialization vector." + }, + "assetFileName": { + "type": "string", + "description": "The Asset File name." + }, + "assetFileId": { + "type": "string", + "format": "uuid", + "description": "The Asset File Id." + } + }, + "type": "object", + "required": [ + "assetFileId" + ], + "description": "The Asset File Storage encryption metadata." + }, + "StorageEncryptedAssetDecryptionData": { + "properties": { + "key": { + "type": "string", + "format": "byte", + "description": "The Asset File storage encryption key." + }, + "assetFileEncryptionMetadata": { + "type": "array", + "items": { + "$ref": "#/definitions/AssetFileEncryptionMetadata" + }, + "description": "Asset File encryption metadata." + } + }, + "type": "object", + "description": "Data needed to decrypt asset files encrypted with legacy storage encryption." + }, + "ListStreamingLocatorsResponse": { + "properties": { + "streamingLocators": { + "type": "array", + "items": { + "$ref": "#/definitions/AssetStreamingLocator" + }, + "description": "The list of Streaming Locators.", + "readOnly": true + } + }, + "type": "object", + "description": "The Streaming Locators associated with this Asset." + }, + "AssetStreamingLocator": { + "properties": { + "name": { + "type": "string", + "description": "Streaming Locator name.", + "readOnly": true + }, + "assetName": { + "type": "string", + "description": "Asset Name.", + "readOnly": true + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation time of the Streaming Locator.", + "readOnly": true, + "x-nullable": false + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the Streaming Locator.", + "readOnly": true, + "x-nullable": false + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the Streaming Locator.", + "readOnly": true, + "x-nullable": false + }, + "streamingLocatorId": { + "type": "string", + "format": "uuid", + "description": "StreamingLocatorId of the Streaming Locator.", + "readOnly": true, + "x-nullable": false + }, + "streamingPolicyName": { + "type": "string", + "description": "Name of the Streaming Policy used by this Streaming Locator.", + "readOnly": true + }, + "defaultContentKeyPolicyName": { + "type": "string", + "description": "Name of the default ContentKeyPolicy used by this Streaming Locator.", + "readOnly": true + } + }, + "type": "object", + "description": "Properties of the Streaming Locator." + }, + "Asset": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AssetProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "An Asset." + }, + "PresentationTimeRange": { + "properties": { + "startTimestamp": { + "type": "integer", + "format": "int64", + "description": "The absolute start time boundary." + }, + "endTimestamp": { + "type": "integer", + "format": "int64", + "description": "The absolute end time boundary." + }, + "presentationWindowDuration": { + "type": "integer", + "format": "int64", + "description": "The relative to end sliding window." + }, + "liveBackoffDuration": { + "type": "integer", + "format": "int64", + "description": "The relative to end right edge." + }, + "timescale": { + "type": "integer", + "format": "int64", + "description": "The time scale of time stamps." + }, + "forceEndTimestamp": { + "type": "boolean", + "description": "The indicator of forcing existing of end time stamp." + } + }, + "type": "object", + "description": "The presentation time range, this is asset related and not recommended for Account Filter." + }, + "FilterTrackPropertyCondition": { + "properties": { + "property": { + "type": "string", + "enum": [ + "Unknown", + "Type", + "Name", + "Language", + "FourCC", + "Bitrate" + ], + "x-ms-enum": { + "name": "FilterTrackPropertyType", + "values": [ + { + "value": "Unknown", + "description": "The unknown track property type." + }, + { + "value": "Type", + "description": "The type." + }, + { + "value": "Name", + "description": "The name." + }, + { + "value": "Language", + "description": "The language." + }, + { + "value": "FourCC", + "description": "The fourCC." + }, + { + "value": "Bitrate", + "description": "The bitrate." + } + ], + "modelAsString": true + }, + "description": "The track property type." + }, + "value": { + "type": "string", + "description": "The track property value." + }, + "operation": { + "type": "string", + "enum": [ + "Equal", + "NotEqual" + ], + "x-ms-enum": { + "name": "FilterTrackPropertyCompareOperation", + "values": [ + { + "value": "Equal", + "description": "The equal operation." + }, + { + "value": "NotEqual", + "description": "The not equal operation." + } + ], + "modelAsString": true + }, + "description": "The track property condition operation." + } + }, + "type": "object", + "required": [ + "property", + "value", + "operation" + ], + "description": "The class to specify one track property condition." + }, + "FirstQuality": { + "properties": { + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The first quality bitrate." + } + }, + "type": "object", + "required": [ + "bitrate" + ], + "description": "Filter First Quality" + }, + "FilterTrackSelection": { + "properties": { + "trackSelections": { + "type": "array", + "items": { + "$ref": "#/definitions/FilterTrackPropertyCondition" + }, + "description": "The track selections." + } + }, + "type": "object", + "required": [ + "trackSelections" + ], + "description": "Representing a list of FilterTrackPropertyConditions to select a track. The filters are combined using a logical AND operation." + }, + "MediaFilterProperties": { + "properties": { + "presentationTimeRange": { + "$ref": "#/definitions/PresentationTimeRange", + "description": "The presentation time range." + }, + "firstQuality": { + "$ref": "#/definitions/FirstQuality", + "description": "The first quality." + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/FilterTrackSelection" + }, + "description": "The tracks selection conditions." + } + }, + "type": "object", + "description": "The Media Filter properties." + }, + "AssetFilter": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/MediaFilterProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "An Asset Filter." + }, + "AssetCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Asset" + }, + "description": "A collection of Asset items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Asset items." + }, + "ListContainerSasInput": { + "description": "The parameters to the list SAS request.", + "properties": { + "permissions": { + "description": "The permissions to set on the SAS URL.", + "type": "string", + "enum": [ + "Read", + "ReadWrite", + "ReadWriteDelete" + ], + "x-ms-enum": { + "name": "AssetContainerPermission", + "values": [ + { + "value": "Read", + "description": "The SAS URL will allow read access to the container." + }, + { + "value": "ReadWrite", + "description": "The SAS URL will allow read and write access to the container." + }, + { + "value": "ReadWriteDelete", + "description": "The SAS URL will allow read, write and delete access to the container." + } + ], + "modelAsString": true + } + }, + "expiryTime": { + "description": "The SAS URL expiration time. This must be less than 24 hours from the current time.", + "type": "string", + "format": "date-time" + } + }, + "type": "object" + }, + "AssetFilterCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AssetFilter" + }, + "description": "A collection of AssetFilter items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of AssetFilter items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets": { + "get": { + "summary": "List Assets", + "description": "List Assets in the Media Services account with optional filtering and ordering", + "operationId": "Assets_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Asset", + "x-ms-examples": { + "List all Assets": { + "$ref": "examples/assets-list-all.json" + }, + "List Asset ordered by date": { + "$ref": "examples/assets-list-by-date.json" + }, + "List Asset created in a date range": { + "$ref": "examples/assets-list-in-date-range.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}": { + "get": { + "summary": "Get an Asset", + "description": "Get the details of an Asset in the Media Services account", + "operationId": "Assets_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Asset by name": { + "$ref": "examples/assets-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Asset", + "description": "Creates or updates an Asset in the Media Services account", + "operationId": "Assets_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Asset" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create an Asset": { + "$ref": "examples/assets-create.json" + } + } + }, + "delete": { + "summary": "Delete an Asset.", + "description": "Deletes an Asset in the Media Services account", + "operationId": "Assets_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete an Asset": { + "$ref": "examples/assets-delete.json" + } + } + }, + "patch": { + "summary": "Update an Asset", + "description": "Updates an existing Asset in the Media Services account", + "operationId": "Assets_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Asset" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Asset" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update an Asset": { + "$ref": "examples/assets-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/listContainerSas": { + "post": { + "summary": "List the Asset URLs", + "description": "Lists storage container URLs with shared access signatures (SAS) for uploading and downloading Asset content. The signatures are derived from the storage account keys.", + "operationId": "Assets_ListContainerSas", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetContainerSas" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ListContainerSasInput" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Asset SAS URLs": { + "$ref": "examples/assets-list-sas-urls.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/getEncryptionKey": { + "post": { + "summary": "Gets the Asset storage key", + "description": "Gets the Asset storage encryption keys used to decrypt content created by version 2 of the Media Services API", + "operationId": "Assets_GetEncryptionKey", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StorageEncryptedAssetDecryptionData" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get Asset Storage Encryption Keys": { + "$ref": "examples/assets-get-encryption-keys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/listStreamingLocators": { + "post": { + "summary": "List Streaming Locators", + "description": "Lists Streaming Locators which are associated with this asset.", + "operationId": "Assets_ListStreamingLocators", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListStreamingLocatorsResponse" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Asset SAS URLs": { + "$ref": "examples/assets-list-streaming-locators.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/assetFilters": { + "get": { + "summary": "List Asset Filters", + "description": "List Asset Filters associated with the specified Asset.", + "operationId": "AssetFilters_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetFilterCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all Asset Filters": { + "$ref": "examples/assetFilters-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/assets/{assetName}/assetFilters/{filterName}": { + "get": { + "summary": "Get an Asset Filter.", + "description": "Get the details of an Asset Filter associated with the specified Asset.", + "operationId": "AssetFilters_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetFilter" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset Filter name" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Asset Filter by name": { + "$ref": "examples/assetFilters-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Asset Filter", + "description": "Creates or updates an Asset Filter associated with the specified Asset.", + "operationId": "AssetFilters_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetFilter" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/AssetFilter" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset Filter name" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssetFilter" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create an Asset Filter": { + "$ref": "examples/assetFilters-create.json" + } + } + }, + "delete": { + "summary": "Delete an Asset Filter.", + "description": "Deletes an Asset Filter associated with the specified Asset.", + "operationId": "AssetFilters_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset Filter name" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete an Asset Filter": { + "$ref": "examples/assetFilters-delete.json" + } + } + }, + "patch": { + "summary": "Update an Asset Filter", + "description": "Updates an existing Asset Filter associated with the specified Asset.", + "operationId": "AssetFilters_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/AssetFilter" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "assetName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset name." + }, + { + "name": "filterName", + "in": "path", + "required": true, + "type": "string", + "description": "The Asset Filter name" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AssetFilter" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update an Asset Filter": { + "$ref": "examples/assetFilters-update.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Common.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Common.json new file mode 100644 index 000000000000..47062ce01dfd --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Common.json @@ -0,0 +1,56 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "version": "2020-05-01" + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": {}, + "definitions": { + "ODataError": { + "properties": { + "code": { + "type": "string", + "description": "A language-independent error name." + }, + "message": { + "type": "string", + "description": "The error message." + }, + "target": { + "type": "string", + "description": "The target of the error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ODataError" + }, + "description": "The error details." + } + }, + "type": "object", + "description": "Information about an error." + }, + "ApiError": { + "properties": { + "error": { + "$ref": "#/definitions/ODataError", + "description": "The error properties." + } + }, + "type": "object", + "description": "The API error." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/ContentKeyPolicies.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/ContentKeyPolicies.json new file mode 100644 index 000000000000..806e5ed64f1d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/ContentKeyPolicies.json @@ -0,0 +1,1169 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction": { + "properties": { + "bestEffort": { + "type": "boolean", + "description": "Indicates whether this restriction is enforced on a Best Effort basis." + }, + "configurationData": { + "type": "integer", + "format": "int32", + "description": "Configures the restriction control bits. Must be between 0 and 3 inclusive." + } + }, + "type": "object", + "required": [ + "bestEffort", + "configurationData" + ], + "description": "Configures the Explicit Analog Television Output Restriction control bits. For further details see the PlayReady Compliance Rules." + }, + "ContentKeyPolicyPlayReadyContentKeyLocation": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for content key ID location. A derived class must be used to represent the location." + }, + "ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation" + } + ], + "properties": {}, + "type": "object", + "description": "Specifies that the content key ID is in the PlayReady header." + }, + "ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromKeyIdentifier", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation" + } + ], + "properties": { + "keyId": { + "type": "string", + "format": "uuid", + "description": "The content key ID.", + "x-nullable": true + } + }, + "type": "object", + "required": [ + "keyId" + ], + "description": "Specifies that the content key ID is specified in the PlayReady configuration." + }, + "ContentKeyPolicyPlayReadyPlayRight": { + "properties": { + "firstPlayExpiration": { + "type": "string", + "format": "duration", + "description": "The amount of time that the license is valid after the license is first used to play content." + }, + "scmsRestriction": { + "type": "integer", + "format": "int32", + "description": "Configures the Serial Copy Management System (SCMS) in the license. Must be between 0 and 3 inclusive." + }, + "agcAndColorStripeRestriction": { + "type": "integer", + "format": "int32", + "description": "Configures Automatic Gain Control (AGC) and Color Stripe in the license. Must be between 0 and 3 inclusive." + }, + "explicitAnalogTelevisionOutputRestriction": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyExplicitAnalogTelevisionRestriction", + "description": "Configures the Explicit Analog Television Output Restriction in the license. Configuration data must be between 0 and 3 inclusive." + }, + "digitalVideoOnlyContentRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "imageConstraintForAnalogComponentVideoRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "imageConstraintForAnalogComputerMonitorRestriction": { + "type": "boolean", + "description": "Enables the Image Constraint For Analog Component Video Restriction in the license." + }, + "allowPassingVideoContentToUnknownOutput": { + "type": "string", + "enum": [ + "Unknown", + "NotAllowed", + "Allowed", + "AllowedWithVideoConstriction" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyUnknownOutputPassingOption", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyUnknownOutputPassingOption that is unavailable in current API version." + }, + { + "value": "NotAllowed", + "description": "Passing the video portion of protected content to an Unknown Output is not allowed." + }, + { + "value": "Allowed", + "description": "Passing the video portion of protected content to an Unknown Output is allowed." + }, + { + "value": "AllowedWithVideoConstriction", + "description": "Passing the video portion of protected content to an Unknown Output is allowed but with constrained resolution." + } + ], + "modelAsString": true + }, + "description": "Configures Unknown output handling settings of the license." + }, + "uncompressedDigitalVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for uncompressed digital video." + }, + "compressedDigitalVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital video." + }, + "analogVideoOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital audio." + }, + "compressedDigitalAudioOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for compressed digital audio." + }, + "uncompressedDigitalAudioOpl": { + "type": "integer", + "format": "int32", + "description": "Specifies the output protection level for uncompressed digital audio." + } + }, + "type": "object", + "required": [ + "digitalVideoOnlyContentRestriction", + "imageConstraintForAnalogComponentVideoRestriction", + "imageConstraintForAnalogComputerMonitorRestriction", + "allowPassingVideoContentToUnknownOutput" + ], + "description": "Configures the Play Right in the PlayReady license." + }, + "ContentKeyPolicyTokenClaim": { + "properties": { + "claimType": { + "type": "string", + "description": "Token claim type." + }, + "claimValue": { + "type": "string", + "description": "Token claim value." + } + }, + "type": "object", + "description": "Represents a token claim." + }, + "ContentKeyPolicyPlayReadyLicense": { + "properties": { + "allowTestDevices": { + "type": "boolean", + "description": "A flag indicating whether test devices can use the license." + }, + "beginDate": { + "type": "string", + "format": "date-time", + "description": "The begin date of license" + }, + "expirationDate": { + "type": "string", + "format": "date-time", + "description": "The expiration date of license." + }, + "relativeBeginDate": { + "type": "string", + "format": "duration", + "description": "The relative begin date of license." + }, + "relativeExpirationDate": { + "type": "string", + "format": "duration", + "description": "The relative expiration date of license." + }, + "gracePeriod": { + "type": "string", + "format": "duration", + "description": "The grace period of license." + }, + "playRight": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyPlayRight", + "description": "The license PlayRight" + }, + "licenseType": { + "type": "string", + "enum": [ + "Unknown", + "NonPersistent", + "Persistent" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyLicenseType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyLicenseType that is unavailable in current API version." + }, + { + "value": "NonPersistent", + "description": "Non persistent license." + }, + { + "value": "Persistent", + "description": "Persistent license. Allows offline playback." + } + ], + "modelAsString": true + }, + "description": "The license type." + }, + "contentKeyLocation": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyContentKeyLocation", + "description": "The content key location." + }, + "contentType": { + "type": "string", + "enum": [ + "Unknown", + "Unspecified", + "UltraVioletDownload", + "UltraVioletStreaming" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyPlayReadyContentType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyPlayReadyContentType that is unavailable in current API version." + }, + { + "value": "Unspecified", + "description": "Unspecified content type." + }, + { + "value": "UltraVioletDownload", + "description": "Ultraviolet download content type." + }, + { + "value": "UltraVioletStreaming", + "description": "Ultraviolet streaming content type." + } + ], + "modelAsString": true + }, + "description": "The PlayReady content type." + } + }, + "type": "object", + "required": [ + "allowTestDevices", + "licenseType", + "contentKeyLocation", + "contentType" + ], + "description": "The PlayReady license" + }, + "ContentKeyPolicyRestriction": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy restrictions. A derived class must be used to create a restriction." + }, + "ContentKeyPolicyOpenRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyOpenRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": {}, + "type": "object", + "description": "Represents an open restriction. License or key will be delivered on every request." + }, + "ContentKeyPolicyUnknownRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyUnknownRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a ContentKeyPolicyRestriction that is unavailable in the current API version." + }, + "ContentKeyPolicyConfiguration": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy configuration. A derived class must be used to create a configuration." + }, + "ContentKeyPolicyRestrictionTokenKey": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for Content Key Policy key for token validation. A derived class must be used to create a token key." + }, + "ContentKeyPolicySymmetricTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "keyValue": { + "type": "string", + "format": "byte", + "description": "The key value of the key", + "x-nullable": true + } + }, + "type": "object", + "required": [ + "keyValue" + ], + "description": "Specifies a symmetric key for token validation." + }, + "ContentKeyPolicyRsaTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "exponent": { + "type": "string", + "format": "byte", + "description": "The RSA Parameter exponent", + "x-nullable": true + }, + "modulus": { + "type": "string", + "format": "byte", + "description": "The RSA Parameter modulus", + "x-nullable": true + } + }, + "type": "object", + "required": [ + "exponent", + "modulus" + ], + "description": "Specifies a RSA key for token validation" + }, + "ContentKeyPolicyX509CertificateTokenKey": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyX509CertificateTokenKey", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + } + ], + "properties": { + "rawBody": { + "type": "string", + "format": "byte", + "description": "The raw data field of a certificate in PKCS 12 format (X509Certificate2 in .NET)", + "x-nullable": true + } + }, + "type": "object", + "required": [ + "rawBody" + ], + "description": "Specifies a certificate for token validation." + }, + "ContentKeyPolicyTokenRestriction": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyRestriction" + } + ], + "properties": { + "issuer": { + "type": "string", + "description": "The token issuer." + }, + "audience": { + "type": "string", + "description": "The audience for the token." + }, + "primaryVerificationKey": { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey", + "description": "The primary verification key." + }, + "alternateVerificationKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyRestrictionTokenKey" + }, + "description": "A list of alternative verification keys." + }, + "requiredClaims": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyTokenClaim" + }, + "description": "A list of required token claims." + }, + "restrictionTokenType": { + "type": "string", + "enum": [ + "Unknown", + "Swt", + "Jwt" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyRestrictionTokenType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyRestrictionTokenType that is unavailable in current API version." + }, + { + "value": "Swt", + "description": "Simple Web Token." + }, + { + "value": "Jwt", + "description": "JSON Web Token." + } + ], + "modelAsString": true + }, + "description": "The type of token." + }, + "openIdConnectDiscoveryDocument": { + "type": "string", + "description": "The OpenID connect discovery document." + } + }, + "type": "object", + "required": [ + "issuer", + "audience", + "primaryVerificationKey", + "restrictionTokenType" + ], + "description": "Represents a token restriction. Provided token must match these requirements for successful license or key delivery." + }, + "ContentKeyPolicyClearKeyConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a configuration for non-DRM keys." + }, + "ContentKeyPolicyUnknownConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyUnknownConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": {}, + "type": "object", + "description": "Represents a ContentKeyPolicyConfiguration that is unavailable in the current API version." + }, + "ContentKeyPolicyWidevineConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "widevineTemplate": { + "type": "string", + "description": "The Widevine template." + } + }, + "type": "object", + "required": [ + "widevineTemplate" + ], + "description": "Specifies a configuration for Widevine licenses." + }, + "ContentKeyPolicyPlayReadyConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "licenses": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyPlayReadyLicense" + }, + "description": "The PlayReady licenses." + }, + "responseCustomData": { + "type": "string", + "description": "The custom response data." + } + }, + "type": "object", + "required": [ + "licenses" + ], + "description": "Specifies a configuration for PlayReady licenses." + }, + "ContentKeyPolicyFairPlayOfflineRentalConfiguration": { + "properties": { + "playbackDurationSeconds": { + "type": "integer", + "format": "int64", + "description": "Playback duration" + }, + "storageDurationSeconds": { + "type": "integer", + "format": "int64", + "description": "Storage duration" + } + }, + "type": "object", + "required": [ + "playbackDurationSeconds", + "storageDurationSeconds" + ] + }, + "ContentKeyPolicyFairPlayConfiguration": { + "x-ms-discriminator-value": "#Microsoft.Media.ContentKeyPolicyFairPlayConfiguration", + "allOf": [ + { + "$ref": "#/definitions/ContentKeyPolicyConfiguration" + } + ], + "properties": { + "ask": { + "type": "string", + "format": "byte", + "description": "The key that must be used as FairPlay Application Secret key.", + "x-nullable": true + }, + "fairPlayPfxPassword": { + "type": "string", + "description": "The password encrypting FairPlay certificate in PKCS 12 (pfx) format.", + "x-nullable": true + }, + "fairPlayPfx": { + "type": "string", + "description": "The Base64 representation of FairPlay certificate in PKCS 12 (pfx) format (including private key).", + "x-nullable": true + }, + "rentalAndLeaseKeyType": { + "type": "string", + "enum": [ + "Unknown", + "Undefined", + "DualExpiry", + "PersistentUnlimited", + "PersistentLimited" + ], + "x-ms-enum": { + "name": "ContentKeyPolicyFairPlayRentalAndLeaseKeyType", + "values": [ + { + "value": "Unknown", + "description": "Represents a ContentKeyPolicyFairPlayRentalAndLeaseKeyType that is unavailable in current API version." + }, + { + "value": "Undefined", + "description": "Key duration is not specified." + }, + { + "value": "DualExpiry", + "description": "Dual expiry for offline rental." + }, + { + "value": "PersistentUnlimited", + "description": "Content key can be persisted with an unlimited duration" + }, + { + "value": "PersistentLimited", + "description": "Content key can be persisted and the valid duration is limited by the Rental Duration value" + } + ], + "modelAsString": true + }, + "description": "The rental and lease key type." + }, + "rentalDuration": { + "type": "integer", + "format": "int64", + "description": "The rental duration. Must be greater than or equal to 0." + }, + "offlineRentalConfiguration": { + "$ref": "#/definitions/ContentKeyPolicyFairPlayOfflineRentalConfiguration", + "description": "Offline rental policy" + } + }, + "type": "object", + "required": [ + "ask", + "fairPlayPfxPassword", + "fairPlayPfx", + "rentalAndLeaseKeyType", + "rentalDuration" + ], + "description": "Specifies a configuration for FairPlay licenses." + }, + "ContentKeyPolicyOption": { + "properties": { + "policyOptionId": { + "type": "string", + "format": "uuid", + "description": "The legacy Policy Option ID.", + "readOnly": true, + "x-nullable": false + }, + "name": { + "type": "string", + "description": "The Policy Option description." + }, + "configuration": { + "$ref": "#/definitions/ContentKeyPolicyConfiguration", + "description": "The key delivery configuration." + }, + "restriction": { + "$ref": "#/definitions/ContentKeyPolicyRestriction", + "description": "The requirements that must be met to deliver keys with this configuration" + } + }, + "type": "object", + "required": [ + "configuration", + "restriction" + ], + "description": "Represents a policy option." + }, + "ContentKeyPolicyProperties": { + "properties": { + "policyId": { + "type": "string", + "format": "uuid", + "description": "The legacy Policy ID.", + "readOnly": true, + "x-nullable": false + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation date of the Policy", + "readOnly": true, + "x-nullable": false + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The last modified date of the Policy", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "A description for the Policy." + }, + "options": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicyOption" + }, + "description": "The Key Policy options." + } + }, + "type": "object", + "required": [ + "options" + ], + "description": "The properties of the Content Key Policy." + }, + "ContentKeyPolicy": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ContentKeyPolicyProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Content Key Policy resource." + }, + "ContentKeyPolicyCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "A collection of ContentKeyPolicy items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of ContentKeyPolicy items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies": { + "get": { + "summary": "List Content Key Policies", + "description": "Lists the Content Key Policies in the account", + "operationId": "ContentKeyPolicies_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicyCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/ContentKeyPolicy", + "x-ms-examples": { + "Lists all Content Key Policies": { + "$ref": "examples/content-key-policies-list-all.json" + }, + "Lists Content Key Policies ordered by last modified.": { + "$ref": "examples/content-key-policies-list-by-lastModified.json" + }, + "Lists Content Key Policies with created and last modified filters.": { + "$ref": "examples/content-key-policies-list-in-date-range.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}": { + "get": { + "summary": "Get a Content Key Policy", + "description": "Get the details of a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Content Key Policy by name": { + "$ref": "examples/content-key-policies-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or update an Content Key Policy", + "description": "Create or update a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Content Key Policy with PlayReady option and Open Restriction": { + "$ref": "examples/content-key-policies-create-playready-open.json" + }, + "Creates a Content Key Policy with Widevine option and Token Restriction": { + "$ref": "examples/content-key-policies-create-widevine-token.json" + }, + "Creates a Content Key Policy with ClearKey option and Token Restriction": { + "$ref": "examples/content-key-policies-create-nodrm-token.json" + }, + "Creates a Content Key Policy with multiple options": { + "$ref": "examples/content-key-policies-create-multiple-options.json" + } + } + }, + "delete": { + "summary": "Delete a Content Key Policy", + "description": "Deletes a Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Key Policy": { + "$ref": "examples/content-key-policies-delete.json" + } + } + }, + "patch": { + "summary": "Update a Content Key Policy", + "description": "Updates an existing Content Key Policy in the Media Services account", + "operationId": "ContentKeyPolicies_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ContentKeyPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Content Key Policy": { + "$ref": "examples/content-key-policies-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/contentKeyPolicies/{contentKeyPolicyName}/getPolicyPropertiesWithSecrets": { + "post": { + "summary": "Get a Content Key Policy with secrets", + "description": "Get a Content Key Policy including secret values", + "operationId": "ContentKeyPolicies_GetPolicyPropertiesWithSecrets", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ContentKeyPolicyProperties" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "contentKeyPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Content Key Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get an Content Key Policy with secrets": { + "$ref": "examples/content-key-policies-get-with-secrets.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Encoding.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Encoding.json new file mode 100644 index 000000000000..57052bf2fe4d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/Encoding.json @@ -0,0 +1,2445 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "Preset": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base type for all Presets, which define the recipe or instructions on how the input media files should be processed." + }, + "Codec": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "label": { + "type": "string", + "description": "An optional label for the codec. The label can be used to control muxing behavior." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Describes the basic properties of all codecs." + }, + "Audio": { + "x-ms-discriminator-value": "#Microsoft.Media.Audio", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": { + "channels": { + "type": "integer", + "format": "int32", + "description": "The number of channels in the audio." + }, + "samplingRate": { + "type": "integer", + "format": "int32", + "description": "The sampling rate to use for encoding in hertz." + }, + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The bitrate, in bits per second, of the output encoded audio." + } + }, + "type": "object", + "description": "Defines the common properties for all audio codecs." + }, + "AacAudio": { + "x-ms-discriminator-value": "#Microsoft.Media.AacAudio", + "allOf": [ + { + "$ref": "#/definitions/Audio" + } + ], + "properties": { + "profile": { + "type": "string", + "enum": [ + "AacLc", + "HeAacV1", + "HeAacV2" + ], + "x-ms-enum": { + "name": "AacAudioProfile", + "values": [ + { + "value": "AacLc", + "description": "Specifies that the output audio is to be encoded into AAC Low Complexity profile (AAC-LC)." + }, + { + "value": "HeAacV1", + "description": "Specifies that the output audio is to be encoded into HE-AAC v1 profile." + }, + { + "value": "HeAacV2", + "description": "Specifies that the output audio is to be encoded into HE-AAC v2 profile." + } + ], + "modelAsString": true + }, + "description": "The encoding profile to be used when encoding audio with AAC." + } + }, + "type": "object", + "description": "Describes Advanced Audio Codec (AAC) audio encoding settings." + }, + "FaceDetectorPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.FaceDetectorPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "resolution": { + "type": "string", + "enum": [ + "SourceResolution", + "StandardDefinition" + ], + "x-ms-enum": { + "name": "AnalysisResolution", + "values": [ + { + "value": "SourceResolution" + }, + { + "value": "StandardDefinition" + } + ], + "modelAsString": true + }, + "description": "Specifies the maximum resolution at which your video is analyzed. The default behavior is \"SourceResolution,\" which will keep the input video at its original resolution when analyzed. Using \"StandardDefinition\" will resize input videos to standard definition while preserving the appropriate aspect ratio. It will only resize if the video is of higher resolution. For example, a 1920x1080 input would be scaled to 640x360 before processing. Switching to \"StandardDefinition\" will reduce the time it takes to process high resolution video. It may also reduce the cost of using this component (see https://azure.microsoft.com/en-us/pricing/details/media-services/#analytics for details). However, faces that end up being too small in the resized video may not be detected." + }, + "experimentalOptions": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Dictionary containing key value pairs for parameters not exposed in the preset itself" + } + }, + "type": "object", + "description": "Describes all the settings to be used when analyzing a video in order to detect all the faces present." + }, + "AudioAnalyzerPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.AudioAnalyzerPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "audioLanguage": { + "type": "string", + "description": "The language for the audio payload in the input using the BCP-47 format of 'language tag-region' (e.g: 'en-US'). If you know the language of your content, it is recommended that you specify it. If the language isn't specified or set to null, automatic language detection will choose the first language detected and process with the selected language for the duration of the file. It does not currently support dynamically switching between languages after the first language is detected. The automatic detection works best with audio recordings with clearly discernable speech. If automatic detection fails to find the language, transcription would fallback to 'en-US'.\" The list of supported languages is available here: https://go.microsoft.com/fwlink/?linkid=2109463" + }, + "experimentalOptions": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Dictionary containing key value pairs for parameters not exposed in the preset itself" + } + }, + "type": "object", + "description": "The Audio Analyzer preset applies a pre-defined set of AI-based analysis operations, including speech transcription. Currently, the preset supports processing of content with a single audio track." + }, + "Overlay": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "inputLabel": { + "type": "string", + "description": "The label of the job input which is to be used as an overlay. The Input must specify exactly one file. You can specify an image file in JPG or PNG formats, or an audio file (such as a WAV, MP3, WMA or M4A file), or a video file. See https://aka.ms/mesformats for the complete list of supported audio and video file formats." + }, + "start": { + "type": "string", + "format": "duration", + "description": "The start position, with reference to the input video, at which the overlay starts. The value should be in ISO 8601 format. For example, PT05S to start the overlay at 5 seconds in to the input video. If not specified the overlay starts from the beginning of the input video." + }, + "end": { + "type": "string", + "format": "duration", + "description": "The position in the input video at which the overlay ends. The value should be in ISO 8601 duration format. For example, PT30S to end the overlay at 30 seconds in to the input video. If not specified the overlay will be applied until the end of the input video if inputLoop is true. Else, if inputLoop is false, then overlay will last as long as the duration of the overlay media." + }, + "fadeInDuration": { + "type": "string", + "format": "duration", + "description": "The duration over which the overlay fades in onto the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade in (same as PT0S)." + }, + "fadeOutDuration": { + "type": "string", + "format": "duration", + "description": "The duration over which the overlay fades out of the input video. The value should be in ISO 8601 duration format. If not specified the default behavior is to have no fade out (same as PT0S)." + }, + "audioGainLevel": { + "type": "number", + "format": "double", + "description": "The gain level of audio in the overlay. The value should be in the range [0, 1.0]. The default is 1.0." + } + }, + "type": "object", + "required": [ + "@odata.type", + "inputLabel" + ], + "description": "Base type for all overlays - image, audio or video." + }, + "AudioOverlay": { + "x-ms-discriminator-value": "#Microsoft.Media.AudioOverlay", + "allOf": [ + { + "$ref": "#/definitions/Overlay" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties of an audio overlay." + }, + "CopyVideo": { + "x-ms-discriminator-value": "#Microsoft.Media.CopyVideo", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": {}, + "type": "object", + "description": "A codec flag, which tells the encoder to copy the input video bitstream without re-encoding." + }, + "Video": { + "x-ms-discriminator-value": "#Microsoft.Media.Video", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": { + "keyFrameInterval": { + "type": "string", + "format": "duration", + "description": "The distance between two key frames. The value should be non-zero in the range [0.5, 20] seconds, specified in ISO 8601 format. The default is 2 seconds(PT2S). Note that this setting is ignored if VideoSyncMode.Passthrough is set, where the KeyFrameInterval value will follow the input source setting." + }, + "stretchMode": { + "type": "string", + "enum": [ + "None", + "AutoSize", + "AutoFit" + ], + "x-ms-enum": { + "name": "StretchMode", + "values": [ + { + "value": "None", + "description": "Strictly respect the output resolution without considering the pixel aspect ratio or display aspect ratio of the input video." + }, + { + "value": "AutoSize", + "description": "Override the output resolution, and change it to match the display aspect ratio of the input, without padding. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the value in the preset is overridden, and the output will be at 1280x720, which maintains the input aspect ratio of 16:9." + }, + { + "value": "AutoFit", + "description": "Pad the output (with either letterbox or pillar box) to honor the output resolution, while ensuring that the active video region in the output has the same aspect ratio as the input. For example, if the input is 1920x1080 and the encoding preset asks for 1280x1280, then the output will be at 1280x1280, which contains an inner rectangle of 1280x720 at aspect ratio of 16:9, and pillar box regions 280 pixels wide at the left and right." + } + ], + "modelAsString": true + }, + "description": "The resizing mode - how the input video will be resized to fit the desired output resolution(s). Default is AutoSize" + }, + "syncMode": { + "type": "string", + "enum": [ + "Auto", + "Passthrough", + "Cfr", + "Vfr" + ], + "x-ms-enum": { + "name": "VideoSyncMode", + "values": [ + { + "value": "Auto", + "description": "This is the default method. Chooses between Cfr and Vfr depending on muxer capabilities. For output format MP4, the default mode is Cfr." + }, + { + "value": "Passthrough", + "description": "The presentation timestamps on frames are passed through from the input file to the output file writer. Recommended when the input source has variable frame rate, and are attempting to produce multiple layers for adaptive streaming in the output which have aligned GOP boundaries. Note: if two or more frames in the input have duplicate timestamps, then the output will also have the same behavior" + }, + { + "value": "Cfr", + "description": "Input frames will be repeated and/or dropped as needed to achieve exactly the requested constant frame rate. Recommended when the output frame rate is explicitly set at a specified value" + }, + { + "value": "Vfr", + "description": "Similar to the Passthrough mode, but if the input has frames that have duplicate timestamps, then only one frame is passed through to the output, and others are dropped. Recommended when the number of output frames is expected to be equal to the number of input frames. For example, the output is used to calculate a quality metric like PSNR against the input" + } + ], + "modelAsString": true + }, + "description": "The Video Sync Mode" + } + }, + "type": "object", + "description": "Describes the basic properties for encoding the input video." + }, + "Image": { + "x-ms-discriminator-value": "#Microsoft.Media.Image", + "allOf": [ + { + "$ref": "#/definitions/Video" + } + ], + "properties": { + "start": { + "type": "string", + "description": "The position in the input video from where to start generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT05S), or a frame count (For example, 10 for the 10th frame), or a relative value (For example, 1%). Also supports a macro {Best}, which tells the encoder to select the best thumbnail from the first few seconds of the video." + }, + "step": { + "type": "string", + "description": "The intervals at which thumbnails are generated. The value can be in absolute timestamp (ISO 8601, e.g: PT05S for one image every 5 seconds), or a frame count (For example, 30 for every 30 frames), or a relative value (For example, 1%)." + }, + "range": { + "type": "string", + "description": "The position in the input video at which to stop generating thumbnails. The value can be in absolute timestamp (ISO 8601, e.g: PT5M30S to stop at 5 minutes and 30 seconds), or a frame count (For example, 300 to stop at the 300th frame), or a relative value (For example, 100%)." + } + }, + "type": "object", + "required": [ + "start" + ], + "description": "Describes the basic properties for generating thumbnails from the input video" + }, + "Format": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "filenamePattern": { + "type": "string", + "description": "The pattern of the file names for the generated output files. The following macros are supported in the file name: {Basename} - The base name of the input video {Extension} - The appropriate extension for this format. {Label} - The label assigned to the codec/layer. {Index} - A unique index for thumbnails. Only applicable to thumbnails. {Bitrate} - The audio/video bitrate. Not applicable to thumbnails. {Codec} - The type of the audio/video codec. Any unsubstituted macros will be collapsed and removed from the filename." + } + }, + "type": "object", + "required": [ + "@odata.type", + "filenamePattern" + ], + "description": "Base class for output." + }, + "ImageFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.ImageFormat", + "allOf": [ + { + "$ref": "#/definitions/Format" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for an output image file." + }, + "JpgFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgFormat", + "allOf": [ + { + "$ref": "#/definitions/ImageFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings for producing JPEG thumbnails." + }, + "PngFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.PngFormat", + "allOf": [ + { + "$ref": "#/definitions/ImageFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings for producing PNG thumbnails." + }, + "CopyAudio": { + "x-ms-discriminator-value": "#Microsoft.Media.CopyAudio", + "allOf": [ + { + "$ref": "#/definitions/Codec" + } + ], + "properties": {}, + "type": "object", + "description": "A codec flag, which tells the encoder to copy the input audio bitstream." + }, + "Deinterlace": { + "properties": { + "parity": { + "type": "string", + "enum": [ + "Auto", + "TopFieldFirst", + "BottomFieldFirst" + ], + "x-ms-enum": { + "name": "DeinterlaceParity", + "values": [ + { + "value": "Auto", + "description": "Automatically detect the order of fields" + }, + { + "value": "TopFieldFirst", + "description": "Apply top field first processing of input video." + }, + { + "value": "BottomFieldFirst", + "description": "Apply bottom field first processing of input video." + } + ], + "modelAsString": true + }, + "description": "The field parity for de-interlacing, defaults to Auto." + }, + "mode": { + "type": "string", + "enum": [ + "Off", + "AutoPixelAdaptive" + ], + "x-ms-enum": { + "name": "DeinterlaceMode", + "values": [ + { + "value": "Off", + "description": "Disables de-interlacing of the source video." + }, + { + "value": "AutoPixelAdaptive", + "description": "Apply automatic pixel adaptive de-interlacing on each frame in the input video." + } + ], + "modelAsString": true + }, + "description": "The deinterlacing mode. Defaults to AutoPixelAdaptive." + } + }, + "type": "object", + "description": "Describes the de-interlacing settings." + }, + "Rectangle": { + "properties": { + "left": { + "type": "string", + "description": "The number of pixels from the left-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "top": { + "type": "string", + "description": "The number of pixels from the top-margin. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "width": { + "type": "string", + "description": "The width of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + }, + "height": { + "type": "string", + "description": "The height of the rectangular region in pixels. This can be absolute pixel value (e.g 100), or relative to the size of the video (For example, 50%)." + } + }, + "type": "object", + "description": "Describes the properties of a rectangular window applied to the input media before processing it." + }, + "Filters": { + "properties": { + "deinterlace": { + "$ref": "#/definitions/Deinterlace", + "description": "The de-interlacing settings." + }, + "rotation": { + "type": "string", + "enum": [ + "Auto", + "None", + "Rotate0", + "Rotate90", + "Rotate180", + "Rotate270" + ], + "x-ms-enum": { + "name": "Rotation", + "values": [ + { + "value": "Auto", + "description": "Automatically detect and rotate as needed." + }, + { + "value": "None", + "description": "Do not rotate the video. If the output format supports it, any metadata about rotation is kept intact." + }, + { + "value": "Rotate0", + "description": "Do not rotate the video but remove any metadata about the rotation." + }, + { + "value": "Rotate90", + "description": "Rotate 90 degrees clockwise." + }, + { + "value": "Rotate180", + "description": "Rotate 180 degrees clockwise." + }, + { + "value": "Rotate270", + "description": "Rotate 270 degrees clockwise." + } + ], + "modelAsString": true + }, + "description": "The rotation, if any, to be applied to the input video, before it is encoded. Default is Auto" + }, + "crop": { + "$ref": "#/definitions/Rectangle", + "description": "The parameters for the rectangular window with which to crop the input video." + }, + "overlays": { + "type": "array", + "items": { + "$ref": "#/definitions/Overlay" + }, + "description": "The properties of overlays to be applied to the input video. These could be audio, image or video overlays." + } + }, + "type": "object", + "description": "Describes all the filtering operations, such as de-interlacing, rotation etc. that are to be applied to the input media before encoding." + }, + "Layer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "width": { + "type": "string", + "description": "The width of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in width as the input." + }, + "height": { + "type": "string", + "description": "The height of the output video for this layer. The value can be absolute (in pixels) or relative (in percentage). For example 50% means the output video has half as many pixels in height as the input." + }, + "label": { + "type": "string", + "description": "The alphanumeric label for this layer, which can be used in multiplexing different video and audio layers, or in naming the output file." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "The encoder can be configured to produce video and/or images (thumbnails) at different resolutions, by specifying a layer for each desired resolution. A layer represents the properties for the video or image at a resolution." + }, + "VideoLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": { + "bitrate": { + "type": "integer", + "format": "int32", + "description": "The average bitrate in bits per second at which to encode the input video when generating this layer. This is a required field." + }, + "maxBitrate": { + "type": "integer", + "format": "int32", + "description": "The maximum bitrate (in bits per second), at which the VBV buffer should be assumed to refill. If not specified, defaults to the same value as bitrate." + }, + "bFrames": { + "type": "integer", + "format": "int32", + "description": "The number of B-frames to be used when encoding this layer. If not specified, the encoder chooses an appropriate number based on the video profile and level." + }, + "frameRate": { + "type": "string", + "description": "The frame rate (in frames per second) at which to encode this layer. The value can be in the form of M/N where M and N are integers (For example, 30000/1001), or in the form of a number (For example, 30, or 29.97). The encoder enforces constraints on allowed frame rates based on the profile and level. If it is not specified, the encoder will use the same frame rate as the input video." + }, + "slices": { + "type": "integer", + "format": "int32", + "description": "The number of slices to be used when encoding this layer. If not specified, default is zero, which means that encoder will use a single slice for each frame." + }, + "adaptiveBFrame": { + "type": "boolean", + "description": "Whether or not adaptive B-frames are to be used when encoding this layer. If not specified, the encoder will turn it on whenever the video profile permits its use." + } + }, + "type": "object", + "required": [ + "bitrate" + ], + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer." + }, + "H264Layer": { + "x-ms-discriminator-value": "#Microsoft.Media.H264Layer", + "allOf": [ + { + "$ref": "#/definitions/VideoLayer" + } + ], + "properties": { + "profile": { + "type": "string", + "enum": [ + "Auto", + "Baseline", + "Main", + "High", + "High422", + "High444" + ], + "x-ms-enum": { + "name": "H264VideoProfile", + "values": [ + { + "value": "Auto", + "description": "Tells the encoder to automatically determine the appropriate H.264 profile." + }, + { + "value": "Baseline", + "description": "Baseline profile" + }, + { + "value": "Main", + "description": "Main profile" + }, + { + "value": "High", + "description": "High profile." + }, + { + "value": "High422", + "description": "High 4:2:2 profile." + }, + { + "value": "High444", + "description": "High 4:4:4 predictive profile." + } + ], + "modelAsString": true + }, + "description": "We currently support Baseline, Main, High, High422, High444. Default is Auto." + }, + "level": { + "type": "string", + "description": "We currently support Level up to 6.2. The value can be Auto, or a number that matches the H.264 profile. If not specified, the default is Auto, which lets the encoder choose the Level that is appropriate for this layer." + }, + "bufferWindow": { + "type": "string", + "format": "duration", + "description": "The VBV buffer window length. The value should be in ISO 8601 format. The value should be in the range [0.1-100] seconds. The default is 5 seconds (for example, PT5S)." + }, + "referenceFrames": { + "type": "integer", + "format": "int32", + "description": "The number of reference frames to be used when encoding this layer. If not specified, the encoder determines an appropriate number based on the encoder complexity setting." + }, + "entropyMode": { + "type": "string", + "enum": [ + "Cabac", + "Cavlc" + ], + "x-ms-enum": { + "name": "EntropyMode", + "values": [ + { + "value": "Cabac", + "description": "Context Adaptive Binary Arithmetic Coder (CABAC) entropy encoding." + }, + { + "value": "Cavlc", + "description": "Context Adaptive Variable Length Coder (CAVLC) entropy encoding." + } + ], + "modelAsString": true + }, + "description": "The entropy mode to be used for this layer. If not specified, the encoder chooses the mode that is appropriate for the profile and level." + } + }, + "type": "object", + "description": "Describes the settings to be used when encoding the input video into a desired output bitrate layer with the H.264 video codec." + }, + "H264Video": { + "x-ms-discriminator-value": "#Microsoft.Media.H264Video", + "allOf": [ + { + "$ref": "#/definitions/Video" + } + ], + "properties": { + "sceneChangeDetection": { + "type": "boolean", + "description": "Whether or not the encoder should insert key frames at scene changes. If not specified, the default is false. This flag should be set to true only when the encoder is being configured to produce a single output video." + }, + "complexity": { + "type": "string", + "enum": [ + "Speed", + "Balanced", + "Quality" + ], + "x-ms-enum": { + "name": "H264Complexity", + "values": [ + { + "value": "Speed", + "description": "Tells the encoder to use settings that are optimized for faster encoding. Quality is sacrificed to decrease encoding time." + }, + { + "value": "Balanced", + "description": "Tells the encoder to use settings that achieve a balance between speed and quality." + }, + { + "value": "Quality", + "description": "Tells the encoder to use settings that are optimized to produce higher quality output at the expense of slower overall encode time." + } + ], + "modelAsString": true + }, + "description": "Tells the encoder how to choose its encoding settings. The default value is Balanced." + }, + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/H264Layer" + }, + "description": "The collection of output H.264 layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes all the properties for encoding a video with the H.264 codec." + }, + "JpgImage": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgImage", + "allOf": [ + { + "$ref": "#/definitions/Image" + } + ], + "properties": { + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/JpgLayer" + }, + "description": "A collection of output JPEG image layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes the properties for producing a series of JPEG images from the input video." + }, + "JpgLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.JpgLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": { + "quality": { + "type": "integer", + "format": "int32", + "description": "The compression quality of the JPEG output. Range is from 0-100 and the default is 70." + } + }, + "type": "object", + "description": "Describes the settings to produce a JPEG image from the input video." + }, + "MultiBitrateFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.MultiBitrateFormat", + "allOf": [ + { + "$ref": "#/definitions/Format" + } + ], + "properties": { + "outputFiles": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFile" + }, + "description": "The list of output files to produce. Each entry in the list is a set of audio and video layer labels to be muxed together ." + } + }, + "type": "object", + "description": "Describes the properties for producing a collection of GOP aligned multi-bitrate files. The default behavior is to produce one output file for each video layer which is muxed together with all the audios. The exact output files produced can be controlled by specifying the outputFiles collection." + }, + "OutputFile": { + "properties": { + "labels": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of labels that describe how the encoder should multiplex video and audio into an output file. For example, if the encoder is producing two video layers with labels v1 and v2, and one audio layer with label a1, then an array like '[v1, a1]' tells the encoder to produce an output file with the video track represented by v1 and the audio track represented by a1." + } + }, + "type": "object", + "required": [ + "labels" + ], + "description": "Represents an output file produced." + }, + "Mp4Format": { + "x-ms-discriminator-value": "#Microsoft.Media.Mp4Format", + "allOf": [ + { + "$ref": "#/definitions/MultiBitrateFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for an output ISO MP4 file." + }, + "PngImage": { + "x-ms-discriminator-value": "#Microsoft.Media.PngImage", + "allOf": [ + { + "$ref": "#/definitions/Image" + } + ], + "properties": { + "layers": { + "type": "array", + "items": { + "$ref": "#/definitions/PngLayer" + }, + "description": "A collection of output PNG image layers to be produced by the encoder." + } + }, + "type": "object", + "description": "Describes the properties for producing a series of PNG images from the input video." + }, + "PngLayer": { + "x-ms-discriminator-value": "#Microsoft.Media.PngLayer", + "allOf": [ + { + "$ref": "#/definitions/Layer" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the settings to produce a PNG image from the input video." + }, + "BuiltInStandardEncoderPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "presetName": { + "type": "string", + "enum": [ + "H264SingleBitrateSD", + "H264SingleBitrate720p", + "H264SingleBitrate1080p", + "AdaptiveStreaming", + "AACGoodQualityAudio", + "ContentAwareEncodingExperimental", + "ContentAwareEncoding", + "H264MultipleBitrate1080p", + "H264MultipleBitrate720p", + "H264MultipleBitrateSD" + ], + "x-ms-enum": { + "name": "EncoderNamedPreset", + "values": [ + { + "value": "H264SingleBitrateSD", + "description": "Produces an MP4 file where the video is encoded with H.264 codec at 2200 kbps and a picture height of 480 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps." + }, + { + "value": "H264SingleBitrate720p", + "description": "Produces an MP4 file where the video is encoded with H.264 codec at 4500 kbps and a picture height of 720 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps." + }, + { + "value": "H264SingleBitrate1080p", + "description": "Produces an MP4 file where the video is encoded with H.264 codec at 6750 kbps and a picture height of 1080 pixels, and the stereo audio is encoded with AAC-LC codec at 128 kbps." + }, + { + "value": "AdaptiveStreaming", + "description": "Produces a set of GOP aligned MP4 files with H.264 video and stereo AAC audio. Auto-generates a bitrate ladder based on the input resolution and bitrate. The auto-generated preset will never exceed the input resolution and bitrate. For example, if the input is 720p at 3 Mbps, output will remain 720p at best, and will start at rates lower than 3 Mbps. The output will have video and audio in separate MP4 files, which is optimal for adaptive streaming." + }, + { + "value": "AACGoodQualityAudio", + "description": "Produces a single MP4 file containing only stereo audio encoded at 192 kbps." + }, + { + "value": "ContentAwareEncodingExperimental", + "description": "Exposes an experimental preset for content-aware encoding. Given any input content, the service attempts to automatically determine the optimal number of layers, appropriate bitrate and resolution settings for delivery by adaptive streaming. The underlying algorithms will continue to evolve over time. The output will contain MP4 files with video and audio interleaved." + }, + { + "value": "ContentAwareEncoding", + "description": "Produces a set of GOP-aligned MP4s by using content-aware encoding. Given any input content, the service performs an initial lightweight analysis of the input content, and uses the results to determine the optimal number of layers, appropriate bitrate and resolution settings for delivery by adaptive streaming. This preset is particularly effective for low and medium complexity videos, where the output files will be at lower bitrates but at a quality that still delivers a good experience to viewers. The output will contain MP4 files with video and audio interleaved." + }, + { + "value": "H264MultipleBitrate1080p", + "description": "Produces a set of 8 GOP-aligned MP4 files, ranging from 6000 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 1080p and goes down to 180p." + }, + { + "value": "H264MultipleBitrate720p", + "description": "Produces a set of 6 GOP-aligned MP4 files, ranging from 3400 kbps to 400 kbps, and stereo AAC audio. Resolution starts at 720p and goes down to 180p." + }, + { + "value": "H264MultipleBitrateSD", + "description": "Produces a set of 5 GOP-aligned MP4 files, ranging from 1900kbps to 400 kbps, and stereo AAC audio. Resolution starts at 480p and goes down to 240p." + } + ], + "modelAsString": true + }, + "description": "The built-in preset to be used for encoding videos." + } + }, + "type": "object", + "required": [ + "presetName" + ], + "description": "Describes a built-in preset for encoding the input video with the Standard Encoder." + }, + "StandardEncoderPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.StandardEncoderPreset", + "allOf": [ + { + "$ref": "#/definitions/Preset" + } + ], + "properties": { + "filters": { + "$ref": "#/definitions/Filters", + "description": "One or more filtering operations that are applied to the input media before encoding." + }, + "codecs": { + "type": "array", + "items": { + "$ref": "#/definitions/Codec" + }, + "description": "The list of codecs to be used when encoding the input video." + }, + "formats": { + "type": "array", + "items": { + "$ref": "#/definitions/Format" + }, + "description": "The list of outputs to be produced by the encoder." + } + }, + "type": "object", + "required": [ + "codecs", + "formats" + ], + "description": "Describes all the settings to be used when encoding the input video with the Standard Encoder." + }, + "VideoAnalyzerPreset": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoAnalyzerPreset", + "allOf": [ + { + "$ref": "#/definitions/AudioAnalyzerPreset" + } + ], + "properties": { + "insightsToExtract": { + "type": "string", + "enum": [ + "AudioInsightsOnly", + "VideoInsightsOnly", + "AllInsights" + ], + "x-ms-enum": { + "name": "InsightsType", + "values": [ + { + "value": "AudioInsightsOnly", + "description": "Generate audio only insights. Ignore video even if present. Fails if no audio is present." + }, + { + "value": "VideoInsightsOnly", + "description": "Generate video only insights. Ignore audio if present. Fails if no video is present." + }, + { + "value": "AllInsights", + "description": "Generate both audio and video insights. Fails if either audio or video Insights fail." + } + ], + "modelAsString": true + }, + "description": "Defines the type of insights that you want the service to generate. The allowed values are 'AudioInsightsOnly', 'VideoInsightsOnly', and 'AllInsights'. The default is AllInsights. If you set this to AllInsights and the input is audio only, then only audio insights are generated. Similarly if the input is video only, then only video insights are generated. It is recommended that you not use AudioInsightsOnly if you expect some of your inputs to be video only; or use VideoInsightsOnly if you expect some of your inputs to be audio only. Your Jobs in such conditions would error out." + } + }, + "type": "object", + "description": "A video analyzer preset that extracts insights (rich metadata) from both audio and video, and outputs a JSON format file." + }, + "TransportStreamFormat": { + "x-ms-discriminator-value": "#Microsoft.Media.TransportStreamFormat", + "allOf": [ + { + "$ref": "#/definitions/MultiBitrateFormat" + } + ], + "properties": {}, + "type": "object", + "description": "Describes the properties for generating an MPEG-2 Transport Stream (ISO/IEC 13818-1) output video file(s)." + }, + "VideoOverlay": { + "x-ms-discriminator-value": "#Microsoft.Media.VideoOverlay", + "allOf": [ + { + "$ref": "#/definitions/Overlay" + } + ], + "properties": { + "position": { + "$ref": "#/definitions/Rectangle", + "description": "The location in the input video where the overlay is applied." + }, + "opacity": { + "type": "number", + "format": "double", + "description": "The opacity of the overlay. This is a value in the range [0 - 1.0]. Default is 1.0 which mean the overlay is opaque." + }, + "cropRectangle": { + "$ref": "#/definitions/Rectangle", + "description": "An optional rectangular window used to crop the overlay image or video." + } + }, + "type": "object", + "description": "Describes the properties of a video overlay." + }, + "TransformOutput": { + "properties": { + "onError": { + "type": "string", + "enum": [ + "StopProcessingJob", + "ContinueJob" + ], + "x-ms-enum": { + "name": "OnErrorType", + "values": [ + { + "value": "StopProcessingJob", + "description": "Tells the service that if this TransformOutput fails, then any other incomplete TransformOutputs can be stopped." + }, + { + "value": "ContinueJob", + "description": "Tells the service that if this TransformOutput fails, then allow any other TransformOutput to continue." + } + ], + "modelAsString": true + }, + "description": "A Transform can define more than one outputs. This property defines what the service should do when one output fails - either continue to produce other outputs, or, stop the other outputs. The overall Job state will not reflect failures of outputs that are specified with 'ContinueJob'. The default is 'StopProcessingJob'." + }, + "relativePriority": { + "type": "string", + "enum": [ + "Low", + "Normal", + "High" + ], + "x-ms-enum": { + "name": "Priority", + "values": [ + { + "value": "Low", + "description": "Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs." + }, + { + "value": "Normal", + "description": "Used for TransformOutputs that can be generated at Normal priority." + }, + { + "value": "High", + "description": "Used for TransformOutputs that should take precedence over others." + } + ], + "modelAsString": true + }, + "description": "Sets the relative priority of the TransformOutputs within a Transform. This sets the priority that the service uses for processing TransformOutputs. The default priority is Normal." + }, + "preset": { + "$ref": "#/definitions/Preset", + "description": "Preset that describes the operations that will be used to modify, transcode, or extract insights from the source file to generate the output." + } + }, + "type": "object", + "required": [ + "preset" + ], + "description": "Describes the properties of a TransformOutput, which are the rules to be applied while generating the desired output." + }, + "TransformProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Transform was created, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "An optional verbose description of the Transform." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Transform was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/TransformOutput" + }, + "description": "An array of one or more TransformOutputs that the Transform should generate." + } + }, + "type": "object", + "required": [ + "outputs" + ], + "description": "A Transform." + }, + "Transform": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/TransformProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Transform encapsulates the rules or instructions for generating desired outputs from input media, such as by transcoding or by extracting insights. After the Transform is created, it can be applied to input media by creating Jobs." + }, + "JobInput": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for inputs to a Job." + }, + "JobInputClip": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputClip", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "files": { + "type": "array", + "items": { + "type": "string" + }, + "description": "List of files. Required for JobInputHttp. Maximum of 4000 characters each." + }, + "start": { + "$ref": "#/definitions/ClipTime", + "description": "Defines a point on the timeline of the input media at which processing will start. Defaults to the beginning of the input media." + }, + "end": { + "$ref": "#/definitions/ClipTime", + "description": "Defines a point on the timeline of the input media at which processing will end. Defaults to the end of the input media." + }, + "label": { + "type": "string", + "description": "A label that is assigned to a JobInputClip, that is used to satisfy a reference used in the Transform. For example, a Transform can be authored so as to take an image file with the label 'xyz' and apply it as an overlay onto the input video before it is encoded. When submitting a Job, exactly one of the JobInputs should be the image file, and it should have the label 'xyz'." + } + }, + "type": "object", + "description": "Represents input files for a Job." + }, + "ClipTime": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Base class for specifying a clip time. Use sub classes of this class to specify the time position in the media." + }, + "AbsoluteClipTime": { + "x-ms-discriminator-value": "#Microsoft.Media.AbsoluteClipTime", + "allOf": [ + { + "$ref": "#/definitions/ClipTime" + } + ], + "properties": { + "time": { + "type": "string", + "format": "duration", + "description": "The time position on the timeline of the input media. It is usually specified as an ISO8601 period. e.g PT30S for 30 seconds." + } + }, + "type": "object", + "required": [ + "time" + ], + "description": "Specifies the clip time as an absolute time position in the media file. The absolute time can point to a different position depending on whether the media file starts from a timestamp of zero or not." + }, + "JobInputs": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputs", + "allOf": [ + { + "$ref": "#/definitions/JobInput" + } + ], + "properties": { + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/JobInput" + }, + "description": "List of inputs to a Job." + } + }, + "type": "object", + "description": "Describes a list of inputs to a Job." + }, + "JobInputAsset": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputAsset", + "allOf": [ + { + "$ref": "#/definitions/JobInputClip" + } + ], + "properties": { + "assetName": { + "type": "string", + "description": "The name of the input Asset." + } + }, + "type": "object", + "required": [ + "assetName" + ], + "description": "Represents an Asset for input into a Job." + }, + "JobInputHttp": { + "x-ms-discriminator-value": "#Microsoft.Media.JobInputHttp", + "allOf": [ + { + "$ref": "#/definitions/JobInputClip" + } + ], + "properties": { + "baseUri": { + "type": "string", + "description": "Base URI for HTTPS job input. It will be concatenated with provided file names. If no base uri is given, then the provided file list is assumed to be fully qualified uris. Maximum length of 4000 characters." + } + }, + "type": "object", + "description": "Represents HTTPS job input." + }, + "JobOutput": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "error": { + "$ref": "#/definitions/JobError", + "description": "If the JobOutput is in the Error state, it contains the details of the error.", + "readOnly": true + }, + "state": { + "type": "string", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobState", + "values": [ + { + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ], + "modelAsString": true + }, + "description": "Describes the state of the JobOutput.", + "readOnly": true, + "x-nullable": false + }, + "progress": { + "type": "integer", + "format": "int32", + "description": "If the JobOutput is in a Processing state, this contains the Job completion percentage. The value is an estimate and not intended to be used to predict Job completion times. To determine if the JobOutput is complete, use the State property.", + "readOnly": true, + "x-nullable": false + }, + "label": { + "type": "string", + "description": "A label that is assigned to a JobOutput in order to help uniquely identify it. This is useful when your Transform has more than one TransformOutput, whereby your Job has more than one JobOutput. In such cases, when you submit the Job, you will add two or more JobOutputs, in the same order as TransformOutputs in the Transform. Subsequently, when you retrieve the Job, either through events or on a GET request, you can use the label to easily identify the JobOutput. If a label is not provided, a default value of '{presetName}_{outputIndex}' will be used, where the preset name is the name of the preset in the corresponding TransformOutput and the output index is the relative index of the this JobOutput within the Job. Note that this index is the same as the relative index of the corresponding TransformOutput within its Transform." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which this Job Output began processing.", + "readOnly": true, + "x-nullable": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which this Job Output finished processing.", + "readOnly": true, + "x-nullable": true + } + }, + "type": "object", + "required": [ + "@odata.type" + ], + "description": "Describes all the properties of a JobOutput." + }, + "JobError": { + "properties": { + "code": { + "type": "string", + "enum": [ + "ServiceError", + "ServiceTransientError", + "DownloadNotAccessible", + "DownloadTransientError", + "UploadNotAccessible", + "UploadTransientError", + "ConfigurationUnsupported", + "ContentMalformed", + "ContentUnsupported" + ], + "x-ms-enum": { + "name": "JobErrorCode", + "values": [ + { + "value": "ServiceError", + "description": "Fatal service error, please contact support." + }, + { + "value": "ServiceTransientError", + "description": "Transient error, please retry, if retry is unsuccessful, please contact support." + }, + { + "value": "DownloadNotAccessible", + "description": "While trying to download the input files, the files were not accessible, please check the availability of the source." + }, + { + "value": "DownloadTransientError", + "description": "While trying to download the input files, there was an issue during transfer (storage service, network errors), see details and check your source." + }, + { + "value": "UploadNotAccessible", + "description": "While trying to upload the output files, the destination was not reachable, please check the availability of the destination." + }, + { + "value": "UploadTransientError", + "description": "While trying to upload the output files, there was an issue during transfer (storage service, network errors), see details and check your destination." + }, + { + "value": "ConfigurationUnsupported", + "description": "There was a problem with the combination of input files and the configuration settings applied, fix the configuration settings and retry with the same input, or change input to match the configuration." + }, + { + "value": "ContentMalformed", + "description": "There was a problem with the input content (for example: zero byte files, or corrupt/non-decodable files), check the input files." + }, + { + "value": "ContentUnsupported", + "description": "There was a problem with the format of the input (not valid media file, or an unsupported file/codec), check the validity of the input files." + } + ], + "modelAsString": true + }, + "description": "Error code describing the error.", + "readOnly": true, + "x-nullable": false + }, + "message": { + "type": "string", + "description": "A human-readable language-dependent representation of the error.", + "readOnly": true + }, + "category": { + "type": "string", + "enum": [ + "Service", + "Download", + "Upload", + "Configuration", + "Content" + ], + "x-ms-enum": { + "name": "JobErrorCategory", + "values": [ + { + "value": "Service", + "description": "The error is service related." + }, + { + "value": "Download", + "description": "The error is download related." + }, + { + "value": "Upload", + "description": "The error is upload related." + }, + { + "value": "Configuration", + "description": "The error is configuration related." + }, + { + "value": "Content", + "description": "The error is related to data in the input files." + } + ], + "modelAsString": true + }, + "description": "Helps with categorization of errors.", + "readOnly": true, + "x-nullable": false + }, + "retry": { + "type": "string", + "enum": [ + "DoNotRetry", + "MayRetry" + ], + "x-ms-enum": { + "name": "JobRetry", + "values": [ + { + "value": "DoNotRetry", + "description": "Issue needs to be investigated and then the job resubmitted with corrections or retried once the underlying issue has been corrected." + }, + { + "value": "MayRetry", + "description": "Issue may be resolved after waiting for a period of time and resubmitting the same Job." + } + ], + "modelAsString": true + }, + "description": "Indicates that it may be possible to retry the Job. If retry is unsuccessful, please contact Azure support via Azure Portal.", + "readOnly": true, + "x-nullable": false + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorDetail" + }, + "description": "An array of details about specific errors that led to this reported error.", + "readOnly": true + } + }, + "type": "object", + "description": "Details of JobOutput errors." + }, + "JobOutputAsset": { + "x-ms-discriminator-value": "#Microsoft.Media.JobOutputAsset", + "allOf": [ + { + "$ref": "#/definitions/JobOutput" + } + ], + "properties": { + "assetName": { + "type": "string", + "description": "The name of the output Asset." + } + }, + "type": "object", + "required": [ + "assetName" + ], + "description": "Represents an Asset used as a JobOutput." + }, + "JobErrorDetail": { + "properties": { + "code": { + "type": "string", + "description": "Code describing the error detail.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "A human-readable representation of the error.", + "readOnly": true + } + }, + "type": "object", + "description": "Details of JobOutput errors." + }, + "JobProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Job was created, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "state": { + "type": "string", + "enum": [ + "Canceled", + "Canceling", + "Error", + "Finished", + "Processing", + "Queued", + "Scheduled" + ], + "x-ms-enum": { + "name": "JobState", + "values": [ + { + "value": "Canceled", + "description": "The job was canceled. This is a final state for the job." + }, + { + "value": "Canceling", + "description": "The job is in the process of being canceled. This is a transient state for the job." + }, + { + "value": "Error", + "description": "The job has encountered an error. This is a final state for the job." + }, + { + "value": "Finished", + "description": "The job is finished. This is a final state for the job." + }, + { + "value": "Processing", + "description": "The job is processing. This is a transient state for the job." + }, + { + "value": "Queued", + "description": "The job is in a queued state, waiting for resources to become available. This is a transient state." + }, + { + "value": "Scheduled", + "description": "The job is being scheduled to run on an available resource. This is a transient state, between queued and processing states." + } + ], + "modelAsString": true + }, + "description": "The current state of the job.", + "readOnly": true, + "x-nullable": false + }, + "description": { + "type": "string", + "description": "Optional customer supplied description of the Job." + }, + "input": { + "$ref": "#/definitions/JobInput", + "description": "The inputs for the Job." + }, + "lastModified": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time when the Job was last updated, in 'YYYY-MM-DDThh:mm:ssZ' format.", + "readOnly": true, + "x-nullable": false + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/JobOutput" + }, + "description": "The outputs for the Job." + }, + "priority": { + "type": "string", + "enum": [ + "Low", + "Normal", + "High" + ], + "x-ms-enum": { + "name": "Priority", + "values": [ + { + "value": "Low", + "description": "Used for TransformOutputs that can be generated after Normal and High priority TransformOutputs." + }, + { + "value": "Normal", + "description": "Used for TransformOutputs that can be generated at Normal priority." + }, + { + "value": "High", + "description": "Used for TransformOutputs that should take precedence over others." + } + ], + "modelAsString": true + }, + "description": "Priority with which the job should be processed. Higher priority jobs are processed before lower priority jobs. If not set, the default is normal." + }, + "correlationData": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Customer provided key, value pairs that will be returned in Job and JobOutput state events." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which this Job began processing.", + "readOnly": true, + "x-nullable": true + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The UTC date and time at which this Job finished processing.", + "readOnly": true, + "x-nullable": true + } + }, + "type": "object", + "required": [ + "input", + "outputs" + ], + "description": "Properties of the Job." + }, + "Job": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The resource properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Job resource type. The progress and state can be obtained by polling a Job or subscribing to events using EventGrid." + }, + "TransformCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Transform" + }, + "description": "A collection of Transform items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Transform items." + }, + "JobCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Job" + }, + "description": "A collection of Job items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of Job items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms": { + "get": { + "summary": "List Transforms", + "description": "Lists the Transforms in the account.", + "operationId": "Transforms_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/TransformCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Transform", + "x-ms-examples": { + "Lists the Transforms": { + "$ref": "examples/transforms-list-all.json" + }, + "Lists the Transforms filter by name": { + "$ref": "examples/transforms-list-all-filter-by-name.json" + }, + "Lists the Transforms filter by created": { + "$ref": "examples/transforms-list-all-filter-by-created.json" + }, + "Lists the Transforms filter by lastmodified": { + "$ref": "examples/transforms-list-all-filter-by-lastmodified.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}": { + "get": { + "summary": "Get Transform", + "description": "Gets a Transform.", + "operationId": "Transforms_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Transform by name": { + "$ref": "examples/transforms-get-by-name.json" + } + } + }, + "put": { + "summary": "Create or Update Transform", + "description": "Creates or updates a new Transform.", + "operationId": "Transforms_CreateOrUpdate", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transform" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create or update a Transform": { + "$ref": "examples/transforms-create.json" + } + } + }, + "delete": { + "summary": "Delete Transform", + "description": "Deletes a Transform.", + "operationId": "Transforms_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Transform": { + "$ref": "examples/transforms-delete.json" + } + } + }, + "patch": { + "summary": "Update Transform", + "description": "Updates a Transform.", + "operationId": "Transforms_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Transform" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Transform" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Transform.": { + "$ref": "examples/transforms-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs": { + "get": { + "summary": "List Jobs", + "description": "Lists all of the Jobs for the Transform.", + "operationId": "Jobs_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/JobCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/Job", + "x-ms-examples": { + "Lists all of the Jobs for the Transform.": { + "$ref": "examples/jobs-list-all.json" + }, + "Lists Jobs for the Transform filter by name.": { + "$ref": "examples/jobs-list-all-filter-by-name.json" + }, + "Lists Jobs for the Transform filter by state equal.": { + "$ref": "examples/jobs-list-all-filter-by-state-eq.json" + }, + "Lists Jobs for the Transform filter by state not equal.": { + "$ref": "examples/jobs-list-all-filter-by-state-ne.json" + }, + "Lists Jobs for the Transform filter by name and state.": { + "$ref": "examples/jobs-list-all-filter-by-name-and-state.json" + }, + "Lists Jobs for the Transform filter by created.": { + "$ref": "examples/jobs-list-all-filter-by-created.json" + }, + "Lists Jobs for the Transform filter by lastmodified.": { + "$ref": "examples/jobs-list-all-filter-by-lastmodified.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}": { + "get": { + "summary": "Get Job", + "description": "Gets a Job.", + "operationId": "Jobs_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Job by name": { + "$ref": "examples/jobs-get-by-name.json" + } + } + }, + "put": { + "summary": "Create Job", + "description": "Creates a Job.", + "operationId": "Jobs_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Job" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Create a Job": { + "$ref": "examples/jobs-create.json" + } + } + }, + "delete": { + "summary": "Delete Job", + "description": "Deletes a Job.", + "operationId": "Jobs_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Job": { + "$ref": "examples/jobs-delete.json" + } + } + }, + "patch": { + "summary": "Update Job", + "description": "Update is only supported for description and priority. Updating Priority will take effect when the Job state is Queued or Scheduled and depending on the timing the priority update may be ignored.", + "operationId": "Jobs_Update", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Job" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Update a Job": { + "$ref": "examples/jobs-update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/transforms/{transformName}/jobs/{jobName}/cancelJob": { + "post": { + "summary": "Cancel Job", + "description": "Cancel a Job.", + "operationId": "Jobs_CancelJob", + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "transformName", + "in": "path", + "required": true, + "type": "string", + "description": "The Transform name." + }, + { + "name": "jobName", + "in": "path", + "required": true, + "type": "string", + "description": "The Job name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Cancel a Job": { + "$ref": "examples/jobs-cancel.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/StreamingPoliciesAndStreamingLocators.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/StreamingPoliciesAndStreamingLocators.json new file mode 100644 index 000000000000..37e7bd9ee454 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/StreamingPoliciesAndStreamingLocators.json @@ -0,0 +1,1254 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "This Swagger was generated by the API Framework.", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "definitions": { + "TrackPropertyCondition": { + "properties": { + "property": { + "type": "string", + "enum": [ + "Unknown", + "FourCC" + ], + "x-ms-enum": { + "name": "TrackPropertyType", + "values": [ + { + "value": "Unknown", + "description": "Unknown track property" + }, + { + "value": "FourCC", + "description": "Track FourCC" + } + ], + "modelAsString": true + }, + "description": "Track property type" + }, + "operation": { + "type": "string", + "enum": [ + "Unknown", + "Equal" + ], + "x-ms-enum": { + "name": "TrackPropertyCompareOperation", + "values": [ + { + "value": "Unknown", + "description": "Unknown track property compare operation" + }, + { + "value": "Equal", + "description": "Equal operation" + } + ], + "modelAsString": true + }, + "description": "Track property condition operation" + }, + "value": { + "type": "string", + "description": "Track property value" + } + }, + "type": "object", + "required": [ + "property", + "operation" + ], + "description": "Class to specify one track property condition" + }, + "TrackSelection": { + "properties": { + "trackSelections": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackPropertyCondition" + }, + "description": "TrackSelections is a track property condition list which can specify track(s)" + } + }, + "type": "object", + "description": "Class to select a track" + }, + "DefaultKey": { + "properties": { + "label": { + "type": "string", + "description": "Label can be used to specify Content Key when creating a Streaming Locator" + }, + "policyName": { + "type": "string", + "description": "Policy used by Default Key" + } + }, + "type": "object", + "description": "Class to specify properties of default content key for each encryption scheme" + }, + "StreamingPolicyContentKey": { + "properties": { + "label": { + "type": "string", + "description": "Label can be used to specify Content Key when creating a Streaming Locator" + }, + "policyName": { + "type": "string", + "description": "Policy used by Content Key" + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Tracks which use this content key" + } + }, + "type": "object", + "description": "Class to specify properties of content key" + }, + "StreamingPolicyContentKeys": { + "properties": { + "defaultKey": { + "$ref": "#/definitions/DefaultKey", + "description": "Default content key for an encryption scheme" + }, + "keyToTrackMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPolicyContentKey" + }, + "description": "Representing tracks needs separate content key" + } + }, + "type": "object", + "description": "Class to specify properties of all content keys in Streaming Policy" + }, + "StreamingPolicyPlayReadyConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested." + }, + "playReadyCustomAttributes": { + "type": "string", + "description": "Custom attributes for PlayReady" + } + }, + "type": "object", + "description": "Class to specify configurations of PlayReady in Streaming Policy" + }, + "StreamingPolicyWidevineConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested." + } + }, + "type": "object", + "description": "Class to specify configurations of Widevine in Streaming Policy" + }, + "StreamingPolicyFairPlayConfiguration": { + "properties": { + "customLicenseAcquisitionUrlTemplate": { + "type": "string", + "description": "Template for the URL of the custom service delivering licenses to end user players. Not required when using Azure Media Services for issuing licenses. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested." + }, + "allowPersistentLicense": { + "type": "boolean", + "description": "All license to be persistent or not" + } + }, + "type": "object", + "required": [ + "allowPersistentLicense" + ], + "description": "Class to specify configurations of FairPlay in Streaming Policy" + }, + "CbcsDrmConfiguration": { + "properties": { + "fairPlay": { + "$ref": "#/definitions/StreamingPolicyFairPlayConfiguration", + "description": "FairPlay configurations" + }, + "playReady": { + "$ref": "#/definitions/StreamingPolicyPlayReadyConfiguration", + "description": "PlayReady configurations" + }, + "widevine": { + "$ref": "#/definitions/StreamingPolicyWidevineConfiguration", + "description": "Widevine configurations" + } + }, + "type": "object", + "description": "Class to specify DRM configurations of CommonEncryptionCbcs scheme in Streaming Policy" + }, + "CencDrmConfiguration": { + "properties": { + "playReady": { + "$ref": "#/definitions/StreamingPolicyPlayReadyConfiguration", + "description": "PlayReady configurations" + }, + "widevine": { + "$ref": "#/definitions/StreamingPolicyWidevineConfiguration", + "description": "Widevine configurations" + } + }, + "type": "object", + "description": "Class to specify DRM configurations of CommonEncryptionCenc scheme in Streaming Policy" + }, + "EnabledProtocols": { + "properties": { + "download": { + "type": "boolean", + "description": "Enable Download protocol or not" + }, + "dash": { + "type": "boolean", + "description": "Enable DASH protocol or not" + }, + "hls": { + "type": "boolean", + "description": "Enable HLS protocol or not" + }, + "smoothStreaming": { + "type": "boolean", + "description": "Enable SmoothStreaming protocol or not" + } + }, + "type": "object", + "required": [ + "download", + "dash", + "hls", + "smoothStreaming" + ], + "description": "Class to specify which protocols are enabled" + }, + "NoEncryption": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + } + }, + "type": "object", + "description": "Class for NoEncryption scheme" + }, + "EnvelopeEncryption": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "customKeyAcquisitionUrlTemplate": { + "type": "string", + "description": "Template for the URL of the custom service delivering keys to end user players. Not required when using Azure Media Services for issuing keys. The template supports replaceable tokens that the service will update at runtime with the value specific to the request. The currently supported token values are {AlternativeMediaId}, which is replaced with the value of StreamingLocatorId.AlternativeMediaId, and {ContentKeyId}, which is replaced with the value of identifier of the key being requested." + } + }, + "type": "object", + "description": "Class for EnvelopeEncryption encryption scheme" + }, + "CommonEncryptionCenc": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "drm": { + "$ref": "#/definitions/CencDrmConfiguration", + "description": "Configuration of DRMs for CommonEncryptionCenc encryption scheme" + } + }, + "type": "object", + "description": "Class for envelope encryption scheme" + }, + "CommonEncryptionCbcs": { + "properties": { + "enabledProtocols": { + "$ref": "#/definitions/EnabledProtocols", + "description": "Representing supported protocols" + }, + "clearTracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Representing which tracks should not be encrypted" + }, + "contentKeys": { + "$ref": "#/definitions/StreamingPolicyContentKeys", + "description": "Representing default content key for each encryption scheme and separate content keys for specific tracks" + }, + "drm": { + "$ref": "#/definitions/CbcsDrmConfiguration", + "description": "Configuration of DRMs for current encryption scheme" + } + }, + "type": "object", + "description": "Class for CommonEncryptionCbcs encryption scheme" + }, + "StreamingPolicyProperties": { + "properties": { + "created": { + "type": "string", + "format": "date-time", + "description": "Creation time of Streaming Policy", + "readOnly": true, + "x-nullable": false + }, + "defaultContentKeyPolicyName": { + "type": "string", + "description": "Default ContentKey used by current Streaming Policy" + }, + "envelopeEncryption": { + "$ref": "#/definitions/EnvelopeEncryption", + "description": "Configuration of EnvelopeEncryption" + }, + "commonEncryptionCenc": { + "$ref": "#/definitions/CommonEncryptionCenc", + "description": "Configuration of CommonEncryptionCenc" + }, + "commonEncryptionCbcs": { + "$ref": "#/definitions/CommonEncryptionCbcs", + "description": "Configuration of CommonEncryptionCbcs" + }, + "noEncryption": { + "$ref": "#/definitions/NoEncryption", + "description": "Configurations of NoEncryption" + } + }, + "type": "object", + "description": "Class to specify properties of Streaming Policy" + }, + "StreamingPolicy": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StreamingPolicyProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Streaming Policy resource" + }, + "StreamingLocatorContentKey": { + "properties": { + "id": { + "type": "string", + "format": "uuid", + "description": "ID of Content Key" + }, + "type": { + "type": "string", + "enum": [ + "CommonEncryptionCenc", + "CommonEncryptionCbcs", + "EnvelopeEncryption" + ], + "x-ms-enum": { + "name": "StreamingLocatorContentKeyType", + "values": [ + { + "value": "CommonEncryptionCenc", + "description": "Common Encryption using CENC" + }, + { + "value": "CommonEncryptionCbcs", + "description": "Common Encryption using CBCS" + }, + { + "value": "EnvelopeEncryption", + "description": "Envelope Encryption" + } + ], + "modelAsString": true + }, + "description": "Encryption type of Content Key", + "readOnly": true, + "x-nullable": false + }, + "labelReferenceInStreamingPolicy": { + "type": "string", + "description": "Label of Content Key as specified in the Streaming Policy" + }, + "value": { + "type": "string", + "description": "Value of Content Key" + }, + "policyName": { + "type": "string", + "description": "ContentKeyPolicy used by Content Key", + "readOnly": true + }, + "tracks": { + "type": "array", + "items": { + "$ref": "#/definitions/TrackSelection" + }, + "description": "Tracks which use this Content Key", + "readOnly": true + } + }, + "type": "object", + "required": [ + "id" + ], + "description": "Class for content key in Streaming Locator" + }, + "StreamingPath": { + "properties": { + "streamingProtocol": { + "type": "string", + "enum": [ + "Hls", + "Dash", + "SmoothStreaming", + "Download" + ], + "x-ms-enum": { + "name": "StreamingPolicyStreamingProtocol", + "values": [ + { + "value": "Hls", + "description": "HLS protocol" + }, + { + "value": "Dash", + "description": "DASH protocol" + }, + { + "value": "SmoothStreaming", + "description": "SmoothStreaming protocol" + }, + { + "value": "Download", + "description": "Download protocol" + } + ], + "modelAsString": true + }, + "description": "Streaming protocol" + }, + "encryptionScheme": { + "type": "string", + "enum": [ + "NoEncryption", + "EnvelopeEncryption", + "CommonEncryptionCenc", + "CommonEncryptionCbcs" + ], + "x-ms-enum": { + "name": "EncryptionScheme", + "values": [ + { + "value": "NoEncryption", + "description": "NoEncryption scheme" + }, + { + "value": "EnvelopeEncryption", + "description": "EnvelopeEncryption scheme" + }, + { + "value": "CommonEncryptionCenc", + "description": "CommonEncryptionCenc scheme" + }, + { + "value": "CommonEncryptionCbcs", + "description": "CommonEncryptionCbcs scheme" + } + ], + "modelAsString": true + }, + "description": "Encryption scheme" + }, + "paths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Streaming paths for each protocol and encryptionScheme pair" + } + }, + "type": "object", + "required": [ + "streamingProtocol", + "encryptionScheme" + ], + "description": "Class of paths for streaming" + }, + "StreamingLocatorProperties": { + "properties": { + "assetName": { + "type": "string", + "description": "Asset Name" + }, + "created": { + "type": "string", + "format": "date-time", + "description": "The creation time of the Streaming Locator.", + "readOnly": true, + "x-nullable": false + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The start time of the Streaming Locator." + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "The end time of the Streaming Locator." + }, + "streamingLocatorId": { + "type": "string", + "format": "uuid", + "description": "The StreamingLocatorId of the Streaming Locator." + }, + "streamingPolicyName": { + "type": "string", + "description": "Name of the Streaming Policy used by this Streaming Locator. Either specify the name of Streaming Policy you created or use one of the predefined Streaming Policies. The predefined Streaming Policies available are: 'Predefined_DownloadOnly', 'Predefined_ClearStreamingOnly', 'Predefined_DownloadAndClearStreaming', 'Predefined_ClearKey', 'Predefined_MultiDrmCencStreaming' and 'Predefined_MultiDrmStreaming'" + }, + "defaultContentKeyPolicyName": { + "type": "string", + "description": "Name of the default ContentKeyPolicy used by this Streaming Locator." + }, + "contentKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocatorContentKey" + }, + "description": "The ContentKeys used by this Streaming Locator." + }, + "alternativeMediaId": { + "type": "string", + "description": "Alternative Media ID of this Streaming Locator" + }, + "filters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of asset or account filters which apply to this streaming locator" + } + }, + "type": "object", + "required": [ + "assetName", + "streamingPolicyName" + ], + "description": "Properties of the Streaming Locator." + }, + "ListContentKeysResponse": { + "properties": { + "contentKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocatorContentKey" + }, + "description": "ContentKeys used by current Streaming Locator" + } + }, + "type": "object", + "description": "Class of response for listContentKeys action" + }, + "ListPathsResponse": { + "properties": { + "streamingPaths": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPath" + }, + "description": "Streaming Paths supported by current Streaming Locator" + }, + "downloadPaths": { + "type": "array", + "items": { + "type": "string" + }, + "description": "Download Paths supported by current Streaming Locator" + } + }, + "type": "object", + "description": "Class of response for listPaths action" + }, + "StreamingLocator": { + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StreamingLocatorProperties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "description": "A Streaming Locator resource" + }, + "StreamingPolicyCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingPolicy" + }, + "description": "A collection of StreamingPolicy items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of StreamingPolicy items." + }, + "StreamingLocatorCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingLocator" + }, + "description": "A collection of StreamingLocator items." + }, + "@odata.nextLink": { + "type": "string", + "description": "A link to the next page of the collection (when the collection contains too many results to return in one response)." + } + }, + "type": "object", + "description": "A collection of StreamingLocator items." + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies": { + "get": { + "summary": "List Streaming Policies", + "description": "Lists the Streaming Policies in the account", + "operationId": "StreamingPolicies_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingPolicyCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/StreamingPolicy", + "x-ms-examples": { + "Lists Streaming Policies": { + "$ref": "examples/streaming-policies-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingPolicies/{streamingPolicyName}": { + "get": { + "summary": "Get a Streaming Policy", + "description": "Get the details of a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingPolicy" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Streaming Policy by name": { + "$ref": "examples/streaming-policy-get-by-name.json" + } + } + }, + "put": { + "summary": "Create a Streaming Policy", + "description": "Create a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/StreamingPolicy" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingPolicy" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Streaming Policy with clear streaming": { + "$ref": "examples/streaming-policies-create-clear.json" + }, + "Creates a Streaming Policy with envelopeEncryption only": { + "$ref": "examples/streaming-policies-create-envelopeEncryption-only.json" + }, + "Creates a Streaming Policy with commonEncryptionCenc only": { + "$ref": "examples/streaming-policies-create-commonEncryptionCenc-only.json" + }, + "Creates a Streaming Policy with commonEncryptionCbcs only": { + "$ref": "examples/streaming-policies-create-commonEncryptionCbcs-only.json" + }, + "Creates a Streaming Policy with secure streaming": { + "$ref": "examples/streaming-policies-create-secure-streaming.json" + } + } + }, + "delete": { + "summary": "Delete a Streaming Policy", + "description": "Deletes a Streaming Policy in the Media Services account", + "operationId": "StreamingPolicies_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Policy name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Streaming Policy": { + "$ref": "examples/streaming-policies-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators": { + "get": { + "summary": "List Streaming Locators", + "description": "Lists the Streaming Locators in the account", + "operationId": "StreamingLocators_List", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingLocatorCollection" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "Restricts the set of items returned." + }, + { + "name": "$top", + "in": "query", + "required": false, + "type": "integer", + "description": "Specifies a non-negative integer n that limits the number of items returned from a collection. The service returns the number of available items up to but not greater than the specified value n." + }, + { + "name": "$orderby", + "in": "query", + "required": false, + "type": "string", + "description": "Specifies the key by which the result collection should be ordered." + } + ], + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-odata": "#/definitions/StreamingLocator", + "x-ms-examples": { + "Lists Streaming Locators": { + "$ref": "examples/streaming-locators-list.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}": { + "get": { + "summary": "Get a Streaming Locator", + "description": "Get the details of a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Get", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/StreamingLocator" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Get a Streaming Locator by name": { + "$ref": "examples/streaming-locators-get-by-name.json" + } + } + }, + "put": { + "summary": "Create a Streaming Locator", + "description": "Create a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Create", + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/StreamingLocator" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingLocator" + }, + "description": "The request parameters" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Creates a Streaming Locator with clear streaming": { + "$ref": "examples/streaming-locators-create-clear.json" + }, + "Creates a Streaming Locator with secure streaming": { + "$ref": "examples/streaming-locators-create-secure.json" + }, + "Creates a Streaming Locator with user defined content keys": { + "$ref": "examples/streaming-locators-create-secure-userDefinedContentKeys.json" + } + } + }, + "delete": { + "summary": "Delete a Streaming Locator", + "description": "Deletes a Streaming Locator in the Media Services account", + "operationId": "StreamingLocators_Delete", + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "NoContent" + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "Delete a Streaming Locator": { + "$ref": "examples/streaming-locators-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listContentKeys": { + "post": { + "summary": "List Content Keys", + "description": "List Content Keys used by this Streaming Locator", + "operationId": "StreamingLocators_ListContentKeys", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListContentKeysResponse" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Content Keys": { + "$ref": "examples/streaming-locators-list-content-keys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaServices/{accountName}/streamingLocators/{streamingLocatorName}/listPaths": { + "post": { + "summary": "List Paths", + "description": "List Paths supported by this Streaming Locator", + "operationId": "StreamingLocators_ListPaths", + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListPathsResponse" + } + }, + "default": { + "description": "Detailed error information.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "name": "streamingLocatorName", + "in": "path", + "required": true, + "type": "string", + "description": "The Streaming Locator name." + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "x-ms-examples": { + "List Paths which has streaming paths only": { + "$ref": "examples/streaming-locators-list-paths-streaming-only.json" + }, + "List Paths which has streaming paths and download paths": { + "$ref": "examples/streaming-locators-list-paths-streaming-and-download.json" + } + } + } + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The unique identifier for a Microsoft Azure subscription." + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group within the Azure subscription.", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "description": "The Media Services account name.", + "x-ms-parameter-location": "method" + }, + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The Version of the API to be used with the client request." + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-create.json new file mode 100644 index 000000000000..77adbae7b6e8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-create.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "filterName": "newAccountFilter", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "operation": "Equal", + "value": "Audio" + }, + { + "property": "Language", + "operation": "NotEqual", + "value": "en" + }, + { + "property": "FourCC", + "operation": "NotEqual", + "value": "EC-3" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "operation": "Equal", + "value": "Video" + }, + { + "property": "Bitrate", + "operation": "Equal", + "value": "3000000-5000000" + } + ] + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "newAccountFilter", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/newAccountFilter", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + }, + "200": { + "body": { + "name": "newAccountFilter", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/newAccountFilter", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-delete.json new file mode 100644 index 000000000000..b8ce20a48042 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "filterName": "accountFilterWithTimeWindowAndTrack", + "api-version": "2020-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-get-by-name.json new file mode 100644 index 000000000000..5a74560c990f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-get-by-name.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "filterName": "accountFilterWithTrack", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "accountFilterWithTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/accountFilterWithTrack", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + }, + "404": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-list-all.json new file mode 100644 index 000000000000..3fea2d6b9abe --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-list-all.json @@ -0,0 +1,111 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "accountFilterWithTimeWindowAndTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/accountFilterWithTimeWindowAndTrack", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + }, + { + "name": "accountFilterWithTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/accountFilterWithTrack", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-update.json new file mode 100644 index 000000000000..a524fe83e770 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accountFilters-update.json @@ -0,0 +1,81 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "filterName": "accountFilterWithTimeWindowAndTrack", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "presentationTimeRange": { + "startTimestamp": 10, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "accountFilterWithTimeWindowAndTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/accountFilters/accountFilterWithTimeWindowAndTrack", + "type": "Microsoft.Media/mediaservices/accountFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 10, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-check-name-availability.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-check-name-availability.json new file mode 100644 index 000000000000..d706c1e825ec --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-check-name-availability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "locationName": "japaneast", + "parameters": { + "name": "contosonew", + "type": "Microsoft.Media/MediaService" + }, + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "reason": "None", + "message": "" + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-create.json new file mode 100644 index 000000000000..8f761a357b83 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-create.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2020-05-01", + "parameters": { + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + }, + "200": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-delete.json new file mode 100644 index 000000000000..70012feb623d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2020-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-get-by-name.json new file mode 100644 index 000000000000..7512c2a08c66 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-get-by-name.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosotv", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-list-all-accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-list-all-accounts.json new file mode 100644 index 000000000000..04ff56babaec --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-list-all-accounts.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + }, + { + "name": "contosomovies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomovies", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "72681c0f-9dd1-4f1c-95c9-8a8d7d31c4ee", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosomoviesstore", + "type": "Primary" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-list-media-edge-policies.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-list-media-edge-policies.json new file mode 100644 index 000000000000..dff0e11b78cb --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-list-media-edge-policies.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2020-05-01", + "parameters": { + "deviceId": "contosiothubhost_contosoiotdevice" + } + }, + "responses": { + "200": { + "body": { + "usageDataCollectionPolicy": { + "dataCollectionFrequency": "PT10M", + "dataReportingFrequency": "PT1H", + "maxAllowedUnreportedUsageDuration": "PT36H", + "eventHubDetails": { + "name": "ams-x", + "namespace": "ams-y-1-1", + "token": "SharedAccessSignature sr=sb%3a%2f%2fams-x.servicebus.windows.net%2fams-y-1-1%2fPublishers%2f96a510a1-0565-492a-a67f-83d1aed1d1f6_SampleDeviceId&sig=signature_value%3d&se=1584073736&skn=EdgeUsageData" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-subscription-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-subscription-get-by-name.json new file mode 100644 index 000000000000..c40be298ae98 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-subscription-get-by-name.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-subscription-list-all-accounts.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-subscription-list-all-accounts.json new file mode 100644 index 000000000000..ca18508aa67e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-subscription-list-all-accounts.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "contosotv", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosotv", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "6ac94f91-283c-4492-85a7-57976928c17d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosotvstore", + "type": "Primary" + } + ] + } + }, + { + "name": "contosomovies", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomovies", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "72681c0f-9dd1-4f1c-95c9-8a8d7d31c4ee", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contosomoviesstore", + "type": "Primary" + } + ] + } + }, + { + "name": "fabrikamnews", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/fabrikamnews", + "type": "Microsoft.Media/mediaservices", + "location": "East US", + "tags": { + "key1": "value1", + "key2": "value2" + }, + "properties": { + "mediaServiceId": "d96036f9-4e37-491d-8c29-5bc53a29dfcd", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Storage/storageAccounts/fabrikamnewsstore", + "type": "Primary" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-sync-storage-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-sync-storage-keys.json new file mode 100644 index 000000000000..453aaa7a88e8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-sync-storage-keys.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2020-05-01", + "parameters": { + "id": "contososportsstore" + } + }, + "responses": { + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-update.json new file mode 100644 index 000000000000..d1d67e1cc9bb --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/accounts-update.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2020-05-01", + "parameters": { + "location": "South Central US", + "tags": { + "key1": "value3" + } + } + }, + "responses": { + "200": { + "body": { + "name": "contososports", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contososports", + "type": "Microsoft.Media/mediaservices", + "location": "South Central US", + "tags": { + "key1": "value3" + }, + "properties": { + "mediaServiceId": "42bea25f-1aa9-4f7a-82af-5a417592f22d", + "storageAccounts": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Storage/storageAccounts/contososportsstore", + "type": "Primary" + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-create.json new file mode 100644 index 000000000000..f03f5d658dab --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-create.json @@ -0,0 +1,172 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountRainer", + "filterName": "newAssetFilter", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "operation": "Equal", + "value": "Audio" + }, + { + "property": "Language", + "operation": "NotEqual", + "value": "en" + }, + { + "property": "FourCC", + "operation": "NotEqual", + "value": "EC-3" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "operation": "Equal", + "value": "Video" + }, + { + "property": "Bitrate", + "operation": "Equal", + "value": "3000000-5000000" + } + ] + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "newAssetFilter", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/newAssetFilter", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + }, + "200": { + "body": { + "name": "newAssetFilter", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/newAssetFilter", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-delete.json new file mode 100644 index 000000000000..da8d2fe16746 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountRainer", + "filterName": "assetFilterWithTimeWindowAndTrack", + "api-version": "2020-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-get-by-name.json new file mode 100644 index 000000000000..a3f46555e7f9 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-get-by-name.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountRainer", + "filterName": "assetFilterWithTimeWindowAndTrack", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "assetFilterWithTimeWindowAndTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/assetFilterWithTimeWindowAndTrack", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + }, + "404": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-list-all.json new file mode 100644 index 000000000000..7a4244008adf --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-list-all.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountRainer", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "assetFilterWithTimeWindowAndTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/assetFilterWithTimeWindowAndTrack", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + }, + { + "name": "assetFilterWithTimeWindow", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/assetFilterWithTimeWindow", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 0, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [] + } + }, + { + "name": "assetFilterWithTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/assetFilterWithTrack", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-update.json new file mode 100644 index 000000000000..448c28ac5bb2 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assetFilters-update.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountRainer", + "filterName": "assetFilterWithTimeWindowAndTrack", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "presentationTimeRange": { + "startTimestamp": 10, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "assetFilterWithTimeWindowAndTrack", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer/assetFilters/assetFilterWithTimeWindowAndTrack", + "type": "Microsoft.Media/mediaservices/assets/assetFilters", + "properties": { + "presentationTimeRange": { + "startTimestamp": 10, + "endTimestamp": 170000000, + "presentationWindowDuration": 9223372036854775807, + "liveBackoffDuration": 0, + "timescale": 10000000, + "forceEndTimestamp": false + }, + "firstQuality": { + "bitrate": 128000 + }, + "tracks": [ + { + "trackSelections": [ + { + "property": "Type", + "value": "Audio", + "operation": "Equal" + }, + { + "property": "Language", + "value": "en", + "operation": "NotEqual" + }, + { + "property": "FourCC", + "value": "EC-3", + "operation": "NotEqual" + } + ] + }, + { + "trackSelections": [ + { + "property": "Type", + "value": "Video", + "operation": "Equal" + }, + { + "property": "Bitrate", + "value": "3000000-5000000", + "operation": "Equal" + } + ] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-create.json new file mode 100644 index 000000000000..b15a6d7ecff2 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-create.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountLogan", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "description": "A documentary showing the ascent of Mount Logan", + "storageAccountName": "storage0" + } + } + }, + "responses": { + "201": { + "body": { + "name": "ClimbingMountLogan", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountLogan", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "09194258-36ba-4403-abb3-68780e6bc545", + "created": "2018-08-08T18:29:26.08Z", + "lastModified": "2018-08-08T18:29:26.08Z", + "description": "A documentary showing the ascent of Mount Logan", + "container": "asset-09194258-36ba-4403-abb3-68780e6bc545", + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + } + }, + "200": { + "body": { + "name": "ClimbingMountLogan", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountLogan", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "09194258-36ba-4403-abb3-68780e6bc545", + "created": "2018-08-08T18:29:26.08Z", + "lastModified": "2018-08-08T18:29:26.107Z", + "description": "A documentary showing the ascent of Mount Logan", + "container": "asset-09194258-36ba-4403-abb3-68780e6bc545", + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-delete.json new file mode 100644 index 000000000000..0147afd32330 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountAdams", + "api-version": "2020-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-get-by-name.json new file mode 100644 index 000000000000..f4635b39442d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-get-by-name.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountAdams", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": "asset-1b648c1a-2268-461d-a1da-742bde23db40", + "storageEncryptionFormat": "None" + } + } + }, + "404": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-get-encryption-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-get-encryption-keys.json new file mode 100644 index 000000000000..1b0ee2f1db86 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-get-encryption-keys.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountSaintHelens", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "key": "AAAAAAAAAAAAAAAAAAAAAA==", + "assetFileEncryptionMetadata": [ + { + "initializationVector": "-988929866", + "assetFileName": "AssetFile0", + "assetFileId": "a9536fa7-bd5d-4f84-a137-d1290982fe95" + }, + { + "initializationVector": "1604993689", + "assetFileName": "AssetFile1", + "assetFileId": "f4060046-94ac-422d-824c-3f1d6aa3ecf2" + }, + { + "initializationVector": "100082635", + "assetFileName": "AssetFile2", + "assetFileId": "485968d3-ddae-4b13-98e7-901201a9620b" + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-all.json new file mode 100644 index 000000000000..5bba32e159de --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-all.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingLittleTahoma", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingLittleTahoma", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "created": "2012-04-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00003", + "description": "A documentary showing the ascent of Little Tahoma", + "container": "asset-e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": "asset-1b648c1a-2268-461d-a1da-742bde23db40", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker", + "container": "asset-89af1750-e681-4fbe-8c4c-9a5567867a6b", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountRainer", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "258878ef-fe05-4518-988f-052e86dc19f6", + "created": "2018-08-08T18:29:24.3948982Z", + "lastModified": "2018-08-08T21:29:24.3948982Z", + "alternateId": "altClimbingMountRainer", + "description": "descClimbingMountRainer", + "container": "testasset0", + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": "asset-f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountSaintHelens", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountSaintHelens", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "14d58c40-ec1f-446c-b041-f5cff949bd1d", + "created": "2013-03-01T00:00:00Z", + "lastModified": "2013-04-01T00:00:00Z", + "alternateId": "CLIMB00005", + "description": "A documentary showing the ascent of Saint Helens", + "container": "asset-14d58c40-ec1f-446c-b041-f5cff949bd1d", + "storageEncryptionFormat": "MediaStorageClientEncryption" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-by-date.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-by-date.json new file mode 100644 index 000000000000..fb2932e24145 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-by-date.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2020-05-01", + "$orderby": "properties/created" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker", + "container": "asset-89af1750-e681-4fbe-8c4c-9a5567867a6b", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingLittleTahoma", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingLittleTahoma", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "created": "2012-04-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00003", + "description": "A documentary showing the ascent of Little Tahoma", + "container": "asset-e6c7ee55-d1f5-48bc-9c36-2d2157aadbbe", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": "asset-f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": "asset-1b648c1a-2268-461d-a1da-742bde23db40", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountSaintHelens", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountSaintHelens", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "14d58c40-ec1f-446c-b041-f5cff949bd1d", + "created": "2013-03-01T00:00:00Z", + "lastModified": "2013-04-01T00:00:00Z", + "alternateId": "CLIMB00005", + "description": "A documentary showing the ascent of Saint Helens", + "container": "asset-14d58c40-ec1f-446c-b041-f5cff949bd1d", + "storageEncryptionFormat": "MediaStorageClientEncryption" + } + }, + { + "name": "ClimbingMountRainer", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainer", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "8cdacfe5-8473-413a-9aec-dd2a478b37c8", + "created": "2018-08-08T18:29:25.0514734Z", + "lastModified": "2018-08-08T21:29:25.0514734Z", + "alternateId": "altClimbingMountRainer", + "description": "descClimbingMountRainer", + "container": "testasset0", + "storageAccountName": "storage0", + "storageEncryptionFormat": "None" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-in-date-range.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-in-date-range.json new file mode 100644 index 000000000000..8c1e80ae23b8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-in-date-range.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2020-05-01", + "$orderby": "properties/created", + "$filter": "properties/created gt 2012-06-01 and properties/created lt 2013-07-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "ClimbingMountRainier", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountRainier", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "alternateId": "CLIMB00001", + "description": "A documentary showing the ascent of Mount Rainier", + "container": "asset-f8eea45c-b814-44c2-9c42-a5174ebdee4c", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountAdams", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountAdams", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "1b648c1a-2268-461d-a1da-742bde23db40", + "created": "2013-02-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "alternateId": "CLIMB00002", + "description": "A documentary showing the ascent of Mount Adams", + "container": "asset-1b648c1a-2268-461d-a1da-742bde23db40", + "storageEncryptionFormat": "None" + } + }, + { + "name": "ClimbingMountSaintHelens", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountSaintHelens", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "14d58c40-ec1f-446c-b041-f5cff949bd1d", + "created": "2013-03-01T00:00:00Z", + "lastModified": "2013-04-01T00:00:00Z", + "alternateId": "CLIMB00005", + "description": "A documentary showing the ascent of Saint Helens", + "container": "asset-14d58c40-ec1f-446c-b041-f5cff949bd1d", + "storageEncryptionFormat": "MediaStorageClientEncryption" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-sas-urls.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-sas-urls.json new file mode 100644 index 000000000000..e3ac6b3104dd --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-sas-urls.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountBaker", + "api-version": "2020-05-01", + "parameters": { + "permissions": "ReadWrite", + "expiryTime": "2018-01-01T10:00:00.007Z" + } + }, + "responses": { + "200": { + "body": { + "assetContainerSasUrls": [ + "https://storage0.blob.core.windows.net/asset-89af1750-e681-4fbe-8c4c-9a5567867a6b?sr=b&sig=&se=2018-01-01T10:00:00Z&sp=lrw", + "https://storage0.blob.core.windows.net/asset-89af1750-e681-4fbe-8c4c-9a5567867a6b?sr=b&sig=&se=2018-01-01T10:00:00Z&sp=lrw" + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-streaming-locators.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-streaming-locators.json new file mode 100644 index 000000000000..4b99b6b6aae4 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-list-streaming-locators.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountSaintHelens", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "streamingLocators": [ + { + "name": "secureStreamingLocator", + "assetName": "ClimbingMountSaintHelens", + "created": "2018-08-08T18:29:26.9729344Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "36b74ce3-20b4-4de0-84f1-97e9138e886c", + "streamingPolicyName": "secureStreamingPolicy" + }, + { + "name": "clearStreamingLocator", + "assetName": "ClimbingMountSaintHelens", + "created": "2018-08-08T18:29:26.9487636Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "3e8d9ac3-50f6-4f6d-8482-078ceb56f23a", + "streamingPolicyName": "clearStreamingPolicy" + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-update.json new file mode 100644 index 000000000000..2e45ce22a21c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/assets-update.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "assetName": "ClimbingMountBaker", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "description": "A documentary showing the ascent of Mount Baker in HD" + } + } + }, + "responses": { + "200": { + "body": { + "name": "ClimbingMountBaker", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/assets/ClimbingMountBaker", + "type": "Microsoft.Media/mediaservices/assets", + "properties": { + "assetId": "89af1750-e681-4fbe-8c4c-9a5567867a6b", + "created": "2011-02-01T00:00:00Z", + "lastModified": "2018-08-08T18:29:26.503Z", + "alternateId": "CLIMB00004", + "description": "A documentary showing the ascent of Mount Baker in HD", + "container": "asset-89af1750-e681-4fbe-8c4c-9a5567867a6b", + "storageEncryptionFormat": "None" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-multiple-options.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-multiple-options.json new file mode 100644 index 000000000000..fb8abf5c67f6 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-multiple-options.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyCreatedWithMultipleOptions", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + }, + "restrictionTokenType": "Swt" + } + }, + { + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyCreatedWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyCreatedWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "07ad673b-dc14-4230-adab-716622f33992", + "created": "2018-08-08T18:29:29.98Z", + "lastModified": "2018-08-08T18:29:29.98Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "8dac9510-770a-401f-8f2b-f72640977ed0", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt" + } + }, + { + "policyOptionId": "fc121776-6ced-4135-be92-f928dedc029a", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyCreatedWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyCreatedWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "07ad673b-dc14-4230-adab-716622f33992", + "created": "2018-08-08T18:29:29.98Z", + "lastModified": "2018-08-08T18:29:29.98Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "8dac9510-770a-401f-8f2b-f72640977ed0", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt" + } + }, + { + "policyOptionId": "fc121776-6ced-4135-be92-f928dedc029a", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-nodrm-token.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-nodrm-token.json new file mode 100644 index 000000000000..13eca3bac701 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-nodrm-token.json @@ -0,0 +1,102 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + }, + "restrictionTokenType": "Swt" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndSwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "2926c1bc-4dec-4a11-9d19-3f99006530a9", + "created": "2018-08-08T18:29:29.837Z", + "lastModified": "2018-08-08T18:29:29.837Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "e7d4d465-b6f7-4830-9a21-74a7326ef797", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithClearKeyOptionAndSwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndSwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "2926c1bc-4dec-4a11-9d19-3f99006530a9", + "created": "2018-08-08T18:29:29.837Z", + "lastModified": "2018-08-08T18:29:29.837Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "e7d4d465-b6f7-4830-9a21-74a7326ef797", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [], + "restrictionTokenType": "Swt" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-playready-open.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-playready-open.json new file mode 100644 index 000000000000..c1917240ee27 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-playready-open.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "playRight": { + "scmsRestriction": 2, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": true, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed" + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ] + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2018-08-08T18:29:29.51Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "c52f9af0-1f53-4775-8edb-af2d9a6e28cd", + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "playRight": { + "scmsRestriction": 2, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": true, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed" + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ] + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2018-08-08T18:29:29.51Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "c52f9af0-1f53-4775-8edb-af2d9a6e28cd", + "name": "ArmPolicyOptionName", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": true, + "beginDate": "2017-10-16T18:22:53.46Z", + "playRight": { + "scmsRestriction": 2, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": true, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed" + }, + "licenseType": "Persistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "UltraVioletDownload" + } + ] + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-widevine-token.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-widevine-token.json new file mode 100644 index 000000000000..8c88dc47c4ad --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-create-widevine-token.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "description": "ArmPolicyDescription", + "options": [ + { + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "AQAB", + "modulus": "AQAD" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAAAAAAAAAAAAAAAAAAAAA==" + } + ], + "restrictionTokenType": "Jwt" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithWidevineOptionAndJwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "bad1d030-7d5c-4643-8f1e-49807a4bf64c", + "created": "2018-08-08T18:29:29.663Z", + "lastModified": "2018-08-08T18:29:29.663Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "26fee004-8dfa-4828-bcad-5e63c637534f", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "", + "modulus": "" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + } + ], + "requiredClaims": [], + "restrictionTokenType": "Jwt" + } + } + ] + } + } + }, + "201": { + "body": { + "name": "PolicyWithWidevineOptionAndJwtTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithWidevineOptionAndJwtTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "bad1d030-7d5c-4643-8f1e-49807a4bf64c", + "created": "2018-08-08T18:29:29.663Z", + "lastModified": "2018-08-08T18:29:29.663Z", + "description": "ArmPolicyDescription", + "options": [ + { + "policyOptionId": "26fee004-8dfa-4828-bcad-5e63c637534f", + "name": "widevineoption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "urn:issuer", + "audience": "urn:audience", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyRsaTokenKey", + "exponent": "", + "modulus": "" + }, + "alternateVerificationKeys": [ + { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + } + ], + "requiredClaims": [], + "restrictionTokenType": "Jwt" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-delete.json new file mode 100644 index 000000000000..33eba3a15826 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "api-version": "2020-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-get-by-name.json new file mode 100644 index 000000000000..28c9e5dc131d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-get-by-name.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithMultipleOptions", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier" + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt" + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "404": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-get-with-secrets.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-get-with-secrets.json new file mode 100644 index 000000000000..0da829c2d657 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-get-with-secrets.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithMultipleOptions", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "AAA=" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier" + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt" + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + "404": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-all.json new file mode 100644 index 000000000000..a0e49ad9839b --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-all.json @@ -0,0 +1,165 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "description": "A policy with one ClearKey option and Open Restriction.", + "options": [ + { + "policyOptionId": "a3448d09-567a-4642-8309-d17e846be59f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + } + ] + } + }, + { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier", + "claimValue": null + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt", + "openIdConnectDiscoveryDocument": null + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "description": "A policy with one PlayReady option and Open Restriction.", + "options": [ + { + "policyOptionId": "294a833f-f128-48be-9edf-8d1bb5b35ff3", + "name": null, + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": false, + "beginDate": null, + "expirationDate": null, + "relativeBeginDate": null, + "relativeExpirationDate": null, + "gracePeriod": null, + "playRight": { + "firstPlayExpiration": null, + "scmsRestriction": null, + "agcAndColorStripeRestriction": null, + "explicitAnalogTelevisionOutputRestriction": null, + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": false, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed", + "uncompressedDigitalVideoOpl": null, + "compressedDigitalVideoOpl": null, + "analogVideoOpl": null, + "compressedDigitalAudioOpl": null, + "uncompressedDigitalAudioOpl": null + }, + "licenseType": "NonPersistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "Unspecified" + } + ], + "responseCustomData": "testCustomData" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-by-lastModified.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-by-lastModified.json new file mode 100644 index 000000000000..6cb81fd7ad9f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-by-lastModified.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2020-05-01", + "$orderby": "properties/lastModified" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "PolicyWithPlayReadyOptionAndOpenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithPlayReadyOptionAndOpenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "a9bacd1d-60f5-4af3-8d2b-cf46ca5c9b04", + "created": "2012-11-01T00:00:00Z", + "lastModified": "2012-11-01T00:00:00Z", + "description": "A policy with one PlayReady option and Open Restriction.", + "options": [ + { + "policyOptionId": "294a833f-f128-48be-9edf-8d1bb5b35ff3", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyConfiguration", + "licenses": [ + { + "allowTestDevices": false, + "playRight": { + "digitalVideoOnlyContentRestriction": false, + "imageConstraintForAnalogComponentVideoRestriction": false, + "imageConstraintForAnalogComputerMonitorRestriction": false, + "allowPassingVideoContentToUnknownOutput": "NotAllowed" + }, + "licenseType": "NonPersistent", + "contentKeyLocation": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyPlayReadyContentEncryptionKeyFromHeader" + }, + "contentType": "Unspecified" + } + ], + "responseCustomData": "testCustomData" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithMultipleOptions", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithMultipleOptions", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "ed7f3d1b-cfa7-4181-b966-e0b3027eec3a", + "created": "2015-12-01T00:00:00Z", + "lastModified": "2016-12-02T00:00:00Z", + "description": "A policy with multiple options.", + "options": [ + { + "policyOptionId": "caf1e28c-8288-4301-8c46-c0f9312c512f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier" + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt" + } + }, + { + "policyOptionId": "da346259-0cd6-4609-89dc-15ac131bd92f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyWidevineConfiguration", + "widevineTemplate": "{\"allowed_track_types\":\"SD_HD\",\"content_key_specs\":[{\"track_type\":\"SD\",\"security_level\":1,\"required_output_protection\":{\"hdcp\":\"HDCP_V2\"}}],\"policy_overrides\":{\"can_play\":true,\"can_persist\":true,\"can_renew\":false}}" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + }, + { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2017-11-01T00:00:00Z", + "description": "A policy with one ClearKey option and Open Restriction.", + "options": [ + { + "policyOptionId": "a3448d09-567a-4642-8309-d17e846be59f", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyTokenRestriction", + "issuer": "http://testacs", + "audience": "urn:test", + "primaryVerificationKey": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicySymmetricTokenKey", + "keyValue": "" + }, + "alternateVerificationKeys": [], + "requiredClaims": [ + { + "claimType": "urn:microsoft:azure:mediaservices:contentkeyidentifier" + }, + { + "claimType": "DRM", + "claimValue": "Widevine" + } + ], + "restrictionTokenType": "Jwt" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-in-date-range.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-in-date-range.json new file mode 100644 index 000000000000..179d30addc94 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-list-in-date-range.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2020-05-01", + "$filter": "properties/lastModified gt 2016-06-01 and properties/created lt 2013-07-01" + }, + "responses": { + "200": { + "body": { + "value": [] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-update.json new file mode 100644 index 000000000000..33d98dab8af3 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/content-key-policies-update.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "contentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "description": "Updated Policy", + "options": [ + { + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "PolicyWithClearKeyOptionAndTokenRestriction", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/contentKeyPolicies/PolicyWithClearKeyOptionAndTokenRestriction", + "type": "Microsoft.Media/mediaservices/contentKeyPolicies", + "properties": { + "policyId": "8352435b-ebea-4681-aae7-e19277771f64", + "created": "2017-12-01T00:00:00Z", + "lastModified": "2018-08-08T18:29:30.303Z", + "description": "Updated Policy", + "options": [ + { + "policyOptionId": "7d3f4bc1-d2bf-43a3-b02e-a7e31ab15d43", + "name": "ClearKeyOption", + "configuration": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyClearKeyConfiguration" + }, + "restriction": { + "@odata.type": "#Microsoft.Media.ContentKeyPolicyOpenRestriction" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-cancel.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-cancel.json new file mode 100644 index 000000000000..550a8aaf77c8 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-cancel.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "jobName": "job1" + }, + "responses": { + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-create.json new file mode 100644 index 000000000000..13195c89754a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-create.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "jobName": "job1", + "parameters": { + "properties": { + "input": { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "assetName": "job1-InputAsset" + }, + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "assetName": "job1-OutputAsset" + } + ], + "correlationData": { + "key1": "value1", + "Key 2": "Value 2" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2019-10-10T22:38:03.4426085Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job1-InputAsset" + }, + "lastModified": "2019-10-10T22:38:03.4426085Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "BuiltInStandardEncoderPreset_0", + "assetName": "job1-OutputAsset" + } + ], + "priority": "Normal", + "correlationData": { + "key1": "value1", + "Key 2": "Value 2" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-delete.json new file mode 100644 index 000000000000..2b68932ec48f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "jobName": "jobToDelete" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-get-by-name.json new file mode 100644 index 000000000000..b15e14539dbf --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-get-by-name.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "jobName": "job1" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1 output" + } + ], + "priority": "Low", + "correlationData": {} + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-created.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-created.json new file mode 100644 index 000000000000..ab38522ad492 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-created.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/created ge 2019-10-10T22:38:13.1259050Z and properties/created le 2019-10-10T22:38:23.1259050Z", + "$orderby": "properties/created" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2019-10-10T22:38:13.125905Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "2019-10-10T22:38:13.125905Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:03.125905Z", + "assetName": "job2 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:03.125905Z" + } + }, + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2019-10-10T22:38:23.125905Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "2019-10-10T22:38:23.125905Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:03.125905Z", + "endTime": "2019-10-10T22:38:03.125905Z", + "assetName": "job3 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:03.125905Z", + "endTime": "2019-10-10T22:38:03.125905Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-lastmodified.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-lastmodified.json new file mode 100644 index 000000000000..6933bae85fdc --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-lastmodified.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/lastmodified ge 2019-10-10T22:38:13.1931019Z and properties/lastmodified le 2019-10-10T22:38:23.1931019Z", + "$orderby": "properties/lastmodified desc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2019-10-10T22:38:23.1931019Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "2019-10-10T22:38:23.1931019Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:03.1931019Z", + "endTime": "2019-10-10T22:38:03.1931019Z", + "assetName": "job3 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:03.1931019Z", + "endTime": "2019-10-10T22:38:03.1931019Z" + } + }, + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "2019-10-10T22:38:13.1931019Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "2019-10-10T22:38:13.1931019Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:03.1931019Z", + "assetName": "job2 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:03.1931019Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name-and-state.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name-and-state.json new file mode 100644 index 000000000000..201428425920 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name-and-state.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "name eq 'job3' and properties/state eq Microsoft.Media.JobState'finished'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:03.0624915Z", + "endTime": "2019-10-10T22:38:03.0624915Z", + "assetName": "job3 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:03.0624915Z", + "endTime": "2019-10-10T22:38:03.0624915Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name.json new file mode 100644 index 000000000000..2328cdd0e27d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-name.json @@ -0,0 +1,83 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "name eq 'job1' or name eq 'job2'", + "$orderby": "name" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1 output" + } + ], + "priority": "Low", + "correlationData": {} + } + }, + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:02.7835215Z", + "assetName": "job2 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:02.7835215Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-eq.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-eq.json new file mode 100644 index 000000000000..c8bdd90a1084 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-eq.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/state eq Microsoft.Media.JobState'Processing'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:02.8754914Z", + "assetName": "job2 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:02.8754914Z" + } + }, + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:02.8754914Z", + "assetName": "job3 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:02.8754914Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-ne.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-ne.json new file mode 100644 index 000000000000..8271f7e9f526 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all-filter-by-state-ne.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "$filter": "properties/state ne Microsoft.Media.JobState'processing'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1 output" + } + ], + "priority": "Low", + "correlationData": {} + } + }, + { + "name": "job4", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job4", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job4 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:02.9885137Z", + "endTime": "2019-10-10T22:38:02.9885137Z", + "assetName": "job4 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:02.9885137Z", + "endTime": "2019-10-10T22:38:02.9885137Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all.json new file mode 100644 index 000000000000..3ecc50aca0cc --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-list-all.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Queued", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1 output" + } + ], + "priority": "Low", + "correlationData": {} + } + }, + { + "name": "job2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job2", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Processing", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job2 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Processing", + "progress": 50, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:02.6465994Z", + "assetName": "job2 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:02.6465994Z" + } + }, + { + "name": "job3", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job3", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Finished", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job3 input" + } + ] + }, + "lastModified": "0001-01-01T00:00:00Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Finished", + "progress": 100, + "label": "example-custom-label", + "startTime": "2019-10-10T22:28:02.6465994Z", + "endTime": "2019-10-10T22:38:02.6465994Z", + "assetName": "job3 output" + } + ], + "priority": "Low", + "correlationData": {}, + "startTime": "2019-10-10T22:28:02.6465994Z", + "endTime": "2019-10-10T22:38:02.6465994Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-update.json new file mode 100644 index 000000000000..e4cb0593537c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/jobs-update.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "exampleTransform", + "jobName": "job1", + "parameters": { + "properties": { + "description": "Example job to illustrate update.", + "priority": "High", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job1 input" + } + ] + }, + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "label": "example-custom-label", + "assetName": "job1 output" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "job1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/exampleTransform/jobs/job1", + "type": "Microsoft.Media/mediaservices/transforms/jobs", + "properties": { + "created": "0001-01-01T00:00:00Z", + "state": "Queued", + "description": "Example job to illustrate update.", + "input": { + "@odata.type": "#Microsoft.Media.JobInputs", + "inputs": [ + { + "@odata.type": "#Microsoft.Media.JobInputAsset", + "files": [], + "assetName": "job1 input" + } + ] + }, + "lastModified": "2019-10-10T22:38:03.737608Z", + "outputs": [ + { + "@odata.type": "#Microsoft.Media.JobOutputAsset", + "state": "Queued", + "progress": 0, + "label": "example-custom-label", + "assetName": "job1 output" + } + ], + "priority": "High", + "correlationData": {} + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-create.json new file mode 100644 index 000000000000..a87311c83976 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-create.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2020-05-01", + "parameters": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "input": { + "streamingProtocol": "RTMP", + "keyFrameIntervalDuration": "PT6S" + }, + "preview": { + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "InProgress", + "created": "2018-03-03T02:25:06.0982751Z", + "lastModified": "2018-03-03T02:25:06.0982751Z", + "useStaticHostname": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "0abf356884d74b4aacbd7b1ebd3da0f7", + "endpoints": [] + }, + "preview": { + "previewLocator": "c91726b4-880c-4090-94aa-e6ddb1384b37", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + }, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "InProgress", + "created": "2018-03-03T02:25:06.0982751Z", + "lastModified": "2018-03-03T02:25:06.0982751Z", + "useStaticHostname": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "0abf356884d74b4aacbd7b1ebd3da0f7", + "endpoints": [] + }, + "preview": { + "previewLocator": "c91726b4-880c-4090-94aa-e6ddb1384b37", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-delete.json new file mode 100644 index 000000000000..ffcbac281305 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-delete.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2020-05-01", + "parameters": { + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "Name": "myLiveEvent1", + "Type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents", + "Location": "West US", + "Tags": { + "DynamicProperties": { + "tag1": "value1", + "tag2": "value2" + } + }, + "properties": { + "Description": "test event updated", + "Input": { + "StreamingProtocol": "FragmentedMP4", + "KeyFrameIntervalDuration": "PT6S", + "Endpoints": [], + "AccessToken": null + }, + "Preview": { + "Endpoints": [], + "AccessControl": { + "IP": { + "Allow": [ + { + "Name": "AllowOne", + "Address": "192.1.1.0", + "SubnetPrefixLength": null + } + ] + } + }, + "PreviewLocator": null, + "streamingPolicyName": null + }, + "Encoding": { + "EncodingType": "None", + "PresetName": null + }, + "ProvisioningState": null, + "ResourceState": "Stopped", + "CrossSiteAccessPolicies": null, + "useStaticHostname": false, + "StreamOptions": [], + "Created": "2018-03-02T18:25:07.5748853-08:00", + "LastModified": "2018-03-02T18:25:07.5748853-08:00" + } + } + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-list-all.json new file mode 100644 index 000000000000..d9543a6cafc0 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-list-all.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "resourceState": "Stopped", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:08.5564064Z", + "lastModified": "2018-03-03T02:25:08.5564064Z", + "useStaticHostname": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "de153bb0814542d9b7e2339ce9430dc4", + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "http://clouddeployment.media-test.net/de153bb0814542d9b7e2339ce9430dc4/ingest.isml" + } + ] + }, + "preview": { + "previewLocator": "a220e223-faf8-4e03-b9a9-2c2432f48025", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + }, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "https://myliveevent1-slitestmedia10.preview-usso.channel.mediaservices.windows.net/a220e223-faf8-4e03-b9a9-2c2432f48025/preview.ism/manifest" + } + ] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": null, + "crossDomainPolicy": null + } + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-list-by-name.json new file mode 100644 index 000000000000..d7087ca92578 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-list-by-name.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2020-05-01" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": {}, + "properties": { + "description": "", + "resourceState": "Stopped", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:08.3474032Z", + "lastModified": "2018-03-03T02:25:08.3474032Z", + "useStaticHostname": false, + "streamOptions": [ + "Default" + ], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": null, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "http://clouddeployment.media-test.net/ingest.isml" + } + ] + }, + "preview": { + "previewLocator": "763f3ea4-d94f-441c-a634-c833f61a4e04", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowAll", + "address": "0.0.0.0", + "subnetPrefixLength": 0 + } + ] + } + }, + "endpoints": [ + { + "protocol": "FragmentedMP4", + "url": "https://testeventopito4idh2r-weibzmedia05.preview-ts051.channel.media-test.windows-int.net/763f3ea4-d94f-441c-a634-c833f61a4e04/preview.ism/manifest" + } + ] + }, + "encoding": { + "encodingType": "None", + "presetName": null + }, + "crossSiteAccessPolicies": { + "clientAccessPolicy": "", + "crossDomainPolicy": "" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-reset.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-reset.json new file mode 100644 index 000000000000..95fd7e6461e1 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-reset.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2020-05-01" + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-start.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-start.json new file mode 100644 index 000000000000..95fd7e6461e1 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-start.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2020-05-01" + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-stop.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-stop.json new file mode 100644 index 000000000000..a23df8bb0574 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-stop.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2020-05-01", + "parameters": { + "removeOutputsOnStop": false + } + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-update.json new file mode 100644 index 000000000000..0e2416078954 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveevent-update.json @@ -0,0 +1,134 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2020-05-01", + "parameters": { + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "input": { + "streamingProtocol": "FragmentedMP4", + "keyFrameIntervalDuration": "PT6S" + }, + "preview": { + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0" + } + ] + } + } + } + } + } + }, + "responses": { + "202": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "resourceState": "Running", + "provisioningState": "InProgress", + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z", + "useStaticHostname": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "c638baac3195406a84d7ff3bcba8bde4", + "endpoints": [] + }, + "preview": { + "previewLocator": "c10ea3fc-587f-4daf-b2b2-fa8f647a9ed2", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + } + } + } + }, + "200": { + "body": { + "name": "myLiveEvent1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1", + "type": "Microsoft.Media/mediaservices/liveevents", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2", + "tag3": "value3" + }, + "properties": { + "description": "test event updated", + "resourceState": "Running", + "provisioningState": "InProgress", + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z", + "useStaticHostname": false, + "streamOptions": [], + "input": { + "keyFrameIntervalDuration": "PT6S", + "streamingProtocol": "FragmentedMP4", + "accessToken": "c638baac3195406a84d7ff3bcba8bde4", + "endpoints": [] + }, + "preview": { + "previewLocator": "c10ea3fc-587f-4daf-b2b2-fa8f647a9ed2", + "streamingPolicyName": null, + "accessControl": { + "ip": { + "allow": [ + { + "name": "AllowOne", + "address": "192.1.1.0", + "subnetPrefixLength": null + } + ] + } + }, + "endpoints": [] + }, + "encoding": { + "encodingType": "None", + "presetName": null + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-create.json new file mode 100644 index 000000000000..0289f1207488 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-create.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "outputSnapTime": 0, + "resourceState": "Creating", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:09.9431835Z", + "lastModified": "2018-03-03T02:25:09.9431835Z", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + }, + "202": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": "test live output 1", + "assetName": "6f3264f5-a189-48b4-a29a-a40f22575212", + "archiveWindowLength": "PT5M", + "manifestName": "testmanifest", + "outputSnapTime": 0, + "resourceState": "Creating", + "provisioningState": "Succeeded", + "created": "2018-03-03T02:25:09.9431835Z", + "lastModified": "2018-03-03T02:25:09.9431835Z", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-delete.json new file mode 100644 index 000000000000..c4abf69dcc75 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-delete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2020-05-01" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-list-all.json new file mode 100644 index 000000000000..ebf145bcd695 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-list-all.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "liveoutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": null, + "assetName": "95dafce4-5320-464c-8597-909373854119", + "archiveWindowLength": "PT30S", + "manifestName": "c3a23d4b-02a6-4937-a1ad-6416f463fdca", + "outputSnapTime": 0, + "resourceState": "Running", + "provisioningState": "Succeeded", + "created": "0001-01-01T00:00:00-08:00", + "lastModified": "0001-01-01T00:00:00-08:00", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-list-by-name.json new file mode 100644 index 000000000000..fe3c9cfbe866 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/liveoutput-list-by-name.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "liveEventName": "myLiveEvent1", + "liveOutputName": "myLiveOutput1", + "api-version": "2020-05-01" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "myLiveOutput1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/liveevents/myLiveEvent1/liveoutputs/myLiveOutput1", + "type": "Microsoft.Media/mediaservices/liveevents/liveoutputs", + "properties": { + "description": null, + "assetName": "cb2ae0bc-677a-4830-9c8e-06ce4c4cb607", + "archiveWindowLength": "PT30S", + "manifestName": "fc7096f5-c488-4b86-8302-f3bfde53fc27", + "outputSnapTime": 0, + "resourceState": "Running", + "provisioningState": "Succeeded", + "created": "0001-01-01T00:00:00-08:00", + "lastModified": "0001-01-01T00:00:00-08:00", + "hls": { + "fragmentsPerTsSegment": 5 + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/operations-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/operations-list-all.json new file mode 100644 index 000000000000..530eeb904efb --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/operations-list-all.json @@ -0,0 +1,589 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.Media/register/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Registers the Media Services Resource Provider", + "description": "Registers the subscription for the Media Services resource provider and enables the creation of Media Services accounts" + } + }, + { + "name": "Microsoft.Media/unregister/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Unregisters the Media Services Resource Provider", + "description": "Unregisters the subscription for the Media Services resource provider" + } + }, + { + "name": "Microsoft.Media/checknameavailability/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Check Name Availability", + "description": "Checks if a Media Services account name is available" + } + }, + { + "name": "Microsoft.Media/operations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Available Operations", + "operation": "Get Available Operations", + "description": "Get Available Operations" + } + }, + { + "name": "Microsoft.Media/mediaservices/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Read Media Services Account", + "description": "Read any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Create or Update Media Services Account", + "description": "Create or Update any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Delete Media Services Account", + "description": "Delete any Media Services Account" + } + }, + { + "name": "Microsoft.Media/mediaservices/syncStorageKeys/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Media Services Account", + "operation": "Synchronize Storage Keys", + "description": "Synchronize the Storage Keys for an attached Azure Storage account" + } + }, + { + "name": "Microsoft.Media/mediaservices/eventGridFilters/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Event Grid Filter", + "operation": "Read Event Grid Filter", + "description": "Read any Event Grid Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/eventGridFilters/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Event Grid Filter", + "operation": "Create or Update Event Grid Filter", + "description": "Create or Update any Event Grid Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/eventGridFilters/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Event Grid Filter", + "operation": "Delete Event Grid Filter", + "description": "Delete any Event Grid Filter" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Read Asset", + "description": "Read any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Create or Update Asset", + "description": "Create or Update any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Delete Asset", + "description": "Delete any Asset" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/listContainerSas/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "List Asset Container SAS URLs", + "description": "List Asset Container SAS URLs" + } + }, + { + "name": "Microsoft.Media/mediaservices/assets/getEncryptionKey/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Asset", + "operation": "Get Asset Encryption Key", + "description": "Get Asset Encryption Key" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Read Streaming Policy", + "description": "Read any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Create or Update Streaming Policy", + "description": "Create or Update any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingPolicies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Policy", + "operation": "Delete Streaming Policy", + "description": "Delete any Streaming Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Read Streaming Locator", + "description": "Read any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Create or Update Streaming Locator", + "description": "Create or Update any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "Delete Streaming Locator", + "description": "Delete any Streaming Locator" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/listContentKeys/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "List Content Keys", + "description": "List Content Keys" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingLocators/listPaths/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Locator", + "operation": "List Paths", + "description": "List Paths" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Read Content Key Policy", + "description": "Read any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Create or Update Content Key Policy", + "description": "Create or Update any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Delete Content Key Policy", + "description": "Delete any Content Key Policy" + } + }, + { + "name": "Microsoft.Media/mediaservices/contentKeyPolicies/getPolicyPropertiesWithSecrets/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Content Key Policy", + "operation": "Get Policy Properties With Secrets", + "description": "Get Policy Properties With Secrets" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Read Transform", + "description": "Read any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Create or Update Transform", + "description": "Create or Update any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Transform", + "operation": "Delete Transform", + "description": "Delete any Transform" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Read Job", + "description": "Read any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Create or Update Job", + "description": "Create or Update any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Delete Job", + "description": "Delete any Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/transforms/jobs/cancelJob/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Job", + "operation": "Cancel Job", + "description": "Cancel Job" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Read Streaming Endpoint", + "description": "Read any Streaming Endpoint" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Create or Update Streaming Endpoint", + "description": "Create or Update any Streaming Endpoint" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Delete Streaming Endpoint", + "description": "Delete any Streaming Endpoint" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/start/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Start Streaming Endpoint Operation", + "description": "Start any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/stop/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Stop Streaming Endpoint Operation", + "description": "Stop any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/scale/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint", + "operation": "Scale Streaming Endpoint Operation", + "description": "Scale any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoints", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoints", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource." + }, + "origin": "system" + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpoints/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoints", + "operation": "Get list of Media Services Streaming Endpoint Metrics definitions.", + "description": "Get list of Media Services Streaming Endpoint Metrics definitions." + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "Egress", + "displayName": "Egress", + "displayDescription": "The amount of Egress data, in bytes.", + "unit": "Bytes", + "aggregationType": "Total", + "dimensions": [ + { + "name": "OutputFormat", + "displayName": "Output Format", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "SuccessE2ELatency", + "displayName": "Success end to end Latency", + "displayDescription": "The average latency for successful requests in milliseconds.", + "unit": "Milliseconds", + "aggregationType": "Average", + "dimensions": [ + { + "name": "OutputFormat", + "displayName": "Output Format", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "Requests", + "displayName": "Requests", + "displayDescription": "Requests to a Streaming Endpoint.", + "unit": "Count", + "aggregationType": "Count", + "dimensions": [ + { + "name": "OutputFormat", + "displayName": "Output Format", + "toBeExportedForShoebox": true + }, + { + "name": "HttpStatusCode", + "displayName": "HTTP Status Code", + "toBeExportedForShoebox": true + }, + { + "name": "ErrorCode", + "displayName": "Error Code", + "toBeExportedForShoebox": false + } + ] + } + ] + } + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Read Live Event", + "description": "Read any Live Event" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Create or Update Live Event", + "description": "Create or Update any Live Event" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Delete Live Event", + "description": "Delete any Live Event" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/start/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Start Live Event Operation", + "description": "Start any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/stop/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Stop Live Event Operation", + "description": "Stop any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/reset/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event", + "operation": "Reset Live Event Operation", + "description": "Reset any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/liveOutputs/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output", + "operation": "Read Live Output", + "description": "Read any Live Output" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/liveOutputs/write", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output", + "operation": "Create or Update Live Output", + "description": "Create or Update any Live Output" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEvents/liveOutputs/delete", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output", + "operation": "Delete Live Output", + "description": "Delete any Live Output" + } + }, + { + "name": "Microsoft.Media/mediaservices/streamingEndpointOperations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Streaming Endpoint Operation", + "operation": "Read Streaming Endpoint Operation", + "description": "Read any Streaming Endpoint Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveEventOperations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Event Operation", + "operation": "Read Live Event Operation", + "description": "Read any Live Event Operation" + } + }, + { + "name": "Microsoft.Media/mediaservices/liveOutputOperations/read", + "display": { + "provider": "Microsoft Media Services", + "resource": "Live Output Operation", + "operation": "Read Live Output Operation", + "description": "Read any Live Output Operation" + } + }, + { + "name": "Microsoft.Media/locations/checkNameAvailability/action", + "display": { + "provider": "Microsoft Media Services", + "resource": "Microsoft Media Services", + "operation": "Check Name Availability", + "description": "Checks if a Media Services account name is available" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-delete.json new file mode 100644 index 000000000000..ddc3608e5cab --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-delete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "name": "connectionName1", + "api-version": "2020-05-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-get-by-name.json new file mode 100644 index 000000000000..859c2857b95a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-get-by-name.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "name": "connectionName1", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "connectionName1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/connectionName1", + "type": "Microsoft.Media/mediaservices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Test description." + }, + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/reosuceGroup1/providers/Microsoft.Network/privateEndpoints/privateEndpointName1" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-list.json new file mode 100644 index 000000000000..785b32db5fb0 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-list.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "cn1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/cn1", + "type": "Microsoft.Media/mediaservices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Test description" + }, + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/reosuceGroup1/providers/Microsoft.Network/privateEndpoints/pe1" + } + } + }, + { + "name": "cn2", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/cn2", + "type": "Microsoft.Media/mediaservices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnectionState": { + "status": "Pending", + "description": "Test description" + }, + "privateEndpoint": { + "id": "/subscriptions/22222222-2222-2222-2222-222222222222/resourceGroups/reosuceGroup2/providers/Microsoft.Network/privateEndpoints/pe2" + } + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-put.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-put.json new file mode 100644 index 000000000000..03ee510a3286 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-endpoint-connection-put.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "name": "connectionName1", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Test description." + } + } + } + }, + "responses": { + "200": { + "body": { + "name": "connectionName1", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateEndpointConnections/connectionName1", + "type": "Microsoft.Media/mediaservices/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Test description." + }, + "privateEndpoint": { + "id": "/subscriptions/11111111-1111-1111-1111-111111111111/resourceGroups/reosuceGroup1/providers/Microsoft.Network/privateEndpoints/privateEndpointName1" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-link-resources-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-link-resources-get-by-name.json new file mode 100644 index 000000000000..7ef5ee153fcd --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-link-resources-get-by-name.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "name": "keydelivery", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "keydelivery", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateLinkResources/keydelivery", + "type": "Microsoft.Media/mediaservices/privateLinkResources", + "properties": { + "groupId": "keydelivery", + "requiredMembers": [ + "keydelivery" + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-link-resources-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-link-resources-list.json new file mode 100644 index 000000000000..5aa331ad27fd --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/private-link-resources-list.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contososports", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "keydelivery", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/fabrikam/providers/Microsoft.Media/mediaservices/contososports/privateLinkResources/keydelivery", + "type": "Microsoft.Media/mediaservices/privateLinkResources", + "properties": { + "groupId": "keydelivery", + "requiredMembers": [ + "keydelivery" + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-clear.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-clear.json new file mode 100644 index 000000000000..e5ef74a68e3b --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-clear.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedClearStreamingLocator", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "streamingPolicyName": "clearStreamingPolicy", + "assetName": "ClimbingMountRainier" + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedClearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedClearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:32.4323237Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "e34b0fc4-3be0-4a3c-9793-1f6b7be5b013", + "streamingPolicyName": "clearStreamingPolicy", + "contentKeys": [] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-secure-userDefinedContentKeys.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-secure-userDefinedContentKeys.json new file mode 100644 index 000000000000..72f7bc7edcf2 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-secure-userDefinedContentKeys.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "assetName": "ClimbingMountRainier", + "streamingPolicyName": "secureStreamingPolicy", + "streamingLocatorId": "90000000-0000-0000-0000-00000000000A", + "contentKeys": [ + { + "labelReferenceInStreamingPolicy": "aesDefaultKey", + "id": "60000000-0000-0000-0000-000000000001", + "value": "1UqLohAfWsEGkULYxHjYZg==" + }, + { + "labelReferenceInStreamingPolicy": "cencDefaultKey", + "id": "60000000-0000-0000-0000-000000000004", + "value": "4UqLohAfWsEGkULYxHjYZg==" + }, + { + "labelReferenceInStreamingPolicy": "cbcsDefaultKey", + "id": "60000000-0000-0000-0000-000000000007", + "value": "7UqLohAfWsEGkULYxHjYZg==" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocatorWithUserDefinedContentKeys", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:32.7859424Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "90000000-0000-0000-0000-00000000000a", + "streamingPolicyName": "secureStreamingPolicy", + "contentKeys": [ + { + "id": "60000000-0000-0000-0000-000000000007", + "type": "CommonEncryptionCbcs", + "labelReferenceInStreamingPolicy": "cbcsDefaultKey", + "tracks": [] + }, + { + "id": "60000000-0000-0000-0000-000000000004", + "type": "CommonEncryptionCenc", + "labelReferenceInStreamingPolicy": "cencDefaultKey", + "tracks": [] + }, + { + "id": "60000000-0000-0000-0000-000000000001", + "type": "EnvelopeEncryption", + "labelReferenceInStreamingPolicy": "aesDefaultKey", + "tracks": [] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-secure.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-secure.json new file mode 100644 index 000000000000..ac78cdfa4e47 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-create-secure.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "UserCreatedSecureStreamingLocator", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "streamingPolicyName": "secureStreamingPolicy", + "assetName": "ClimbingMountRainier", + "startTime": "2018-03-01T00:00:00Z", + "endTime": "2028-12-31T23:59:59.9999999Z" + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/UserCreatedSecureStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:32.6243295Z", + "startTime": "2018-03-01T00:00:00Z", + "endTime": "2028-12-31T23:59:59.9999999Z", + "streamingLocatorId": "962775be-41fb-452a-b0dc-72ca2543a945", + "streamingPolicyName": "secureStreamingPolicy", + "contentKeys": [ + { + "id": "1b2d5581-4518-4a51-ad8a-f55d3bf993d4", + "type": "CommonEncryptionCbcs", + "labelReferenceInStreamingPolicy": "cbcsDefaultKey", + "tracks": [] + }, + { + "id": "1a9858b1-3566-4bf1-9fee-60f2fb98e7e4", + "type": "CommonEncryptionCenc", + "labelReferenceInStreamingPolicy": "cencDefaultKey", + "tracks": [] + }, + { + "id": "5faac86a-3aca-4d6b-99c0-6bb8cc3497a1", + "type": "EnvelopeEncryption", + "labelReferenceInStreamingPolicy": "aesDefaultKey", + "tracks": [] + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-delete.json new file mode 100644 index 000000000000..ae40b3c0d91e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2020-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-get-by-name.json new file mode 100644 index 000000000000..5cded2bd270e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-get-by-name.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "clearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/clearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:32.1154071Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "7684043b-f6d1-44a7-8bed-8a4aa474c5a4", + "streamingPolicyName": "clearStreamingPolicy", + "contentKeys": [] + } + } + }, + "404": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-content-keys.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-content-keys.json new file mode 100644 index 000000000000..e912886dbc2b --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-content-keys.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "secureStreamingLocator", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "contentKeys": [ + { + "id": "9259eb06-eeee-4f77-987f-48f4ea5c649f", + "type": "EnvelopeEncryption", + "labelReferenceInStreamingPolicy": "aesDefaultKey", + "value": "QpiqeQROdN5xamnfUF2Wdw==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + }, + { + "id": "06bfeff1-2bb6-4f58-af27-a2767f058bca", + "type": "CommonEncryptionCenc", + "labelReferenceInStreamingPolicy": "cencDefaultKey", + "value": "ZjgWhNnqnqcov/h+wrYusw==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + }, + { + "id": "799e78a0-ed6f-4179-9222-ed4ec4223cec", + "type": "CommonEncryptionCbcs", + "labelReferenceInStreamingPolicy": "cbcsDefaultKey", + "value": "FjZ3n3yRcVxRFftdYFbe9g==", + "policyName": "PolicyWithMultipleOptions", + "tracks": [] + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-paths-streaming-and-download.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-paths-streaming-and-download.json new file mode 100644 index 000000000000..58c864fe4494 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-paths-streaming-and-download.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "clearStreamingLocator", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "streamingPaths": [ + { + "streamingProtocol": "Hls", + "encryptionScheme": "NoEncryption", + "paths": [ + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest1.ism/manifest(format=m3u8-aapl)", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest2.ism/manifest(format=m3u8-aapl)", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest3.ism/manifest(format=m3u8-aapl)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "NoEncryption", + "paths": [ + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest1.ism/manifest(format=mpd-time-csf)", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest2.ism/manifest(format=mpd-time-csf)", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest3.ism/manifest(format=mpd-time-csf)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "NoEncryption", + "paths": [ + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest1.ism/manifest", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest2.ism/manifest", + "/262a87b6-b538-4657-bac1-b6897924471d/videoManifest3.ism/manifest" + ] + } + ], + "downloadPaths": [ + "/262a87b6-b538-4657-bac1-b6897924471d/textTrack.vtt", + "/262a87b6-b538-4657-bac1-b6897924471d/video1.mp4", + "/262a87b6-b538-4657-bac1-b6897924471d/video2.mp4", + "/262a87b6-b538-4657-bac1-b6897924471d/video3.mp4" + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-paths-streaming-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-paths-streaming-only.json new file mode 100644 index 000000000000..d0fb861781bf --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list-paths-streaming-only.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingLocatorName": "secureStreamingLocator", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "streamingPaths": [ + { + "streamingProtocol": "Hls", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=m3u8-aapl,encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=m3u8-aapl,encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=m3u8-aapl,encryption=cbc)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=mpd-time-csf,encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=mpd-time-csf,encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=mpd-time-csf,encryption=cbc)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "EnvelopeEncryption", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(encryption=cbc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(encryption=cbc)" + ] + }, + { + "streamingProtocol": "Dash", + "encryptionScheme": "CommonEncryptionCenc", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=mpd-time-csf,encryption=cenc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=mpd-time-csf,encryption=cenc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=mpd-time-csf,encryption=cenc)" + ] + }, + { + "streamingProtocol": "SmoothStreaming", + "encryptionScheme": "CommonEncryptionCenc", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(encryption=cenc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(encryption=cenc)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(encryption=cenc)" + ] + }, + { + "streamingProtocol": "Hls", + "encryptionScheme": "CommonEncryptionCbcs", + "paths": [ + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest1.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest2.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)", + "/c3cd62e3-d117-4619-bcbd-99f96edd8dbe/videoManifest3.ism/manifest(format=m3u8-aapl,encryption=cbcs-aapl)" + ] + } + ], + "downloadPaths": [] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list.json new file mode 100644 index 000000000000..e5a389fed597 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-locators-list.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "clearStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/clearStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:31.9341192Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "6a116ec6-0c85-441f-9c31-89a5bc3adf0a", + "streamingPolicyName": "clearStreamingPolicy", + "contentKeys": [] + } + }, + { + "name": "secureStreamingLocator", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingLocators/secureStreamingLocator", + "type": "Microsoft.Media/mediaservices/streamingLocators", + "properties": { + "assetName": "ClimbingMountRainier", + "created": "2018-08-08T18:29:31.9544387Z", + "endTime": "9999-12-31T23:59:59.9999999Z", + "streamingLocatorId": "7338ef90-ffc8-42de-8bff-de8f99973300", + "streamingPolicyName": "secureStreamingPolicy", + "contentKeys": [] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-clear.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-clear.json new file mode 100644 index 000000000000..bca0dd3c4eab --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-clear.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedClearStreamingPolicy", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedClearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedClearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:31.1535417Z", + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-commonEncryptionCbcs-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-commonEncryptionCbcs-only.json new file mode 100644 index 000000000000..4814bb3ca62a --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-commonEncryptionCbcs-only.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + } + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithCommonEncryptionCbcsOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:31.6197199Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-commonEncryptionCenc-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-commonEncryptionCenc-only.json new file mode 100644 index 000000000000..074818a1b1fc --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-commonEncryptionCenc-only.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + } + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithCommonEncryptionCencOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:31.4678543Z", + "defaultContentKeyPolicyName": "PolicyWithPlayReadyOptionAndOpenRestriction", + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-envelopeEncryption-only.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-envelopeEncryption-only.json new file mode 100644 index 000000000000..d6c0cf3248b5 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-envelopeEncryption-only.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + } + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicyWithEnvelopeEncryptionOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:31.3055712Z", + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-secure-streaming.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-secure-streaming.json new file mode 100644 index 000000000000..cdd2235204c3 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-create-secure-streaming.json @@ -0,0 +1,164 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "UserCreatedSecureStreamingPolicy", + "api-version": "2020-05-01", + "parameters": { + "properties": { + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + } + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + } + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + } + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "UserCreatedSecureStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/UserCreatedSecureStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:31.7715696Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Equal", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-delete.json new file mode 100644 index 000000000000..8278daace0e4 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "api-version": "2020-05-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-list.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-list.json new file mode 100644 index 000000000000..5feec41b392f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policies-list.json @@ -0,0 +1,211 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "clearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.676067Z", + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + }, + { + "name": "secureStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.6781134Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + }, + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Unknown", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + }, + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + }, + { + "name": "secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithCommonEncryptionCbcsOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.6781134Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "commonEncryptionCbcs": { + "enabledProtocols": { + "download": false, + "dash": false, + "hls": true, + "smoothStreaming": false + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "cbcsDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "fairPlay": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/fairplay/{ContentKeyId}", + "allowPersistentLicense": true + } + } + } + } + }, + { + "name": "secureStreamingPolicyWithCommonEncryptionCencOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithCommonEncryptionCencOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.6781134Z", + "defaultContentKeyPolicyName": "PolicyWithMultipleOptions", + "commonEncryptionCenc": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": false, + "smoothStreaming": true + }, + "clearTracks": [ + { + "trackSelections": [ + { + "property": "FourCC", + "operation": "Unknown", + "value": "hev1" + } + ] + } + ], + "contentKeys": { + "defaultKey": { + "label": "cencDefaultKey" + }, + "keyToTrackMappings": [] + }, + "drm": { + "playReady": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/playready/{ContentKeyId}", + "playReadyCustomAttributes": "PlayReady CustomAttributes" + }, + "widevine": { + "customLicenseAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/widevine/{ContentKeyId" + } + } + } + } + }, + { + "name": "secureStreamingPolicyWithEnvelopeEncryptionOnly", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/secureStreamingPolicyWithEnvelopeEncryptionOnly", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.6781134Z", + "defaultContentKeyPolicyName": "PolicyWithClearKeyOptionAndTokenRestriction", + "envelopeEncryption": { + "enabledProtocols": { + "download": false, + "dash": true, + "hls": true, + "smoothStreaming": true + }, + "clearTracks": [], + "contentKeys": { + "defaultKey": { + "label": "aesDefaultKey" + }, + "keyToTrackMappings": [] + }, + "customKeyAcquisitionUrlTemplate": "https://contoso.com/{AssetAlternativeId}/envelope/{ContentKeyId}" + } + } + } + ], + "@odata.nextLink": "http://server/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaServices/contosomedia/streamingPolicies?api-version=2020-05-01&$skiptoken=secureStreamingPolicyWithEnvelopeEncryptionOnly" + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policy-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policy-get-by-name.json new file mode 100644 index 000000000000..7772551258f0 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streaming-policy-get-by-name.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contoso", + "accountName": "contosomedia", + "streamingPolicyName": "clearStreamingPolicy", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "name": "clearStreamingPolicy", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contoso/providers/Microsoft.Media/mediaservices/contosomedia/streamingPolicies/clearStreamingPolicy", + "type": "Microsoft.Media/mediaservices/streamingPolicies", + "properties": { + "created": "2018-08-08T18:29:30.8501486Z", + "noEncryption": { + "enabledProtocols": { + "download": true, + "dash": true, + "hls": true, + "smoothStreaming": true + } + } + } + } + }, + "404": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-create.json new file mode 100644 index 000000000000..8394c166bc54 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-create.json @@ -0,0 +1,155 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2020-05-01", + "parameters": { + "id": null, + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2029-12-31T16:00:00-08:00", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2030-12-31T16:00:00-08:00", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1" + } + ] + } + }, + "cdnEnabled": false + } + } + }, + "responses": { + "202": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2030-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2031-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1", + "subnetPrefixLength": null + } + ] + } + }, + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.7561389Z", + "lastModified": "2018-03-03T02:25:09.7561389Z" + } + } + }, + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "accessControl": { + "akamai": { + "akamaiSignatureHeaderAuthenticationKeyList": [ + { + "identifier": "id1", + "expiration": "2030-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + }, + { + "identifier": "id2", + "expiration": "2031-01-01T00:00:00Z", + "base64Key": "dGVzdGlkMQ==" + } + ] + }, + "ip": { + "allow": [ + { + "name": "AllowedIp", + "address": "192.168.1.1", + "subnetPrefixLength": null + } + ] + } + }, + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.7561389Z", + "lastModified": "2018-03-03T02:25:09.7561389Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-delete.json new file mode 100644 index 000000000000..eebd53df788c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-delete.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2020-05-01", + "parameters": { + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "Name": "myStreamingEndpoint1", + "Type": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourcegroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints", + "Location": "West US", + "Tags": { + "DynamicProperties": { + "tag1": "value1", + "tag2": "value2" + } + }, + "properties": { + "Description": "test event 1", + "ScaleUnits": 1, + "AccessControl": null, + "AvailabilitySetName": "availableset", + "MaxCacheAge": null, + "CrossSiteAccessPolicies": null, + "CustomHostNames": [], + "HostName": null, + "CdnEnabled": false, + "CdnProvider": null, + "CdnProfile": null, + "FreeTrialEndTime": "0001-01-01T00:00:00-08:00", + "ProvisioningState": null, + "ResourceState": "Stopped", + "Created": "2018-03-02T18:25:09.4897514-08:00", + "LastModified": "2018-03-02T18:25:09.4897514-08:00" + } + } + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-list-all.json new file mode 100644 index 000000000000..4a08601fdf6f --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-list-all.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "api-version": "2020-05-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T08:00:00Z", + "provisioningState": "Succeeded", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.202013Z", + "lastModified": "2018-03-03T02:25:09.202013Z" + } + }, + { + "name": "default", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/default", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": {}, + "properties": { + "description": "", + "scaleUnits": 0, + "availabilitySetName": null, + "cdnEnabled": true, + "cdnProvider": "StandardVerizon", + "cdnProfile": "AzureMediaStreamingPlatformCdnProfile-StandardVerizon", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T00:00:00-08:00", + "provisioningState": "InProgress", + "resourceState": "Starting", + "created": "2018-03-03T02:25:09.2310128Z", + "lastModified": "2018-03-03T02:25:09.2310128Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-list-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-list-by-name.json new file mode 100644 index 000000000000..1aa22e2e8c4e --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-list-by-name.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2020-05-01" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag1": "value1", + "tag2": "value2" + }, + "properties": { + "description": "test event 1", + "scaleUnits": 1, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": "", + "customHostNames": [], + "maxCacheAge": null, + "hostName": "mystreamingendpoint1-slitestmedia10.streaming.mediaservices.windows.net", + "freeTrialEndTime": "0001-01-01T08:00:00Z", + "provisioningState": "Succeeded", + "resourceState": "Stopped", + "created": "2018-03-03T02:25:09.3500423Z", + "lastModified": "2018-03-03T02:25:09.3500423Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-scale.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-scale.json new file mode 100644 index 000000000000..4182c5ba595d --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-scale.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2020-05-01", + "parameters": { + "scaleUnit": 5 + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-start.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-start.json new file mode 100644 index 000000000000..0edeff80c178 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-start.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2020-05-01" + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-stop.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-stop.json new file mode 100644 index 000000000000..0edeff80c178 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-stop.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2020-05-01" + }, + "responses": { + "202": {}, + "200": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-update.json new file mode 100644 index 000000000000..8633a2681e19 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/streamingendpoint-update.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "subscriptionId": "0a6ec948-5a62-437d-b9df-934dc7c1b722", + "resourceGroupName": "mediaresources", + "accountName": "slitestmedia10", + "streamingEndpointName": "myStreamingEndpoint1", + "api-version": "2020-05-01", + "parameters": { + "id": null, + "location": "West US", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset" + } + } + }, + "responses": { + "200": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": null, + "customHostNames": [], + "maxCacheAge": null, + "hostName": null, + "freeTrialEndTime": "0001-01-01T00:00:00Z", + "provisioningState": "Succeeded", + "resourceState": null, + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z" + } + } + }, + "202": { + "body": { + "name": "myStreamingEndpoint1", + "id": "/subscriptions/0a6ec948-5a62-437d-b9df-934dc7c1b722/resourceGroups/mediaresources/providers/Microsoft.Media/mediaservices/slitestmedia10/streamingendpoints/myStreamingEndpoint1", + "type": "Microsoft.Media/mediaservices/streamingEndpoints", + "location": "West US", + "tags": { + "tag3": "value3", + "tag5": "value5" + }, + "properties": { + "description": "test event 2", + "scaleUnits": 5, + "availabilitySetName": "availableset", + "cdnEnabled": false, + "cdnProvider": null, + "cdnProfile": null, + "customHostNames": [], + "maxCacheAge": null, + "hostName": null, + "freeTrialEndTime": "0001-01-01T00:00:00Z", + "provisioningState": "Succeeded", + "resourceState": null, + "created": "0001-01-01T00:00:00Z", + "lastModified": "0001-01-01T00:00:00Z" + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-create.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-create.json new file mode 100644 index 000000000000..3dd7b2c06dfd --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-create.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "createdTransform", + "parameters": { + "properties": { + "description": "Example Transform to illustrate create and update.", + "outputs": [ + { + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "name": "createdTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/createdTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2019-10-10T22:38:02.2021719-07:00", + "description": "Example Transform to illustrate create and update.", + "lastModified": "2019-10-10T22:38:02.2021719-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + }, + "200": { + "body": { + "name": "createdTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/createdTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2019-10-10T22:38:02.2021719-07:00", + "description": "Example Transform to illustrate create and update.", + "lastModified": "2019-10-10T22:38:02.2021719-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-delete.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-delete.json new file mode 100644 index 000000000000..4a6cf2b6b7b3 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "sampleTransform" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-get-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-get-by-name.json new file mode 100644 index 000000000000..6e165e7b5b43 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-get-by-name.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "sampleTransform" + }, + "responses": { + "404": {}, + "200": { + "body": { + "name": "sampleTransform", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleTransform", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2019-10-10T22:38:01.9599144-07:00", + "description": "A sample Transform using the Standard Encoder with a built in preset.", + "lastModified": "2019-10-10T22:38:01.9599144-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate1080p" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-created.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-created.json new file mode 100644 index 000000000000..257c637422cb --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-created.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "$filter": "properties/created gt 2019-10-10T22:38:01.7859346Z and properties/created le 2019-10-10T22:38:11.7859346Z", + "$orderby": "properties/created" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2019-10-10T22:38:11.7859346-07:00", + "description": "A sample Transform using the Video Analyzer.", + "lastModified": "2019-10-10T22:38:11.7859346-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "insightsToExtract": "AllInsights" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-lastmodified.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-lastmodified.json new file mode 100644 index 000000000000..cb97582fae9c --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-lastmodified.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "$filter": "properties/lastmodified gt 2019-10-10T22:38:01.8751625Z and properties/lastmodified le 2019-10-10T22:38:11.8751625Z", + "$orderby": "properties/lastmodified desc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2019-10-10T22:38:11.8751625-07:00", + "description": "A sample Transform using the Video Analyzer.", + "lastModified": "2019-10-10T22:38:11.8751625-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "insightsToExtract": "AllInsights" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-name.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-name.json new file mode 100644 index 000000000000..75a08549f9fa --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all-filter-by-name.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "$filter": "(name eq 'sampleEncode') or (name eq 'sampleEncodeAndVideoIndex')", + "$orderby": "name desc" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2019-10-10T22:38:01.5489351-07:00", + "description": "A sample Transform using the Standard Encoder with a built-in preset, as well as the Video Analyzer.", + "lastModified": "2019-10-10T22:38:01.5489351-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + }, + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "insightsToExtract": "AllInsights" + } + } + ] + } + }, + { + "name": "sampleEncode", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncode", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2019-10-10T22:38:01.5489351-07:00", + "description": "A sample Transform using the Standard Encoder with a built in preset.", + "lastModified": "2019-10-10T22:38:01.5489351-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all.json new file mode 100644 index 000000000000..7552799d9b22 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-list-all.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "sampleEncode", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncode", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2019-10-10T22:38:01.0599386-07:00", + "description": "A sample Transform using the Standard Encoder with a built in preset.", + "lastModified": "2019-10-10T22:38:01.0599386-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + } + ] + } + }, + { + "name": "sampleEncodeAndVideoIndex", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/sampleEncodeAndVideoIndex", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2019-10-10T22:38:01.0649389-07:00", + "description": "A sample Transform using the Standard Encoder with a built-in preset, as well as the Video Analyzer.", + "lastModified": "2019-10-10T22:38:01.0649389-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "AdaptiveStreaming" + } + }, + { + "onError": "StopProcessingJob", + "relativePriority": "Normal", + "preset": { + "@odata.type": "#Microsoft.Media.VideoAnalyzerPreset", + "insightsToExtract": "AllInsights" + } + } + ] + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-update.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-update.json new file mode 100644 index 000000000000..5a9a2096bae5 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/examples/transforms-update.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-05-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "contosoresources", + "accountName": "contosomedia", + "transformName": "transformToUpdate", + "parameters": { + "properties": { + "description": "Example transform to illustrate update.", + "outputs": [ + { + "relativePriority": "High", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate720p" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "transformToUpdate", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/contosoresources/providers/Microsoft.Media/mediaservices/contosomedia/transforms/transformToUpdate", + "type": "Microsoft.Media/mediaservices/transforms", + "properties": { + "created": "2019-10-10T22:38:02.3591446-07:00", + "description": "Example transform to illustrate update.", + "lastModified": "2019-10-10T22:38:02.4291412-07:00", + "outputs": [ + { + "onError": "StopProcessingJob", + "relativePriority": "High", + "preset": { + "@odata.type": "#Microsoft.Media.BuiltInStandardEncoderPreset", + "presetName": "H264MultipleBitrate720p" + } + } + ] + } + } + } + } +} diff --git a/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/streamingservice.json b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/streamingservice.json new file mode 100644 index 000000000000..3c7352ccae25 --- /dev/null +++ b/specification/mediaservices/resource-manager/Microsoft.Media/stable/2020-05-01/streamingservice.json @@ -0,0 +1,1757 @@ +{ + "schemes": [ + "https" + ], + "swagger": "2.0", + "info": { + "title": "Azure Media Services", + "description": "Streaming resource management client for Azure Media Services", + "version": "2020-05-01" + }, + "host": "management.azure.com", + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents": { + "get": { + "tags": [ + "LiveEvents" + ], + "summary": "List Live Events", + "description": "Lists the Live Events in the account.", + "operationId": "LiveEvents_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEventListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all LiveEvents": { + "$ref": "examples/liveevent-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}": { + "get": { + "tags": [ + "LiveEvents" + ], + "summary": "Get Live Event", + "description": "Gets a Live Event.", + "operationId": "LiveEvents_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Get a LiveEvent by name": { + "$ref": "examples/liveevent-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "LiveEvents" + ], + "summary": "Create Live Event", + "description": "Creates a Live Event.", + "operationId": "LiveEvents_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StreamingResourceAutoStart" + }, + { + "name": "parameters", + "description": "Live Event properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEvent" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a LiveEvent": { + "$ref": "examples/liveevent-create.json" + } + } + }, + "patch": { + "tags": [ + "LiveEvents" + ], + "description": "Updates a existing Live Event.", + "operationId": "LiveEvents_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "Live Event properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEvent" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations.", + "schema": { + "$ref": "#/definitions/LiveEvent" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a LiveEvent": { + "$ref": "examples/liveevent-update.json" + } + } + }, + "delete": { + "tags": [ + "LiveEvents" + ], + "summary": "Delete Live Event", + "description": "Deletes a Live Event.", + "operationId": "LiveEvents_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "204": { + "description": "No content. The request has been accepted but the Live Event was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a LiveEvent": { + "$ref": "examples/liveevent-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/start": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Start Live Event", + "description": "Starts an existing Live Event.", + "operationId": "LiveEvents_Start", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start a LiveEvent": { + "$ref": "examples/liveevent-start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/stop": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Stop Live Event", + "description": "Stops an existing Live Event.", + "operationId": "LiveEvents_Stop", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "LiveEvent stop parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveEventActionInput" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop a LiveEvent": { + "$ref": "examples/liveevent-stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/reset": { + "post": { + "tags": [ + "LiveEvents" + ], + "summary": "Reset Live Event", + "description": "Resets an existing Live Event.", + "operationId": "LiveEvents_Reset", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Reset a LiveEvent": { + "$ref": "examples/liveevent-reset.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs": { + "get": { + "tags": [ + "LiveOutputs" + ], + "summary": "List Live Outputs", + "description": "Lists the Live Outputs in the Live Event.", + "operationId": "LiveOutputs_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutputListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all LiveOutputs": { + "$ref": "examples/liveoutput-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/liveEvents/{liveEventName}/liveOutputs/{liveOutputName}": { + "get": { + "tags": [ + "LiveOutputs" + ], + "summary": "Get Live Output", + "description": "Gets a Live Output.", + "operationId": "LiveOutputs_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Get a LiveOutput by name": { + "$ref": "examples/liveoutput-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "LiveOutputs" + ], + "summary": "Create Live Output", + "description": "Creates a Live Output.", + "operationId": "LiveOutputs_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "Live Output properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LiveOutput" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations.", + "schema": { + "$ref": "#/definitions/LiveOutput" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a LiveOutput": { + "$ref": "examples/liveoutput-create.json" + } + } + }, + "delete": { + "tags": [ + "LiveOutputs" + ], + "summary": "Delete Live Output", + "description": "Deletes a Live Output.", + "operationId": "LiveOutputs_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/LiveEventName" + }, + { + "$ref": "#/parameters/LiveOutputName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "204": { + "description": "No content. The request has been accepted but the Live Output was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a LiveOutput": { + "$ref": "examples/liveoutput-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints": { + "get": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "List StreamingEndpoints", + "description": "Lists the StreamingEndpoints in the account.", + "operationId": "StreamingEndpoints_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpointListResult" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "@odata.nextLink" + }, + "x-ms-examples": { + "List all StreamingEndpoints": { + "$ref": "examples/streamingendpoint-list-all.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}": { + "get": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Get StreamingEndpoint", + "description": "Gets a StreamingEndpoint.", + "operationId": "StreamingEndpoints_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "404": { + "description": "NotFound" + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-examples": { + "Get a StreamingEndpoint by name": { + "$ref": "examples/streamingendpoint-list-by-name.json" + } + } + }, + "put": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Create StreamingEndpoint", + "description": "Creates a StreamingEndpoint.", + "operationId": "StreamingEndpoints_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StreamingResourceAutoStart" + }, + { + "name": "parameters", + "description": "StreamingEndpoint properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-create.json" + } + } + }, + "patch": { + "tags": [ + "StreamingEndpoint" + ], + "summary": "Update StreamingEndpoint", + "description": "Updates a existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "StreamingEndpoint properties needed for creation.", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations.", + "schema": { + "$ref": "#/definitions/StreamingEndpoint" + } + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-update.json" + } + } + }, + "delete": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Delete StreamingEndpoint", + "description": "Deletes a StreamingEndpoint.", + "operationId": "StreamingEndpoints_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "204": { + "description": "No content. The request has been accepted but the Streaming Endpoint was not found." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/start": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Start StreamingEndpoint", + "description": "Starts an existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Start", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Start a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-start.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/stop": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Stop StreamingEndpoint", + "description": "Stops an existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Stop", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Stop a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-stop.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Media/mediaservices/{accountName}/streamingEndpoints/{streamingEndpointName}/scale": { + "post": { + "tags": [ + "StreamingEndpoints" + ], + "summary": "Scale StreamingEndpoint", + "description": "Scales an existing StreamingEndpoint.", + "operationId": "StreamingEndpoints_Scale", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/MediaServicesAccountName" + }, + { + "$ref": "#/parameters/StreamingEndpointName" + }, + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "description": "StreamingEndpoint scale parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/StreamingEntityScaleUnit" + } + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "202": { + "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously. See https://go.microsoft.com/fwlink/?linkid=2087017 for details on the monitoring asynchronous Azure Operations." + }, + "default": { + "description": "The streaming error response describing why the operation failed.", + "schema": { + "$ref": "./Common.json#/definitions/ApiError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Scale a StreamingEndpoint": { + "$ref": "examples/streamingendpoint-scale.json" + } + } + } + } + }, + "definitions": { + "Hls": { + "properties": { + "fragmentsPerTsSegment": { + "format": "int32", + "type": "integer", + "description": "The amount of fragments per HTTP Live Streaming (HLS) segment." + } + }, + "description": "The HLS configuration." + }, + "LiveOutputProperties": { + "required": [ + "assetName", + "archiveWindowLength" + ], + "properties": { + "description": { + "type": "string", + "description": "The description of the Live Output." + }, + "assetName": { + "type": "string", + "description": "The asset name." + }, + "archiveWindowLength": { + "format": "duration", + "type": "string", + "description": "ISO 8601 timespan duration of the archive window length. This is duration that customer want to retain the recorded content." + }, + "manifestName": { + "type": "string", + "description": "The manifest file name. If not provided, the service will generate one automatically." + }, + "hls": { + "type": "object", + "$ref": "#/definitions/Hls", + "description": "The HLS configuration." + }, + "outputSnapTime": { + "type": "integer", + "format": "int64", + "description": "The output snapshot time." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Output was created." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Output was last modified." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the Live Output." + }, + "resourceState": { + "description": "The resource state of the Live Output.", + "readOnly": true, + "type": "string", + "enum": [ + "Creating", + "Running", + "Deleting" + ], + "x-ms-enum": { + "name": "LiveOutputResourceState", + "modelAsString": true + } + } + }, + "description": "The JSON object that contains the properties required to create a Live Output." + }, + "LiveOutput": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LiveOutputProperties", + "description": "The Live Output properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "The Live Output." + }, + "LiveOutputListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveOutput" + }, + "description": "The result of the List Live Output operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "Th link to the next set of results. Not empty if value contains incomplete list of Live Outputs." + } + }, + "description": "The LiveOutput list result.", + "title": "LiveOutputListResult" + }, + "LiveEventEndpoint": { + "properties": { + "protocol": { + "type": "string", + "description": "The endpoint protocol." + }, + "url": { + "type": "string", + "description": "The endpoint URL." + } + }, + "description": "The Live Event endpoint." + }, + "LiveEventInputAccessControl": { + "properties": { + "ip": { + "type": "object", + "$ref": "#/definitions/IPAccessControl", + "description": "The IP access control properties." + } + }, + "description": "The IP access control for Live Event Input." + }, + "LiveEventInput": { + "required": [ + "streamingProtocol" + ], + "properties": { + "streamingProtocol": { + "type": "string", + "description": "The streaming protocol for the Live Event. This is specified at creation time and cannot be updated.", + "enum": [ + "FragmentedMP4", + "RTMP" + ], + "x-ms-enum": { + "name": "LiveEventInputProtocol", + "modelAsString": true + } + }, + "accessControl": { + "type": "object", + "$ref": "#/definitions/LiveEventInputAccessControl", + "description": "The access control for LiveEvent Input." + }, + "keyFrameIntervalDuration": { + "type": "string", + "description": "ISO 8601 timespan duration of the key frame interval duration." + }, + "accessToken": { + "type": "string", + "description": "A UUID in string form to uniquely identify the stream. This can be specified at creation time but cannot be updated. If omitted, the service will generate a unique value." + }, + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEventEndpoint" + }, + "description": "The input endpoints for the Live Event." + } + }, + "description": "The Live Event input." + }, + "IPRange": { + "properties": { + "name": { + "type": "string", + "description": "The friendly name for the IP address range." + }, + "address": { + "type": "string", + "description": "The IP address." + }, + "subnetPrefixLength": { + "format": "int32", + "type": "integer", + "description": "The subnet mask prefix length (see CIDR notation)." + } + }, + "description": "The IP address range in the CIDR scheme." + }, + "IPAccessControl": { + "properties": { + "allow": { + "type": "array", + "items": { + "$ref": "#/definitions/IPRange" + }, + "description": "The IP allow list." + } + }, + "description": "The IP access control." + }, + "LiveEventPreviewAccessControl": { + "properties": { + "ip": { + "type": "object", + "$ref": "#/definitions/IPAccessControl", + "description": "The IP access control properties." + } + }, + "description": "The IP access control for Live Event preview." + }, + "LiveEventPreview": { + "properties": { + "endpoints": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEventEndpoint" + }, + "description": "The endpoints for preview." + }, + "accessControl": { + "type": "object", + "$ref": "#/definitions/LiveEventPreviewAccessControl", + "description": "The access control for LiveEvent preview." + }, + "previewLocator": { + "type": "string", + "description": "The identifier of the preview locator in Guid format. Specifying this at creation time allows the caller to know the preview locator url before the event is created. If omitted, the service will generate a random identifier. This value cannot be updated once the live event is created." + }, + "streamingPolicyName": { + "type": "string", + "description": "The name of streaming policy used for the LiveEvent preview. This value is specified at creation time and cannot be updated." + }, + "alternativeMediaId": { + "type": "string", + "description": "An Alternative Media Identifier associated with the StreamingLocator created for the preview. This value is specified at creation time and cannot be updated. The identifier can be used in the CustomLicenseAcquisitionUrlTemplate or the CustomKeyAcquisitionUrlTemplate of the StreamingPolicy specified in the StreamingPolicyName field." + } + }, + "description": "The Live Event preview." + }, + "LiveEventEncoding": { + "properties": { + "encodingType": { + "type": "string", + "description": "The encoding type for Live Event. This value is specified at creation time and cannot be updated. When encodingType is set to None, the service simply passes through the incoming video and audio layer(s) to the output. When encodingType is set to Standard or Premium1080p, a live encoder transcodes the incoming stream into multiple bit rates or layers. See https://go.microsoft.com/fwlink/?linkid=2095101 for more information. The encodingType of Basic is obsolete – if specified, the service will treat this as a Standard Live Event.", + "enum": [ + "None", + "Basic", + "Standard", + "Premium1080p" + ], + "x-ms-enum": { + "name": "LiveEventEncodingType", + "modelAsString": true + } + }, + "presetName": { + "type": "string", + "description": "The optional encoding preset name, used when encodingType is not None. This value is specified at creation time and cannot be updated. If the encodingType is set to Standard, then the default preset name is ‘Default720p’. Else if the encodingType is set to Premium1080p, the default preset is ‘Default1080p’." + } + }, + "description": "The Live Event encoding." + }, + "CrossSiteAccessPolicies": { + "properties": { + "clientAccessPolicy": { + "type": "string", + "description": "The content of clientaccesspolicy.xml used by Silverlight." + }, + "crossDomainPolicy": { + "type": "string", + "description": "The content of crossdomain.xml used by Silverlight." + } + }, + "description": "The client access policy." + }, + "LiveEventActionInput": { + "properties": { + "removeOutputsOnStop": { + "type": "boolean", + "description": "The flag indicates if remove LiveOutputs on Stop." + } + }, + "description": "The LiveEvent action input parameter definition." + }, + "LiveEventProperties": { + "required": [ + "input" + ], + "properties": { + "description": { + "type": "string", + "description": "The Live Event description." + }, + "input": { + "type": "object", + "$ref": "#/definitions/LiveEventInput", + "description": "The Live Event input." + }, + "preview": { + "type": "object", + "$ref": "#/definitions/LiveEventPreview", + "description": "The Live Event preview." + }, + "encoding": { + "type": "object", + "$ref": "#/definitions/LiveEventEncoding", + "description": "The Live Event encoding." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the Live Event." + }, + "resourceState": { + "readOnly": true, + "type": "string", + "description": "The resource state of the Live Event.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping", + "Deleting" + ], + "x-ms-enum": { + "name": "LiveEventResourceState", + "modelAsString": true + } + }, + "crossSiteAccessPolicies": { + "type": "object", + "$ref": "#/definitions/CrossSiteAccessPolicies", + "description": "The Live Event access policies." + }, + "useStaticHostname": { + "type": "boolean", + "description": "Specifies whether to use a vanity url with the Live Event. This value is specified at creation time and cannot be updated." + }, + "streamOptions": { + "type": "array", + "items": { + "type": "string", + "enum": [ + "Default", + "LowLatency" + ], + "x-ms-enum": { + "name": "StreamOptionsFlag", + "modelAsString": true + } + }, + "description": "The options to use for the LiveEvent. This value is specified at creation time and cannot be updated. The valid values for the array entry values are 'Default' and 'LowLatency'." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Event was created." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the Live Event was last modified." + } + }, + "description": "The Live Event properties." + }, + "LiveEvent": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/LiveEventProperties", + "description": "The Live Event properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "The Live Event." + }, + "LiveEventListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LiveEvent" + }, + "description": "The result of the List Live Event operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "Th link to the next set of results. Not empty if value contains incomplete list of Live Outputs." + } + }, + "description": "The LiveEvent list result.", + "title": "LiveEventListResult" + }, + "AkamaiSignatureHeaderAuthenticationKey": { + "properties": { + "identifier": { + "type": "string", + "description": "identifier of the key" + }, + "base64Key": { + "type": "string", + "description": "authentication key" + }, + "expiration": { + "format": "date-time", + "type": "string", + "description": "The expiration time of the authentication key." + } + }, + "description": "Akamai Signature Header authentication key." + }, + "AkamaiAccessControl": { + "properties": { + "akamaiSignatureHeaderAuthenticationKeyList": { + "type": "array", + "items": { + "$ref": "#/definitions/AkamaiSignatureHeaderAuthenticationKey" + }, + "description": "authentication key list" + } + }, + "description": "Akamai access control" + }, + "StreamingEndpointAccessControl": { + "properties": { + "akamai": { + "type": "object", + "$ref": "#/definitions/AkamaiAccessControl", + "description": "The access control of Akamai" + }, + "ip": { + "type": "object", + "$ref": "#/definitions/IPAccessControl", + "description": "The IP access control of the StreamingEndpoint." + } + }, + "description": "StreamingEndpoint access control definition." + }, + "StreamingEntityScaleUnit": { + "properties": { + "scaleUnit": { + "type": "integer", + "format": "int32", + "description": "The scale unit number of the StreamingEndpoint." + } + }, + "description": "scale units definition" + }, + "StreamingEndpointProperties": { + "required": [ + "scaleUnits" + ], + "properties": { + "description": { + "type": "string", + "description": "The StreamingEndpoint description." + }, + "scaleUnits": { + "type": "integer", + "format": "int32", + "description": "The number of scale units. Use the Scale operation to adjust this value." + }, + "availabilitySetName": { + "type": "string", + "description": "The name of the AvailabilitySet used with this StreamingEndpoint for high availability streaming. This value can only be set at creation time." + }, + "accessControl": { + "type": "object", + "$ref": "#/definitions/StreamingEndpointAccessControl", + "description": "The access control definition of the StreamingEndpoint." + }, + "maxCacheAge": { + "type": "integer", + "format": "int64", + "description": "Max cache age" + }, + "customHostNames": { + "type": "array", + "items": { + "type": "string", + "description": "custom host name" + }, + "description": "The custom host names of the StreamingEndpoint" + }, + "hostName": { + "readOnly": true, + "type": "string", + "description": "The StreamingEndpoint host name." + }, + "cdnEnabled": { + "type": "boolean", + "description": "The CDN enabled flag." + }, + "cdnProvider": { + "type": "string", + "description": "The CDN provider name." + }, + "cdnProfile": { + "type": "string", + "description": "The CDN profile name." + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state of the StreamingEndpoint." + }, + "resourceState": { + "readOnly": true, + "type": "string", + "description": "The resource state of the StreamingEndpoint.", + "enum": [ + "Stopped", + "Starting", + "Running", + "Stopping", + "Deleting", + "Scaling" + ], + "x-ms-enum": { + "name": "StreamingEndpointResourceState", + "modelAsString": true + } + }, + "crossSiteAccessPolicies": { + "type": "object", + "$ref": "#/definitions/CrossSiteAccessPolicies", + "description": "The StreamingEndpoint access policies." + }, + "freeTrialEndTime": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The free trial expiration time." + }, + "created": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the StreamingEndpoint was created." + }, + "lastModified": { + "readOnly": true, + "format": "date-time", + "type": "string", + "description": "The exact time the StreamingEndpoint was last modified." + } + }, + "description": "The StreamingEndpoint properties." + }, + "StreamingEndpoint": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/StreamingEndpointProperties", + "description": "The StreamingEndpoint properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "The StreamingEndpoint." + }, + "StreamingEndpointListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/StreamingEndpoint" + }, + "description": "The result of the List StreamingEndpoint operation." + }, + "@odata.count": { + "type": "integer", + "format": "int32", + "description": "The number of result." + }, + "@odata.nextLink": { + "type": "string", + "description": "Th link to the next set of results. Not empty if value contains incomplete list of StreamingEndpoints." + } + }, + "description": "The StreamingEndpoint list result.", + "title": "StreamingEndpointListResult" + } + }, + "parameters": { + "SubscriptionId": { + "name": "subscriptionId", + "description": "The unique identifier for a Microsoft Azure subscription.", + "in": "path", + "required": true, + "type": "string" + }, + "ApiVersion": { + "name": "api-version", + "description": "The Version of the API to be used with the client request.", + "in": "query", + "required": true, + "type": "string" + }, + "ResourceGroupName": { + "name": "resourceGroupName", + "description": "The name of the resource group within the Azure subscription.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "MediaServicesAccountName": { + "name": "accountName", + "description": "The Media Services account name.", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "LiveEventName": { + "name": "liveEventName", + "description": "The name of the Live Event.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 32, + "x-ms-parameter-location": "method" + }, + "StreamingResourceAutoStart": { + "name": "autoStart", + "description": "The flag indicates if the resource should be automatically started on creation.", + "in": "query", + "required": false, + "type": "boolean", + "x-ms-parameter-location": "method" + }, + "LiveOutputName": { + "name": "liveOutputName", + "description": "The name of the Live Output.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^([a-zA-Z0-9])+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 256, + "x-ms-parameter-location": "method" + }, + "StreamingEndpointName": { + "name": "streamingEndpointName", + "description": "The name of the StreamingEndpoint.", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[a-zA-Z0-9]+(-*[a-zA-Z0-9])*$", + "minLength": 1, + "maxLength": 24, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/mediaservices/resource-manager/readme.md b/specification/mediaservices/resource-manager/readme.md index db3b5caa0fc4..86bd41461ddd 100644 --- a/specification/mediaservices/resource-manager/readme.md +++ b/specification/mediaservices/resource-manager/readme.md @@ -26,10 +26,30 @@ These are the global settings for the MediaServices API. ``` yaml openapi-type: arm -tag: package-2018-07 +tag: package-2020-05 opt-in-extensible-enums: true ``` + +### Tag: package-2020-05 + +These settings apply only when `--tag=package-2020-05` is specified on the command line. + +```yaml $(tag) == 'package-2020-05' +input-file: + - Microsoft.Media/stable/2020-05-01/AccountFilters.json + - Microsoft.Media/stable/2020-05-01/Accounts.json + - Microsoft.Media/stable/2020-05-01/AssetsAndAssetFilters.json + - Microsoft.Media/stable/2020-05-01/ContentKeyPolicies.json + - Microsoft.Media/stable/2020-05-01/Encoding.json + - Microsoft.Media/stable/2020-05-01/StreamingPoliciesAndStreamingLocators.json + - Microsoft.Media/stable/2020-05-01/streamingservice.json + - Microsoft.Media/stable/2020-05-01/Common.json +directive: + - suppress: R2016 + where: $.definitions.TrackedResource.required + reason: location is a required property for our patch calls +``` ### Tag: package-2020-02-preview These settings apply only when `--tag=package-2020-02-preview` is specified on the command line. @@ -46,7 +66,6 @@ input-file: - Microsoft.Media/stable/2018-07-01/streamingservice.json ``` - ### Tag: package-2019-09-preview These settings apply only when `--tag=package-2019-09-preview` is specified on the command line. @@ -63,7 +82,6 @@ input-file: - Microsoft.Media/stable/2018-07-01/streamingservice.json ``` - ### Tag: package-2019-05-preview These settings apply only when `--tag=package-2019-05-preview` is specified on the command line. @@ -308,7 +326,7 @@ directive: reason: Output not required for job update ``` -## Multi-API/Profile support for AutoRest v3 generators +## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -354,7 +372,7 @@ input-file: ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' From 7aa5d12d710ded8cd805e62e81bccda2b86a3914 Mon Sep 17 00:00:00 2001 From: Gurvinder Singh Date: Wed, 24 Jun 2020 23:32:14 +0530 Subject: [PATCH 195/318] [QnA Maker] Update replace kb json (#9932) * [QnA Maker] Update replace kb json * Updated replace doc * Json modification * Json updated --- .../stable/v4.0/examples/SuccessfulRepKb.json | 48 +------------------ 1 file changed, 1 insertion(+), 47 deletions(-) diff --git a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json index 074f4541e639..640d3f21dc32 100644 --- a/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json +++ b/specification/cognitiveservices/data-plane/QnAMaker/stable/v4.0/examples/SuccessfulRepKb.json @@ -27,53 +27,7 @@ "name": "category", "value": "api" } - ], - "context": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "displayText": "Update KB", - "qna": { - "answer": "You can use our REST apis to update your KB. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/knowledgebase/update", - "questions": [ - "How do I programmatically update my KB?" - ], - "metadata": [ - { - "name": "category", - "value": "api" - } - ], - "context": { - "isContextOnly": false, - "prompts": [ - { - "displayOrder": 1, - "displayText": "Refresh Endpoint Keys", - "qna": { - "answer": "You can use our REST apis to refresh endpoint keys. See here for details: https://docs.microsoft.com/en-us/rest/api/cognitiveservices/qnamaker/endpointkeys/refreshkeys", - "questions": [ - "How do I programmatically refresh endpoint keys?" - ] - } - } - ] - } - } - } - ] - } - } - ], - "urls": [ - "https://docs.microsoft.com/en-in/azure/cognitive-services/qnamaker/faqs", - "https://docs.microsoft.com/en-us/bot-framework/resources-bot-framework-faq" - ], - "files": [ - { - "fileName": "SurfaceManual.pdf", - "fileUri": "https://download.microsoft.com/download/2/9/B/29B20383-302C-4517-A006-B0186F04BE28/surface-pro-4-user-guide-EN.pdf" + ] } ] } From 9dbff8c6f75666257e65d40ef2cf9d58063514e0 Mon Sep 17 00:00:00 2001 From: longli0 Date: Wed, 24 Jun 2020 12:13:52 -0700 Subject: [PATCH 196/318] Add definition and description about recognition_03 (#9802) * Add definition and description about recognition_03 * add newline at EOF --- .../data-plane/Face/stable/v1.0/Face.json | 18 ++++++++++-------- 1 file changed, 10 insertions(+), 8 deletions(-) diff --git a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json index c1ffa742a19a..d96a1f87d277 100644 --- a/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json +++ b/specification/cognitiveservices/data-plane/Face/stable/v1.0/Face.json @@ -513,7 +513,7 @@ }, "/persongroups/{personGroupId}": { "put": { - "description": "Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel.\n
    A person group is the container of the uploaded person data, including face recognition features.\n
    After creation, use [PersonGroup Person - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/create) to add persons into the group, and then call [PersonGroup - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/train) to get this group ready for [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n
    No image will be stored. Only the person's extracted face features and userData will be stored on server until [PersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/delete) or [PersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/delete) is called.\n
    'recognitionModel' should be specified to associate with this person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing person group will use the recognition model that's already associated with the collection. Existing face features in a person group can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [PersonGroup - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/create). All those person groups created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nPerson group quota:\n* Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons.\n* S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons.\n* to handle larger scale face identification problem, please consider using [LargePersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup).", + "description": "Create a new person group with specified personGroupId, name, user-provided userData and recognitionModel.\n
    A person group is the container of the uploaded person data, including face recognition features.\n
    After creation, use [PersonGroup Person - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/create) to add persons into the group, and then call [PersonGroup - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/train) to get this group ready for [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n
    No image will be stored. Only the person's extracted face features and userData will be stored on server until [PersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroupperson/delete) or [PersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/delete) is called.\n
    'recognitionModel' should be specified to associate with this person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing person group will use the recognition model that's already associated with the collection. Existing face features in a person group can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [PersonGroup - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup/create). All those person groups created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March.\n* 'recognition_03': Recognition model released in 2020 May. 'recognition_03' is recommended since its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.\n\nPerson group quota:\n* Free-tier subscription quota: 1,000 person groups. Each holds up to 1,000 persons.\n* S0-tier subscription quota: 1,000,000 person groups. Each holds up to 10,000 persons.\n* to handle larger scale face identification problem, please consider using [LargePersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup).", "operationId": "PersonGroup_Create", "parameters": [ { @@ -764,7 +764,7 @@ }, "/facelists/{faceListId}": { "put": { - "description": "Create an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription.\n
    Face list is a list of faces, up to 1,000 faces, and used by [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar).\n
    After creation, user should use [FaceList - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/addfacefromurl) to import the faces. No image will be stored. Only the extracted face features are stored on server until [FaceList - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/delete) is called.\n
    Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup) / [LargePersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup) and [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n
    Please consider [LargeFaceList](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist) when the face number is large. It can support up to 1,000,000 faces.\n
    'recognitionModel' should be specified to associate with this face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing face list will use the recognition model that's already associated with the collection. Existing face features in a face list can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [FaceList- Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/create). All those face lists created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.", + "description": "Create an empty face list with user-specified faceListId, name, an optional userData and recognitionModel. Up to 64 face lists are allowed in one subscription.\n
    Face list is a list of faces, up to 1,000 faces, and used by [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar).\n
    After creation, user should use [FaceList - Add Face](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/addfacefromurl) to import the faces. No image will be stored. Only the extracted face features are stored on server until [FaceList - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/delete) is called.\n
    Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup) / [LargePersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup) and [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n
    Please consider [LargeFaceList](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist) when the face number is large. It can support up to 1,000,000 faces.\n
    'recognitionModel' should be specified to associate with this face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing face list will use the recognition model that's already associated with the collection. Existing face features in a face list can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [FaceList- Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/facelist/create). All those face lists created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March.\n* 'recognition_03': Recognition model released in 2020 May. 'recognition_03' is recommended since its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.", "operationId": "FaceList_Create", "parameters": [ { @@ -1018,7 +1018,7 @@ }, "/detect": { "post": { - "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
    \n* No image will be stored. Only the extracted face feature will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar). The stored face feature(s) will expire and be deleted 24 hours after the original detection call.\n* Optional parameters include faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Some of the results returned for specific attributes may not be highly accurate.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n* For optimal results when querying [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar) ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\n* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [How to specify a recognition model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'recognition_01': | The default recognition model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). All those faceIds created before 2019 March are bonded with this recognition model. |\n | 'recognition_02': | Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'. |", + "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
    \n* No image will be stored. Only the extracted face feature will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar). The stored face feature(s) will expire and be deleted 24 hours after the original detection call.\n* Optional parameters include faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Some of the results returned for specific attributes may not be highly accurate.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n* For optimal results when querying [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar) ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\n* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [How to specify a recognition model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'recognition_01': | The default recognition model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). All those faceIds created before 2019 March are bonded with this recognition model. |\n | 'recognition_02': | Recognition model released in 2019 March. |\n | 'recognition_03': | Recognition model released in 2020 May. 'recognition_03' is recommended since its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'. |", "operationId": "Face_DetectWithUrl", "parameters": [ { @@ -1440,7 +1440,7 @@ }, "/largepersongroups/{largePersonGroupId}": { "put": { - "description": "Create a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.\n
    A large person group is the container of the uploaded person data, including face recognition feature, and up to 1,000,000\npeople.\n
    After creation, use [LargePersonGroup Person - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/create) to add person into the group, and call [LargePersonGroup - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/train) to get this group ready for [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n
    No image will be stored. Only the person's extracted face features and userData will be stored on server until [LargePersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/delete) or [LargePersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/delete) is called.\n
    'recognitionModel' should be specified to associate with this large person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large person group will use the recognition model that's already associated with the collection. Existing face features in a large person group can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [LargePersonGroup - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/create). All those large person groups created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nLarge person group quota:\n* Free-tier subscription quota: 1,000 large person groups.\n* S0-tier subscription quota: 1,000,000 large person groups.", + "description": "Create a new large person group with user-specified largePersonGroupId, name, an optional userData and recognitionModel.\n
    A large person group is the container of the uploaded person data, including face recognition feature, and up to 1,000,000\npeople.\n
    After creation, use [LargePersonGroup Person - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/create) to add person into the group, and call [LargePersonGroup - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/train) to get this group ready for [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n
    No image will be stored. Only the person's extracted face features and userData will be stored on server until [LargePersonGroup Person - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroupperson/delete) or [LargePersonGroup - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/delete) is called.\n
    'recognitionModel' should be specified to associate with this large person group. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large person group will use the recognition model that's already associated with the collection. Existing face features in a large person group can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [LargePersonGroup - Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup/create). All those large person groups created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March.\n* 'recognition_03': Recognition model released in 2020 May. 'recognition_03' is recommended since its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.\n\nLarge person group quota:\n* Free-tier subscription quota: 1,000 large person groups.\n* S0-tier subscription quota: 1,000,000 large person groups.", "operationId": "LargePersonGroup_Create", "parameters": [ { @@ -1742,7 +1742,7 @@ }, "/largefacelists/{largeFaceListId}": { "put": { - "description": "Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel.\n
    Large face list is a list of faces, up to 1,000,000 faces, and used by [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar).\n
    After creation, user should use [LargeFaceList Face - Add](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/addfacefromurl) to import the faces and [LargeFaceList - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/train) to make it ready for [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar). No image will be stored. Only the extracted face features are stored on server until [LargeFaceList - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/delete) is called.\n
    Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup) / [LargePersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup) and [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n
    'recognitionModel' should be specified to associate with this large face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large face list will use the recognition model that's already associated with the collection. Existing face features in a large face list can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [LargeFaceList- Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/create). All those large face lists created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'.\n\nLarge face list quota:\n* Free-tier subscription quota: 64 large face lists.\n* S0-tier subscription quota: 1,000,000 large face lists.", + "description": "Create an empty large face list with user-specified largeFaceListId, name, an optional userData and recognitionModel.\n
    Large face list is a list of faces, up to 1,000,000 faces, and used by [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar).\n
    After creation, user should use [LargeFaceList Face - Add](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/addfacefromurl) to import the faces and [LargeFaceList - Train](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/train) to make it ready for [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar). No image will be stored. Only the extracted face features are stored on server until [LargeFaceList - Delete](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/delete) is called.\n
    Find Similar is used for scenario like finding celebrity-like faces, similar face filtering, or as a light way face identification. But if the actual use is to identify person, please use [PersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/persongroup) / [LargePersonGroup](https://docs.microsoft.com/rest/api/cognitiveservices/face/largepersongroup) and [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify).\n
    'recognitionModel' should be specified to associate with this large face list. The default value for 'recognitionModel' is 'recognition_01', if the latest model needed, please explicitly specify the model you need in this parameter. New faces that are added to an existing large face list will use the recognition model that's already associated with the collection. Existing face features in a large face list can't be updated to features extracted by another version of recognition model.\n* 'recognition_01': The default recognition model for [LargeFaceList- Create](https://docs.microsoft.com/rest/api/cognitiveservices/face/largefacelist/create). All those large face lists created before 2019 March are bonded with this recognition model.\n* 'recognition_02': Recognition model released in 2019 March.\n* 'recognition_03': Recognition model released in 2020 May. 'recognition_03' is recommended since its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'.\n\nLarge face list quota:\n* Free-tier subscription quota: 64 large face lists.\n* S0-tier subscription quota: 1,000,000 large face lists.", "operationId": "LargeFaceList_Create", "parameters": [ { @@ -2495,7 +2495,7 @@ }, "/detect?overload=stream": { "post": { - "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
    \n* No image will be stored. Only the extracted face feature will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar). The stored face feature(s) will expire and be deleted 24 hours after the original detection call.\n* Optional parameters include faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Some of the results returned for specific attributes may not be highly accurate.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n* For optimal results when querying [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar) ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\n* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [How to specify a recognition model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'recognition_01': | The default recognition model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). All those faceIds created before 2019 March are bonded with this recognition model. |\n | 'recognition_02': | Recognition model released in 2019 March. 'recognition_02' is recommended since its overall accuracy is improved compared with 'recognition_01'. |", + "description": "Detect human faces in an image, return face rectangles, and optionally with faceIds, landmarks, and attributes.
    \n* No image will be stored. Only the extracted face feature will be stored on server. The faceId is an identifier of the face feature and will be used in [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar). The stored face feature(s) will expire and be deleted 24 hours after the original detection call.\n* Optional parameters include faceId, landmarks, and attributes. Attributes include age, gender, headPose, smile, facialHair, glasses, emotion, hair, makeup, occlusion, accessories, blur, exposure and noise. Some of the results returned for specific attributes may not be highly accurate.\n* JPEG, PNG, GIF (the first frame), and BMP format are supported. The allowed image file size is from 1KB to 6MB.\n* Up to 100 faces can be returned for an image. Faces are ranked by face rectangle size from large to small.\n* For optimal results when querying [Face - Identify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/identify), [Face - Verify](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/verifyfacetoface), and [Face - Find Similar](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/findsimilar) ('returnFaceId' is true), please use faces that are: frontal, clear, and with a minimum size of 200x200 pixels (100 pixels between eyes).\n* The minimum detectable face size is 36x36 pixels in an image no larger than 1920x1080 pixels. Images with dimensions higher than 1920x1080 pixels will need a proportionally larger minimum face size.\n* Different 'detectionModel' values can be provided. To use and compare different detection models, please refer to [How to specify a detection model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-detection-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'detection_01': | The default detection model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). Recommend for near frontal face detection. For scenarios with exceptionally large angle (head-pose) faces, occluded faces or wrong image orientation, the faces in such cases may not be detected. |\n | 'detection_02': | Detection model released in 2019 May with improved accuracy especially on small, side and blurry faces. |\n\n* Different 'recognitionModel' values are provided. If follow-up operations like Verify, Identify, Find Similar are needed, please specify the recognition model with 'recognitionModel' parameter. The default value for 'recognitionModel' is 'recognition_01', if latest model needed, please explicitly specify the model you need in this parameter. Once specified, the detected faceIds will be associated with the specified recognition model. More details, please refer to [How to specify a recognition model](https://docs.microsoft.com/azure/cognitive-services/face/face-api-how-to-topics/specify-recognition-model)\n | Model | Recommended use-case(s) |\n | ---------- | -------- |\n | 'recognition_01': | The default recognition model for [Face - Detect](https://docs.microsoft.com/rest/api/cognitiveservices/face/face/detectwithurl). All those faceIds created before 2019 March are bonded with this recognition model. |\n | 'recognition_02': | Recognition model released in 2019 March. |\n | 'recognition_03': | Recognition model released in 2020 May. 'recognition_03' is recommended since its overall accuracy is improved compared with 'recognition_01' and 'recognition_02'. |", "operationId": "Face_DetectWithStream", "parameters": [ { @@ -3874,7 +3874,8 @@ }, "enum": [ "recognition_01", - "recognition_02" + "recognition_02", + "recognition_03" ] }, "ApplyScope": { @@ -4257,7 +4258,8 @@ }, "enum": [ "recognition_01", - "recognition_02" + "recognition_02", + "recognition_03" ] }, "returnRecognitionModel": { From f487ebc93065fd42540aa422c04edd6a768a03e6 Mon Sep 17 00:00:00 2001 From: jadrefke Date: Wed, 24 Jun 2020 15:44:37 -0700 Subject: [PATCH 197/318] [Azure Search] Copy swagger specs to introduce 2020 apis (#9857) * copy specs for 2020 api * copy correct versions and move to preview folder * fix api version for 2020-GA * fix preview tag on GA swagger * fix synonym map example versions * fix readme 2020-GA paths * attempt to supress non-applicable linter rules * change directory name to be capital -Preview * update readme to match new directory casing Co-authored-by: Austin Drefke --- ...SearchServiceCreateOrUpdateSynonymMap.json | 2 +- .../SearchIndexAutocompleteDocumentsGet.json | 38 + .../SearchIndexAutocompleteDocumentsPost.json | 36 + .../examples/SearchIndexCountDocuments.json | 12 + .../examples/SearchIndexGetDocument.json | 22 + .../examples/SearchIndexIndexDocuments.json | 93 + .../SearchIndexSearchDocumentsGet.json | 84 + .../SearchIndexSearchDocumentsPost.json | 97 + .../SearchIndexSuggestDocumentsGet.json | 47 + .../SearchIndexSuggestDocumentsPost.json | 39 + .../SearchServiceCreateDataSource.json | 52 + .../examples/SearchServiceCreateIndex.json | 373 + .../examples/SearchServiceCreateIndexer.json | 40 + ...SearchServiceCreateOrUpdateDataSource.json | 77 + .../SearchServiceCreateOrUpdateIndex.json | 598 ++ .../SearchServiceCreateOrUpdateIndexer.json | 60 + .../SearchServiceCreateOrUpdateSkillset.json | 369 + ...SearchServiceCreateOrUpdateSynonymMap.json | 47 + .../examples/SearchServiceCreateSkillset.json | 243 + .../SearchServiceCreateSynonymMap.json | 38 + .../SearchServiceDeleteDataSource.json | 11 + .../examples/SearchServiceDeleteIndex.json | 11 + .../examples/SearchServiceDeleteIndexer.json | 11 + .../examples/SearchServiceDeleteSkillset.json | 11 + .../SearchServiceDeleteSynonymMap.json | 11 + .../examples/SearchServiceGetDataSource.json | 32 + .../examples/SearchServiceGetIndex.json | 244 + .../SearchServiceGetIndexStatistics.json | 15 + .../examples/SearchServiceGetIndexer.json | 27 + .../SearchServiceGetIndexerStatus.json | 89 + .../SearchServiceGetServiceStatistics.json | 48 + .../examples/SearchServiceGetSkillset.json | 135 + .../examples/SearchServiceGetSynonymMap.json | 25 + .../examples/SearchServiceIndexAnalyze.json | 37 + .../SearchServiceListDataSources.json | 36 + .../examples/SearchServiceListIndexers.json | 67 + .../examples/SearchServiceListIndexes.json | 287 + .../examples/SearchServiceListSkillsets.json | 139 + .../SearchServiceListSynonymMaps.json | 31 + .../examples/SearchServiceResetIndexer.json | 10 + .../examples/SearchServiceRunIndexer.json | 10 + .../2020-06-30-Preview/searchindex.json | 1548 +++ .../2020-06-30-Preview/searchservice.json | 8643 +++++++++++++++++ .../SearchIndexAutocompleteDocumentsGet.json | 38 + .../SearchIndexAutocompleteDocumentsPost.json | 36 + .../examples/SearchIndexCountDocuments.json | 12 + .../examples/SearchIndexGetDocument.json | 22 + .../examples/SearchIndexIndexDocuments.json | 93 + .../SearchIndexSearchDocumentsGet.json | 84 + .../SearchIndexSearchDocumentsPost.json | 97 + .../SearchIndexSuggestDocumentsGet.json | 47 + .../SearchIndexSuggestDocumentsPost.json | 39 + .../SearchServiceCreateDataSource.json | 52 + .../examples/SearchServiceCreateIndex.json | 373 + .../examples/SearchServiceCreateIndexer.json | 40 + ...SearchServiceCreateOrUpdateDataSource.json | 77 + .../SearchServiceCreateOrUpdateIndex.json | 598 ++ .../SearchServiceCreateOrUpdateIndexer.json | 60 + .../SearchServiceCreateOrUpdateSkillset.json | 369 + ...SearchServiceCreateOrUpdateSynonymMap.json | 47 + .../examples/SearchServiceCreateSkillset.json | 243 + .../SearchServiceCreateSynonymMap.json | 38 + .../SearchServiceDeleteDataSource.json | 11 + .../examples/SearchServiceDeleteIndex.json | 11 + .../examples/SearchServiceDeleteIndexer.json | 11 + .../examples/SearchServiceDeleteSkillset.json | 11 + .../SearchServiceDeleteSynonymMap.json | 11 + .../examples/SearchServiceGetDataSource.json | 32 + .../examples/SearchServiceGetIndex.json | 244 + .../SearchServiceGetIndexStatistics.json | 15 + .../examples/SearchServiceGetIndexer.json | 27 + .../SearchServiceGetIndexerStatus.json | 89 + .../SearchServiceGetServiceStatistics.json | 48 + .../examples/SearchServiceGetSkillset.json | 135 + .../examples/SearchServiceGetSynonymMap.json | 25 + .../examples/SearchServiceIndexAnalyze.json | 37 + .../SearchServiceListDataSources.json | 36 + .../examples/SearchServiceListIndexers.json | 67 + .../examples/SearchServiceListIndexes.json | 287 + .../examples/SearchServiceListSkillsets.json | 139 + .../SearchServiceListSynonymMaps.json | 31 + .../examples/SearchServiceResetIndexer.json | 10 + .../examples/SearchServiceRunIndexer.json | 10 + .../preview/2020-06-30/searchindex.json | 1548 +++ .../preview/2020-06-30/searchservice.json | 8643 +++++++++++++++++ .../search/data-plane/Azure.Search/readme.md | 182 +- 86 files changed, 27865 insertions(+), 5 deletions(-) create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexAutocompleteDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexAutocompleteDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexCountDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexGetDocument.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexIndexDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSearchDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSearchDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSuggestDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSuggestDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexerStatus.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetServiceStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceIndexAnalyze.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListDataSources.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexers.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexes.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSkillsets.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSynonymMaps.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceResetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceRunIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchindex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexAutocompleteDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexAutocompleteDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexCountDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexGetDocument.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexIndexDocuments.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSearchDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSearchDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSuggestDocumentsGet.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSuggestDocumentsPost.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetDataSource.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexerStatus.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetServiceStatistics.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSkillset.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSynonymMap.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceIndexAnalyze.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListDataSources.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexers.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexes.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSkillsets.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSynonymMaps.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceResetIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceRunIndexer.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/searchindex.json create mode 100644 specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json diff --git a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json index 4e0ed87596e4..5b7592c4e544 100644 --- a/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json +++ b/specification/search/data-plane/Azure.Search/preview/2019-05-06-preview/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -2,7 +2,7 @@ "parameters": { "endpoint": "https://myservice.search.windows.net", "synonymMapName": "mysynonymmap", - "api-version": "2019-5-06-Preview", + "api-version": "2019-05-06-Preview", "Prefer": "return=representation", "synonymMap": { "name": "mysynonymmap", diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexAutocompleteDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexAutocompleteDocumentsGet.json new file mode 100644 index 000000000000..524631487132 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexAutocompleteDocumentsGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30-Preview", + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": [ + "title", + "description" + ], + "top": 10 + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexAutocompleteDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexAutocompleteDocumentsPost.json new file mode 100644 index 000000000000..053c9f3d2077 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexAutocompleteDocumentsPost.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30-Preview", + "autocompleteRequest": { + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": "title,description", + "top": 10 + } + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexCountDocuments.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexCountDocuments.json new file mode 100644 index 000000000000..4b84442f2615 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexCountDocuments.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": 427 + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexGetDocument.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexGetDocument.json new file mode 100644 index 000000000000..b90c7c10e5de --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexGetDocument.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30-Preview", + "key": "1", + "$select": [ + "docId", + "title", + "description" + ] + }, + "responses": { + "200": { + "body": { + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexIndexDocuments.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexIndexDocuments.json new file mode 100644 index 000000000000..40410668b272 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexIndexDocuments.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30-Preview", + "batch": { + "value": [ + { + "@search.action": "upload", + "docId": "1", + "title": "Fancy Stay", + "description": "Best hotel in town" + }, + { + "@search.action": "merge", + "docId": "2", + "title": "Roach Motel" + }, + { + "@search.action": "mergeOrUpload", + "docId": "3", + "title": "Econo Motel" + }, + { + "@search.action": "delete", + "docId": "4" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 201 + }, + { + "key": "2", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + }, + "207": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "2", + "status": false, + "errorMessage": "Document not found.", + "statusCode": 404 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSearchDocumentsGet.json new file mode 100644 index 000000000000..2184e0f220a1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSearchDocumentsGet.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30-Preview", + "$count": true, + "facet": [ + "category,count:10,sort:count" + ], + "$filter": "rating gt 10", + "highlight": [ + "title" + ], + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "queryType": "simple", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": [ + "title", + "description" + ], + "searchMode": "any", + "$select": [ + "docId", + "title", + "description" + ], + "$skip": 100, + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.coverage": 80, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "Nice Hotel" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy Hotel" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSearchDocumentsPost.json new file mode 100644 index 000000000000..d1cf67aff86e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSearchDocumentsPost.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30-Preview", + "searchRequest": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "search.score() desc,rating desc", + "queryType": "simple", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "title,description", + "searchMode": "any", + "select": "docId,title,description", + "skip": 0, + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "@search.nextPageParameters": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "search.score() desc,rating desc", + "queryType": "simple", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "title,description", + "searchMode": "any", + "select": "docId,title,description", + "skip": 2, + "top": 8 + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "Nice Hotel" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy Hotel" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ], + "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2020-06-30-Preview" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSuggestDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSuggestDocumentsGet.json new file mode 100644 index 000000000000..82719e56e8fc --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSuggestDocumentsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30-Preview", + "$filter": "rating gt 10", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "search": "hote", + "searchFields": [ + "title" + ], + "suggesterName": "sg", + "$select": [ + "docId", + "title", + "description" + ], + "$top": 10 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSuggestDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSuggestDocumentsPost.json new file mode 100644 index 000000000000..e7c2fa129d16 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchIndexSuggestDocumentsPost.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30-Preview", + "suggestRequest": { + "filter": "rating gt 4.0", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "orderby": "rating desc", + "search": "hote", + "searchFields": "title", + "select": "docId,title,description", + "suggesterName": "sg", + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateDataSource.json new file mode 100644 index 000000000000..a0bc601ee5ea --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateDataSource.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30-Preview", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "responses": { + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndex.json new file mode 100644 index 000000000000..14dc71b117a0 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndex.json @@ -0,0 +1,373 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30-Preview", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "myapplicationsecret" + } + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "b": 0.5, + "k1": 1.3 + } + } + }, + "responses": { + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "b": 0.5, + "k1": 1.3 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndexer.json new file mode 100644 index 000000000000..b1f9576ade36 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateIndexer.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30-Preview", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + } + } + }, + "responses": { + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json new file mode 100644 index 000000000000..7e2302b90da9 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateDataSource.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2020-06-30-Preview", + "Prefer": "return=representation", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndex.json new file mode 100644 index 000000000000..3027e3fbe609 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndex.json @@ -0,0 +1,598 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "allowIndexDowntime": false, + "api-version": "2020-06-30-Preview", + "Prefer": "return=representation", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity" + } + } + }, + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json new file mode 100644 index 000000000000..4b83952c88db --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateIndexer.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30-Preview", + "Prefer": "return=representation", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + } + } + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + }, + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json new file mode 100644 index 000000000000..8357e13c597c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSkillset.json @@ -0,0 +1,369 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2020-06-30-Preview", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + }, + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json new file mode 100644 index 000000000000..5a38f275ca79 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2020-06-30-Preview", + "Prefer": "return=representation", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSkillset.json new file mode 100644 index 000000000000..5264ef96e53c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSkillset.json @@ -0,0 +1,243 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2020-06-30-Preview", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + }, + "responses": { + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSynonymMap.json new file mode 100644 index 000000000000..4c67fef9dbda --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceCreateSynonymMap.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30-Preview", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "myApplicationSecret" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteDataSource.json new file mode 100644 index 000000000000..1e457e0082d2 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteDataSource.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteIndex.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteIndex.json new file mode 100644 index 000000000000..9619e3daa71d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteIndex.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteIndexer.json new file mode 100644 index 000000000000..6e2c6850644f --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteIndexer.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteSkillset.json new file mode 100644 index 000000000000..04535e653be5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteSkillset.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteSynonymMap.json new file mode 100644 index 000000000000..87e6b9084a77 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceDeleteSynonymMap.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetDataSource.json new file mode 100644 index 000000000000..4fd21c6cd58d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetDataSource.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndex.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndex.json new file mode 100644 index 000000000000..5286f59197a6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndex.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexStatistics.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexStatistics.json new file mode 100644 index 000000000000..6804435983b4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexStatistics.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "documentCount": 239572, + "storageSize": 72375920 + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexer.json new file mode 100644 index 000000000000..70d220b9442b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexer.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexerStatus.json new file mode 100644 index 000000000000..7e2f41c2830c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetIndexerStatus.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "status": "running", + "lastResult": { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + "executionHistory": [ + { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + { + "status": "transientFailure", + "errorMessage": null, + "startTime": "2014-11-26T03:28:10.125Z", + "endTime": "2014-11-26T03:28:12.007Z", + "errors": [ + { + "key": "", + "errorMessage": "Document key cannot be missing or empty.", + "statusCode": 400, + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 1", + "errorMessage": "Could not read the value of column 'foo' at index '0'.", + "statusCode": 400, + "name": "DocumentExtraction.AzureBlob.MyDataSource", + "details": "The file could not be parsed.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388" + } + ], + "warnings": [ + { + "key": "document id", + "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob.", + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 2", + "message": "Document was truncated to 50000 characters.", + "name": "Enrichment.LanguageDetectionSkill.#4", + "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692" + } + ], + "itemsProcessed": 1, + "itemsFailed": 2, + "initialTrackingState": null, + "finalTrackingState": null + } + ], + "limits": { + "maxRunTime": "22:00:00", + "maxDocumentExtractionSize": 256000000, + "maxDocumentContentCharactersToExtract": 4000000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetServiceStatistics.json new file mode 100644 index 000000000000..32a0da8a81bd --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetServiceStatistics.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "counters": { + "documentCount": { + "usage": 7093, + "quota": 10000 + }, + "indexesCount": { + "usage": 3, + "quota": 3 + }, + "indexersCount": { + "usage": 3, + "quota": 3 + }, + "dataSourcesCount": { + "usage": 1, + "quota": 3 + }, + "storageSize": { + "usage": 914529, + "quota": 52428800 + }, + "synonymMaps": { + "usage": 2, + "quota": 3 + }, + "skillsetCount": { + "usage": 0, + "quota": 3 + } + }, + "limits": { + "maxFieldsPerIndex": 1000, + "maxFieldNestingDepthPerIndex": 10, + "maxComplexCollectionFieldsPerIndex": 100, + "maxComplexObjectsInCollectionsPerDocument": 3000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSkillset.json new file mode 100644 index 000000000000..bd6392af7e5e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSkillset.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSynonymMap.json new file mode 100644 index 000000000000..cbb563cddc63 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceGetSynonymMap.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceIndexAnalyze.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceIndexAnalyze.json new file mode 100644 index 000000000000..ff9baf5bd0e1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceIndexAnalyze.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2020-06-30-Preview", + "request": { + "text": "Text to analyze", + "analyzer": "standard.lucene" + } + }, + "responses": { + "200": { + "body": { + "tokens": [ + { + "token": "text", + "startOffset": 0, + "endOffset": 4, + "position": 0 + }, + { + "token": "to", + "startOffset": 5, + "endOffset": 7, + "position": 1 + }, + { + "token": "analyze", + "startOffset": 8, + "endOffset": 15, + "position": 2 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListDataSources.json new file mode 100644 index 000000000000..3730022b8d14 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListDataSources.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexers.json new file mode 100644 index 000000000000..b3831b233a9a --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexers.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydocdbdatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + }, + { + "name": "myotherindexer", + "description": "another cool indexer", + "dataSourceName": "myblobdatasource", + "targetIndexName": "orders", + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "batchSize": 15 + }, + "fieldMappings": [ + { + "sourceFieldName": "PersonName", + "targetFieldName": "FirstName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 0 + } + } + }, + { + "sourceFieldName": "PersonName", + "targetFieldName": "LastName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 1 + } + } + } + ], + "disabled": false + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexes.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexes.json new file mode 100644 index 000000000000..e6e6e3a71e93 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListIndexes.json @@ -0,0 +1,287 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + }, + { + "name": "testindex", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": false, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "hidden", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": false, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [], + "defaultScoringProfile": null, + "suggesters": [], + "analyzers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": null, + "encryptionKey": null + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSkillsets.json new file mode 100644 index 000000000000..01e212f5eac4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSkillsets.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSynonymMaps.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSynonymMaps.json new file mode 100644 index 000000000000..d4b428e08c65 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceListSynonymMaps.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + }, + { + "name": "myothersynonymmap", + "format": "solr", + "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat", + "encryptionKey": null + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceResetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceResetIndexer.json new file mode 100644 index 000000000000..b12f8e2d7b72 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceResetIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceRunIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceRunIndexer.json new file mode 100644 index 000000000000..695381edae7e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/examples/SearchServiceRunIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30-Preview" + }, + "responses": { + "202": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchindex.json new file mode 100644 index 000000000000..6d58063f4100 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchindex.json @@ -0,0 +1,1548 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchIndexClient", + "description": "Client that can be used to query an index and upload, merge, or delete documents.", + "version": "2020-06-30-Preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true, + "syncMethods": "None" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/indexes('{indexName}')", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + }, + { + "$ref": "#/parameters/IndexNameParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/docs/$count": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Count", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Count-Documents" + }, + "x-ms-examples": { + "SearchIndexCountDocuments": { + "$ref": "./examples/SearchIndexCountDocuments.json" + } + }, + "description": "Queries the number of documents in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "type": "integer", + "format": "int64" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsGet": { + "$ref": "./examples/SearchIndexSearchDocumentsGet.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "search", + "in": "query", + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + { + "name": "$count", + "in": "query", + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-nullable": false, + "x-ms-client-name": "IncludeTotalResultCount", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "facet", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.", + "x-ms-client-name": "Facets", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "The OData $filter expression to apply to the search query.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlight", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-client-name": "OrderBy", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryType", + "in": "query", + "type": "string", + "enum": [ + "simple", + "full" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringParameter", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-client-name": "ScoringParameters", + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes).", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringProfile", + "in": "query", + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchMode", + "in": "query", + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$skip", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.search": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchPost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsPost": { + "$ref": "./examples/SearchIndexSearchDocumentsPost.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "searchRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchRequest", + "description": "The Search request." + }, + "description": "The definition of the Search request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs('{key}')": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Get", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/lookup-document" + }, + "x-ms-examples": { + "SearchIndexGetDocument": { + "$ref": "./examples/SearchIndexGetDocument.json" + } + }, + "description": "Retrieves a document from the index.", + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "description": "The key of the document to retrieve.", + "type": "string" + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.", + "x-ms-client-name": "SelectedFields" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "responses": { + "200": { + "description": "Response containing the requested document.", + "schema": { + "type": "object" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.suggest": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsGet": { + "$ref": "./examples/SearchIndexSuggestDocumentsGet.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "search", + "in": "query", + "required": true, + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-nullable": false, + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-client-name": "OrderBy", + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to search for the specified search text. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, only the key field will be included in the results.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.suggest": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestPost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsPost": { + "$ref": "./examples/SearchIndexSuggestDocumentsPost.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "suggestRequest", + "in": "body", + "required": true, + "description": "The Suggest request.", + "schema": { + "$ref": "#/definitions/SuggestRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.index": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Index", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents" + }, + "x-ms-examples": { + "SearchIndexIndexDocuments": { + "$ref": "./examples/SearchIndexIndexDocuments.json" + } + }, + "description": "Sends a batch of document write actions to the index.", + "parameters": [ + { + "name": "batch", + "in": "body", + "description": "The batch of index actions.", + "required": true, + "schema": { + "$ref": "#/definitions/IndexBatch" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "207": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.autocomplete": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompleteGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsGet": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsGet.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "search", + "in": "query", + "type": "string", + "required": true, + "description": "The incomplete term which should be auto-completed.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "type": "string", + "required": true, + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "autocompleteMode", + "in": "query", + "type": "string", + "x-nullable": false, + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.autocomplete": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompletePost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsPost": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsPost.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "autocompleteRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutocompleteRequest" + }, + "description": "The definition of the Autocomplete request." + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + } + }, + "definitions": { + "SuggestDocumentsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@search.coverage": { + "type": "number", + "readOnly": true, + "format": "double", + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request." + } + }, + "required": [ + "value" + ], + "description": "Response containing suggestion query results from an index." + }, + "SuggestResult": { + "properties": { + "@search.text": { + "type": "string", + "readOnly": true, + "description": "The text of the suggestion result.", + "x-ms-client-name": "Text" + } + }, + "required": [ + "@search.text" + ], + "additionalProperties": true, + "description": "A result containing a document found by a suggestion query, plus associated metadata." + }, + "FacetResult": { + "properties": { + "count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The approximate count of documents falling within the bucket described by this facet." + } + }, + "additionalProperties": true, + "description": "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval." + }, + "SearchDocumentsResult": { + "properties": { + "@odata.count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "x-ms-client-name": "Count", + "description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response." + }, + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request." + }, + "@search.facets": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/FacetResult" + } + }, + "readOnly": true, + "x-ms-client-name": "Facets", + "description": "The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions." + }, + "@search.nextPageParameters": { + "$ref": "#/definitions/SearchRequest", + "readOnly": true, + "x-ms-client-name": "NextPageParameters", + "description": "Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@odata.nextLink": { + "type": "string", + "readOnly": true, + "x-ms-client-name": "NextLink", + "description": "Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response." + } + }, + "required": [ + "value" + ], + "description": "Response containing search results from an index." + }, + "SearchResult": { + "properties": { + "@search.score": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Score", + "x-nullable": false, + "description": "The relevance score of the document compared to other documents returned by the query." + }, + "@search.highlights": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": true, + "x-ms-client-name": "Highlights", + "description": "Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query." + } + }, + "required": [ + "@search.score" + ], + "additionalProperties": true, + "description": "Contains a document found by a search query, plus associated metadata." + }, + "IndexBatch": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IndexAction" + }, + "description": "The actions in the batch.", + "x-ms-client-name": "Actions" + } + }, + "required": [ + "value" + ], + "description": "Contains a batch of document write actions to send to the index." + }, + "IndexAction": { + "properties": { + "@search.action": { + "type": "string", + "enum": [ + "upload", + "merge", + "mergeOrUpload", + "delete" + ], + "x-ms-enum": { + "name": "IndexActionType", + "modelAsString": false, + "values": [ + { + "value": "upload", + "name": "Upload", + "description": "Inserts the document into the index if it is new and updates it if it exists. All fields are replaced in the update case." + }, + { + "value": "merge", + "name": "Merge", + "description": "Merges the specified field values with an existing document. If the document does not exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This also applies to collections of primitive and complex types." + }, + { + "value": "mergeOrUpload", + "name": "MergeOrUpload", + "description": "Behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document." + }, + { + "value": "delete", + "name": "Delete", + "description": "Removes the specified document from the index. Any field you specify in a delete operation other than the key field will be ignored. If you want to remove an individual field from a document, use merge instead and set the field explicitly to null." + } + ] + }, + "x-ms-client-name": "ActionType", + "x-nullable": false, + "description": "The operation to perform on a document in an indexing batch." + } + }, + "additionalProperties": true, + "description": "Represents an index action that operates on a document." + }, + "IndexingResult": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of a document that was in the indexing request." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded." + }, + "status": { + "x-ms-client-name": "Succeeded", + "type": "boolean", + "x-nullable": false, + "readOnly": true, + "description": "A value indicating whether the indexing operation succeeded for the document identified by the key." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + } + }, + "required": [ + "key", + "status", + "statusCode" + ], + "description": "Status of an indexing operation for a single document." + }, + "IndexDocumentsResult": { + "properties": { + "value": { + "x-ms-client-name": "Results", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexingResult" + }, + "description": "The list of status information for each document in the indexing request." + } + }, + "required": [ + "value" + ], + "description": "Response containing the status of operations for all documents in the indexing request." + }, + "SearchMode": { + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "description": "Specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "QueryType": { + "type": "string", + "enum": [ + "simple", + "full" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + } + ] + }, + "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "AutocompleteMode": { + "type": "string", + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms." + }, + "SearchRequest": { + "properties": { + "count": { + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-ms-client-name": "IncludeTotalResultCount" + }, + "facets": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "The OData $filter expression to apply to the search query." + }, + "highlight": { + "type": "string", + "description": "The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "queryType": { + "$ref": "#/definitions/QueryType", + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "scoringParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes)." + }, + "scoringProfile": { + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results." + }, + "search": { + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter." + }, + "searchMode": { + "$ref": "#/definitions/SearchMode", + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included." + }, + "skip": { + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results." + } + }, + "description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors." + }, + "SuggestRequest": { + "properties": { + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "search": { + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to search for the specified search text. Target fields must be included in the specified suggester." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors." + }, + "AutocompleteRequest": { + "properties": { + "search": { + "type": "string", + "description": "The search text on which to base autocomplete results.", + "x-ms-client-name": "SearchText" + }, + "autocompleteMode": { + "$ref": "#/definitions/AutocompleteMode", + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for fuzzy matching, and other autocomplete query behaviors." + }, + "AutocompleteResult": { + "properties": { + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request." + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AutocompleteItem" + }, + "description": "The list of returned Autocompleted items.", + "x-ms-client-name": "Results" + } + }, + "required": [ + "value" + ], + "description": "The result of Autocomplete query." + }, + "AutocompleteItem": { + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "The completed term." + }, + "queryPlusText": { + "type": "string", + "readOnly": true, + "description": "The query along with the completed term." + } + }, + "required": [ + "text", + "queryPlusText" + ], + "description": "The result of Autocomplete requests." + }, + "SearchError": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "A human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchError" + }, + "readOnly": true, + "description": "An array of details about specific errors that led to this reported error." + } + }, + "required": [ + "message" + ], + "description": "Describes an error condition for the Azure Cognitive Search API." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + }, + "IndexNameParameter": { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": false, + "description": "The name of the index.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json new file mode 100644 index 000000000000..215221732891 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30-Preview/searchservice.json @@ -0,0 +1,8643 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchServiceClient", + "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.", + "version": "2020-06-30-Preview", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/datasources('{dataSourceName}')": { + "put": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateDataSource": { + "$ref": "./examples/SearchServiceCreateOrUpdateDataSource.json" + } + }, + "description": "Creates a new datasource or updates a datasource if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to create or update." + }, + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Delete", + "x-ms-examples": { + "SearchServiceDeleteDataSource": { + "$ref": "./examples/SearchServiceDeleteDataSource.json" + } + }, + "description": "Deletes a datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Get", + "x-ms-examples": { + "SearchServiceGetDataSource": { + "$ref": "./examples/SearchServiceGetDataSource.json" + } + }, + "description": "Retrieves a datasource definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/datasources": { + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_List", + "x-ms-examples": { + "SearchServiceListDataSources": { + "$ref": "./examples/SearchServiceListDataSources.json" + } + }, + "description": "Lists all datasources available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the data sources to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListDataSourcesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Create", + "x-ms-examples": { + "SearchServiceCreateDataSource": { + "$ref": "./examples/SearchServiceCreateDataSource.json" + } + }, + "description": "Creates a new datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "parameters": [ + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.reset": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Reset", + "x-ms-examples": { + "SearchServiceResetIndexer": { + "$ref": "./examples/SearchServiceResetIndexer.json" + } + }, + "description": "Resets the change tracking state associated with an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.run": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Run", + "x-ms-examples": { + "SearchServiceRunIndexer": { + "$ref": "./examples/SearchServiceRunIndexer.json" + } + }, + "description": "Runs an indexer on-demand.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to run." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "202": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')": { + "put": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndexer": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndexer.json" + } + }, + "description": "Creates a new indexer or updates an indexer if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to create or update." + }, + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndexer": { + "$ref": "./examples/SearchServiceDeleteIndexer.json" + } + }, + "description": "Deletes an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "404": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Get", + "x-ms-examples": { + "SearchServiceGetIndexer": { + "$ref": "./examples/SearchServiceGetIndexer.json" + } + }, + "description": "Retrieves an indexer definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_List", + "x-ms-examples": { + "SearchServiceListIndexers": { + "$ref": "./examples/SearchServiceListIndexers.json" + } + }, + "description": "Lists all indexers available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexers" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexersResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Create", + "x-ms-examples": { + "SearchServiceCreateIndexer": { + "$ref": "./examples/SearchServiceCreateIndexer.json" + } + }, + "description": "Creates a new indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.status": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_GetStatus", + "x-ms-examples": { + "SearchServiceGetIndexerStatus": { + "$ref": "./examples/SearchServiceGetIndexerStatus.json" + } + }, + "description": "Returns the current status and execution history of an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer for which to retrieve status." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerStatus" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/skillsets('{skillsetName}')": { + "put": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSkillset": { + "$ref": "./examples/SearchServiceCreateOrUpdateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service or updates the skillset if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/update-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to create or update." + }, + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create or update in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully updated.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Delete", + "x-ms-examples": { + "SearchServiceDeleteSkillset": { + "$ref": "./examples/SearchServiceDeleteSkillset.json" + } + }, + "description": "Deletes a skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/delete-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skillset is successfully deleted." + }, + "404": { + "description": "The provided skillset name is not found." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Get", + "x-ms-examples": { + "SearchServiceGetSkillset": { + "$ref": "./examples/SearchServiceGetSkillset.json" + } + }, + "description": "Retrieves a skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/get-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully returned.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/skillsets": { + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_List", + "x-ms-examples": { + "SearchServiceListSkillsets": { + "$ref": "./examples/SearchServiceListSkillsets.json" + } + }, + "description": "List all skillsets in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/list-skillset" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The list is successfully returned.", + "schema": { + "$ref": "#/definitions/ListSkillsetsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Create", + "x-ms-examples": { + "SearchServiceCreateSkillset": { + "$ref": "./examples/SearchServiceCreateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-skillset" + }, + "parameters": [ + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/synonymmaps('{synonymMapName}')": { + "put": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSynonymMap": { + "$ref": "./examples/SearchServiceCreateOrUpdateSynonymMap.json" + } + }, + "description": "Creates a new synonym map or updates a synonym map if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to create or update." + }, + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Delete", + "x-ms-examples": { + "SearchServiceDeleteSynonymMap": { + "$ref": "./examples/SearchServiceDeleteSynonymMap.json" + } + }, + "description": "Deletes a synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Get", + "x-ms-examples": { + "SearchServiceGetSynonymMap": { + "$ref": "./examples/SearchServiceGetSynonymMap.json" + } + }, + "description": "Retrieves a synonym map definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/synonymmaps": { + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_List", + "x-ms-examples": { + "SearchServiceListSynonymMaps": { + "$ref": "./examples/SearchServiceListSynonymMaps.json" + } + }, + "description": "Lists all synonym maps available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Synonym-Maps" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListSynonymMapsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Create", + "x-ms-examples": { + "SearchServiceCreateSynonymMap": { + "$ref": "./examples/SearchServiceCreateSynonymMap.json" + } + }, + "description": "Creates a new synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Create", + "x-ms-examples": { + "SearchServiceCreateIndex": { + "$ref": "./examples/SearchServiceCreateIndex.json" + } + }, + "description": "Creates a new search index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "parameters": [ + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_List", + "x-ms-examples": { + "SearchServiceListIndexes": { + "$ref": "./examples/SearchServiceListIndexes.json" + } + }, + "description": "Lists all indexes available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexes" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/indexes('{indexName}')": { + "put": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndex": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndex.json" + } + }, + "description": "Creates a new search index or updates an index if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the index to create or update." + }, + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create or update." + }, + { + "name": "allowIndexDowntime", + "in": "query", + "required": false, + "type": "boolean", + "description": "Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndex": { + "$ref": "./examples/SearchServiceDeleteIndex.json" + } + }, + "description": "Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Get", + "x-ms-examples": { + "SearchServiceGetIndex": { + "$ref": "./examples/SearchServiceGetIndex.json" + } + }, + "description": "Retrieves an index definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes('{indexName}')/search.stats": { + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_GetStatistics", + "x-ms-examples": { + "SearchServiceGetIndexStatistics": { + "$ref": "./examples/SearchServiceGetIndexStatistics.json" + } + }, + "description": "Returns statistics for the given index, including a document count and storage usage.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to retrieve statistics." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GetIndexStatisticsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes('{indexName}')/search.analyze": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Analyze", + "x-ms-examples": { + "SearchServiceIndexAnalyze": { + "$ref": "./examples/SearchServiceIndexAnalyze.json" + } + }, + "description": "Shows how an analyzer breaks text into tokens.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/test-analyzer" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to test an analyzer." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeRequest" + }, + "description": "The text and analyzer or analysis components to test." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AnalyzeResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/servicestats": { + "get": { + "tags": [ + "Service" + ], + "operationId": "GetServiceStatistics", + "x-ms-examples": { + "SearchServiceGetServiceStatistics": { + "$ref": "./examples/SearchServiceGetServiceStatistics.json" + } + }, + "description": "Gets service level statistics for a search service.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ServiceStatistics" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + } + }, + "definitions": { + "AnalyzeRequest": { + "properties": { + "text": { + "type": "string", + "description": "The text to break into tokens." + }, + "analyzer": { + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + } + }, + "required": [ + "text" + ], + "description": "Specifies some text and analysis components used to break that text into tokens." + }, + "AnalyzeResult": { + "properties": { + "tokens": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzedTokenInfo" + }, + "description": "The list of tokens returned by the analyzer specified in the request." + } + }, + "required": [ + "tokens" + ], + "description": "The result of testing an analyzer on text." + }, + "AnalyzedTokenInfo": { + "properties": { + "token": { + "type": "string", + "readOnly": true, + "description": "The token returned by the analyzer." + }, + "startOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the first character of the token in the input text." + }, + "endOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the last character of the token in the input text." + }, + "position": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other." + } + }, + "required": [ + "token", + "startOffset", + "endOffset", + "position" + ], + "description": "Information about a token returned by an analyzer." + }, + "LexicalAnalyzerName": { + "type": "string", + "enum": [ + "ar.microsoft", + "ar.lucene", + "hy.lucene", + "bn.microsoft", + "eu.lucene", + "bg.microsoft", + "bg.lucene", + "ca.microsoft", + "ca.lucene", + "zh-Hans.microsoft", + "zh-Hans.lucene", + "zh-Hant.microsoft", + "zh-Hant.lucene", + "hr.microsoft", + "cs.microsoft", + "cs.lucene", + "da.microsoft", + "da.lucene", + "nl.microsoft", + "nl.lucene", + "en.microsoft", + "en.lucene", + "et.microsoft", + "fi.microsoft", + "fi.lucene", + "fr.microsoft", + "fr.lucene", + "gl.lucene", + "de.microsoft", + "de.lucene", + "el.microsoft", + "el.lucene", + "gu.microsoft", + "he.microsoft", + "hi.microsoft", + "hi.lucene", + "hu.microsoft", + "hu.lucene", + "is.microsoft", + "id.microsoft", + "id.lucene", + "ga.lucene", + "it.microsoft", + "it.lucene", + "ja.microsoft", + "ja.lucene", + "kn.microsoft", + "ko.microsoft", + "ko.lucene", + "lv.microsoft", + "lv.lucene", + "lt.microsoft", + "ml.microsoft", + "ms.microsoft", + "mr.microsoft", + "nb.microsoft", + "no.lucene", + "fa.lucene", + "pl.microsoft", + "pl.lucene", + "pt-BR.microsoft", + "pt-BR.lucene", + "pt-PT.microsoft", + "pt-PT.lucene", + "pa.microsoft", + "ro.microsoft", + "ro.lucene", + "ru.microsoft", + "ru.lucene", + "sr-cyrillic.microsoft", + "sr-latin.microsoft", + "sk.microsoft", + "sl.microsoft", + "es.microsoft", + "es.lucene", + "sv.microsoft", + "sv.lucene", + "ta.microsoft", + "te.microsoft", + "th.microsoft", + "th.lucene", + "tr.microsoft", + "tr.lucene", + "uk.microsoft", + "ur.microsoft", + "vi.microsoft", + "standard.lucene", + "standardasciifolding.lucene", + "keyword", + "pattern", + "simple", + "stop", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalAnalyzerName", + "modelAsString": true, + "values": [ + { + "value": "ar.microsoft", + "name": "ArMicrosoft", + "description": "Microsoft analyzer for Arabic." + }, + { + "value": "ar.lucene", + "name": "ArLucene", + "description": "Lucene analyzer for Arabic." + }, + { + "value": "hy.lucene", + "name": "HyLucene", + "description": "Lucene analyzer for Armenian." + }, + { + "value": "bn.microsoft", + "name": "BnMicrosoft", + "description": "Microsoft analyzer for Bangla." + }, + { + "value": "eu.lucene", + "name": "EuLucene", + "description": "Lucene analyzer for Basque." + }, + { + "value": "bg.microsoft", + "name": "BgMicrosoft", + "description": "Microsoft analyzer for Bulgarian." + }, + { + "value": "bg.lucene", + "name": "BgLucene", + "description": "Lucene analyzer for Bulgarian." + }, + { + "value": "ca.microsoft", + "name": "CaMicrosoft", + "description": "Microsoft analyzer for Catalan." + }, + { + "value": "ca.lucene", + "name": "CaLucene", + "description": "Lucene analyzer for Catalan." + }, + { + "value": "zh-Hans.microsoft", + "name": "ZhHansMicrosoft", + "description": "Microsoft analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hans.lucene", + "name": "ZhHansLucene", + "description": "Lucene analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hant.microsoft", + "name": "ZhHantMicrosoft", + "description": "Microsoft analyzer for Chinese (Traditional)." + }, + { + "value": "zh-Hant.lucene", + "name": "ZhHantLucene", + "description": "Lucene analyzer for Chinese (Traditional)." + }, + { + "value": "hr.microsoft", + "name": "HrMicrosoft", + "description": "Microsoft analyzer for Croatian." + }, + { + "value": "cs.microsoft", + "name": "CsMicrosoft", + "description": "Microsoft analyzer for Czech." + }, + { + "value": "cs.lucene", + "name": "CsLucene", + "description": "Lucene analyzer for Czech." + }, + { + "value": "da.microsoft", + "name": "DaMicrosoft", + "description": "Microsoft analyzer for Danish." + }, + { + "value": "da.lucene", + "name": "DaLucene", + "description": "Lucene analyzer for Danish." + }, + { + "value": "nl.microsoft", + "name": "NlMicrosoft", + "description": "Microsoft analyzer for Dutch." + }, + { + "value": "nl.lucene", + "name": "NlLucene", + "description": "Lucene analyzer for Dutch." + }, + { + "value": "en.microsoft", + "name": "EnMicrosoft", + "description": "Microsoft analyzer for English." + }, + { + "value": "en.lucene", + "name": "EnLucene", + "description": "Lucene analyzer for English." + }, + { + "value": "et.microsoft", + "name": "EtMicrosoft", + "description": "Microsoft analyzer for Estonian." + }, + { + "value": "fi.microsoft", + "name": "FiMicrosoft", + "description": "Microsoft analyzer for Finnish." + }, + { + "value": "fi.lucene", + "name": "FiLucene", + "description": "Lucene analyzer for Finnish." + }, + { + "value": "fr.microsoft", + "name": "FrMicrosoft", + "description": "Microsoft analyzer for French." + }, + { + "value": "fr.lucene", + "name": "FrLucene", + "description": "Lucene analyzer for French." + }, + { + "value": "gl.lucene", + "name": "GlLucene", + "description": "Lucene analyzer for Galician." + }, + { + "value": "de.microsoft", + "name": "DeMicrosoft", + "description": "Microsoft analyzer for German." + }, + { + "value": "de.lucene", + "name": "DeLucene", + "description": "Lucene analyzer for German." + }, + { + "value": "el.microsoft", + "name": "ElMicrosoft", + "description": "Microsoft analyzer for Greek." + }, + { + "value": "el.lucene", + "name": "ElLucene", + "description": "Lucene analyzer for Greek." + }, + { + "value": "gu.microsoft", + "name": "GuMicrosoft", + "description": "Microsoft analyzer for Gujarati." + }, + { + "value": "he.microsoft", + "name": "HeMicrosoft", + "description": "Microsoft analyzer for Hebrew." + }, + { + "value": "hi.microsoft", + "name": "HiMicrosoft", + "description": "Microsoft analyzer for Hindi." + }, + { + "value": "hi.lucene", + "name": "HiLucene", + "description": "Lucene analyzer for Hindi." + }, + { + "value": "hu.microsoft", + "name": "HuMicrosoft", + "description": "Microsoft analyzer for Hungarian." + }, + { + "value": "hu.lucene", + "name": "HuLucene", + "description": "Lucene analyzer for Hungarian." + }, + { + "value": "is.microsoft", + "name": "IsMicrosoft", + "description": "Microsoft analyzer for Icelandic." + }, + { + "value": "id.microsoft", + "name": "IdMicrosoft", + "description": "Microsoft analyzer for Indonesian (Bahasa)." + }, + { + "value": "id.lucene", + "name": "IdLucene", + "description": "Lucene analyzer for Indonesian." + }, + { + "value": "ga.lucene", + "name": "GaLucene", + "description": "Lucene analyzer for Irish." + }, + { + "value": "it.microsoft", + "name": "ItMicrosoft", + "description": "Microsoft analyzer for Italian." + }, + { + "value": "it.lucene", + "name": "ItLucene", + "description": "Lucene analyzer for Italian." + }, + { + "value": "ja.microsoft", + "name": "JaMicrosoft", + "description": "Microsoft analyzer for Japanese." + }, + { + "value": "ja.lucene", + "name": "JaLucene", + "description": "Lucene analyzer for Japanese." + }, + { + "value": "kn.microsoft", + "name": "KnMicrosoft", + "description": "Microsoft analyzer for Kannada." + }, + { + "value": "ko.microsoft", + "name": "KoMicrosoft", + "description": "Microsoft analyzer for Korean." + }, + { + "value": "ko.lucene", + "name": "KoLucene", + "description": "Lucene analyzer for Korean." + }, + { + "value": "lv.microsoft", + "name": "LvMicrosoft", + "description": "Microsoft analyzer for Latvian." + }, + { + "value": "lv.lucene", + "name": "LvLucene", + "description": "Lucene analyzer for Latvian." + }, + { + "value": "lt.microsoft", + "name": "LtMicrosoft", + "description": "Microsoft analyzer for Lithuanian." + }, + { + "value": "ml.microsoft", + "name": "MlMicrosoft", + "description": "Microsoft analyzer for Malayalam." + }, + { + "value": "ms.microsoft", + "name": "MsMicrosoft", + "description": "Microsoft analyzer for Malay (Latin)." + }, + { + "value": "mr.microsoft", + "name": "MrMicrosoft", + "description": "Microsoft analyzer for Marathi." + }, + { + "value": "nb.microsoft", + "name": "NbMicrosoft", + "description": "Microsoft analyzer for Norwegian (Bokmål)." + }, + { + "value": "no.lucene", + "name": "NoLucene", + "description": "Lucene analyzer for Norwegian." + }, + { + "value": "fa.lucene", + "name": "FaLucene", + "description": "Lucene analyzer for Persian." + }, + { + "value": "pl.microsoft", + "name": "PlMicrosoft", + "description": "Microsoft analyzer for Polish." + }, + { + "value": "pl.lucene", + "name": "PlLucene", + "description": "Lucene analyzer for Polish." + }, + { + "value": "pt-BR.microsoft", + "name": "PtBrMicrosoft", + "description": "Microsoft analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-BR.lucene", + "name": "PtBrLucene", + "description": "Lucene analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-PT.microsoft", + "name": "PtPtMicrosoft", + "description": "Microsoft analyzer for Portuguese (Portugal)." + }, + { + "value": "pt-PT.lucene", + "name": "PtPtLucene", + "description": "Lucene analyzer for Portuguese (Portugal)." + }, + { + "value": "pa.microsoft", + "name": "PaMicrosoft", + "description": "Microsoft analyzer for Punjabi." + }, + { + "value": "ro.microsoft", + "name": "RoMicrosoft", + "description": "Microsoft analyzer for Romanian." + }, + { + "value": "ro.lucene", + "name": "RoLucene", + "description": "Lucene analyzer for Romanian." + }, + { + "value": "ru.microsoft", + "name": "RuMicrosoft", + "description": "Microsoft analyzer for Russian." + }, + { + "value": "ru.lucene", + "name": "RuLucene", + "description": "Lucene analyzer for Russian." + }, + { + "value": "sr-cyrillic.microsoft", + "name": "SrCyrillicMicrosoft", + "description": "Microsoft analyzer for Serbian (Cyrillic)." + }, + { + "value": "sr-latin.microsoft", + "name": "SrLatinMicrosoft", + "description": "Microsoft analyzer for Serbian (Latin)." + }, + { + "value": "sk.microsoft", + "name": "SkMicrosoft", + "description": "Microsoft analyzer for Slovak." + }, + { + "value": "sl.microsoft", + "name": "SlMicrosoft", + "description": "Microsoft analyzer for Slovenian." + }, + { + "value": "es.microsoft", + "name": "EsMicrosoft", + "description": "Microsoft analyzer for Spanish." + }, + { + "value": "es.lucene", + "name": "EsLucene", + "description": "Lucene analyzer for Spanish." + }, + { + "value": "sv.microsoft", + "name": "SvMicrosoft", + "description": "Microsoft analyzer for Swedish." + }, + { + "value": "sv.lucene", + "name": "SvLucene", + "description": "Lucene analyzer for Swedish." + }, + { + "value": "ta.microsoft", + "name": "TaMicrosoft", + "description": "Microsoft analyzer for Tamil." + }, + { + "value": "te.microsoft", + "name": "TeMicrosoft", + "description": "Microsoft analyzer for Telugu." + }, + { + "value": "th.microsoft", + "name": "ThMicrosoft", + "description": "Microsoft analyzer for Thai." + }, + { + "value": "th.lucene", + "name": "ThLucene", + "description": "Lucene analyzer for Thai." + }, + { + "value": "tr.microsoft", + "name": "TrMicrosoft", + "description": "Microsoft analyzer for Turkish." + }, + { + "value": "tr.lucene", + "name": "TrLucene", + "description": "Lucene analyzer for Turkish." + }, + { + "value": "uk.microsoft", + "name": "UkMicrosoft", + "description": "Microsoft analyzer for Ukrainian." + }, + { + "value": "ur.microsoft", + "name": "UrMicrosoft", + "description": "Microsoft analyzer for Urdu." + }, + { + "value": "vi.microsoft", + "name": "ViMicrosoft", + "description": "Microsoft analyzer for Vietnamese." + }, + { + "value": "standard.lucene", + "name": "StandardLucene", + "description": "Standard Lucene analyzer." + }, + { + "value": "standardasciifolding.lucene", + "name": "StandardAsciiFoldingLucene", + "description": "Standard ASCII Folding Lucene analyzer. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers" + }, + { + "value": "keyword", + "name": "Keyword", + "description": "Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + }, + { + "value": "simple", + "name": "Simple", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html" + }, + { + "value": "stop", + "name": "Stop", + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html" + } + ] + }, + "description": "Defines the names of all text analyzers supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + } + }, + "LexicalTokenizerName": { + "type": "string", + "enum": [ + "classic", + "edgeNGram", + "keyword_v2", + "letter", + "lowercase", + "microsoft_language_tokenizer", + "microsoft_language_stemming_tokenizer", + "nGram", + "path_hierarchy_v2", + "pattern", + "standard_v2", + "uax_url_email", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalTokenizerName", + "modelAsString": true, + "values": [ + { + "value": "classic", + "name": "Classic", + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + }, + { + "value": "edgeNGram", + "name": "EdgeNGram", + "description": "Tokenizes the input from an edge into n-grams of the given size(s). See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + }, + { + "value": "keyword_v2", + "name": "Keyword", + "description": "Emits the entire input as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + { + "value": "letter", + "name": "Letter", + "description": "Divides text at non-letters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html" + }, + { + "value": "microsoft_language_tokenizer", + "name": "MicrosoftLanguageTokenizer", + "description": "Divides text using language-specific rules." + }, + { + "value": "microsoft_language_stemming_tokenizer", + "name": "MicrosoftLanguageStemmingTokenizer", + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + { + "value": "nGram", + "name": "NGram", + "description": "Tokenizes the input into n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + }, + { + "value": "path_hierarchy_v2", + "name": "PathHierarchy", + "description": "Tokenizer for path-like hierarchies. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + }, + { + "value": "standard_v2", + "name": "Standard", + "description": "Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + { + "value": "uax_url_email", + "name": "UaxUrlEmail", + "description": "Tokenizes urls and emails as one token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Divides text at whitespace. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html" + } + ] + }, + "description": "Defines the names of all tokenizers supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "TokenFilterName": { + "type": "string", + "enum": [ + "arabic_normalization", + "apostrophe", + "asciifolding", + "cjk_bigram", + "cjk_width", + "classic", + "common_grams", + "edgeNGram_v2", + "elision", + "german_normalization", + "hindi_normalization", + "indic_normalization", + "keyword_repeat", + "kstem", + "length", + "limit", + "lowercase", + "nGram_v2", + "persian_normalization", + "phonetic", + "porter_stem", + "reverse", + "scandinavian_normalization", + "scandinavian_folding", + "shingle", + "snowball", + "sorani_normalization", + "stemmer", + "stopwords", + "trim", + "truncate", + "unique", + "uppercase", + "word_delimiter" + ], + "x-ms-enum": { + "name": "TokenFilterName", + "modelAsString": true, + "values": [ + { + "value": "arabic_normalization", + "name": "ArabicNormalization", + "description": "A token filter that applies the Arabic normalizer to normalize the orthography. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html" + }, + { + "value": "apostrophe", + "name": "Apostrophe", + "description": "Strips all characters after an apostrophe (including the apostrophe itself). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html" + }, + { + "value": "asciifolding", + "name": "AsciiFolding", + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + }, + { + "value": "cjk_bigram", + "name": "CjkBigram", + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + }, + { + "value": "cjk_width", + "name": "CjkWidth", + "description": "Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html" + }, + { + "value": "classic", + "name": "Classic", + "description": "Removes English possessives, and dots from acronyms. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html" + }, + { + "value": "common_grams", + "name": "CommonGram", + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + }, + { + "value": "edgeNGram_v2", + "name": "EdgeNGram", + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + { + "value": "elision", + "name": "Elision", + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + }, + { + "value": "german_normalization", + "name": "GermanNormalization", + "description": "Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html" + }, + { + "value": "hindi_normalization", + "name": "HindiNormalization", + "description": "Normalizes text in Hindi to remove some differences in spelling variations. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html" + }, + { + "value": "indic_normalization", + "name": "IndicNormalization", + "description": "Normalizes the Unicode representation of text in Indian languages. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html" + }, + { + "value": "keyword_repeat", + "name": "KeywordRepeat", + "description": "Emits each incoming token twice, once as keyword and once as non-keyword. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html" + }, + { + "value": "kstem", + "name": "KStem", + "description": "A high-performance kstem filter for English. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html" + }, + { + "value": "length", + "name": "Length", + "description": "Removes words that are too long or too short. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + }, + { + "value": "limit", + "name": "Limit", + "description": "Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Normalizes token text to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.htm" + }, + { + "value": "nGram_v2", + "name": "NGram", + "description": "Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + { + "value": "persian_normalization", + "name": "PersianNormalization", + "description": "Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html" + }, + { + "value": "phonetic", + "name": "Phonetic", + "description": "Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + }, + { + "value": "porter_stem", + "name": "PorterStem", + "description": "Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer" + }, + { + "value": "reverse", + "name": "Reverse", + "description": "Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" + }, + { + "value": "scandinavian_normalization", + "name": "ScandinavianNormalization", + "description": "Normalizes use of the interchangeable Scandinavian characters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html" + }, + { + "value": "scandinavian_folding", + "name": "ScandinavianFoldingNormalization", + "description": "Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html" + }, + { + "value": "shingle", + "name": "Shingle", + "description": "Creates combinations of tokens as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + }, + { + "value": "snowball", + "name": "Snowball", + "description": "A filter that stems words using a Snowball-generated stemmer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + }, + { + "value": "sorani_normalization", + "name": "SoraniNormalization", + "description": "Normalizes the Unicode representation of Sorani text. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html" + }, + { + "value": "stemmer", + "name": "Stemmer", + "description": "Language specific stemming filter. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + }, + { + "value": "stopwords", + "name": "Stopwords", + "description": "Removes stop words from a token stream. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + }, + { + "value": "trim", + "name": "Trim", + "description": "Trims leading and trailing whitespace from tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html" + }, + { + "value": "truncate", + "name": "Truncate", + "description": "Truncates the terms to a specific length. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + }, + { + "value": "unique", + "name": "Unique", + "description": "Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + }, + { + "value": "uppercase", + "name": "Uppercase", + "description": "Normalizes token text to upper case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" + }, + { + "value": "word_delimiter", + "name": "WordDelimiter", + "description": "Splits words into subwords and performs optional transformations on subword groups." + } + ] + }, + "description": "Defines the names of all token filters supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "CharFilterName": { + "type": "string", + "enum": [ + "html_strip" + ], + "x-ms-enum": { + "name": "CharFilterName", + "modelAsString": true, + "values": [ + { + "value": "html_strip", + "name": "HtmlStrip", + "description": "A character filter that attempts to strip out HTML constructs. See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html" + } + ] + }, + "description": "Defines the names of all character filters supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "RegexFlags": { + "type": "string", + "enum": [ + "CANON_EQ", + "CASE_INSENSITIVE", + "COMMENTS", + "DOTALL", + "LITERAL", + "MULTILINE", + "UNICODE_CASE", + "UNIX_LINES" + ], + "x-ms-enum": { + "name": "RegexFlags", + "modelAsString": true, + "values": [ + { + "value": "CANON_EQ", + "name": "CanonEq", + "description": "Enables canonical equivalence." + }, + { + "value": "CASE_INSENSITIVE", + "name": "CaseInsensitive", + "description": "Enables case-insensitive matching." + }, + { + "value": "COMMENTS", + "name": "Comments", + "description": "Permits whitespace and comments in the pattern." + }, + { + "value": "DOTALL", + "name": "DotAll", + "description": "Enables dotall mode." + }, + { + "value": "LITERAL", + "name": "Literal", + "description": "Enables literal parsing of the pattern." + }, + { + "value": "MULTILINE", + "name": "Multiline", + "description": "Enables multiline mode." + }, + { + "value": "UNICODE_CASE", + "name": "UnicodeCase", + "description": "Enables Unicode-aware case folding." + }, + { + "value": "UNIX_LINES", + "name": "UnixLines", + "description": "Enables Unix lines mode." + } + ] + }, + "description": "Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.", + "externalDocs": { + "url": "http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#field_summary" + } + }, + "SearchFieldDataType": { + "type": "string", + "enum": [ + "Edm.String", + "Edm.Int32", + "Edm.Int64", + "Edm.Double", + "Edm.Boolean", + "Edm.DateTimeOffset", + "Edm.GeographyPoint", + "Edm.ComplexType" + ], + "x-ms-enum": { + "name": "SearchFieldDataType", + "modelAsString": true, + "values": [ + { + "value": "Edm.String", + "name": "String", + "description": "Indicates that a field contains a string." + }, + { + "value": "Edm.Int32", + "name": "Int32", + "description": "Indicates that a field contains a 32-bit signed integer." + }, + { + "value": "Edm.Int64", + "name": "Int64", + "description": "Indicates that a field contains a 64-bit signed integer." + }, + { + "value": "Edm.Double", + "name": "Double", + "description": "Indicates that a field contains an IEEE double-precision floating point number." + }, + { + "value": "Edm.Boolean", + "name": "Boolean", + "description": "Indicates that a field contains a Boolean value (true or false)." + }, + { + "value": "Edm.DateTimeOffset", + "name": "DateTimeOffset", + "description": "Indicates that a field contains a date/time value, including timezone information." + }, + { + "value": "Edm.GeographyPoint", + "name": "GeographyPoint", + "description": "Indicates that a field contains a geo-location in terms of longitude and latitude." + }, + { + "value": "Edm.ComplexType", + "name": "Complex", + "description": "Indicates that a field contains one or more complex objects that in turn have sub-fields of other types." + } + ] + }, + "description": "Defines the data type of a field in a search index." + }, + "LexicalAnalyzer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the analyzer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for analyzers." + }, + "CustomAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "required": [ + "tokenizer" + ], + "description": "Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer." + }, + "PatternAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "lowercase": { + "x-ms-client-name": "LowerCaseTerms", + "type": "boolean", + "default": true, + "description": "A value indicating whether terms should be lower-cased. Default is true." + }, + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + } + }, + "LuceneStandardAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html" + } + }, + "StopAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + } + }, + "LexicalTokenizer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the tokenizer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for tokenizers.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "ClassicTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + } + }, + "TokenCharacterKind": { + "type": "string", + "enum": [ + "letter", + "digit", + "whitespace", + "punctuation", + "symbol" + ], + "x-ms-enum": { + "name": "TokenCharacterKind", + "modelAsString": false, + "values": [ + { + "value": "letter", + "name": "Letter", + "description": "Keeps letters in tokens." + }, + { + "value": "digit", + "name": "Digit", + "description": "Keeps digits in tokens." + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Keeps whitespace in tokens." + }, + { + "value": "punctuation", + "name": "Punctuation", + "description": "Keeps punctuation in tokens." + }, + { + "value": "symbol", + "name": "Symbol", + "description": "Keeps symbols in tokens." + } + ] + }, + "description": "Represents classes of characters on which a token filter can operate." + }, + "EdgeNGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + } + }, + "KeywordTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "bufferSize": { + "type": "integer", + "format": "int32", + "default": 256, + "description": "The read buffer size in bytes. Default is 256." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "KeywordTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 256, + "maximum": 300, + "description": "The maximum token length. Default is 256. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + } + }, + "MicrosoftTokenizerLanguage": { + "type": "string", + "enum": [ + "bangla", + "bulgarian", + "catalan", + "chineseSimplified", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", + "english", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", + "indonesian", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", + "ukrainian", + "urdu", + "vietnamese" + ], + "x-ms-enum": { + "name": "MicrosoftTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft tokenizer for Catalan." + }, + { + "value": "chineseSimplified", + "name": "ChineseSimplified", + "description": "Selects the Microsoft tokenizer for Chinese (Simplified)." + }, + { + "value": "chineseTraditional", + "name": "ChineseTraditional", + "description": "Selects the Microsoft tokenizer for Chinese (Traditional)." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft tokenizer for English." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft tokenizer for Gujarati." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft tokenizer for Hindi." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft tokenizer for Italian." + }, + { + "value": "japanese", + "name": "Japanese", + "description": "Selects the Microsoft tokenizer for Japanese." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft tokenizer for Kannada." + }, + { + "value": "korean", + "name": "Korean", + "description": "Selects the Microsoft tokenizer for Korean." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft tokenizer for Serbian (Latin)." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft tokenizer for Telugu." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the Microsoft tokenizer for Thai." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft tokenizer for Urdu." + }, + { + "value": "vietnamese", + "name": "Vietnamese", + "description": "Selects the Microsoft tokenizer for Vietnamese." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language tokenizer." + }, + "MicrosoftLanguageTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules." + }, + "MicrosoftStemmingTokenizerLanguage": { + "type": "string", + "enum": [ + "arabic", + "bangla", + "bulgarian", + "catalan", + "croatian", + "czech", + "danish", + "dutch", + "english", + "estonian", + "finnish", + "french", + "german", + "greek", + "gujarati", + "hebrew", + "hindi", + "hungarian", + "icelandic", + "indonesian", + "italian", + "kannada", + "latvian", + "lithuanian", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovak", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "turkish", + "ukrainian", + "urdu" + ], + "x-ms-enum": { + "name": "MicrosoftStemmingTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Microsoft stemming tokenizer for Arabic." + }, + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft stemming tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft stemming tokenizer for Catalan." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft stemming tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft stemming tokenizer for English." + }, + { + "value": "estonian", + "name": "Estonian", + "description": "Selects the Microsoft stemming tokenizer for Estonian." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Microsoft stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft stemming tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft stemming tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft stemming tokenizer for Gujarati." + }, + { + "value": "hebrew", + "name": "Hebrew", + "description": "Selects the Microsoft stemming tokenizer for Hebrew." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Microsoft stemming tokenizer for Hungarian." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft stemming tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft stemming tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft stemming tokenizer for Italian." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft stemming tokenizer for Kannada." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Microsoft stemming tokenizer for Latvian." + }, + { + "value": "lithuanian", + "name": "Lithuanian", + "description": "Selects the Microsoft stemming tokenizer for Lithuanian." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft stemming tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft stemming tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft stemming tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft stemming tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft stemming tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft stemming tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft stemming tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Latin)." + }, + { + "value": "slovak", + "name": "Slovak", + "description": "Selects the Microsoft stemming tokenizer for Slovak." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft stemming tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft stemming tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft stemming tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft stemming tokenizer for Telugu." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Microsoft stemming tokenizer for Turkish." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft stemming tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft stemming tokenizer for Urdu." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language stemming tokenizer." + }, + "MicrosoftLanguageStemmingTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftStemmingTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + "NGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + } + }, + "PathHierarchyTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "delimiter": { + "type": "string", + "format": "char", + "default": "/", + "description": "The delimiter character to use. Default is \"/\"." + }, + "replacement": { + "type": "string", + "format": "char", + "default": "/", + "description": "A value that, if set, replaces the delimiter character. Default is \"/\"." + }, + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum token length. Default and maximum is 300." + }, + "reverse": { + "x-ms-client-name": "ReverseTokenOrder", + "type": "boolean", + "default": false, + "description": "A value indicating whether to generate tokens in reverse order. Default is false." + }, + "skip": { + "x-ms-client-name": "NumberOfTokensToSkip", + "type": "integer", + "format": "int32", + "default": 0, + "description": "The number of initial tokens to skip. Default is 0." + } + }, + "description": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + } + }, + "PatternTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "group": { + "type": "integer", + "format": "int32", + "default": -1, + "description": "The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1." + } + }, + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + } + }, + "LuceneStandardTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "LuceneStandardTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + } + }, + "UaxUrlEmailTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + } + }, + "TokenFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the token filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for token filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "AsciiFoldingTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether the original token will be kept. Default is false." + } + }, + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + } + }, + "CjkBigramTokenFilterScripts": { + "type": "string", + "enum": [ + "han", + "hiragana", + "katakana", + "hangul" + ], + "x-ms-enum": { + "name": "CjkBigramTokenFilterScripts", + "modelAsString": false, + "values": [ + { + "value": "han", + "name": "Han", + "description": "Ignore Han script when forming bigrams of CJK terms." + }, + { + "value": "hiragana", + "name": "Hiragana", + "description": "Ignore Hiragana script when forming bigrams of CJK terms." + }, + { + "value": "katakana", + "name": "Katakana", + "description": "Ignore Katakana script when forming bigrams of CJK terms." + }, + { + "value": "hangul", + "name": "Hangul", + "description": "Ignore Hangul script when forming bigrams of CJK terms." + } + ] + }, + "description": "Scripts that can be ignored by CjkBigramTokenFilter." + }, + "CjkBigramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CjkBigramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "ignoreScripts": { + "type": "array", + "items": { + "$ref": "#/definitions/CjkBigramTokenFilterScripts", + "x-nullable": false + }, + "description": "The scripts to ignore." + }, + "outputUnigrams": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false." + } + }, + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + } + }, + "CommonGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CommonGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "commonWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of common words." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether common words matching will be case insensitive. Default is false." + }, + "queryMode": { + "x-ms-client-name": "UseQueryMode", + "type": "boolean", + "default": false, + "description": "A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false." + } + }, + "required": [ + "commonWords" + ], + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + } + }, + "DictionaryDecompounderTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "wordList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to match against." + }, + "minWordSize": { + "type": "integer", + "format": "int32", + "default": 5, + "maximum": 300, + "description": "The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300." + }, + "minSubwordSize": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300." + }, + "maxSubwordSize": { + "type": "integer", + "format": "int32", + "default": 15, + "maximum": 300, + "description": "The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300." + }, + "onlyLongestMatch": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to add only the longest matching subword to the output. Default is false." + } + }, + "required": [ + "wordList" + ], + "description": "Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilter.html" + } + }, + "EdgeNGramTokenFilterSide": { + "type": "string", + "enum": [ + "front", + "back" + ], + "x-ms-enum": { + "name": "EdgeNGramTokenFilterSide", + "modelAsString": false, + "values": [ + { + "value": "front", + "name": "Front", + "description": "Specifies that the n-gram should be generated from the front of the input." + }, + { + "value": "back", + "name": "Back", + "description": "Specifies that the n-gram should be generated from the back of the input." + } + ] + }, + "description": "Specifies which side of the input an n-gram should be generated from." + }, + "EdgeNGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "EdgeNGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + } + }, + "ElisionTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ElisionTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "articles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of articles to remove." + } + }, + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + } + }, + "KeepTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeepTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keepWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to keep." + }, + "keepWordsCase": { + "x-ms-client-name": "LowerCaseKeepWords", + "type": "boolean", + "default": false, + "description": "A value indicating whether to lower case all words first. Default is false." + } + }, + "required": [ + "keepWords" + ], + "description": "A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeepWordFilter.html" + } + }, + "KeywordMarkerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordMarkerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of words to mark as keywords." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + } + }, + "required": [ + "keywords" + ], + "description": "Marks terms as keywords. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordMarkerFilter.html" + } + }, + "LengthTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LengthTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "min": { + "x-ms-client-name": "minLength", + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 300, + "description": "The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max." + }, + "max": { + "x-ms-client-name": "maxLength", + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum length in characters. Default and maximum is 300." + } + }, + "description": "Removes words that are too long or too short. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + } + }, + "LimitTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LimitTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxTokenCount": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The maximum number of tokens to produce. Default is 1." + }, + "consumeAllTokens": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false." + } + }, + "description": "Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + } + }, + "NGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "NGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + } + }, + "PatternCaptureTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternCaptureTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "patterns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of patterns to match against each token." + }, + "preserveOriginal": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to return the original token even if one of the patterns matches. Default is true." + } + }, + "required": [ + "patterns" + ], + "description": "Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternCaptureGroupTokenFilter.html" + } + }, + "PatternReplaceTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceFilter.html" + } + }, + "PhoneticEncoder": { + "type": "string", + "enum": [ + "metaphone", + "doubleMetaphone", + "soundex", + "refinedSoundex", + "caverphone1", + "caverphone2", + "cologne", + "nysiis", + "koelnerPhonetik", + "haasePhonetik", + "beiderMorse" + ], + "x-ms-enum": { + "name": "PhoneticEncoder", + "modelAsString": false, + "values": [ + { + "value": "metaphone", + "name": "Metaphone", + "description": "Encodes a token into a Metaphone value." + }, + { + "value": "doubleMetaphone", + "name": "DoubleMetaphone", + "description": "Encodes a token into a double metaphone value." + }, + { + "value": "soundex", + "name": "Soundex", + "description": "Encodes a token into a Soundex value." + }, + { + "value": "refinedSoundex", + "name": "RefinedSoundex", + "description": "Encodes a token into a Refined Soundex value." + }, + { + "value": "caverphone1", + "name": "Caverphone1", + "description": "Encodes a token into a Caverphone 1.0 value." + }, + { + "value": "caverphone2", + "name": "Caverphone2", + "description": "Encodes a token into a Caverphone 2.0 value." + }, + { + "value": "cologne", + "name": "Cologne", + "description": "Encodes a token into a Cologne Phonetic value." + }, + { + "value": "nysiis", + "name": "Nysiis", + "description": "Encodes a token into a NYSIIS value." + }, + { + "value": "koelnerPhonetik", + "name": "KoelnerPhonetik", + "description": "Encodes a token using the Kölner Phonetik algorithm." + }, + { + "value": "haasePhonetik", + "name": "HaasePhonetik", + "description": "Encodes a token using the Haase refinement of the Kölner Phonetik algorithm." + }, + { + "value": "beiderMorse", + "name": "BeiderMorse", + "description": "Encodes a token into a Beider-Morse value." + } + ] + }, + "description": "Identifies the type of phonetic encoder to use with a PhoneticTokenFilter." + }, + "PhoneticTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PhoneticTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "encoder": { + "$ref": "#/definitions/PhoneticEncoder", + "default": "metaphone", + "description": "The phonetic encoder to use. Default is \"metaphone\"." + }, + "replace": { + "x-ms-client-name": "ReplaceOriginalTokens", + "type": "boolean", + "default": true, + "description": "A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true." + } + }, + "description": "Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + } + }, + "ShingleTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ShingleTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The maximum shingle size. Default and minimum value is 2." + }, + "minShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize." + }, + "outputUnigrams": { + "type": "boolean", + "default": true, + "description": "A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true." + }, + "outputUnigramsIfNoShingles": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false." + }, + "tokenSeparator": { + "type": "string", + "default": " ", + "description": "The string to use when joining adjacent tokens to form a shingle. Default is a single space (\" \")." + }, + "filterToken": { + "type": "string", + "default": "_", + "description": "The string to insert for each position at which there is no token. Default is an underscore (\"_\")." + } + }, + "description": "Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + } + }, + "SnowballTokenFilterLanguage": { + "type": "string", + "enum": [ + "armenian", + "basque", + "catalan", + "danish", + "dutch", + "english", + "finnish", + "french", + "german", + "german2", + "hungarian", + "italian", + "kp", + "lovins", + "norwegian", + "porter", + "portuguese", + "romanian", + "russian", + "spanish", + "swedish", + "turkish" + ], + "x-ms-enum": { + "name": "SnowballTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene Snowball stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene Snowball stemming tokenizer for Basque." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene Snowball stemming tokenizer for Catalan." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene Snowball stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene Snowball stemming tokenizer for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene Snowball stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene Snowball stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene Snowball stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene Snowball stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene Snowball stemming tokenizer for Hungarian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene Snowball stemming tokenizer for Italian." + }, + { + "value": "kp", + "name": "Kp", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene Snowball stemming tokenizer for Norwegian." + }, + { + "value": "porter", + "name": "Porter", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Porter stemming algorithm." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene Snowball stemming tokenizer for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene Snowball stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene Snowball stemming tokenizer for Russian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene Snowball stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene Snowball stemming tokenizer for Swedish." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene Snowball stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a Snowball token filter." + }, + "SnowballTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SnowballTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/SnowballTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + } + }, + "StemmerTokenFilterLanguage": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "dutchKp", + "english", + "lightEnglish", + "minimalEnglish", + "possessiveEnglish", + "porter2", + "lovins", + "finnish", + "lightFinnish", + "french", + "lightFrench", + "minimalFrench", + "galician", + "minimalGalician", + "german", + "german2", + "lightGerman", + "minimalGerman", + "greek", + "hindi", + "hungarian", + "lightHungarian", + "indonesian", + "irish", + "italian", + "lightItalian", + "sorani", + "latvian", + "norwegian", + "lightNorwegian", + "minimalNorwegian", + "lightNynorsk", + "minimalNynorsk", + "portuguese", + "lightPortuguese", + "minimalPortuguese", + "portugueseRslp", + "romanian", + "russian", + "lightRussian", + "spanish", + "lightSpanish", + "swedish", + "lightSwedish", + "turkish" + ], + "x-ms-enum": { + "name": "StemmerTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Lucene stemming tokenizer for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene stemming tokenizer for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the Lucene stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Lucene stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene stemming tokenizer for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Lucene stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene stemming tokenizer for Dutch." + }, + { + "value": "dutchKp", + "name": "DutchKp", + "description": "Selects the Lucene stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene stemming tokenizer for English." + }, + { + "value": "lightEnglish", + "name": "LightEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does light stemming." + }, + { + "value": "minimalEnglish", + "name": "MinimalEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does minimal stemming." + }, + { + "value": "possessiveEnglish", + "name": "PossessiveEnglish", + "description": "Selects the Lucene stemming tokenizer for English that removes trailing possessives from words." + }, + { + "value": "porter2", + "name": "Porter2", + "description": "Selects the Lucene stemming tokenizer for English that uses the Porter2 stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene stemming tokenizer for Finnish." + }, + { + "value": "lightFinnish", + "name": "LightFinnish", + "description": "Selects the Lucene stemming tokenizer for Finnish that does light stemming." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene stemming tokenizer for French." + }, + { + "value": "lightFrench", + "name": "LightFrench", + "description": "Selects the Lucene stemming tokenizer for French that does light stemming." + }, + { + "value": "minimalFrench", + "name": "MinimalFrench", + "description": "Selects the Lucene stemming tokenizer for French that does minimal stemming." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the Lucene stemming tokenizer for Galician." + }, + { + "value": "minimalGalician", + "name": "MinimalGalician", + "description": "Selects the Lucene stemming tokenizer for Galician that does minimal stemming." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "lightGerman", + "name": "LightGerman", + "description": "Selects the Lucene stemming tokenizer for German that does light stemming." + }, + { + "value": "minimalGerman", + "name": "MinimalGerman", + "description": "Selects the Lucene stemming tokenizer for German that does minimal stemming." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Lucene stemming tokenizer for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Lucene stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian." + }, + { + "value": "lightHungarian", + "name": "LightHungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian that does light stemming." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Lucene stemming tokenizer for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the Lucene stemming tokenizer for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene stemming tokenizer for Italian." + }, + { + "value": "lightItalian", + "name": "LightItalian", + "description": "Selects the Lucene stemming tokenizer for Italian that does light stemming." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the Lucene stemming tokenizer for Sorani." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Lucene stemming tokenizer for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "lightNorwegian", + "name": "LightNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does light stemming." + }, + { + "value": "minimalNorwegian", + "name": "MinimalNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does minimal stemming." + }, + { + "value": "lightNynorsk", + "name": "LightNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does light stemming." + }, + { + "value": "minimalNynorsk", + "name": "MinimalNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does minimal stemming." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese." + }, + { + "value": "lightPortuguese", + "name": "LightPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does light stemming." + }, + { + "value": "minimalPortuguese", + "name": "MinimalPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does minimal stemming." + }, + { + "value": "portugueseRslp", + "name": "PortugueseRslp", + "description": "Selects the Lucene stemming tokenizer for Portuguese that uses the RSLP stemming algorithm." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene stemming tokenizer for Russian." + }, + { + "value": "lightRussian", + "name": "LightRussian", + "description": "Selects the Lucene stemming tokenizer for Russian that does light stemming." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene stemming tokenizer for Spanish." + }, + { + "value": "lightSpanish", + "name": "LightSpanish", + "description": "Selects the Lucene stemming tokenizer for Spanish that does light stemming." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene stemming tokenizer for Swedish." + }, + { + "value": "lightSwedish", + "name": "LightSwedish", + "description": "Selects the Lucene stemming tokenizer for Swedish that does light stemming." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a stemmer token filter." + }, + "StemmerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/StemmerTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "Language specific stemming filter. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + } + }, + "StemmerOverrideTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerOverrideTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stemming rules in the following format: \"word => stem\", for example: \"ran => run\"." + } + }, + "required": [ + "rules" + ], + "description": "Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html" + } + }, + "StopwordsList": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "english", + "finnish", + "french", + "galician", + "german", + "greek", + "hindi", + "hungarian", + "indonesian", + "irish", + "italian", + "latvian", + "norwegian", + "persian", + "portuguese", + "romanian", + "russian", + "sorani", + "spanish", + "swedish", + "thai", + "turkish" + ], + "x-ms-enum": { + "name": "StopwordsList", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the stopword list for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the stopword list for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the stopword list for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the stopword list for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the stopword list for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the stopword list for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the stopword list for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the stopword list for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the stopword list for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the stopword list for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the stopword list for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the stopword list for French." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the stopword list for Galician." + }, + { + "value": "german", + "name": "German", + "description": "Selects the stopword list for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the stopword list for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the stopword list for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the stopword list for Hungarian." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the stopword list for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the stopword list for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the stopword list for Italian." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the stopword list for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the stopword list for Norwegian." + }, + { + "value": "persian", + "name": "Persian", + "description": "Selects the stopword list for Persian." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the stopword list for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the stopword list for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the stopword list for Russian." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the stopword list for Sorani." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the stopword list for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the stopword list for Swedish." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the stopword list for Thai." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the stopword list for Turkish." + } + ] + }, + "description": "Identifies a predefined list of language-specific stopwords." + }, + "StopwordsTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopwordsTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of stopwords. This property and the stopwords list property cannot both be set." + }, + "stopwordsList": { + "$ref": "#/definitions/StopwordsList", + "default": "english", + "description": "A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + }, + "removeTrailing": { + "x-ms-client-name": "RemoveTrailingStopWords", + "type": "boolean", + "default": true, + "description": "A value indicating whether to ignore the last search term if it's a stop word. Default is true." + } + }, + "description": "Removes stop words from a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + } + }, + "SynonymTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SynonymTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to case-fold input for matching. Default is false." + }, + "expand": { + "type": "boolean", + "default": true, + "description": "A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true." + } + }, + "required": [ + "synonyms" + ], + "description": "Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html" + } + }, + "TruncateTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.TruncateTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "length": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The length at which terms will be truncated. Default and maximum is 300." + } + }, + "description": "Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + } + }, + "UniqueTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UniqueTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "onlyOnSamePosition": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to remove duplicates only at the same position. Default is false." + } + }, + "description": "Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + } + }, + "WordDelimiterTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.WordDelimiterTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "generateWordParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate part words. If set, causes parts of words to be generated; for example \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "generateNumberParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate number subwords. Default is true." + }, + "catenateWords": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, \"Azure-Search\" becomes \"AzureSearch\". Default is false." + }, + "catenateNumbers": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, \"1-2\" becomes \"12\". Default is false." + }, + "catenateAll": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all subword parts will be catenated. For example, if this is set to true, \"Azure-Search-1\" becomes \"AzureSearch1\". Default is false." + }, + "splitOnCaseChange": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split words on caseChange. For example, if this is set to true, \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether original words will be preserved and added to the subword list. Default is false." + }, + "splitOnNumerics": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split on numbers. For example, if this is set to true, \"Azure1Search\" becomes \"Azure\" \"1\" \"Search\". Default is true." + }, + "stemEnglishPossessive": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to remove trailing \"'s\" for each subword. Default is true." + }, + "protectedWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of tokens to protect from being delimited." + } + }, + "description": "Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html" + } + }, + "CharFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the char filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for character filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "MappingCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MappingCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "mappings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of mappings of the following format: \"a=>b\" (all occurrences of the character \"a\" will be replaced with character \"b\")." + } + }, + "required": [ + "mappings" + ], + "description": "A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/MappingCharFilter.html" + } + }, + "PatternReplaceCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html" + } + }, + "Similarity": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "ClassicSimilarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicSimilarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "description": "Legacy similarity algorithm which uses the Lucene TFIDFSimilarity implementation of TF-IDF. This variation of TF-IDF introduces static document length normalization as well as coordinating factors that penalize documents that only partially match the searched queries." + }, + "BM25Similarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.BM25Similarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "properties": { + "k1": { + "type": "number", + "format": "double", + "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency." + }, + "b": { + "type": "number", + "format": "double", + "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document." + } + }, + "description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)." + }, + "DataSourceCredentials": { + "properties": { + "connectionString": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "type": "string", + "description": "The connection string for the datasource." + } + }, + "description": "Represents credentials that can be used to connect to a datasource." + }, + "SearchIndexerDataContainer": { + "properties": { + "name": { + "type": "string", + "description": "The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed." + }, + "query": { + "type": "string", + "description": "A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources." + } + }, + "required": [ + "name" + ], + "description": "Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed." + }, + "DataChangeDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the data change detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data change detection policies." + }, + "HighWaterMarkChangeDetectionPolicy": { + "description": "Defines a data change detection policy that captures changes based on the value of a high water mark column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ], + "properties": { + "highWaterMarkColumnName": { + "type": "string", + "description": "The name of the high water mark column." + } + }, + "required": [ + "highWaterMarkColumnName" + ] + }, + "SqlIntegratedChangeTrackingPolicy": { + "description": "Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ] + }, + "DataDeletionDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the data deletion detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data deletion detection policies." + }, + "SoftDeleteColumnDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ], + "properties": { + "softDeleteColumnName": { + "type": "string", + "description": "The name of the column to use for soft-deletion detection." + }, + "softDeleteMarkerValue": { + "type": "string", + "description": "The marker value that identifies an item as deleted." + } + } + }, + "SearchIndexerDataSourceType": { + "type": "string", + "enum": [ + "azuresql", + "cosmosdb", + "azureblob", + "azuretable", + "mysql" + ], + "x-ms-enum": { + "name": "SearchIndexerDataSourceType", + "modelAsString": true, + "values": [ + { + "value": "azuresql", + "name": "AzureSql", + "description": "Indicates an Azure SQL datasource." + }, + { + "value": "cosmosdb", + "name": "CosmosDb", + "description": "Indicates a CosmosDB datasource." + }, + { + "value": "azureblob", + "name": "AzureBlob", + "description": "Indicates a Azure Blob datasource." + }, + { + "value": "azuretable", + "name": "AzureTable", + "description": "Indicates a Azure Table datasource." + }, + { + "value": "mysql", + "name": "MySql", + "description": "Indicates a MySql datasource." + } + ] + }, + "description": "Defines the type of a datasource." + }, + "SearchIndexerDataSource": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the datasource." + }, + "description": { + "type": "string", + "description": "The description of the datasource." + }, + "type": { + "$ref": "#/definitions/SearchIndexerDataSourceType", + "description": "The type of the datasource." + }, + "credentials": { + "$ref": "#/definitions/DataSourceCredentials", + "description": "Credentials for the datasource." + }, + "container": { + "$ref": "#/definitions/SearchIndexerDataContainer", + "description": "The data container for the datasource." + }, + "dataChangeDetectionPolicy": { + "$ref": "#/definitions/DataChangeDetectionPolicy", + "description": "The data change detection policy for the datasource." + }, + "dataDeletionDetectionPolicy": { + "$ref": "#/definitions/DataDeletionDetectionPolicy", + "description": "The data deletion detection policy for the datasource." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the data source." + } + }, + "required": [ + "name", + "type", + "credentials", + "container" + ], + "description": "Represents a datasource definition, which can be used to configure an indexer." + }, + "ListDataSourcesResult": { + "properties": { + "value": { + "x-ms-client-name": "DataSources", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The datasources in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Datasources request. If successful, it includes the full definitions of all datasources." + }, + "IndexingSchedule": { + "properties": { + "interval": { + "type": "string", + "format": "duration", + "description": "The interval of time between indexer executions." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time when an indexer should start running." + } + }, + "required": [ + "interval" + ], + "description": "Represents a schedule for indexer execution." + }, + "IndexingParameters": { + "properties": { + "batchSize": { + "type": "integer", + "format": "int32", + "description": "The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type." + }, + "maxFailedItems": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0." + }, + "maxFailedItemsPerBatch": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0." + }, + "configuration": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + } + }, + "description": "Represents parameters for indexer execution." + }, + "FieldMappingFunction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field mapping function." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type." + } + }, + "required": [ + "name" + ], + "description": "Represents a function that transforms a value from a data source before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "FieldMapping": { + "properties": { + "sourceFieldName": { + "type": "string", + "description": "The name of the field in the data source." + }, + "targetFieldName": { + "type": "string", + "description": "The name of the target field in the index. Same as the source field name by default." + }, + "mappingFunction": { + "$ref": "#/definitions/FieldMappingFunction", + "description": "A function to apply to each source field value before indexing." + } + }, + "required": [ + "sourceFieldName" + ], + "description": "Defines a mapping between a field in a data source and a target field in an index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "SearchIndexer": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the indexer." + }, + "description": { + "type": "string", + "description": "The description of the indexer." + }, + "dataSourceName": { + "type": "string", + "description": "The name of the datasource from which this indexer reads data." + }, + "skillsetName": { + "type": "string", + "description": "The name of the skillset executing with this indexer." + }, + "targetIndexName": { + "type": "string", + "description": "The name of the index to which this indexer writes data." + }, + "schedule": { + "$ref": "#/definitions/IndexingSchedule", + "description": "The schedule for this indexer." + }, + "parameters": { + "$ref": "#/definitions/IndexingParameters", + "description": "Parameters for indexer execution." + }, + "fieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Defines mappings between fields in the data source and corresponding target fields in the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "outputFieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Output field mappings are applied after enrichment and immediately before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "disabled": { + "x-ms-client-name": "IsDisabled", + "type": "boolean", + "default": false, + "description": "A value indicating whether the indexer is disabled. Default is false." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the indexer." + } + }, + "required": [ + "name", + "dataSourceName", + "targetIndexName" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Indexer-operations" + }, + "description": "Represents an indexer." + }, + "ListIndexersResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexers", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The indexers in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexers request. If successful, it includes the full definitions of all indexers." + }, + "SearchIndexerError": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item for which indexing failed." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The message describing the error that occurred while processing the item." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the error to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of errors. This may not be always available." + } + }, + "required": [ + "errorMessage", + "statusCode" + ], + "description": "Represents an item- or document-level indexing error." + }, + "SearchIndexerWarning": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item which generated a warning." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The message describing the warning that occurred while processing the item." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of warnings. This may not be always available." + } + }, + "required": [ + "message" + ], + "description": "Represents an item-level warning." + }, + "IndexerExecutionResult": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerExecutionStatus", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message indicating the top-level error, if any." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The start time of this indexer execution." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The end time of this indexer execution, if the execution has already completed." + }, + "errors": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerError" + }, + "description": "The item-level indexing errors." + }, + "warnings": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerWarning" + }, + "description": "The item-level indexing warnings." + }, + "itemsProcessed": { + "x-ms-client-name": "ItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed." + }, + "itemsFailed": { + "x-ms-client-name": "FailedItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that failed to be indexed during this indexer execution." + }, + "initialTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution started." + }, + "finalTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution finished." + } + }, + "required": [ + "status", + "errors", + "warnings", + "itemsProcessed", + "itemsFailed" + ], + "description": "Represents the result of an individual indexer execution." + }, + "IndexerExecutionStatus": { + "type": "string", + "enum": [ + "transientFailure", + "success", + "inProgress", + "reset" + ], + "x-ms-enum": { + "name": "IndexerExecutionStatus", + "modelAsString": false, + "values": [ + { + "value": "transientFailure", + "name": "TransientFailure", + "description": "An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule." + }, + { + "value": "success", + "name": "Success", + "description": "Indexer execution completed successfully." + }, + { + "value": "inProgress", + "name": "InProgress", + "description": "Indexer execution is in progress." + }, + { + "value": "reset", + "name": "Reset", + "description": "Indexer has been reset." + } + ] + }, + "x-nullable": false, + "description": "Represents the status of an individual indexer execution." + }, + "SearchIndexerStatus": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerStatus", + "readOnly": true, + "description": "Overall indexer status." + }, + "lastResult": { + "$ref": "#/definitions/IndexerExecutionResult", + "readOnly": true, + "description": "The result of the most recent or an in-progress indexer execution." + }, + "executionHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexerExecutionResult" + }, + "description": "History of the recent indexer executions, sorted in reverse chronological order." + }, + "limits": { + "$ref": "#/definitions/SearchIndexerLimits", + "readOnly": true, + "description": "The execution limits for the indexer." + } + }, + "required": [ + "status", + "executionHistory", + "limits" + ], + "description": "Represents the current status and execution history of an indexer." + }, + "IndexerStatus": { + "type": "string", + "enum": [ + "unknown", + "error", + "running" + ], + "x-ms-enum": { + "name": "IndexerStatus", + "modelAsString": false, + "values": [ + { + "value": "unknown", + "name": "Unknown", + "description": "Indicates that the indexer is in an unknown state." + }, + { + "value": "error", + "name": "Error", + "description": "Indicates that the indexer experienced an error that cannot be corrected without human intervention." + }, + { + "value": "running", + "name": "Running", + "description": "Indicates that the indexer is running normally." + } + ] + }, + "x-nullable": false, + "description": "Represents the overall indexer status." + }, + "SearchIndexerLimits": { + "properties": { + "maxRunTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "The maximum duration that the indexer is permitted to run for one execution." + }, + "maxDocumentExtractionSize": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum size of a document, in bytes, which will be considered valid for indexing." + }, + "maxDocumentContentCharactersToExtract": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum number of characters that will be extracted from a document picked up for indexing." + } + } + }, + "SearchField": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field, which must be unique within the fields collection of the index or parent field.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + } + }, + "type": { + "$ref": "#/definitions/SearchFieldDataType", + "description": "The data type of the field.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/supported-data-types" + } + }, + "key": { + "type": "boolean", + "description": "A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields." + }, + "retrievable": { + "type": "boolean", + "description": "A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields and null for complex fields." + }, + "searchable": { + "type": "boolean", + "description": "A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like \"sunny day\", internally it will be split into the individual tokens \"sunny\" and \"day\". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index since Azure Cognitive Search will store an additional tokenized version of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false." + }, + "filterable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to \"sunny day\", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields." + }, + "sortable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $orderby expressions. By default Azure Cognitive Search sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields." + }, + "facetable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields." + }, + "analyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields." + }, + "searchAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields." + }, + "indexAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields." + }, + "synonymMaps": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Synonym-Map-operations" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields." + } + }, + "required": [ + "name", + "type" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Represents a field in an index definition, which describes the name, data type, and search behavior of a field." + }, + "TextWeights": { + "properties": { + "weights": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double", + "x-nullable": false + }, + "description": "The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field." + } + }, + "required": [ + "weights" + ], + "description": "Defines weights on index fields for which matches should boost scoring in search queries." + }, + "ScoringFunction": { + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case." + }, + "fieldName": { + "type": "string", + "description": "The name of the field used as input to the scoring function." + }, + "boost": { + "type": "number", + "format": "double", + "description": "A multiplier for the raw score. Must be a positive number not equal to 1.0." + }, + "interpolation": { + "$ref": "#/definitions/ScoringFunctionInterpolation", + "description": "A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"." + } + }, + "required": [ + "type", + "fieldName", + "boost" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Base type for functions that can modify document scores during ranking." + }, + "DistanceScoringFunction": { + "x-ms-discriminator-value": "distance", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "distance": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/DistanceScoringParameters", + "description": "Parameter values for the distance scoring function." + } + }, + "required": [ + "distance" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on distance from a geographic location." + }, + "DistanceScoringParameters": { + "properties": { + "referencePointParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the reference location." + }, + "boostingDistance": { + "type": "number", + "format": "double", + "description": "The distance in kilometers from the reference location where the boosting range ends." + } + }, + "required": [ + "referencePointParameter", + "boostingDistance" + ], + "description": "Provides parameter values to a distance scoring function." + }, + "FreshnessScoringFunction": { + "x-ms-discriminator-value": "freshness", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "freshness": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/FreshnessScoringParameters", + "description": "Parameter values for the freshness scoring function." + } + }, + "required": [ + "freshness" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the value of a date-time field." + }, + "FreshnessScoringParameters": { + "properties": { + "boostingDuration": { + "type": "string", + "format": "duration", + "description": "The expiration period after which boosting will stop for a particular document." + } + }, + "required": [ + "boostingDuration" + ], + "description": "Provides parameter values to a freshness scoring function." + }, + "MagnitudeScoringFunction": { + "x-ms-discriminator-value": "magnitude", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "magnitude": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/MagnitudeScoringParameters", + "description": "Parameter values for the magnitude scoring function." + } + }, + "required": [ + "magnitude" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the magnitude of a numeric field." + }, + "MagnitudeScoringParameters": { + "properties": { + "boostingRangeStart": { + "type": "number", + "format": "double", + "description": "The field value at which boosting starts." + }, + "boostingRangeEnd": { + "type": "number", + "format": "double", + "description": "The field value at which boosting ends." + }, + "constantBoostBeyondRange": { + "x-ms-client-name": "ShouldBoostBeyondRangeByConstant", + "type": "boolean", + "description": "A value indicating whether to apply a constant boost for field values beyond the range end value; default is false." + } + }, + "required": [ + "boostingRangeStart", + "boostingRangeEnd" + ], + "description": "Provides parameter values to a magnitude scoring function." + }, + "TagScoringFunction": { + "x-ms-discriminator-value": "tag", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "tag": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/TagScoringParameters", + "description": "Parameter values for the tag scoring function." + } + }, + "required": [ + "tag" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores of documents with string values matching a given list of tags." + }, + "TagScoringParameters": { + "properties": { + "tagsParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the list of tags to compare against the target field." + } + }, + "required": [ + "tagsParameter" + ], + "description": "Provides parameter values to a tag scoring function." + }, + "ScoringFunctionInterpolation": { + "type": "string", + "enum": [ + "linear", + "constant", + "quadratic", + "logarithmic" + ], + "x-ms-enum": { + "name": "ScoringFunctionInterpolation", + "modelAsString": false, + "values": [ + { + "value": "linear", + "name": "Linear", + "description": "Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions." + }, + { + "value": "constant", + "name": "Constant", + "description": "Boosts scores by a constant factor." + }, + { + "value": "quadratic", + "name": "Quadratic", + "description": "Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + }, + { + "value": "logarithmic", + "name": "Logarithmic", + "description": "Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + } + ] + }, + "description": "Defines the function used to interpolate score boosting across a range of documents." + }, + "ScoringProfile": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the scoring profile." + }, + "text": { + "x-ms-client-name": "TextWeights", + "$ref": "#/definitions/TextWeights", + "description": "Parameters that boost scoring based on text matches in certain index fields." + }, + "functions": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringFunction" + }, + "description": "The collection of functions that influence the scoring of documents." + }, + "functionAggregation": { + "$ref": "#/definitions/ScoringFunctionAggregation", + "description": "A value indicating how the results of individual scoring functions should be combined. Defaults to \"Sum\". Ignored if there are no scoring functions." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines parameters for a search index that influence scoring in search queries." + }, + "ScoringFunctionAggregation": { + "type": "string", + "enum": [ + "sum", + "average", + "minimum", + "maximum", + "firstMatching" + ], + "x-ms-enum": { + "name": "ScoringFunctionAggregation", + "modelAsString": false, + "values": [ + { + "value": "sum", + "name": "Sum", + "description": "Boost scores by the sum of all scoring function results." + }, + { + "value": "average", + "name": "Average", + "description": "Boost scores by the average of all scoring function results." + }, + { + "value": "minimum", + "name": "Minimum", + "description": "Boost scores by the minimum of all scoring function results." + }, + { + "value": "maximum", + "name": "Maximum", + "description": "Boost scores by the maximum of all scoring function results." + }, + { + "value": "firstMatching", + "name": "FirstMatching", + "description": "Boost scores using the first applicable scoring function in the scoring profile." + } + ] + }, + "description": "Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile." + }, + "CorsOptions": { + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended)." + }, + "maxAgeInSeconds": { + "type": "integer", + "format": "int64", + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes." + } + }, + "required": [ + "allowedOrigins" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Defines options to control Cross-Origin Resource Sharing (CORS) for an index." + }, + "Suggester": { + "properties": { + "name": { + "type": "string", + "description": "The name of the suggester." + }, + "searchMode": { + "type": "string", + "enum": [ + "analyzingInfixMatching" + ], + "x-ms-enum": { + "name": "SuggesterSearchMode", + "modelAsString": false, + "values": [ + { + "value": "analyzingInfixMatching", + "name": "AnalyzingInfixMatching", + "description": "Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match." + } + ] + }, + "description": "A value indicating the capabilities of the suggester." + }, + "sourceFields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which the suggester applies. Each field must be searchable." + } + }, + "required": [ + "name", + "searchMode", + "sourceFields" + ], + "description": "Defines how the Suggest API should apply to a group of fields in the index." + }, + "SearchIndex": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the index." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "The fields of the index." + }, + "scoringProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringProfile" + }, + "description": "The scoring profiles for the index." + }, + "defaultScoringProfile": { + "type": "string", + "description": "The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used." + }, + "corsOptions": { + "$ref": "#/definitions/CorsOptions", + "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index." + }, + "suggesters": { + "type": "array", + "items": { + "$ref": "#/definitions/Suggester" + }, + "description": "The suggesters for the index." + }, + "analyzers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalAnalyzer" + }, + "description": "The analyzers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenizers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalTokenizer" + }, + "description": "The tokenizers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilter" + }, + "description": "The token filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilter" + }, + "description": "The character filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + } + }, + "similarity": { + "$ref": "#/definitions/Similarity", + "description": "The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the index." + } + }, + "required": [ + "name", + "fields" + ], + "description": "Represents a search index definition, which describes the fields and search behavior of an index." + }, + "GetIndexStatisticsResult": { + "properties": { + "documentCount": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The number of documents in the index." + }, + "storageSize": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The amount of storage in bytes consumed by the index." + } + }, + "required": [ + "documentCount", + "storageSize" + ], + "description": "Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date." + }, + "ListIndexesResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexes", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The indexes in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexes request. If successful, it includes the full definitions of all indexes." + }, + "SearchIndexerSkillset": { + "properties": { + "name": { + "type": "string", + "description": "The name of the skillset." + }, + "description": { + "type": "string", + "description": "The description of the skillset." + }, + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerSkill" + }, + "description": "A list of skills in the skillset." + }, + "cognitiveServices": { + "x-ms-client-name": "CognitiveServicesAccount", + "$ref": "#/definitions/CognitiveServicesAccount", + "description": "Details about cognitive services to be used when running skills." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the skillset." + } + }, + "required": [ + "name", + "skills" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + }, + "description": "A list of skills." + }, + "CognitiveServicesAccount": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the cognitive service resource attached to a skillset." + }, + "description": { + "type": "string", + "description": "Description of the cognitive service resource attached to a skillset." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for describing any cognitive service resource attached to a skillset." + }, + "DefaultCognitiveServicesAccount": { + "description": "An empty object that represents the default cognitive service resource for a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ] + }, + "CognitiveServicesAccountKey": { + "description": "A cognitive service resource provisioned with a key that is attached to a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CognitiveServicesByKey", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ], + "properties": { + "key": { + "type": "string", + "description": "The key used to provision the cognitive service resource attached to a skillset." + } + }, + "required": [ + "key" + ] + }, + "SearchIndexerSkill": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the skill." + }, + "name": { + "type": "string", + "description": "The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'." + }, + "description": { + "type": "string", + "description": "The description of the skill which describes the inputs, outputs, and usage of the skill." + }, + "context": { + "type": "string", + "description": "Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Inputs of the skills could be a column in the source data set, or the output of an upstream skill." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFieldMappingEntry" + }, + "description": "The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill." + } + }, + "required": [ + "@odata.type", + "inputs", + "outputs" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-predefined-skills" + }, + "description": "Base type for skills." + }, + "InputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the input." + }, + "source": { + "type": "string", + "description": "The source of the input." + }, + "sourceContext": { + "type": "string", + "description": "The source context used for selecting recursive inputs." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "The recursive inputs used when creating a complex type." + } + }, + "required": [ + "name" + ], + "description": "Input field mapping for a skill." + }, + "OutputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the output defined by the skill." + }, + "targetName": { + "type": "string", + "description": "The target name of the output. It is optional and default to name." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/naming-rules" + }, + "description": "Output field mapping for a skill." + }, + "ConditionalSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ConditionalSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-conditional" + }, + "description": "A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output." + }, + "KeyPhraseExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/KeyPhraseExtractionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "maxKeyPhraseCount": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A number indicating how many key phrases to return. If absent, all identified key phrases will be returned." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-keyphrases" + }, + "description": "A skill that uses text analytics for key phrase extraction." + }, + "OcrSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.OcrSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/OcrSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "detectOrientation": { + "x-ms-client-name": "ShouldDetectOrientation", + "type": "boolean", + "default": false, + "description": "A value indicating to turn orientation detection on or not. Default is false." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-ocr" + }, + "description": "A skill that extracts text from image files." + }, + "ImageAnalysisSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.ImageAnalysisSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/ImageAnalysisSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "visualFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/VisualFeature", + "x-nullable": false + }, + "description": "A list of visual features." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDetail", + "x-nullable": false + }, + "description": "A string indicating which domain-specific details to return." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-image-analysis" + }, + "description": "A skill that analyzes image files. It extracts a rich set of visual features based on the image content." + }, + "LanguageDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-language-detection" + }, + "description": "A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis." + }, + "ShaperSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ShaperSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-shaper" + }, + "description": "A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." + }, + "MergeSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.MergeSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "insertPreTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the start of the merged text. By default, the tag is an empty space." + }, + "insertPostTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the end of the merged text. By default, the tag is an empty space." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textmerger" + }, + "description": "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part." + }, + "EntityRecognitionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityCategory", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/EntityRecognitionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "includeTypelessEntities": { + "type": "boolean", + "x-nullable": true, + "description": "Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" + }, + "description": "Text analytics entity recognition." + }, + "SentimentSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SentimentSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment" + }, + "description": "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1." + }, + "SplitSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SplitSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "textSplitMode": { + "$ref": "#/definitions/TextSplitMode", + "x-nullable": false, + "description": "A value indicating which split mode to perform." + }, + "maximumPageLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired maximum page length. Default is 10000." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textsplit" + }, + "description": "A skill to split a string into chunks of text." + }, + "TextTranslationSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultToLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents into for documents that don't specify the to language explicitly. " + }, + "defaultFromLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents from for documents that don't specify the from language explicitly." + }, + "suggestedFrom": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is en." + } + }, + "required": [ + "defaultToLanguageCode" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-text-translation" + }, + "description": "A skill to translate text from one language to another." + }, + "WebApiSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "uri": { + "type": "string", + "description": "The url for the Web API." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the http request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the http request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired batch size which indicates number of documents." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "If set, the number of parallel calls that can be made to the Web API." + } + }, + "required": [ + "uri" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-web-api" + }, + "description": "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code." + }, + "WebApiHttpHeaders": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of http request headers." + }, + "ListSkillsetsResult": { + "properties": { + "value": { + "x-ms-client-name": "Skillsets", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillsets defined in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a list skillset request. If successful, it includes the full definitions of all skillsets." + }, + "TextSplitMode": { + "type": "string", + "enum": [ + "pages", + "sentences" + ], + "x-ms-enum": { + "name": "TextSplitMode", + "modelAsString": true, + "values": [ + { + "value": "pages", + "name": "Pages", + "description": "Split the text into individual pages." + }, + { + "value": "sentences", + "name": "Sentences", + "description": "Split the text into individual sentences." + } + ] + }, + "description": "A value indicating which split mode to perform." + }, + "VisualFeature": { + "type": "string", + "enum": [ + "adult", + "brands", + "categories", + "description", + "faces", + "objects", + "tags" + ], + "x-ms-enum": { + "name": "VisualFeature", + "modelAsString": true, + "values": [ + { + "value": "adult", + "name": "Adult", + "description": "Visual features recognized as adult persons." + }, + { + "value": "brands", + "name": "Brands", + "description": "Visual features recognized as commercial brands." + }, + { + "value": "categories", + "name": "Categories", + "description": "Categories." + }, + { + "value": "description", + "name": "Description", + "description": "Description." + }, + { + "value": "faces", + "name": "Faces", + "description": "Visual features recognized as people faces." + }, + { + "value": "objects", + "name": "Objects", + "description": "Visual features recognized as objects." + }, + { + "value": "tags", + "name": "Tags", + "description": "Tags." + } + ] + }, + "description": "The strings indicating what visual feature types to return." + }, + "ImageDetail": { + "type": "string", + "enum": [ + "celebrities", + "landmarks" + ], + "x-ms-enum": { + "name": "ImageDetail", + "modelAsString": true, + "values": [ + { + "value": "celebrities", + "name": "Celebrities", + "description": "Details recognized as celebrities." + }, + { + "value": "landmarks", + "name": "Landmarks", + "description": "Details recognized as landmarks." + } + ] + }, + "description": "A string indicating which domain-specific details to return." + }, + "EntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person", + "quantity", + "datetime", + "url", + "email" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": true, + "values": [ + { + "value": "location", + "name": "Location", + "description": "Entities describing a physical location." + }, + { + "value": "organization", + "name": "Organization", + "description": "Entities describing an organization." + }, + { + "value": "person", + "name": "Person", + "description": "Entities describing a person." + }, + { + "value": "quantity", + "name": "Quantity", + "description": "Entities describing a quantity." + }, + { + "value": "datetime", + "name": "Datetime", + "description": "Entities describing a date and time." + }, + { + "value": "url", + "name": "Url", + "description": "Entities describing a URL." + }, + { + "value": "email", + "name": "Email", + "description": "Entities describing an email address." + } + ] + }, + "description": "A string indicating what entity categories to return." + }, + "SentimentSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "it", + "no", + "pl", + "pt-PT", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "SentimentSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "The language codes supported for input text by SentimentSkill." + }, + "KeyPhraseExtractionSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv" + ], + "x-ms-enum": { + "name": "KeyPhraseExtractionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + } + ] + }, + "description": "The language codes supported for input text by KeyPhraseExtractionSkill." + }, + "OcrSkillLanguage": { + "type": "string", + "enum": [ + "zh-Hans", + "zh-Hant", + "cs", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "nb", + "pl", + "pt", + "ru", + "es", + "sv", + "tr", + "ar", + "ro", + "sr-Cyrl", + "sr-Latn", + "sk" + ], + "x-ms-enum": { + "name": "OcrSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "zh-Hans", + "description": "Chinese-Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese-Traditional" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "nb", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic, Serbia)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin, Serbia)" + }, + { + "value": "sk", + "description": "Slovak" + } + ] + }, + "description": "The language codes supported for input by OcrSkill." + }, + "SplitSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "SplitSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by SplitSkill." + }, + "EntityRecognitionSkillLanguage": { + "type": "string", + "enum": [ + "ar", + "cs", + "zh-Hans", + "zh-Hant", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "EntityRecognitionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "zh-Hans", + "description": "Chinese-Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese-Traditional" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "The language codes supported for input text by EntityRecognitionSkill." + }, + "TextTranslationSkillLanguage": { + "type": "string", + "enum": [ + "af", + "ar", + "bn", + "bs", + "bg", + "yue", + "ca", + "zh-Hans", + "zh-Hant", + "hr", + "cs", + "da", + "nl", + "en", + "et", + "fj", + "fil", + "fi", + "fr", + "de", + "el", + "ht", + "he", + "hi", + "mww", + "hu", + "is", + "id", + "it", + "ja", + "sw", + "tlh", + "ko", + "lv", + "lt", + "mg", + "ms", + "mt", + "nb", + "fa", + "pl", + "pt", + "otq", + "ro", + "ru", + "sm", + "sr-Cyrl", + "sr-Latn", + "sk", + "sl", + "es", + "sv", + "ty", + "ta", + "te", + "th", + "to", + "tr", + "uk", + "ur", + "vi", + "cy", + "yua" + ], + "x-ms-enum": { + "name": "TextTranslationSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "af", + "description": "Afrikaans" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "bn", + "description": "Bangla" + }, + { + "value": "bs", + "description": "Bosnian (Latin)" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "yue", + "description": "Cantonese (Traditional)" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fj", + "description": "Fijian" + }, + { + "value": "fil", + "description": "Filipino" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "ht", + "description": "Haitian Creole" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "mww", + "description": "Hmong Daw" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "sw", + "description": "Kiswahili" + }, + { + "value": "tlh", + "description": "Klingon" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "mg", + "description": "Malagasy" + }, + { + "value": "ms", + "description": "Malay" + }, + { + "value": "mt", + "description": "Maltese" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "fa", + "description": "Persian" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "otq", + "description": "Queretaro Otomi" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sm", + "description": "Samoan" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin)" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "ty", + "description": "Tahitian" + }, + { + "value": "ta", + "description": "Tamil" + }, + { + "value": "te", + "description": "Telugu" + }, + { + "value": "th", + "description": "Thai" + }, + { + "value": "to", + "description": "Tongan" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "uk", + "description": "Ukrainian" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "vi", + "description": "Vietnamese" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "yua", + "description": "Yucatec Maya" + } + ] + }, + "description": "The language codes supported for input text by TextTranslationSkill." + }, + "ImageAnalysisSkillLanguage": { + "type": "string", + "enum": [ + "en", + "es", + "ja", + "pt", + "zh" + ], + "x-ms-enum": { + "name": "ImageAnalysisSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "zh", + "description": "Chinese" + } + ] + }, + "description": "The language codes supported for input by ImageAnalysisSkill." + }, + "SynonymMap": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the synonym map." + }, + "format": { + "type": "string", + "enum": [ + "solr" + ], + "x-ms-enum": { + "name": "SynonymMapFormat", + "modelAsString": false, + "values": [ + { + "value": "solr", + "name": "Solr", + "description": "Selects the SOLR format for synonym maps." + } + ] + }, + "description": "The format of the synonym map. Only the 'solr' format is currently supported." + }, + "synonyms": { + "type": "string", + "description": "A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + } + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the synonym map." + } + }, + "required": [ + "name", + "format", + "synonyms" + ], + "description": "Represents a synonym map definition." + }, + "ListSynonymMapsResult": { + "properties": { + "value": { + "x-ms-client-name": "SynonymMaps", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The synonym maps in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps." + }, + "SearchResourceEncryptionKey": { + "properties": { + "keyVaultKeyName": { + "x-ms-client-name": "keyName", + "type": "string", + "description": "The name of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultKeyVersion": { + "x-ms-client-name": "keyVersion", + "type": "string", + "description": "The version of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultUri": { + "x-ms-client-name": "vaultUri", + "type": "string", + "description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net." + }, + "accessCredentials": { + "$ref": "#/definitions/AzureActiveDirectoryApplicationCredentials", + "description": "Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.", + "externalDocs": { + "url": "https://aka.ms/azure-search-msi" + } + } + }, + "required": [ + "keyVaultKeyName", + "keyVaultKeyVersion", + "keyVaultUri" + ], + "description": "A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym maps." + }, + "AzureActiveDirectoryApplicationCredentials": { + "properties": { + "applicationId": { + "type": "string", + "description": "An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application." + }, + "applicationSecret": { + "type": "string", + "description": "The authentication key of the specified AAD application." + } + }, + "required": [ + "applicationId" + ], + "description": "Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault." + }, + "ServiceStatistics": { + "properties": { + "counters": { + "$ref": "#/definitions/ServiceCounters", + "description": "Service level resource counters." + }, + "limits": { + "$ref": "#/definitions/ServiceLimits", + "description": "Service level general limits." + } + }, + "required": [ + "counters", + "limits" + ], + "description": "Response from a get service statistics request. If successful, it includes service level counters and limits." + }, + "ServiceCounters": { + "properties": { + "documentCount": { + "x-ms-client-name": "documentCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of documents across all indexes in the service." + }, + "indexesCount": { + "x-ms-client-name": "indexCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexes." + }, + "indexersCount": { + "x-ms-client-name": "indexerCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexers." + }, + "dataSourcesCount": { + "x-ms-client-name": "dataSourceCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of data sources." + }, + "storageSize": { + "x-ms-client-name": "storageSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total size of used storage in bytes." + }, + "synonymMaps": { + "x-ms-client-name": "synonymMapCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of synonym maps." + }, + "skillsetCount": { + "x-ms-client-name": "skillsetCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of skillsets." + } + }, + "required": [ + "documentCount", + "indexesCount", + "indexersCount", + "dataSourcesCount", + "storageSize", + "synonymMaps", + "skillsetCount" + ], + "description": "Represents service-level resource counters and quotas." + }, + "ServiceLimits": { + "properties": { + "maxFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum allowed fields per index." + }, + "maxFieldNestingDepthPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3." + }, + "maxComplexCollectionFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index." + }, + "maxComplexObjectsInCollectionsPerDocument": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of objects in complex collections allowed per document." + } + }, + "description": "Represents various service level limits." + }, + "ResourceCounter": { + "properties": { + "usage": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "description": "The resource usage amount." + }, + "quota": { + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The resource amount quota." + } + }, + "required": [ + "usage" + ], + "description": "Represents a resource's usage and quota." + }, + "SearchError": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "A human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchError" + }, + "readOnly": true, + "description": "An array of details about specific errors that led to this reported error." + } + }, + "required": [ + "message" + ], + "description": "Describes an error condition for the Azure Cognitive Search API." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "x-ms-parameter-location": "method" + }, + "PreferHeaderParameter": { + "name": "Prefer", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "return=representation" + ], + "description": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexAutocompleteDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexAutocompleteDocumentsGet.json new file mode 100644 index 000000000000..fd05e7ec6848 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexAutocompleteDocumentsGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30", + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": [ + "title", + "description" + ], + "top": 10 + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexAutocompleteDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexAutocompleteDocumentsPost.json new file mode 100644 index 000000000000..67787687199c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexAutocompleteDocumentsPost.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30", + "autocompleteRequest": { + "autocompleteMode": "oneTerm", + "search": "washington medic", + "suggesterName": "sg", + "filter": "search.in(docId,'101,102,105')", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "searchFields": "title,description", + "top": 10 + } + }, + "responses": { + "200": { + "body": [ + { + "text": "medicaid", + "queryPlusText": "washington medicaid" + }, + { + "text": "medicare", + "queryPlusText": "washington medicare" + }, + { + "text": "medicine", + "queryPlusText": "washington medicine" + } + ] + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexCountDocuments.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexCountDocuments.json new file mode 100644 index 000000000000..d0d6c5f3b15c --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexCountDocuments.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": 427 + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexGetDocument.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexGetDocument.json new file mode 100644 index 000000000000..c059e9755dee --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexGetDocument.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30", + "key": "1", + "$select": [ + "docId", + "title", + "description" + ] + }, + "responses": { + "200": { + "body": { + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexIndexDocuments.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexIndexDocuments.json new file mode 100644 index 000000000000..b46ac0e84c20 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexIndexDocuments.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30", + "batch": { + "value": [ + { + "@search.action": "upload", + "docId": "1", + "title": "Fancy Stay", + "description": "Best hotel in town" + }, + { + "@search.action": "merge", + "docId": "2", + "title": "Roach Motel" + }, + { + "@search.action": "mergeOrUpload", + "docId": "3", + "title": "Econo Motel" + }, + { + "@search.action": "delete", + "docId": "4" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 201 + }, + { + "key": "2", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + }, + "207": { + "body": { + "value": [ + { + "key": "1", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "2", + "status": false, + "errorMessage": "Document not found.", + "statusCode": 404 + }, + { + "key": "3", + "status": true, + "errorMessage": null, + "statusCode": 200 + }, + { + "key": "4", + "status": true, + "errorMessage": null, + "statusCode": 200 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSearchDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSearchDocumentsGet.json new file mode 100644 index 000000000000..3ce01b6b6ed5 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSearchDocumentsGet.json @@ -0,0 +1,84 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30", + "$count": true, + "facet": [ + "category,count:10,sort:count" + ], + "$filter": "rating gt 10", + "highlight": [ + "title" + ], + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "queryType": "simple", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": [ + "title", + "description" + ], + "searchMode": "any", + "$select": [ + "docId", + "title", + "description" + ], + "$skip": 100, + "$top": 10 + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.coverage": 80, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "Nice Hotel" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy Hotel" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSearchDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSearchDocumentsPost.json new file mode 100644 index 000000000000..df4b9d096f7d --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSearchDocumentsPost.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30", + "searchRequest": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "search.score() desc,rating desc", + "queryType": "simple", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "title,description", + "searchMode": "any", + "select": "docId,title,description", + "skip": 0, + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "@odata.count": 25, + "@search.facets": { + "category": [ + { + "count": 1, + "value": "Economy" + }, + { + "count": 1, + "value": "Luxury" + } + ] + }, + "@search.nextPageParameters": { + "count": true, + "facets": [ + "category,count:10,sort:count" + ], + "filter": "rating gt 4.0", + "highlight": "title", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": null, + "orderby": "search.score() desc,rating desc", + "queryType": "simple", + "scoringParameters": [ + "currentLocation--122.123,44.77233" + ], + "scoringProfile": "sp", + "search": "nice hotels", + "searchFields": "title,description", + "searchMode": "any", + "select": "docId,title,description", + "skip": 2, + "top": 8 + }, + "value": [ + { + "@search.score": 1.50, + "@search.highlights": { + "title": [ + "Nice Hotel" + ] + }, + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.score": 0.70, + "@search.highlights": { + "title": [ + "Fancy Hotel" + ] + }, + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ], + "@odata.nextLink": "https://myservice.search.windows.net/indexes('myindex')/docs/search.post.search?api-version=2020-06-30" + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSuggestDocumentsGet.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSuggestDocumentsGet.json new file mode 100644 index 000000000000..969839390fc6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSuggestDocumentsGet.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30", + "$filter": "rating gt 10", + "fuzzy": false, + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "$orderby": [ + "search.score() desc", + "rating desc" + ], + "search": "hote", + "searchFields": [ + "title" + ], + "suggesterName": "sg", + "$select": [ + "docId", + "title", + "description" + ], + "$top": 10 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSuggestDocumentsPost.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSuggestDocumentsPost.json new file mode 100644 index 000000000000..5b2ca5ca4e3b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchIndexSuggestDocumentsPost.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30", + "suggestRequest": { + "filter": "rating gt 4.0", + "highlightPostTag": "", + "highlightPreTag": "", + "minimumCoverage": 80, + "orderby": "rating desc", + "search": "hote", + "searchFields": "title", + "select": "docId,title,description", + "suggesterName": "sg", + "top": 10 + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@search.text": "Nice Hotel", + "description": "Cheapest hotel in town", + "docId": "1", + "title": "Nice Hotel" + }, + { + "@search.text": "Fancy Hotel", + "description": "Best hotel in town", + "docId": "2", + "title": "Fancy Hotel" + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateDataSource.json new file mode 100644 index 000000000000..75a03fd6a8a2 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateDataSource.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "responses": { + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndex.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndex.json new file mode 100644 index 000000000000..6660e45448ce --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndex.json @@ -0,0 +1,373 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "myapplicationsecret" + } + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "b": 0.5, + "k1": 1.3 + } + } + }, + "responses": { + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.BM25Similarity", + "b": 0.5, + "k1": 1.3 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndexer.json new file mode 100644 index 000000000000..bc6890a484b7 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateIndexer.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + } + } + }, + "responses": { + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateDataSource.json new file mode 100644 index 000000000000..cdb3ff9e4ff1 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateDataSource.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2020-06-30", + "Prefer": "return=representation", + "dataSource": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": "AccountEndpoint=https://myDocDbEndpoint.documents.azure.com;AccountKey=myDocDbAuthKey;Database=myDocDbDatabaseId" + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + }, + "201": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndex.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndex.json new file mode 100644 index 000000000000..a431d0e1deac --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndex.json @@ -0,0 +1,598 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "allowIndexDowntime": false, + "api-version": "2020-06-30", + "Prefer": "return=representation", + "index": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "key": true, + "searchable": false + }, + { + "name": "baseRate", + "type": "Edm.Double" + }, + { + "name": "description", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false + }, + { + "name": "description_fr", + "type": "Edm.String", + "filterable": false, + "sortable": false, + "facetable": false, + "analyzer": "fr.lucene" + }, + { + "name": "hotelName", + "type": "Edm.String" + }, + { + "name": "category", + "type": "Edm.String" + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "analyzer": "tagsAnalyzer" + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean" + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean" + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset" + }, + { + "name": "rating", + "type": "Edm.Int32" + }, + { + "name": "location", + "type": "Edm.GeographyPoint" + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity" + } + } + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + }, + "similarity": { + "@odata.type": "#Microsoft.Azure.Search.ClassicSimilarity" + } + } + }, + "201": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndexer.json new file mode 100644 index 000000000000..b880163531f0 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateIndexer.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30", + "Prefer": "return=representation", + "indexer": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + } + } + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + }, + "201": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSkillset.json new file mode 100644 index 000000000000..6878a7d28b76 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSkillset.json @@ -0,0 +1,369 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2020-06-30", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + }, + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSynonymMap.json new file mode 100644 index 000000000000..cc5297590142 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateOrUpdateSynonymMap.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2020-06-30", + "Prefer": "return=representation", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + }, + "201": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSkillset.json new file mode 100644 index 000000000000..e94fdced936e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSkillset.json @@ -0,0 +1,243 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2020-06-30", + "Prefer": "return=representation", + "skillset": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "textSplitMode": "pages", + "maximumPageLength": 4000, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + }, + "responses": { + "201": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSynonymMap.json new file mode 100644 index 000000000000..427924e85d23 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceCreateSynonymMap.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30", + "synonymMap": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": "myApplicationSecret" + } + } + } + }, + "responses": { + "201": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myUserManagedEncryptionKey-createdinAzureKeyVault", + "keyVaultKeyVersion": "myKeyVersion-32charAlphaNumericString", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteDataSource.json new file mode 100644 index 000000000000..9d963cdb0d36 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteDataSource.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2020-06-30" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteIndex.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteIndex.json new file mode 100644 index 000000000000..f9b9fe10d54b --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteIndex.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "myindex", + "api-version": "2020-06-30" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteIndexer.json new file mode 100644 index 000000000000..88ba28a65c49 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteIndexer.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteSkillset.json new file mode 100644 index 000000000000..4639c666eff0 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteSkillset.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2020-06-30" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteSynonymMap.json new file mode 100644 index 000000000000..54c9fb224dd6 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceDeleteSynonymMap.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2020-06-30" + }, + "responses": { + "204": {}, + "404": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetDataSource.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetDataSource.json new file mode 100644 index 000000000000..73b5e16e2c41 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetDataSource.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "dataSourceName": "mydatasource", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndex.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndex.json new file mode 100644 index 000000000000..659a4ea43756 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndex.json @@ -0,0 +1,244 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexStatistics.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexStatistics.json new file mode 100644 index 000000000000..2aa6e4a07c06 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexStatistics.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "documentCount": 239572, + "storageSize": 72375920 + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexer.json new file mode 100644 index 000000000000..687f23d7fb70 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexer.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexerStatus.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexerStatus.json new file mode 100644 index 000000000000..3d6e631d2fa3 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetIndexerStatus.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "status": "running", + "lastResult": { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + "executionHistory": [ + { + "status": "success", + "errorMessage": null, + "startTime": "2014-11-26T03:37:18.853Z", + "endTime": "2014-11-26T03:37:19.012Z", + "errors": [], + "warnings": [], + "itemsProcessed": 11, + "itemsFailed": 0, + "initialTrackingState": null, + "finalTrackingState": null + }, + { + "status": "transientFailure", + "errorMessage": null, + "startTime": "2014-11-26T03:28:10.125Z", + "endTime": "2014-11-26T03:28:12.007Z", + "errors": [ + { + "key": "", + "errorMessage": "Document key cannot be missing or empty.", + "statusCode": 400, + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 1", + "errorMessage": "Could not read the value of column 'foo' at index '0'.", + "statusCode": 400, + "name": "DocumentExtraction.AzureBlob.MyDataSource", + "details": "The file could not be parsed.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2049388" + } + ], + "warnings": [ + { + "key": "document id", + "message": "A warning doesn't stop indexing, and is intended to inform you of certain interesting situations, like when a blob indexer truncates the amount of text extracted from a blob.", + "name": null, + "details": null, + "documentationLink": null + }, + { + "key": "document id 2", + "message": "Document was truncated to 50000 characters.", + "name": "Enrichment.LanguageDetectionSkill.#4", + "details": "The skill did something that didn't break anything, nonetheless something we didn't expect happened, so it might be worth double checking.", + "documentationLink": "https://go.microsoft.com/fwlink/?linkid=2099692" + } + ], + "itemsProcessed": 1, + "itemsFailed": 2, + "initialTrackingState": null, + "finalTrackingState": null + } + ], + "limits": { + "maxRunTime": "22:00:00", + "maxDocumentExtractionSize": 256000000, + "maxDocumentContentCharactersToExtract": 4000000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetServiceStatistics.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetServiceStatistics.json new file mode 100644 index 000000000000..13cb75e53894 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetServiceStatistics.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "counters": { + "documentCount": { + "usage": 7093, + "quota": 10000 + }, + "indexesCount": { + "usage": 3, + "quota": 3 + }, + "indexersCount": { + "usage": 3, + "quota": 3 + }, + "dataSourcesCount": { + "usage": 1, + "quota": 3 + }, + "storageSize": { + "usage": 914529, + "quota": 52428800 + }, + "synonymMaps": { + "usage": 2, + "quota": 3 + }, + "skillsetCount": { + "usage": 0, + "quota": 3 + } + }, + "limits": { + "maxFieldsPerIndex": 1000, + "maxFieldNestingDepthPerIndex": 10, + "maxComplexCollectionFieldsPerIndex": 100, + "maxComplexObjectsInCollectionsPerDocument": 3000 + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSkillset.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSkillset.json new file mode 100644 index 000000000000..f09a426ffbc4 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSkillset.json @@ -0,0 +1,135 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "skillsetName": "demoskillset", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSynonymMap.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSynonymMap.json new file mode 100644 index 000000000000..31f6143e67aa --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceGetSynonymMap.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "synonymMapName": "mysynonymmap", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": { + "applicationId": "00000000-0000-0000-0000-000000000000", + "applicationSecret": null + } + } + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceIndexAnalyze.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceIndexAnalyze.json new file mode 100644 index 000000000000..f286d0237e62 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceIndexAnalyze.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexName": "hotels", + "api-version": "2020-06-30", + "request": { + "text": "Text to analyze", + "analyzer": "standard.lucene" + } + }, + "responses": { + "200": { + "body": { + "tokens": [ + { + "token": "text", + "startOffset": 0, + "endOffset": 4, + "position": 0 + }, + { + "token": "to", + "startOffset": 5, + "endOffset": 7, + "position": 1 + }, + { + "token": "analyze", + "startOffset": 8, + "endOffset": 15, + "position": 2 + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListDataSources.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListDataSources.json new file mode 100644 index 000000000000..51e07eeb9750 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListDataSources.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mydocdbdatasource", + "description": "My Cosmos DB data source.", + "type": "cosmosdb", + "credentials": { + "connectionString": null + }, + "container": { + "name": "myDocDbCollectionId", + "query": "SELECT c.id, c.userId, tag, c._ts FROM c JOIN tag IN c.tags WHERE c._ts >= @HighWaterMark ORDER BY c._ts" + }, + "dataChangeDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "highWaterMarkColumnName": "_ts" + }, + "dataDeletionDetectionPolicy": { + "@odata.type": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "softDeleteColumnName": "isDeleted", + "softDeleteMarkerValue": "true" + } + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexers.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexers.json new file mode 100644 index 000000000000..6ceef86d3a41 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexers.json @@ -0,0 +1,67 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "myindexer", + "description": "a cool indexer", + "dataSourceName": "mydocdbdatasource", + "targetIndexName": "orders", + "schedule": { + "interval": "PT1H", + "startTime": "2015-01-01T00:00:00Z" + }, + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5 + }, + "fieldMappings": [], + "disabled": false + }, + { + "name": "myotherindexer", + "description": "another cool indexer", + "dataSourceName": "myblobdatasource", + "targetIndexName": "orders", + "parameters": { + "maxFailedItems": 10, + "maxFailedItemsPerBatch": 5, + "batchSize": 15 + }, + "fieldMappings": [ + { + "sourceFieldName": "PersonName", + "targetFieldName": "FirstName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 0 + } + } + }, + { + "sourceFieldName": "PersonName", + "targetFieldName": "LastName", + "mappingFunction": { + "name": "extractTokenAtPosition", + "parameters": { + "delimiter": " ", + "position": 1 + } + } + } + ], + "disabled": false + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexes.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexes.json new file mode 100644 index 000000000000..fe99cd0b3381 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListIndexes.json @@ -0,0 +1,287 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "hotels", + "fields": [ + { + "name": "hotelId", + "type": "Edm.String", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "baseRate", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "description_fr", + "type": "Edm.String", + "searchable": true, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "fr.lucene", + "synonymMaps": [] + }, + { + "name": "hotelName", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "category", + "type": "Edm.String", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "tags", + "type": "Collection(Edm.String)", + "searchable": true, + "filterable": true, + "retrievable": true, + "sortable": false, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": "tagsAnalyzer", + "synonymMaps": [] + }, + { + "name": "parkingIncluded", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "smokingAllowed", + "type": "Edm.Boolean", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "lastRenovationDate", + "type": "Edm.DateTimeOffset", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "rating", + "type": "Edm.Int32", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": true, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "location", + "type": "Edm.GeographyPoint", + "searchable": false, + "filterable": true, + "retrievable": true, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [ + { + "name": "geo", + "text": { + "weights": { + "hotelName": 5 + } + }, + "functions": [ + { + "type": "distance", + "boost": 5, + "fieldName": "location", + "interpolation": "logarithmic", + "distance": { + "referencePointParameter": "currentLocation", + "boostingDistance": 10 + } + } + ] + } + ], + "defaultScoringProfile": "geo", + "suggesters": [ + { + "name": "sg", + "searchMode": "analyzingInfixMatching", + "sourceFields": [ + "hotelName" + ] + } + ], + "analyzers": [ + { + "name": "tagsAnalyzer", + "@odata.type": "#Microsoft.Azure.Search.CustomAnalyzer", + "charFilters": [ + "html_strip" + ], + "tokenizer": "standard_v2" + } + ], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": { + "allowedOrigins": [ + "tempuri.org" + ], + "maxAgeInSeconds": 60 + }, + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + }, + { + "name": "testindex", + "fields": [ + { + "name": "id", + "type": "Edm.String", + "searchable": false, + "filterable": false, + "retrievable": true, + "sortable": false, + "facetable": false, + "key": true, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + }, + { + "name": "hidden", + "type": "Edm.Double", + "searchable": false, + "filterable": true, + "retrievable": false, + "sortable": true, + "facetable": false, + "key": false, + "indexAnalyzer": null, + "searchAnalyzer": null, + "analyzer": null, + "synonymMaps": [] + } + ], + "scoringProfiles": [], + "defaultScoringProfile": null, + "suggesters": [], + "analyzers": [], + "tokenizers": [], + "tokenFilters": [], + "charFilters": [], + "corsOptions": null, + "encryptionKey": null + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSkillsets.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSkillsets.json new file mode 100644 index 000000000000..f9050db649bb --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSkillsets.json @@ -0,0 +1,139 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "$select": "*", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "demoskillset", + "description": "Extract entities, detect language and extract key-phrases", + "skills": [ + { + "@odata.type": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "name": "#1", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "organizations", + "targetName": "organizations" + } + ], + "categories": [ + "organization" + ], + "defaultLanguageCode": "en", + "minimumPrecision": 0.7 + }, + { + "@odata.type": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "name": "#2", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + } + ], + "outputs": [ + { + "name": "languageCode", + "targetName": "languageCode" + } + ] + }, + { + "@odata.type": "#Microsoft.Skills.Text.SplitSkill", + "name": "#3", + "description": null, + "context": null, + "inputs": [ + { + "name": "text", + "source": "/document/content" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "textItems", + "targetName": "pages" + } + ], + "defaultLanguageCode": null, + "textSplitMode": "pages", + "maximumPageLength": 4000 + }, + { + "@odata.type": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "name": "#4", + "description": null, + "context": "/document/pages/*", + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "keyPhrases", + "targetName": "keyPhrases" + } + ], + "defaultLanguageCode": null, + "maxKeyPhraseCount": null + }, + { + "@odata.type": "#Microsoft.Skills.Custom.WebApiSkill", + "name": "MyCustomWebApiSkill", + "description": null, + "context": "/document", + "uri": "https://contoso.example.org", + "httpMethod": "POST", + "timeout": "PT30S", + "batchSize": 1, + "degreeOfParallelism": null, + "inputs": [ + { + "name": "text", + "source": "/document/pages/*" + }, + { + "name": "languageCode", + "source": "/document/languageCode" + } + ], + "outputs": [ + { + "name": "customresult", + "targetName": "result" + } + ], + "httpHeaders": {} + } + ] + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSynonymMaps.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSynonymMaps.json new file mode 100644 index 000000000000..e0316b2e32b2 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceListSynonymMaps.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "api-version": "2020-06-30" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "mysynonymmap", + "format": "solr", + "synonyms": "United States, United States of America, USA\nWashington, Wash. => WA", + "encryptionKey": { + "keyVaultKeyName": "myKeyName", + "keyVaultKeyVersion": "myKeyVersion", + "keyVaultUri": "https://myKeyVault.vault.azure.net", + "accessCredentials": null + } + }, + { + "name": "myothersynonymmap", + "format": "solr", + "synonyms": "couch, sofa, chesterfield\npop, soda\ntoque, hat", + "encryptionKey": null + } + ] + } + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceResetIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceResetIndexer.json new file mode 100644 index 000000000000..b8b5c5952706 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceResetIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30" + }, + "responses": { + "204": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceRunIndexer.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceRunIndexer.json new file mode 100644 index 000000000000..bd5ab49e4c61 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/examples/SearchServiceRunIndexer.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "endpoint": "https://myservice.search.windows.net", + "indexerName": "myindexer", + "api-version": "2020-06-30" + }, + "responses": { + "202": {} + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchindex.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchindex.json new file mode 100644 index 000000000000..688b5849912e --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchindex.json @@ -0,0 +1,1548 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchIndexClient", + "description": "Client that can be used to query an index and upload, merge, or delete documents.", + "version": "2020-06-30", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true, + "syncMethods": "None" + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}/indexes('{indexName}')", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + }, + { + "$ref": "#/parameters/IndexNameParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/docs/$count": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Count", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Count-Documents" + }, + "x-ms-examples": { + "SearchIndexCountDocuments": { + "$ref": "./examples/SearchIndexCountDocuments.json" + } + }, + "description": "Queries the number of documents in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "type": "integer", + "format": "int64" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsGet": { + "$ref": "./examples/SearchIndexSearchDocumentsGet.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "search", + "in": "query", + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + { + "name": "$count", + "in": "query", + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-nullable": false, + "x-ms-client-name": "IncludeTotalResultCount", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "facet", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs.", + "x-ms-client-name": "Facets", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "The OData $filter expression to apply to the search query.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlight", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, and desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no OrderBy is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-client-name": "OrderBy", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "queryType", + "in": "query", + "type": "string", + "enum": [ + "simple", + "full" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringParameter", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "collectionFormat": "multi", + "x-ms-client-name": "ScoringParameters", + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes).", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "scoringProfile", + "in": "query", + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "searchMode", + "in": "query", + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "x-nullable": false, + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$skip", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use $skip due to this limitation, consider using $orderby on a totally-ordered key and $filter with a range query instead.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results.", + "x-ms-parameter-grouping": { + "name": "SearchOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.search": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SearchPost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "x-ms-examples": { + "SearchIndexSearchDocumentsPost": { + "$ref": "./examples/SearchIndexSearchDocumentsPost.json" + } + }, + "description": "Searches for documents in the index.", + "parameters": [ + { + "name": "searchRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchRequest", + "description": "The Search request." + }, + "description": "The definition of the Search request." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing documents that match the search criteria.", + "schema": { + "$ref": "#/definitions/SearchDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs('{key}')": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Get", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/lookup-document" + }, + "x-ms-examples": { + "SearchIndexGetDocument": { + "$ref": "./examples/SearchIndexGetDocument.json" + } + }, + "description": "Retrieves a document from the index.", + "parameters": [ + { + "name": "key", + "in": "path", + "required": true, + "description": "The key of the document to retrieve.", + "type": "string" + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "List of field names to retrieve for the document; Any field not retrieved will be missing from the returned document.", + "x-ms-client-name": "SelectedFields" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "responses": { + "200": { + "description": "Response containing the requested document.", + "schema": { + "type": "object" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.suggest": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsGet": { + "$ref": "./examples/SearchIndexSuggestDocumentsGet.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "search", + "in": "query", + "required": true, + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "required": true, + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestions query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestions queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-nullable": false, + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestions query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$orderby", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "x-ms-client-name": "OrderBy", + "description": "The list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to search for the specified search text. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$select", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of fields to retrieve. If unspecified, only the key field will be included in the results.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. The value must be a number between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "SuggestOptions" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.suggest": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_SuggestPost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/suggestions" + }, + "x-ms-examples": { + "SearchIndexSuggestDocumentsPost": { + "$ref": "./examples/SearchIndexSuggestDocumentsPost.json" + } + }, + "description": "Suggests documents in the index that match the given partial query text.", + "parameters": [ + { + "name": "suggestRequest", + "in": "body", + "required": true, + "description": "The Suggest request.", + "schema": { + "$ref": "#/definitions/SuggestRequest" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested documents that match the partial input.", + "schema": { + "$ref": "#/definitions/SuggestDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.index": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_Index", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/addupdate-or-delete-documents" + }, + "x-ms-examples": { + "SearchIndexIndexDocuments": { + "$ref": "./examples/SearchIndexIndexDocuments.json" + } + }, + "description": "Sends a batch of document write actions to the index.", + "parameters": [ + { + "name": "batch", + "in": "body", + "description": "The batch of index actions.", + "required": true, + "schema": { + "$ref": "#/definitions/IndexBatch" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "207": { + "description": "Response containing the status of operations for all actions in the batch.", + "schema": { + "$ref": "#/definitions/IndexDocumentsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.autocomplete": { + "get": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompleteGet", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsGet": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsGet.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "search", + "in": "query", + "type": "string", + "required": true, + "description": "The incomplete term which should be auto-completed.", + "x-ms-client-name": "SearchText" + }, + { + "name": "suggesterName", + "in": "query", + "type": "string", + "required": true, + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + { + "name": "autocompleteMode", + "in": "query", + "type": "string", + "x-nullable": false, + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$filter", + "in": "query", + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "fuzzy", + "in": "query", + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will find terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPostTag", + "in": "query", + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "highlightPreTag", + "in": "query", + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "minimumCoverage", + "in": "query", + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "searchFields", + "in": "query", + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + }, + { + "name": "$top", + "in": "query", + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5.", + "x-ms-parameter-grouping": { + "name": "AutocompleteOptions" + } + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/docs/search.post.autocomplete": { + "post": { + "tags": [ + "Documents" + ], + "operationId": "Documents_AutocompletePost", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/autocomplete" + }, + "x-ms-examples": { + "SearchIndexAutocompleteDocumentsPost": { + "$ref": "./examples/SearchIndexAutocompleteDocumentsPost.json" + } + }, + "description": "Autocompletes incomplete query terms based on input text and matching terms in the index.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "autocompleteRequest", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AutocompleteRequest" + }, + "description": "The definition of the Autocomplete request." + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "Response containing suggested query terms that complete the partial input.", + "schema": { + "$ref": "#/definitions/AutocompleteResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + } + }, + "definitions": { + "SuggestDocumentsResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SuggestResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@search.coverage": { + "type": "number", + "readOnly": true, + "format": "double", + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not set in the request." + } + }, + "required": [ + "value" + ], + "description": "Response containing suggestion query results from an index." + }, + "SuggestResult": { + "properties": { + "@search.text": { + "type": "string", + "readOnly": true, + "description": "The text of the suggestion result.", + "x-ms-client-name": "Text" + } + }, + "required": [ + "@search.text" + ], + "additionalProperties": true, + "description": "A result containing a document found by a suggestion query, plus associated metadata." + }, + "FacetResult": { + "properties": { + "count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "The approximate count of documents falling within the bucket described by this facet." + } + }, + "additionalProperties": true, + "description": "A single bucket of a facet query result. Reports the number of documents with a field value falling within a particular range or having a particular value or interval." + }, + "SearchDocumentsResult": { + "properties": { + "@odata.count": { + "type": "integer", + "format": "int64", + "readOnly": true, + "x-ms-client-name": "Count", + "description": "The total count of results found by the search operation, or null if the count was not requested. If present, the count may be greater than the number of results in this response. This can happen if you use the $top or $skip parameters, or if Azure Cognitive Search can't return all the requested documents in a single Search response." + }, + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was included in the query, or null if minimumCoverage was not specified in the request." + }, + "@search.facets": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/FacetResult" + } + }, + "readOnly": true, + "x-ms-client-name": "Facets", + "description": "The facet query results for the search operation, organized as a collection of buckets for each faceted field; null if the query did not include any facet expressions." + }, + "@search.nextPageParameters": { + "$ref": "#/definitions/SearchRequest", + "readOnly": true, + "x-ms-client-name": "NextPageParameters", + "description": "Continuation JSON payload returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this JSON along with @odata.nextLink to formulate another POST Search request to get the next part of the search response." + }, + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchResult" + }, + "readOnly": true, + "x-ms-client-name": "Results", + "description": "The sequence of results returned by the query." + }, + "@odata.nextLink": { + "type": "string", + "readOnly": true, + "x-ms-client-name": "NextLink", + "description": "Continuation URL returned when Azure Cognitive Search can't return all the requested results in a single Search response. You can use this URL to formulate another GET or POST Search request to get the next part of the search response. Make sure to use the same verb (GET or POST) as the request that produced this response." + } + }, + "required": [ + "value" + ], + "description": "Response containing search results from an index." + }, + "SearchResult": { + "properties": { + "@search.score": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Score", + "x-nullable": false, + "description": "The relevance score of the document compared to other documents returned by the query." + }, + "@search.highlights": { + "type": "object", + "additionalProperties": { + "type": "array", + "items": { + "type": "string" + } + }, + "readOnly": true, + "x-ms-client-name": "Highlights", + "description": "Text fragments from the document that indicate the matching search terms, organized by each applicable field; null if hit highlighting was not enabled for the query." + } + }, + "required": [ + "@search.score" + ], + "additionalProperties": true, + "description": "Contains a document found by a search query, plus associated metadata." + }, + "IndexBatch": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/IndexAction" + }, + "description": "The actions in the batch.", + "x-ms-client-name": "Actions" + } + }, + "required": [ + "value" + ], + "description": "Contains a batch of document write actions to send to the index." + }, + "IndexAction": { + "properties": { + "@search.action": { + "type": "string", + "enum": [ + "upload", + "merge", + "mergeOrUpload", + "delete" + ], + "x-ms-enum": { + "name": "IndexActionType", + "modelAsString": false, + "values": [ + { + "value": "upload", + "name": "Upload", + "description": "Inserts the document into the index if it is new and updates it if it exists. All fields are replaced in the update case." + }, + { + "value": "merge", + "name": "Merge", + "description": "Merges the specified field values with an existing document. If the document does not exist, the merge will fail. Any field you specify in a merge will replace the existing field in the document. This also applies to collections of primitive and complex types." + }, + { + "value": "mergeOrUpload", + "name": "MergeOrUpload", + "description": "Behaves like merge if a document with the given key already exists in the index. If the document does not exist, it behaves like upload with a new document." + }, + { + "value": "delete", + "name": "Delete", + "description": "Removes the specified document from the index. Any field you specify in a delete operation other than the key field will be ignored. If you want to remove an individual field from a document, use merge instead and set the field explicitly to null." + } + ] + }, + "x-ms-client-name": "ActionType", + "x-nullable": false, + "description": "The operation to perform on a document in an indexing batch." + } + }, + "additionalProperties": true, + "description": "Represents an index action that operates on a document." + }, + "IndexingResult": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of a document that was in the indexing request." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message explaining why the indexing operation failed for the document identified by the key; null if indexing succeeded." + }, + "status": { + "x-ms-client-name": "Succeeded", + "type": "boolean", + "x-nullable": false, + "readOnly": true, + "description": "A value indicating whether the indexing operation succeeded for the document identified by the key." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code of the indexing operation. Possible values include: 200 for a successful update or delete, 201 for successful document creation, 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + } + }, + "required": [ + "key", + "status", + "statusCode" + ], + "description": "Status of an indexing operation for a single document." + }, + "IndexDocumentsResult": { + "properties": { + "value": { + "x-ms-client-name": "Results", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexingResult" + }, + "description": "The list of status information for each document in the indexing request." + } + }, + "required": [ + "value" + ], + "description": "Response containing the status of operations for all documents in the indexing request." + }, + "SearchMode": { + "type": "string", + "enum": [ + "any", + "all" + ], + "x-ms-enum": { + "name": "SearchMode", + "modelAsString": false, + "values": [ + { + "value": "any", + "name": "Any", + "description": "Any of the search terms must be matched in order to count the document as a match." + }, + { + "value": "all", + "name": "All", + "description": "All of the search terms must be matched in order to count the document as a match." + } + ] + }, + "description": "Specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "QueryType": { + "type": "string", + "enum": [ + "simple", + "full" + ], + "x-ms-enum": { + "name": "QueryType", + "modelAsString": false, + "values": [ + { + "value": "simple", + "name": "Simple", + "description": "Uses the simple query syntax for searches. Search text is interpreted using a simple query language that allows for symbols such as +, * and \"\". Queries are evaluated across all searchable fields by default, unless the searchFields parameter is specified." + }, + { + "value": "full", + "name": "Full", + "description": "Uses the full Lucene query syntax for searches. Search text is interpreted using the Lucene query language which allows field-specific and weighted searches, as well as other advanced features." + } + ] + }, + "description": "Specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "AutocompleteMode": { + "type": "string", + "enum": [ + "oneTerm", + "twoTerms", + "oneTermWithContext" + ], + "x-ms-enum": { + "name": "AutocompleteMode", + "modelAsString": false, + "values": [ + { + "value": "oneTerm", + "name": "OneTerm", + "description": "Only one term is suggested. If the query has two terms, only the last term is completed. For example, if the input is 'washington medic', the suggested terms could include 'medicaid', 'medicare', and 'medicine'." + }, + { + "value": "twoTerms", + "name": "TwoTerms", + "description": "Matching two-term phrases in the index will be suggested. For example, if the input is 'medic', the suggested terms could include 'medicare coverage' and 'medical assistant'." + }, + { + "value": "oneTermWithContext", + "name": "OneTermWithContext", + "description": "Completes the last term in a query with two or more terms, where the last two terms are a phrase that exists in the index. For example, if the input is 'washington medic', the suggested terms could include 'washington medicaid' and 'washington medical'." + } + ] + }, + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context in producing autocomplete terms." + }, + "SearchRequest": { + "properties": { + "count": { + "type": "boolean", + "description": "A value that specifies whether to fetch the total count of results. Default is false. Setting this value to true may have a performance impact. Note that the count returned is an approximation.", + "x-ms-client-name": "IncludeTotalResultCount" + }, + "facets": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Search-Documents" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of facet expressions to apply to the search query. Each facet expression contains a field name, optionally followed by a comma-separated list of name:value pairs." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "The OData $filter expression to apply to the search query." + }, + "highlight": { + "type": "string", + "description": "The comma-separated list of field names to use for hit highlights. Only searchable fields can be used for hit highlighting.", + "x-ms-client-name": "HighlightFields" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. Default is </em>." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. Default is <em>." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a search query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 100." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "queryType": { + "$ref": "#/definitions/QueryType", + "description": "A value that specifies the syntax of the search query. The default is 'simple'. Use 'full' if your query uses the Lucene query syntax." + }, + "scoringParameters": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of parameter values to be used in scoring functions (for example, referencePointParameter) using the format name-values. For example, if the scoring profile defines a function with a parameter called 'mylocation' the parameter string would be \"mylocation--122.2,44.8\" (without the quotes)." + }, + "scoringProfile": { + "type": "string", + "description": "The name of a scoring profile to evaluate match scores for matching documents in order to sort the results." + }, + "search": { + "type": "string", + "description": "A full-text search query expression; Use \"*\" or omit this parameter to match all documents.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to which to scope the full-text search. When using fielded search (fieldName:searchExpression) in a full Lucene query, the field names of each fielded search expression take precedence over any field names listed in this parameter." + }, + "searchMode": { + "$ref": "#/definitions/SearchMode", + "description": "A value that specifies whether any or all of the search terms must be matched in order to count the document as a match." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, all fields marked as retrievable in the schema are included." + }, + "skip": { + "type": "integer", + "format": "int32", + "description": "The number of search results to skip. This value cannot be greater than 100,000. If you need to scan documents in sequence, but cannot use skip due to this limitation, consider using orderby on a totally-ordered key and filter with a range query instead." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of search results to retrieve. This can be used in conjunction with $skip to implement client-side paging of search results. If results are truncated due to server-side paging, the response will include a continuation token that can be used to issue another Search request for the next page of results." + } + }, + "description": "Parameters for filtering, sorting, faceting, paging, and other search query behaviors." + }, + "SuggestRequest": { + "properties": { + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents considered for suggestions." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the suggestion query. Default is false. When set to true, the query will find suggestions even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy suggestion searches are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting of suggestions is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting of suggestions is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by a suggestion query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "orderby": { + "x-ms-client-name": "OrderBy", + "type": "string", + "description": "The comma-separated list of OData $orderby expressions by which to sort the results. Each expression can be either a field name or a call to either the geo.distance() or the search.score() functions. Each expression can be followed by asc to indicate ascending, or desc to indicate descending. The default is ascending order. Ties will be broken by the match scores of documents. If no $orderby is specified, the default sort order is descending by document match score. There can be at most 32 $orderby clauses." + }, + "search": { + "type": "string", + "description": "The search text to use to suggest documents. Must be at least 1 character, and no more than 100 characters.", + "x-ms-client-name": "SearchText" + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to search for the specified search text. Target fields must be included in the specified suggester." + }, + "select": { + "type": "string", + "description": "The comma-separated list of fields to retrieve. If unspecified, only the key field will be included in the results." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of suggestions to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for filtering, sorting, fuzzy matching, and other suggestions query behaviors." + }, + "AutocompleteRequest": { + "properties": { + "search": { + "type": "string", + "description": "The search text on which to base autocomplete results.", + "x-ms-client-name": "SearchText" + }, + "autocompleteMode": { + "$ref": "#/definitions/AutocompleteMode", + "description": "Specifies the mode for Autocomplete. The default is 'oneTerm'. Use 'twoTerms' to get shingles and 'oneTermWithContext' to use the current context while producing auto-completed terms." + }, + "filter": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/OData-Expression-Syntax-for-Azure-Search" + }, + "type": "string", + "description": "An OData expression that filters the documents used to produce completed terms for the Autocomplete result." + }, + "fuzzy": { + "type": "boolean", + "description": "A value indicating whether to use fuzzy matching for the autocomplete query. Default is false. When set to true, the query will autocomplete terms even if there's a substituted or missing character in the search text. While this provides a better experience in some scenarios, it comes at a performance cost as fuzzy autocomplete queries are slower and consume more resources.", + "x-ms-client-name": "UseFuzzyMatching" + }, + "highlightPostTag": { + "type": "string", + "description": "A string tag that is appended to hit highlights. Must be set with highlightPreTag. If omitted, hit highlighting is disabled." + }, + "highlightPreTag": { + "type": "string", + "description": "A string tag that is prepended to hit highlights. Must be set with highlightPostTag. If omitted, hit highlighting is disabled." + }, + "minimumCoverage": { + "type": "number", + "format": "double", + "description": "A number between 0 and 100 indicating the percentage of the index that must be covered by an autocomplete query in order for the query to be reported as a success. This parameter can be useful for ensuring search availability even for services with only one replica. The default is 80." + }, + "searchFields": { + "type": "string", + "description": "The comma-separated list of field names to consider when querying for auto-completed terms. Target fields must be included in the specified suggester." + }, + "suggesterName": { + "type": "string", + "description": "The name of the suggester as specified in the suggesters collection that's part of the index definition." + }, + "top": { + "type": "integer", + "format": "int32", + "description": "The number of auto-completed terms to retrieve. This must be a value between 1 and 100. The default is 5." + } + }, + "required": [ + "search", + "suggesterName" + ], + "description": "Parameters for fuzzy matching, and other autocomplete query behaviors." + }, + "AutocompleteResult": { + "properties": { + "@search.coverage": { + "type": "number", + "format": "double", + "readOnly": true, + "x-ms-client-name": "Coverage", + "description": "A value indicating the percentage of the index that was considered by the autocomplete request, or null if minimumCoverage was not specified in the request." + }, + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/AutocompleteItem" + }, + "description": "The list of returned Autocompleted items.", + "x-ms-client-name": "Results" + } + }, + "required": [ + "value" + ], + "description": "The result of Autocomplete query." + }, + "AutocompleteItem": { + "properties": { + "text": { + "type": "string", + "readOnly": true, + "description": "The completed term." + }, + "queryPlusText": { + "type": "string", + "readOnly": true, + "description": "The query along with the completed term." + } + }, + "required": [ + "text", + "queryPlusText" + ], + "description": "The result of Autocomplete requests." + }, + "SearchError": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "A human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchError" + }, + "readOnly": true, + "description": "An array of details about specific errors that led to this reported error." + } + }, + "required": [ + "message" + ], + "description": "Describes an error condition for the Azure Cognitive Search API." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + }, + "IndexNameParameter": { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": false, + "description": "The name of the index.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json new file mode 100644 index 000000000000..3bccedc1fe49 --- /dev/null +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json @@ -0,0 +1,8643 @@ +{ + "swagger": "2.0", + "info": { + "title": "SearchServiceClient", + "description": "Client that can be used to manage and query indexes and documents, as well as manage other resources, on a search service.", + "version": "2020-06-30", + "x-ms-code-generation-settings": { + "useDateTimeOffset": true + } + }, + "x-ms-parameterized-host": { + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, + "parameters": [ + { + "$ref": "#/parameters/EndpointParameter" + } + ] + }, + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/datasources('{dataSourceName}')": { + "put": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateDataSource": { + "$ref": "./examples/SearchServiceCreateOrUpdateDataSource.json" + } + }, + "description": "Creates a new datasource or updates a datasource if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to create or update." + }, + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Delete", + "x-ms-examples": { + "SearchServiceDeleteDataSource": { + "$ref": "./examples/SearchServiceDeleteDataSource.json" + } + }, + "description": "Deletes a datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Get", + "x-ms-examples": { + "SearchServiceGetDataSource": { + "$ref": "./examples/SearchServiceGetDataSource.json" + } + }, + "description": "Retrieves a datasource definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Data-Source" + }, + "parameters": [ + { + "name": "dataSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the datasource to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/datasources": { + "get": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_List", + "x-ms-examples": { + "SearchServiceListDataSources": { + "$ref": "./examples/SearchServiceListDataSources.json" + } + }, + "description": "Lists all datasources available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Data-Sources" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the data sources to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListDataSourcesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "DataSources" + ], + "operationId": "DataSources_Create", + "x-ms-examples": { + "SearchServiceCreateDataSource": { + "$ref": "./examples/SearchServiceCreateDataSource.json" + } + }, + "description": "Creates a new datasource.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "parameters": [ + { + "name": "dataSource", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The definition of the datasource to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerDataSource" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.reset": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Reset", + "x-ms-examples": { + "SearchServiceResetIndexer": { + "$ref": "./examples/SearchServiceResetIndexer.json" + } + }, + "description": "Resets the change tracking state associated with an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Reset-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to reset." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.run": { + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Run", + "x-ms-examples": { + "SearchServiceRunIndexer": { + "$ref": "./examples/SearchServiceRunIndexer.json" + } + }, + "description": "Runs an indexer on-demand.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Run-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to run." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "202": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')": { + "put": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndexer": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndexer.json" + } + }, + "description": "Creates a new indexer or updates an indexer if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to create or update." + }, + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndexer": { + "$ref": "./examples/SearchServiceDeleteIndexer.json" + } + }, + "description": "Deletes an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "404": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Get", + "x-ms-examples": { + "SearchServiceGetIndexer": { + "$ref": "./examples/SearchServiceGetIndexer.json" + } + }, + "description": "Retrieves an indexer definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_List", + "x-ms-examples": { + "SearchServiceListIndexers": { + "$ref": "./examples/SearchServiceListIndexers.json" + } + }, + "description": "Lists all indexers available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexers" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the indexers to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexersResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_Create", + "x-ms-examples": { + "SearchServiceCreateIndexer": { + "$ref": "./examples/SearchServiceCreateIndexer.json" + } + }, + "description": "Creates a new indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Indexer" + }, + "parameters": [ + { + "name": "indexer", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The definition of the indexer to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexer" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexers('{indexerName}')/search.status": { + "get": { + "tags": [ + "Indexers" + ], + "operationId": "Indexers_GetStatus", + "x-ms-examples": { + "SearchServiceGetIndexerStatus": { + "$ref": "./examples/SearchServiceGetIndexerStatus.json" + } + }, + "description": "Returns the current status and execution history of an indexer.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Indexer-Status" + }, + "parameters": [ + { + "name": "indexerName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the indexer for which to retrieve status." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndexerStatus" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/skillsets('{skillsetName}')": { + "put": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSkillset": { + "$ref": "./examples/SearchServiceCreateOrUpdateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service or updates the skillset if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/update-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to create or update." + }, + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create or update in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully updated.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Delete", + "x-ms-examples": { + "SearchServiceDeleteSkillset": { + "$ref": "./examples/SearchServiceDeleteSkillset.json" + } + }, + "description": "Deletes a skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/delete-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "The skillset is successfully deleted." + }, + "404": { + "description": "The provided skillset name is not found." + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Get", + "x-ms-examples": { + "SearchServiceGetSkillset": { + "$ref": "./examples/SearchServiceGetSkillset.json" + } + }, + "description": "Retrieves a skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/get-skillset" + }, + "parameters": [ + { + "name": "skillsetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the skillset to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The skillset is successfully returned.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/skillsets": { + "get": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_List", + "x-ms-examples": { + "SearchServiceListSkillsets": { + "$ref": "./examples/SearchServiceListSkillsets.json" + } + }, + "description": "List all skillsets in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/list-skillset" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the skillsets to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "The list is successfully returned.", + "schema": { + "$ref": "#/definitions/ListSkillsetsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "Skillsets" + ], + "operationId": "Skillsets_Create", + "x-ms-examples": { + "SearchServiceCreateSkillset": { + "$ref": "./examples/SearchServiceCreateSkillset.json" + } + }, + "description": "Creates a new skillset in a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/create-skillset" + }, + "parameters": [ + { + "name": "skillset", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillset containing one or more skills to create in a search service." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "The skillset is successfully created.", + "schema": { + "$ref": "#/definitions/SearchIndexerSkillset" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/synonymmaps('{synonymMapName}')": { + "put": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateSynonymMap": { + "$ref": "./examples/SearchServiceCreateOrUpdateSynonymMap.json" + } + }, + "description": "Creates a new synonym map or updates a synonym map if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to create or update." + }, + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create or update." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Delete", + "x-ms-examples": { + "SearchServiceDeleteSynonymMap": { + "$ref": "./examples/SearchServiceDeleteSynonymMap.json" + } + }, + "description": "Deletes a synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Get", + "x-ms-examples": { + "SearchServiceGetSynonymMap": { + "$ref": "./examples/SearchServiceGetSynonymMap.json" + } + }, + "description": "Retrieves a synonym map definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMapName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the synonym map to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/synonymmaps": { + "get": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_List", + "x-ms-examples": { + "SearchServiceListSynonymMaps": { + "$ref": "./examples/SearchServiceListSynonymMaps.json" + } + }, + "description": "Lists all synonym maps available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Synonym-Maps" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the synonym maps to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListSynonymMapsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "post": { + "tags": [ + "SynonymMaps" + ], + "operationId": "SynonymMaps_Create", + "x-ms-examples": { + "SearchServiceCreateSynonymMap": { + "$ref": "./examples/SearchServiceCreateSynonymMap.json" + } + }, + "description": "Creates a new synonym map.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map" + }, + "parameters": [ + { + "name": "synonymMap", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The definition of the synonym map to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SynonymMap" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Create", + "x-ms-examples": { + "SearchServiceCreateIndex": { + "$ref": "./examples/SearchServiceCreateIndex.json" + } + }, + "description": "Creates a new search index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "parameters": [ + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_List", + "x-ms-examples": { + "SearchServiceListIndexes": { + "$ref": "./examples/SearchServiceListIndexes.json" + } + }, + "description": "Lists all indexes available for a search service.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/List-Indexes" + }, + "parameters": [ + { + "name": "$select", + "in": "query", + "required": false, + "type": "string", + "description": "Selects which top-level properties of the index definitions to retrieve. Specified as a comma-separated list of JSON property names, or '*' for all properties. The default is all properties." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ListIndexesResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/indexes('{indexName}')": { + "put": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_CreateOrUpdate", + "x-ms-examples": { + "SearchServiceCreateOrUpdateIndex": { + "$ref": "./examples/SearchServiceCreateOrUpdateIndex.json" + } + }, + "description": "Creates a new search index or updates an index if it already exists.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Update-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The definition of the index to create or update." + }, + { + "name": "index", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The definition of the index to create or update." + }, + { + "name": "allowIndexDowntime", + "in": "query", + "required": false, + "type": "boolean", + "description": "Allows new analyzers, tokenizers, token filters, or char filters to be added to an index by taking the index offline for at least a few seconds. This temporarily causes indexing and query requests to fail. Performance and write availability of the index can be impaired for several minutes after the index is updated, or longer for very large indexes." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/PreferHeaderParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "201": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "delete": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Delete", + "x-ms-examples": { + "SearchServiceDeleteIndex": { + "$ref": "./examples/SearchServiceDeleteIndex.json" + } + }, + "description": "Deletes a search index and all the documents it contains. This operation is permanent, with no recovery option. Make sure you have a master copy of your index definition, data ingestion code, and a backup of the primary data source in case you need to re-build the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Delete-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to delete." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/IfMatchParameter" + }, + { + "$ref": "#/parameters/IfNoneMatchParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "204": { + "description": "" + }, + "404": { + "description": "" + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + }, + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Get", + "x-ms-examples": { + "SearchServiceGetIndex": { + "$ref": "./examples/SearchServiceGetIndex.json" + } + }, + "description": "Retrieves an index definition.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index to retrieve." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/SearchIndex" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes('{indexName}')/search.stats": { + "get": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_GetStatistics", + "x-ms-examples": { + "SearchServiceGetIndexStatistics": { + "$ref": "./examples/SearchServiceGetIndexStatistics.json" + } + }, + "description": "Returns statistics for the given index, including a document count and storage usage.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Get-Index-Statistics" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to retrieve statistics." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/GetIndexStatisticsResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/indexes('{indexName}')/search.analyze": { + "post": { + "tags": [ + "Indexes" + ], + "operationId": "Indexes_Analyze", + "x-ms-examples": { + "SearchServiceIndexAnalyze": { + "$ref": "./examples/SearchServiceIndexAnalyze.json" + } + }, + "description": "Shows how an analyzer breaks text into tokens.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/test-analyzer" + }, + "parameters": [ + { + "name": "indexName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the index for which to test an analyzer." + }, + { + "name": "request", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AnalyzeRequest" + }, + "description": "The text and analyzer or analysis components to test." + }, + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/AnalyzeResult" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + }, + "/servicestats": { + "get": { + "tags": [ + "Service" + ], + "operationId": "GetServiceStatistics", + "x-ms-examples": { + "SearchServiceGetServiceStatistics": { + "$ref": "./examples/SearchServiceGetServiceStatistics.json" + } + }, + "description": "Gets service level statistics for a search service.", + "parameters": [ + { + "$ref": "#/parameters/ClientRequestIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "x-ms-request-id": "request-id", + "responses": { + "200": { + "description": "", + "schema": { + "$ref": "#/definitions/ServiceStatistics" + } + }, + "default": { + "description": "Error response.", + "schema": { + "$ref": "#/definitions/SearchError" + } + } + } + } + } + }, + "definitions": { + "AnalyzeRequest": { + "properties": { + "text": { + "type": "string", + "description": "The text to break into tokens." + }, + "analyzer": { + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use to break the given text. If this parameter is not specified, you must specify a tokenizer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to break the given text. If this parameter is not specified, you must specify an analyzer instead. The tokenizer and analyzer parameters are mutually exclusive." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "An optional list of token filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "An optional list of character filters to use when breaking the given text. This parameter can only be set when using the tokenizer parameter." + } + }, + "required": [ + "text" + ], + "description": "Specifies some text and analysis components used to break that text into tokens." + }, + "AnalyzeResult": { + "properties": { + "tokens": { + "type": "array", + "items": { + "$ref": "#/definitions/AnalyzedTokenInfo" + }, + "description": "The list of tokens returned by the analyzer specified in the request." + } + }, + "required": [ + "tokens" + ], + "description": "The result of testing an analyzer on text." + }, + "AnalyzedTokenInfo": { + "properties": { + "token": { + "type": "string", + "readOnly": true, + "description": "The token returned by the analyzer." + }, + "startOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the first character of the token in the input text." + }, + "endOffset": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The index of the last character of the token in the input text." + }, + "position": { + "type": "integer", + "format": "int32", + "readOnly": true, + "x-nullable": false, + "description": "The position of the token in the input text relative to other tokens. The first token in the input text has position 0, the next has position 1, and so on. Depending on the analyzer used, some tokens might have the same position, for example if they are synonyms of each other." + } + }, + "required": [ + "token", + "startOffset", + "endOffset", + "position" + ], + "description": "Information about a token returned by an analyzer." + }, + "LexicalAnalyzerName": { + "type": "string", + "enum": [ + "ar.microsoft", + "ar.lucene", + "hy.lucene", + "bn.microsoft", + "eu.lucene", + "bg.microsoft", + "bg.lucene", + "ca.microsoft", + "ca.lucene", + "zh-Hans.microsoft", + "zh-Hans.lucene", + "zh-Hant.microsoft", + "zh-Hant.lucene", + "hr.microsoft", + "cs.microsoft", + "cs.lucene", + "da.microsoft", + "da.lucene", + "nl.microsoft", + "nl.lucene", + "en.microsoft", + "en.lucene", + "et.microsoft", + "fi.microsoft", + "fi.lucene", + "fr.microsoft", + "fr.lucene", + "gl.lucene", + "de.microsoft", + "de.lucene", + "el.microsoft", + "el.lucene", + "gu.microsoft", + "he.microsoft", + "hi.microsoft", + "hi.lucene", + "hu.microsoft", + "hu.lucene", + "is.microsoft", + "id.microsoft", + "id.lucene", + "ga.lucene", + "it.microsoft", + "it.lucene", + "ja.microsoft", + "ja.lucene", + "kn.microsoft", + "ko.microsoft", + "ko.lucene", + "lv.microsoft", + "lv.lucene", + "lt.microsoft", + "ml.microsoft", + "ms.microsoft", + "mr.microsoft", + "nb.microsoft", + "no.lucene", + "fa.lucene", + "pl.microsoft", + "pl.lucene", + "pt-BR.microsoft", + "pt-BR.lucene", + "pt-PT.microsoft", + "pt-PT.lucene", + "pa.microsoft", + "ro.microsoft", + "ro.lucene", + "ru.microsoft", + "ru.lucene", + "sr-cyrillic.microsoft", + "sr-latin.microsoft", + "sk.microsoft", + "sl.microsoft", + "es.microsoft", + "es.lucene", + "sv.microsoft", + "sv.lucene", + "ta.microsoft", + "te.microsoft", + "th.microsoft", + "th.lucene", + "tr.microsoft", + "tr.lucene", + "uk.microsoft", + "ur.microsoft", + "vi.microsoft", + "standard.lucene", + "standardasciifolding.lucene", + "keyword", + "pattern", + "simple", + "stop", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalAnalyzerName", + "modelAsString": true, + "values": [ + { + "value": "ar.microsoft", + "name": "ArMicrosoft", + "description": "Microsoft analyzer for Arabic." + }, + { + "value": "ar.lucene", + "name": "ArLucene", + "description": "Lucene analyzer for Arabic." + }, + { + "value": "hy.lucene", + "name": "HyLucene", + "description": "Lucene analyzer for Armenian." + }, + { + "value": "bn.microsoft", + "name": "BnMicrosoft", + "description": "Microsoft analyzer for Bangla." + }, + { + "value": "eu.lucene", + "name": "EuLucene", + "description": "Lucene analyzer for Basque." + }, + { + "value": "bg.microsoft", + "name": "BgMicrosoft", + "description": "Microsoft analyzer for Bulgarian." + }, + { + "value": "bg.lucene", + "name": "BgLucene", + "description": "Lucene analyzer for Bulgarian." + }, + { + "value": "ca.microsoft", + "name": "CaMicrosoft", + "description": "Microsoft analyzer for Catalan." + }, + { + "value": "ca.lucene", + "name": "CaLucene", + "description": "Lucene analyzer for Catalan." + }, + { + "value": "zh-Hans.microsoft", + "name": "ZhHansMicrosoft", + "description": "Microsoft analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hans.lucene", + "name": "ZhHansLucene", + "description": "Lucene analyzer for Chinese (Simplified)." + }, + { + "value": "zh-Hant.microsoft", + "name": "ZhHantMicrosoft", + "description": "Microsoft analyzer for Chinese (Traditional)." + }, + { + "value": "zh-Hant.lucene", + "name": "ZhHantLucene", + "description": "Lucene analyzer for Chinese (Traditional)." + }, + { + "value": "hr.microsoft", + "name": "HrMicrosoft", + "description": "Microsoft analyzer for Croatian." + }, + { + "value": "cs.microsoft", + "name": "CsMicrosoft", + "description": "Microsoft analyzer for Czech." + }, + { + "value": "cs.lucene", + "name": "CsLucene", + "description": "Lucene analyzer for Czech." + }, + { + "value": "da.microsoft", + "name": "DaMicrosoft", + "description": "Microsoft analyzer for Danish." + }, + { + "value": "da.lucene", + "name": "DaLucene", + "description": "Lucene analyzer for Danish." + }, + { + "value": "nl.microsoft", + "name": "NlMicrosoft", + "description": "Microsoft analyzer for Dutch." + }, + { + "value": "nl.lucene", + "name": "NlLucene", + "description": "Lucene analyzer for Dutch." + }, + { + "value": "en.microsoft", + "name": "EnMicrosoft", + "description": "Microsoft analyzer for English." + }, + { + "value": "en.lucene", + "name": "EnLucene", + "description": "Lucene analyzer for English." + }, + { + "value": "et.microsoft", + "name": "EtMicrosoft", + "description": "Microsoft analyzer for Estonian." + }, + { + "value": "fi.microsoft", + "name": "FiMicrosoft", + "description": "Microsoft analyzer for Finnish." + }, + { + "value": "fi.lucene", + "name": "FiLucene", + "description": "Lucene analyzer for Finnish." + }, + { + "value": "fr.microsoft", + "name": "FrMicrosoft", + "description": "Microsoft analyzer for French." + }, + { + "value": "fr.lucene", + "name": "FrLucene", + "description": "Lucene analyzer for French." + }, + { + "value": "gl.lucene", + "name": "GlLucene", + "description": "Lucene analyzer for Galician." + }, + { + "value": "de.microsoft", + "name": "DeMicrosoft", + "description": "Microsoft analyzer for German." + }, + { + "value": "de.lucene", + "name": "DeLucene", + "description": "Lucene analyzer for German." + }, + { + "value": "el.microsoft", + "name": "ElMicrosoft", + "description": "Microsoft analyzer for Greek." + }, + { + "value": "el.lucene", + "name": "ElLucene", + "description": "Lucene analyzer for Greek." + }, + { + "value": "gu.microsoft", + "name": "GuMicrosoft", + "description": "Microsoft analyzer for Gujarati." + }, + { + "value": "he.microsoft", + "name": "HeMicrosoft", + "description": "Microsoft analyzer for Hebrew." + }, + { + "value": "hi.microsoft", + "name": "HiMicrosoft", + "description": "Microsoft analyzer for Hindi." + }, + { + "value": "hi.lucene", + "name": "HiLucene", + "description": "Lucene analyzer for Hindi." + }, + { + "value": "hu.microsoft", + "name": "HuMicrosoft", + "description": "Microsoft analyzer for Hungarian." + }, + { + "value": "hu.lucene", + "name": "HuLucene", + "description": "Lucene analyzer for Hungarian." + }, + { + "value": "is.microsoft", + "name": "IsMicrosoft", + "description": "Microsoft analyzer for Icelandic." + }, + { + "value": "id.microsoft", + "name": "IdMicrosoft", + "description": "Microsoft analyzer for Indonesian (Bahasa)." + }, + { + "value": "id.lucene", + "name": "IdLucene", + "description": "Lucene analyzer for Indonesian." + }, + { + "value": "ga.lucene", + "name": "GaLucene", + "description": "Lucene analyzer for Irish." + }, + { + "value": "it.microsoft", + "name": "ItMicrosoft", + "description": "Microsoft analyzer for Italian." + }, + { + "value": "it.lucene", + "name": "ItLucene", + "description": "Lucene analyzer for Italian." + }, + { + "value": "ja.microsoft", + "name": "JaMicrosoft", + "description": "Microsoft analyzer for Japanese." + }, + { + "value": "ja.lucene", + "name": "JaLucene", + "description": "Lucene analyzer for Japanese." + }, + { + "value": "kn.microsoft", + "name": "KnMicrosoft", + "description": "Microsoft analyzer for Kannada." + }, + { + "value": "ko.microsoft", + "name": "KoMicrosoft", + "description": "Microsoft analyzer for Korean." + }, + { + "value": "ko.lucene", + "name": "KoLucene", + "description": "Lucene analyzer for Korean." + }, + { + "value": "lv.microsoft", + "name": "LvMicrosoft", + "description": "Microsoft analyzer for Latvian." + }, + { + "value": "lv.lucene", + "name": "LvLucene", + "description": "Lucene analyzer for Latvian." + }, + { + "value": "lt.microsoft", + "name": "LtMicrosoft", + "description": "Microsoft analyzer for Lithuanian." + }, + { + "value": "ml.microsoft", + "name": "MlMicrosoft", + "description": "Microsoft analyzer for Malayalam." + }, + { + "value": "ms.microsoft", + "name": "MsMicrosoft", + "description": "Microsoft analyzer for Malay (Latin)." + }, + { + "value": "mr.microsoft", + "name": "MrMicrosoft", + "description": "Microsoft analyzer for Marathi." + }, + { + "value": "nb.microsoft", + "name": "NbMicrosoft", + "description": "Microsoft analyzer for Norwegian (Bokmål)." + }, + { + "value": "no.lucene", + "name": "NoLucene", + "description": "Lucene analyzer for Norwegian." + }, + { + "value": "fa.lucene", + "name": "FaLucene", + "description": "Lucene analyzer for Persian." + }, + { + "value": "pl.microsoft", + "name": "PlMicrosoft", + "description": "Microsoft analyzer for Polish." + }, + { + "value": "pl.lucene", + "name": "PlLucene", + "description": "Lucene analyzer for Polish." + }, + { + "value": "pt-BR.microsoft", + "name": "PtBrMicrosoft", + "description": "Microsoft analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-BR.lucene", + "name": "PtBrLucene", + "description": "Lucene analyzer for Portuguese (Brazil)." + }, + { + "value": "pt-PT.microsoft", + "name": "PtPtMicrosoft", + "description": "Microsoft analyzer for Portuguese (Portugal)." + }, + { + "value": "pt-PT.lucene", + "name": "PtPtLucene", + "description": "Lucene analyzer for Portuguese (Portugal)." + }, + { + "value": "pa.microsoft", + "name": "PaMicrosoft", + "description": "Microsoft analyzer for Punjabi." + }, + { + "value": "ro.microsoft", + "name": "RoMicrosoft", + "description": "Microsoft analyzer for Romanian." + }, + { + "value": "ro.lucene", + "name": "RoLucene", + "description": "Lucene analyzer for Romanian." + }, + { + "value": "ru.microsoft", + "name": "RuMicrosoft", + "description": "Microsoft analyzer for Russian." + }, + { + "value": "ru.lucene", + "name": "RuLucene", + "description": "Lucene analyzer for Russian." + }, + { + "value": "sr-cyrillic.microsoft", + "name": "SrCyrillicMicrosoft", + "description": "Microsoft analyzer for Serbian (Cyrillic)." + }, + { + "value": "sr-latin.microsoft", + "name": "SrLatinMicrosoft", + "description": "Microsoft analyzer for Serbian (Latin)." + }, + { + "value": "sk.microsoft", + "name": "SkMicrosoft", + "description": "Microsoft analyzer for Slovak." + }, + { + "value": "sl.microsoft", + "name": "SlMicrosoft", + "description": "Microsoft analyzer for Slovenian." + }, + { + "value": "es.microsoft", + "name": "EsMicrosoft", + "description": "Microsoft analyzer for Spanish." + }, + { + "value": "es.lucene", + "name": "EsLucene", + "description": "Lucene analyzer for Spanish." + }, + { + "value": "sv.microsoft", + "name": "SvMicrosoft", + "description": "Microsoft analyzer for Swedish." + }, + { + "value": "sv.lucene", + "name": "SvLucene", + "description": "Lucene analyzer for Swedish." + }, + { + "value": "ta.microsoft", + "name": "TaMicrosoft", + "description": "Microsoft analyzer for Tamil." + }, + { + "value": "te.microsoft", + "name": "TeMicrosoft", + "description": "Microsoft analyzer for Telugu." + }, + { + "value": "th.microsoft", + "name": "ThMicrosoft", + "description": "Microsoft analyzer for Thai." + }, + { + "value": "th.lucene", + "name": "ThLucene", + "description": "Lucene analyzer for Thai." + }, + { + "value": "tr.microsoft", + "name": "TrMicrosoft", + "description": "Microsoft analyzer for Turkish." + }, + { + "value": "tr.lucene", + "name": "TrLucene", + "description": "Lucene analyzer for Turkish." + }, + { + "value": "uk.microsoft", + "name": "UkMicrosoft", + "description": "Microsoft analyzer for Ukrainian." + }, + { + "value": "ur.microsoft", + "name": "UrMicrosoft", + "description": "Microsoft analyzer for Urdu." + }, + { + "value": "vi.microsoft", + "name": "ViMicrosoft", + "description": "Microsoft analyzer for Vietnamese." + }, + { + "value": "standard.lucene", + "name": "StandardLucene", + "description": "Standard Lucene analyzer." + }, + { + "value": "standardasciifolding.lucene", + "name": "StandardAsciiFoldingLucene", + "description": "Standard ASCII Folding Lucene analyzer. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#Analyzers" + }, + { + "value": "keyword", + "name": "Keyword", + "description": "Treats the entire content of a field as a single token. This is useful for data like zip codes, ids, and some product names. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordAnalyzer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Flexibly separates text into terms via a regular expression pattern. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + }, + { + "value": "simple", + "name": "Simple", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/SimpleAnalyzer.html" + }, + { + "value": "stop", + "name": "Stop", + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "An analyzer that uses the whitespace tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceAnalyzer.html" + } + ] + }, + "description": "Defines the names of all text analyzers supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + } + }, + "LexicalTokenizerName": { + "type": "string", + "enum": [ + "classic", + "edgeNGram", + "keyword_v2", + "letter", + "lowercase", + "microsoft_language_tokenizer", + "microsoft_language_stemming_tokenizer", + "nGram", + "path_hierarchy_v2", + "pattern", + "standard_v2", + "uax_url_email", + "whitespace" + ], + "x-ms-enum": { + "name": "LexicalTokenizerName", + "modelAsString": true, + "values": [ + { + "value": "classic", + "name": "Classic", + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + }, + { + "value": "edgeNGram", + "name": "EdgeNGram", + "description": "Tokenizes the input from an edge into n-grams of the given size(s). See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + }, + { + "value": "keyword_v2", + "name": "Keyword", + "description": "Emits the entire input as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + { + "value": "letter", + "name": "Letter", + "description": "Divides text at non-letters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LetterTokenizer.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Divides text at non-letters and converts them to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseTokenizer.html" + }, + { + "value": "microsoft_language_tokenizer", + "name": "MicrosoftLanguageTokenizer", + "description": "Divides text using language-specific rules." + }, + { + "value": "microsoft_language_stemming_tokenizer", + "name": "MicrosoftLanguageStemmingTokenizer", + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + { + "value": "nGram", + "name": "NGram", + "description": "Tokenizes the input into n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + }, + { + "value": "path_hierarchy_v2", + "name": "PathHierarchy", + "description": "Tokenizer for path-like hierarchies. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + }, + { + "value": "pattern", + "name": "Pattern", + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + }, + { + "value": "standard_v2", + "name": "Standard", + "description": "Standard Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + { + "value": "uax_url_email", + "name": "UaxUrlEmail", + "description": "Tokenizes urls and emails as one token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Divides text at whitespace. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/WhitespaceTokenizer.html" + } + ] + }, + "description": "Defines the names of all tokenizers supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "TokenFilterName": { + "type": "string", + "enum": [ + "arabic_normalization", + "apostrophe", + "asciifolding", + "cjk_bigram", + "cjk_width", + "classic", + "common_grams", + "edgeNGram_v2", + "elision", + "german_normalization", + "hindi_normalization", + "indic_normalization", + "keyword_repeat", + "kstem", + "length", + "limit", + "lowercase", + "nGram_v2", + "persian_normalization", + "phonetic", + "porter_stem", + "reverse", + "scandinavian_normalization", + "scandinavian_folding", + "shingle", + "snowball", + "sorani_normalization", + "stemmer", + "stopwords", + "trim", + "truncate", + "unique", + "uppercase", + "word_delimiter" + ], + "x-ms-enum": { + "name": "TokenFilterName", + "modelAsString": true, + "values": [ + { + "value": "arabic_normalization", + "name": "ArabicNormalization", + "description": "A token filter that applies the Arabic normalizer to normalize the orthography. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ar/ArabicNormalizationFilter.html" + }, + { + "value": "apostrophe", + "name": "Apostrophe", + "description": "Strips all characters after an apostrophe (including the apostrophe itself). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/tr/ApostropheFilter.html" + }, + { + "value": "asciifolding", + "name": "AsciiFolding", + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + }, + { + "value": "cjk_bigram", + "name": "CjkBigram", + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + }, + { + "value": "cjk_width", + "name": "CjkWidth", + "description": "Normalizes CJK width differences. Folds fullwidth ASCII variants into the equivalent basic Latin, and half-width Katakana variants into the equivalent Kana. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKWidthFilter.html" + }, + { + "value": "classic", + "name": "Classic", + "description": "Removes English possessives, and dots from acronyms. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicFilter.html" + }, + { + "value": "common_grams", + "name": "CommonGram", + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + }, + { + "value": "edgeNGram_v2", + "name": "EdgeNGram", + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + { + "value": "elision", + "name": "Elision", + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + }, + { + "value": "german_normalization", + "name": "GermanNormalization", + "description": "Normalizes German characters according to the heuristics of the German2 snowball algorithm. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/de/GermanNormalizationFilter.html" + }, + { + "value": "hindi_normalization", + "name": "HindiNormalization", + "description": "Normalizes text in Hindi to remove some differences in spelling variations. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/hi/HindiNormalizationFilter.html" + }, + { + "value": "indic_normalization", + "name": "IndicNormalization", + "description": "Normalizes the Unicode representation of text in Indian languages. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/in/IndicNormalizationFilter.html" + }, + { + "value": "keyword_repeat", + "name": "KeywordRepeat", + "description": "Emits each incoming token twice, once as keyword and once as non-keyword. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordRepeatFilter.html" + }, + { + "value": "kstem", + "name": "KStem", + "description": "A high-performance kstem filter for English. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/en/KStemFilter.html" + }, + { + "value": "length", + "name": "Length", + "description": "Removes words that are too long or too short. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + }, + { + "value": "limit", + "name": "Limit", + "description": "Limits the number of tokens while indexing. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + }, + { + "value": "lowercase", + "name": "Lowercase", + "description": "Normalizes token text to lower case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/LowerCaseFilter.htm" + }, + { + "value": "nGram_v2", + "name": "NGram", + "description": "Generates n-grams of the given size(s). See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + { + "value": "persian_normalization", + "name": "PersianNormalization", + "description": "Applies normalization for Persian. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/fa/PersianNormalizationFilter.html" + }, + { + "value": "phonetic", + "name": "Phonetic", + "description": "Create tokens for phonetic matches. See https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + }, + { + "value": "porter_stem", + "name": "PorterStem", + "description": "Uses the Porter stemming algorithm to transform the token stream. See http://tartarus.org/~martin/PorterStemmer" + }, + { + "value": "reverse", + "name": "Reverse", + "description": "Reverses the token string. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/reverse/ReverseStringFilter.html" + }, + { + "value": "scandinavian_normalization", + "name": "ScandinavianNormalization", + "description": "Normalizes use of the interchangeable Scandinavian characters. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianNormalizationFilter.html" + }, + { + "value": "scandinavian_folding", + "name": "ScandinavianFoldingNormalization", + "description": "Folds Scandinavian characters åÅäæÄÆ->a and öÖøØ->o. It also discriminates against use of double vowels aa, ae, ao, oe and oo, leaving just the first one. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ScandinavianFoldingFilter.html" + }, + { + "value": "shingle", + "name": "Shingle", + "description": "Creates combinations of tokens as a single token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + }, + { + "value": "snowball", + "name": "Snowball", + "description": "A filter that stems words using a Snowball-generated stemmer. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + }, + { + "value": "sorani_normalization", + "name": "SoraniNormalization", + "description": "Normalizes the Unicode representation of Sorani text. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ckb/SoraniNormalizationFilter.html" + }, + { + "value": "stemmer", + "name": "Stemmer", + "description": "Language specific stemming filter. See https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + }, + { + "value": "stopwords", + "name": "Stopwords", + "description": "Removes stop words from a token stream. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + }, + { + "value": "trim", + "name": "Trim", + "description": "Trims leading and trailing whitespace from tokens. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TrimFilter.html" + }, + { + "value": "truncate", + "name": "Truncate", + "description": "Truncates the terms to a specific length. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + }, + { + "value": "unique", + "name": "Unique", + "description": "Filters out tokens with same text as the previous token. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + }, + { + "value": "uppercase", + "name": "Uppercase", + "description": "Normalizes token text to upper case. See http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/UpperCaseFilter.html" + }, + { + "value": "word_delimiter", + "name": "WordDelimiter", + "description": "Splits words into subwords and performs optional transformations on subword groups." + } + ] + }, + "description": "Defines the names of all token filters supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "CharFilterName": { + "type": "string", + "enum": [ + "html_strip" + ], + "x-ms-enum": { + "name": "CharFilterName", + "modelAsString": true, + "values": [ + { + "value": "html_strip", + "name": "HtmlStrip", + "description": "A character filter that attempts to strip out HTML constructs. See https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/HTMLStripCharFilter.html" + } + ] + }, + "description": "Defines the names of all character filters supported by Azure Cognitive Search.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "RegexFlags": { + "type": "string", + "enum": [ + "CANON_EQ", + "CASE_INSENSITIVE", + "COMMENTS", + "DOTALL", + "LITERAL", + "MULTILINE", + "UNICODE_CASE", + "UNIX_LINES" + ], + "x-ms-enum": { + "name": "RegexFlags", + "modelAsString": true, + "values": [ + { + "value": "CANON_EQ", + "name": "CanonEq", + "description": "Enables canonical equivalence." + }, + { + "value": "CASE_INSENSITIVE", + "name": "CaseInsensitive", + "description": "Enables case-insensitive matching." + }, + { + "value": "COMMENTS", + "name": "Comments", + "description": "Permits whitespace and comments in the pattern." + }, + { + "value": "DOTALL", + "name": "DotAll", + "description": "Enables dotall mode." + }, + { + "value": "LITERAL", + "name": "Literal", + "description": "Enables literal parsing of the pattern." + }, + { + "value": "MULTILINE", + "name": "Multiline", + "description": "Enables multiline mode." + }, + { + "value": "UNICODE_CASE", + "name": "UnicodeCase", + "description": "Enables Unicode-aware case folding." + }, + { + "value": "UNIX_LINES", + "name": "UnixLines", + "description": "Enables Unix lines mode." + } + ] + }, + "description": "Defines flags that can be combined to control how regular expressions are used in the pattern analyzer and pattern tokenizer.", + "externalDocs": { + "url": "http://docs.oracle.com/javase/6/docs/api/java/util/regex/Pattern.html#field_summary" + } + }, + "SearchFieldDataType": { + "type": "string", + "enum": [ + "Edm.String", + "Edm.Int32", + "Edm.Int64", + "Edm.Double", + "Edm.Boolean", + "Edm.DateTimeOffset", + "Edm.GeographyPoint", + "Edm.ComplexType" + ], + "x-ms-enum": { + "name": "SearchFieldDataType", + "modelAsString": true, + "values": [ + { + "value": "Edm.String", + "name": "String", + "description": "Indicates that a field contains a string." + }, + { + "value": "Edm.Int32", + "name": "Int32", + "description": "Indicates that a field contains a 32-bit signed integer." + }, + { + "value": "Edm.Int64", + "name": "Int64", + "description": "Indicates that a field contains a 64-bit signed integer." + }, + { + "value": "Edm.Double", + "name": "Double", + "description": "Indicates that a field contains an IEEE double-precision floating point number." + }, + { + "value": "Edm.Boolean", + "name": "Boolean", + "description": "Indicates that a field contains a Boolean value (true or false)." + }, + { + "value": "Edm.DateTimeOffset", + "name": "DateTimeOffset", + "description": "Indicates that a field contains a date/time value, including timezone information." + }, + { + "value": "Edm.GeographyPoint", + "name": "GeographyPoint", + "description": "Indicates that a field contains a geo-location in terms of longitude and latitude." + }, + { + "value": "Edm.ComplexType", + "name": "Complex", + "description": "Indicates that a field contains one or more complex objects that in turn have sub-fields of other types." + } + ] + }, + "description": "Defines the data type of a field in a search index." + }, + "LexicalAnalyzer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the analyzer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the analyzer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for analyzers." + }, + "CustomAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CustomAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "tokenizer": { + "$ref": "#/definitions/LexicalTokenizerName", + "description": "The name of the tokenizer to use to divide continuous text into a sequence of tokens, such as breaking a sentence into words." + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilterName", + "x-nullable": false + }, + "description": "A list of token filters used to filter out or modify the tokens generated by a tokenizer. For example, you can specify a lowercase filter that converts all characters to lowercase. The filters are run in the order in which they are listed." + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilterName", + "x-nullable": false + }, + "description": "A list of character filters used to prepare input text before it is processed by the tokenizer. For instance, they can replace certain characters or symbols. The filters are run in the order in which they are listed." + } + }, + "required": [ + "tokenizer" + ], + "description": "Allows you to take control over the process of converting text into indexable/searchable tokens. It's a user-defined configuration consisting of a single predefined tokenizer and one or more filters. The tokenizer is responsible for breaking text into tokens, and the filters for modifying tokens emitted by the tokenizer." + }, + "PatternAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "lowercase": { + "x-ms-client-name": "LowerCaseTerms", + "type": "boolean", + "default": true, + "description": "A value indicating whether terms should be lower-cased. Default is true." + }, + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Flexibly separates text into terms via a regular expression pattern. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/PatternAnalyzer.html" + } + }, + "LuceneStandardAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + }, + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Standard Apache Lucene analyzer; Composed of the standard tokenizer, lowercase filter and stop filter.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardAnalyzer.html" + } + }, + "StopAnalyzer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopAnalyzer", + "allOf": [ + { + "$ref": "#/definitions/LexicalAnalyzer" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stopwords." + } + }, + "description": "Divides text at non-letters; Applies the lowercase and stopword token filters. This analyzer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopAnalyzer.html" + } + }, + "LexicalTokenizer": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the tokenizer." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the tokenizer. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for tokenizers.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "ClassicTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Grammar-based tokenizer that is suitable for processing most European-language documents. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/ClassicTokenizer.html" + } + }, + "TokenCharacterKind": { + "type": "string", + "enum": [ + "letter", + "digit", + "whitespace", + "punctuation", + "symbol" + ], + "x-ms-enum": { + "name": "TokenCharacterKind", + "modelAsString": false, + "values": [ + { + "value": "letter", + "name": "Letter", + "description": "Keeps letters in tokens." + }, + { + "value": "digit", + "name": "Digit", + "description": "Keeps digits in tokens." + }, + { + "value": "whitespace", + "name": "Whitespace", + "description": "Keeps whitespace in tokens." + }, + { + "value": "punctuation", + "name": "Punctuation", + "description": "Keeps punctuation in tokens." + }, + { + "value": "symbol", + "name": "Symbol", + "description": "Keeps symbols in tokens." + } + ] + }, + "description": "Represents classes of characters on which a token filter can operate." + }, + "EdgeNGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input from an edge into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenizer.html" + } + }, + "KeywordTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "bufferSize": { + "type": "integer", + "format": "int32", + "default": 256, + "description": "The read buffer size in bytes. Default is 256." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "KeywordTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 256, + "maximum": 300, + "description": "The maximum token length. Default is 256. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Emits the entire input as a single token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/KeywordTokenizer.html" + } + }, + "MicrosoftTokenizerLanguage": { + "type": "string", + "enum": [ + "bangla", + "bulgarian", + "catalan", + "chineseSimplified", + "chineseTraditional", + "croatian", + "czech", + "danish", + "dutch", + "english", + "french", + "german", + "greek", + "gujarati", + "hindi", + "icelandic", + "indonesian", + "italian", + "japanese", + "kannada", + "korean", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "thai", + "ukrainian", + "urdu", + "vietnamese" + ], + "x-ms-enum": { + "name": "MicrosoftTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft tokenizer for Catalan." + }, + { + "value": "chineseSimplified", + "name": "ChineseSimplified", + "description": "Selects the Microsoft tokenizer for Chinese (Simplified)." + }, + { + "value": "chineseTraditional", + "name": "ChineseTraditional", + "description": "Selects the Microsoft tokenizer for Chinese (Traditional)." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft tokenizer for English." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft tokenizer for Gujarati." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft tokenizer for Hindi." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft tokenizer for Italian." + }, + { + "value": "japanese", + "name": "Japanese", + "description": "Selects the Microsoft tokenizer for Japanese." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft tokenizer for Kannada." + }, + { + "value": "korean", + "name": "Korean", + "description": "Selects the Microsoft tokenizer for Korean." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft tokenizer for Serbian (Latin)." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft tokenizer for Telugu." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the Microsoft tokenizer for Thai." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft tokenizer for Urdu." + }, + { + "value": "vietnamese", + "name": "Vietnamese", + "description": "Selects the Microsoft tokenizer for Vietnamese." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language tokenizer." + }, + "MicrosoftLanguageTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules." + }, + "MicrosoftStemmingTokenizerLanguage": { + "type": "string", + "enum": [ + "arabic", + "bangla", + "bulgarian", + "catalan", + "croatian", + "czech", + "danish", + "dutch", + "english", + "estonian", + "finnish", + "french", + "german", + "greek", + "gujarati", + "hebrew", + "hindi", + "hungarian", + "icelandic", + "indonesian", + "italian", + "kannada", + "latvian", + "lithuanian", + "malay", + "malayalam", + "marathi", + "norwegianBokmaal", + "polish", + "portuguese", + "portugueseBrazilian", + "punjabi", + "romanian", + "russian", + "serbianCyrillic", + "serbianLatin", + "slovak", + "slovenian", + "spanish", + "swedish", + "tamil", + "telugu", + "turkish", + "ukrainian", + "urdu" + ], + "x-ms-enum": { + "name": "MicrosoftStemmingTokenizerLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Microsoft stemming tokenizer for Arabic." + }, + { + "value": "bangla", + "name": "Bangla", + "description": "Selects the Microsoft stemming tokenizer for Bangla." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Microsoft stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Microsoft stemming tokenizer for Catalan." + }, + { + "value": "croatian", + "name": "Croatian", + "description": "Selects the Microsoft stemming tokenizer for Croatian." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Microsoft stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Microsoft stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Microsoft stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Microsoft stemming tokenizer for English." + }, + { + "value": "estonian", + "name": "Estonian", + "description": "Selects the Microsoft stemming tokenizer for Estonian." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Microsoft stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Microsoft stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Microsoft stemming tokenizer for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Microsoft stemming tokenizer for Greek." + }, + { + "value": "gujarati", + "name": "Gujarati", + "description": "Selects the Microsoft stemming tokenizer for Gujarati." + }, + { + "value": "hebrew", + "name": "Hebrew", + "description": "Selects the Microsoft stemming tokenizer for Hebrew." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Microsoft stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Microsoft stemming tokenizer for Hungarian." + }, + { + "value": "icelandic", + "name": "Icelandic", + "description": "Selects the Microsoft stemming tokenizer for Icelandic." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Microsoft stemming tokenizer for Indonesian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Microsoft stemming tokenizer for Italian." + }, + { + "value": "kannada", + "name": "Kannada", + "description": "Selects the Microsoft stemming tokenizer for Kannada." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Microsoft stemming tokenizer for Latvian." + }, + { + "value": "lithuanian", + "name": "Lithuanian", + "description": "Selects the Microsoft stemming tokenizer for Lithuanian." + }, + { + "value": "malay", + "name": "Malay", + "description": "Selects the Microsoft stemming tokenizer for Malay." + }, + { + "value": "malayalam", + "name": "Malayalam", + "description": "Selects the Microsoft stemming tokenizer for Malayalam." + }, + { + "value": "marathi", + "name": "Marathi", + "description": "Selects the Microsoft stemming tokenizer for Marathi." + }, + { + "value": "norwegianBokmaal", + "name": "NorwegianBokmaal", + "description": "Selects the Microsoft stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "polish", + "name": "Polish", + "description": "Selects the Microsoft stemming tokenizer for Polish." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Microsoft stemming tokenizer for Portuguese." + }, + { + "value": "portugueseBrazilian", + "name": "PortugueseBrazilian", + "description": "Selects the Microsoft stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "punjabi", + "name": "Punjabi", + "description": "Selects the Microsoft stemming tokenizer for Punjabi." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Microsoft stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Microsoft stemming tokenizer for Russian." + }, + { + "value": "serbianCyrillic", + "name": "SerbianCyrillic", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Cyrillic)." + }, + { + "value": "serbianLatin", + "name": "SerbianLatin", + "description": "Selects the Microsoft stemming tokenizer for Serbian (Latin)." + }, + { + "value": "slovak", + "name": "Slovak", + "description": "Selects the Microsoft stemming tokenizer for Slovak." + }, + { + "value": "slovenian", + "name": "Slovenian", + "description": "Selects the Microsoft stemming tokenizer for Slovenian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Microsoft stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Microsoft stemming tokenizer for Swedish." + }, + { + "value": "tamil", + "name": "Tamil", + "description": "Selects the Microsoft stemming tokenizer for Tamil." + }, + { + "value": "telugu", + "name": "Telugu", + "description": "Selects the Microsoft stemming tokenizer for Telugu." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Microsoft stemming tokenizer for Turkish." + }, + { + "value": "ukrainian", + "name": "Ukrainian", + "description": "Selects the Microsoft stemming tokenizer for Ukrainian." + }, + { + "value": "urdu", + "name": "Urdu", + "description": "Selects the Microsoft stemming tokenizer for Urdu." + } + ] + }, + "description": "Lists the languages supported by the Microsoft language stemming tokenizer." + }, + "MicrosoftLanguageStemmingTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MicrosoftLanguageStemmingTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Tokens longer than the maximum length are split. Maximum token length that can be used is 300 characters. Tokens longer than 300 characters are first split into tokens of length 300 and then each of those tokens is split based on the max token length set. Default is 255." + }, + "isSearchTokenizer": { + "type": "boolean", + "default": false, + "description": "A value indicating how the tokenizer is used. Set to true if used as the search tokenizer, set to false if used as the indexing tokenizer. Default is false." + }, + "language": { + "$ref": "#/definitions/MicrosoftStemmingTokenizerLanguage", + "description": "The language to use. The default is English." + } + }, + "description": "Divides text using language-specific rules and reduces words to their base forms." + }, + "NGramTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "tokenChars": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenCharacterKind", + "x-nullable": false + }, + "description": "Character classes to keep in the tokens." + } + }, + "description": "Tokenizes the input into n-grams of the given size(s). This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenizer.html" + } + }, + "PathHierarchyTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PathHierarchyTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "delimiter": { + "type": "string", + "format": "char", + "default": "/", + "description": "The delimiter character to use. Default is \"/\"." + }, + "replacement": { + "type": "string", + "format": "char", + "default": "/", + "description": "A value that, if set, replaces the delimiter character. Default is \"/\"." + }, + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum token length. Default and maximum is 300." + }, + "reverse": { + "x-ms-client-name": "ReverseTokenOrder", + "type": "boolean", + "default": false, + "description": "A value indicating whether to generate tokens in reverse order. Default is false." + }, + "skip": { + "x-ms-client-name": "NumberOfTokensToSkip", + "type": "integer", + "format": "int32", + "default": 0, + "description": "The number of initial tokens to skip. Default is 0." + } + }, + "description": "Tokenizer for path-like hierarchies. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/path/PathHierarchyTokenizer.html" + } + }, + "PatternTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "pattern": { + "type": "string", + "default": "\\W+", + "description": "A regular expression pattern to match token separators. Default is an expression that matches one or more non-word characters." + }, + "flags": { + "$ref": "#/definitions/RegexFlags", + "description": "Regular expression flags." + }, + "group": { + "type": "integer", + "format": "int32", + "default": -1, + "description": "The zero-based ordinal of the matching group in the regular expression pattern to extract into tokens. Use -1 if you want to use the entire pattern to split the input into tokens, irrespective of matching groups. Default is -1." + } + }, + "description": "Tokenizer that uses regex pattern matching to construct distinct tokens. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternTokenizer.html" + } + }, + "LuceneStandardTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + }, + "x-az-search-deprecated": true + }, + "LuceneStandardTokenizerV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StandardTokenizerV2", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Breaks text following the Unicode Text Segmentation rules. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/StandardTokenizer.html" + } + }, + "UaxUrlEmailTokenizer": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UaxUrlEmailTokenizer", + "allOf": [ + { + "$ref": "#/definitions/LexicalTokenizer" + } + ], + "properties": { + "maxTokenLength": { + "type": "integer", + "format": "int32", + "default": 255, + "maximum": 300, + "description": "The maximum token length. Default is 255. Tokens longer than the maximum length are split. The maximum token length that can be used is 300 characters." + } + }, + "description": "Tokenizes urls and emails as one token. This tokenizer is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/standard/UAX29URLEmailTokenizer.html" + } + }, + "TokenFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the token filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the token filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for token filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "AsciiFoldingTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.AsciiFoldingTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether the original token will be kept. Default is false." + } + }, + "description": "Converts alphabetic, numeric, and symbolic Unicode characters which are not in the first 127 ASCII characters (the \"Basic Latin\" Unicode block) into their ASCII equivalents, if such equivalents exist. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/ASCIIFoldingFilter.html" + } + }, + "CjkBigramTokenFilterScripts": { + "type": "string", + "enum": [ + "han", + "hiragana", + "katakana", + "hangul" + ], + "x-ms-enum": { + "name": "CjkBigramTokenFilterScripts", + "modelAsString": false, + "values": [ + { + "value": "han", + "name": "Han", + "description": "Ignore Han script when forming bigrams of CJK terms." + }, + { + "value": "hiragana", + "name": "Hiragana", + "description": "Ignore Hiragana script when forming bigrams of CJK terms." + }, + { + "value": "katakana", + "name": "Katakana", + "description": "Ignore Katakana script when forming bigrams of CJK terms." + }, + { + "value": "hangul", + "name": "Hangul", + "description": "Ignore Hangul script when forming bigrams of CJK terms." + } + ] + }, + "description": "Scripts that can be ignored by CjkBigramTokenFilter." + }, + "CjkBigramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CjkBigramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "ignoreScripts": { + "type": "array", + "items": { + "$ref": "#/definitions/CjkBigramTokenFilterScripts", + "x-nullable": false + }, + "description": "The scripts to ignore." + }, + "outputUnigrams": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output both unigrams and bigrams (if true), or just bigrams (if false). Default is false." + } + }, + "description": "Forms bigrams of CJK terms that are generated from the standard tokenizer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/cjk/CJKBigramFilter.html" + } + }, + "CommonGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CommonGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "commonWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of common words." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether common words matching will be case insensitive. Default is false." + }, + "queryMode": { + "x-ms-client-name": "UseQueryMode", + "type": "boolean", + "default": false, + "description": "A value that indicates whether the token filter is in query mode. When in query mode, the token filter generates bigrams and then removes common words and single terms followed by a common word. Default is false." + } + }, + "required": [ + "commonWords" + ], + "description": "Construct bigrams for frequently occurring terms while indexing. Single terms are still indexed too, with bigrams overlaid. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/commongrams/CommonGramsFilter.html" + } + }, + "DictionaryDecompounderTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DictionaryDecompounderTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "wordList": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to match against." + }, + "minWordSize": { + "type": "integer", + "format": "int32", + "default": 5, + "maximum": 300, + "description": "The minimum word size. Only words longer than this get processed. Default is 5. Maximum is 300." + }, + "minSubwordSize": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The minimum subword size. Only subwords longer than this are outputted. Default is 2. Maximum is 300." + }, + "maxSubwordSize": { + "type": "integer", + "format": "int32", + "default": 15, + "maximum": 300, + "description": "The maximum subword size. Only subwords shorter than this are outputted. Default is 15. Maximum is 300." + }, + "onlyLongestMatch": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to add only the longest matching subword to the output. Default is false." + } + }, + "required": [ + "wordList" + ], + "description": "Decomposes compound words found in many Germanic languages. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/compound/DictionaryCompoundWordTokenFilter.html" + } + }, + "EdgeNGramTokenFilterSide": { + "type": "string", + "enum": [ + "front", + "back" + ], + "x-ms-enum": { + "name": "EdgeNGramTokenFilterSide", + "modelAsString": false, + "values": [ + { + "value": "front", + "name": "Front", + "description": "Specifies that the n-gram should be generated from the front of the input." + }, + { + "value": "back", + "name": "Back", + "description": "Specifies that the n-gram should be generated from the back of the input." + } + ] + }, + "description": "Specifies which side of the input an n-gram should be generated from." + }, + "EdgeNGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "EdgeNGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.EdgeNGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + }, + "side": { + "$ref": "#/definitions/EdgeNGramTokenFilterSide", + "default": "front", + "description": "Specifies which side of the input the n-gram should be generated from. Default is \"front\"." + } + }, + "description": "Generates n-grams of the given size(s) starting from the front or the back of an input token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/EdgeNGramTokenFilter.html" + } + }, + "ElisionTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ElisionTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "articles": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of articles to remove." + } + }, + "description": "Removes elisions. For example, \"l'avion\" (the plane) will be converted to \"avion\" (plane). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/util/ElisionFilter.html" + } + }, + "KeepTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeepTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keepWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of words to keep." + }, + "keepWordsCase": { + "x-ms-client-name": "LowerCaseKeepWords", + "type": "boolean", + "default": false, + "description": "A value indicating whether to lower case all words first. Default is false." + } + }, + "required": [ + "keepWords" + ], + "description": "A token filter that only keeps tokens with text contained in a specified list of words. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeepWordFilter.html" + } + }, + "KeywordMarkerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.KeywordMarkerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "keywords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of words to mark as keywords." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + } + }, + "required": [ + "keywords" + ], + "description": "Marks terms as keywords. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/KeywordMarkerFilter.html" + } + }, + "LengthTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LengthTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "min": { + "x-ms-client-name": "minLength", + "type": "integer", + "format": "int32", + "default": 0, + "maximum": 300, + "description": "The minimum length in characters. Default is 0. Maximum is 300. Must be less than the value of max." + }, + "max": { + "x-ms-client-name": "maxLength", + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The maximum length in characters. Default and maximum is 300." + } + }, + "description": "Removes words that are too long or too short. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LengthFilter.html" + } + }, + "LimitTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.LimitTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxTokenCount": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The maximum number of tokens to produce. Default is 1." + }, + "consumeAllTokens": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all tokens from the input must be consumed even if maxTokenCount is reached. Default is false." + } + }, + "description": "Limits the number of tokens while indexing. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/LimitTokenCountFilter.html" + } + }, + "NGramTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "description": "The minimum n-gram length. Default is 1. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "description": "The maximum n-gram length. Default is 2." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + }, + "x-az-search-deprecated": true + }, + "NGramTokenFilterV2": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.NGramTokenFilterV2", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "minGram": { + "type": "integer", + "format": "int32", + "default": 1, + "maximum": 300, + "description": "The minimum n-gram length. Default is 1. Maximum is 300. Must be less than the value of maxGram." + }, + "maxGram": { + "type": "integer", + "format": "int32", + "default": 2, + "maximum": 300, + "description": "The maximum n-gram length. Default is 2. Maximum is 300." + } + }, + "description": "Generates n-grams of the given size(s). This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/ngram/NGramTokenFilter.html" + } + }, + "PatternCaptureTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternCaptureTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "patterns": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of patterns to match against each token." + }, + "preserveOriginal": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to return the original token even if one of the patterns matches. Default is true." + } + }, + "required": [ + "patterns" + ], + "description": "Uses Java regexes to emit multiple tokens - one for each capture group in one or more patterns. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternCaptureGroupTokenFilter.html" + } + }, + "PatternReplaceTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceFilter.html" + } + }, + "PhoneticEncoder": { + "type": "string", + "enum": [ + "metaphone", + "doubleMetaphone", + "soundex", + "refinedSoundex", + "caverphone1", + "caverphone2", + "cologne", + "nysiis", + "koelnerPhonetik", + "haasePhonetik", + "beiderMorse" + ], + "x-ms-enum": { + "name": "PhoneticEncoder", + "modelAsString": false, + "values": [ + { + "value": "metaphone", + "name": "Metaphone", + "description": "Encodes a token into a Metaphone value." + }, + { + "value": "doubleMetaphone", + "name": "DoubleMetaphone", + "description": "Encodes a token into a double metaphone value." + }, + { + "value": "soundex", + "name": "Soundex", + "description": "Encodes a token into a Soundex value." + }, + { + "value": "refinedSoundex", + "name": "RefinedSoundex", + "description": "Encodes a token into a Refined Soundex value." + }, + { + "value": "caverphone1", + "name": "Caverphone1", + "description": "Encodes a token into a Caverphone 1.0 value." + }, + { + "value": "caverphone2", + "name": "Caverphone2", + "description": "Encodes a token into a Caverphone 2.0 value." + }, + { + "value": "cologne", + "name": "Cologne", + "description": "Encodes a token into a Cologne Phonetic value." + }, + { + "value": "nysiis", + "name": "Nysiis", + "description": "Encodes a token into a NYSIIS value." + }, + { + "value": "koelnerPhonetik", + "name": "KoelnerPhonetik", + "description": "Encodes a token using the Kölner Phonetik algorithm." + }, + { + "value": "haasePhonetik", + "name": "HaasePhonetik", + "description": "Encodes a token using the Haase refinement of the Kölner Phonetik algorithm." + }, + { + "value": "beiderMorse", + "name": "BeiderMorse", + "description": "Encodes a token into a Beider-Morse value." + } + ] + }, + "description": "Identifies the type of phonetic encoder to use with a PhoneticTokenFilter." + }, + "PhoneticTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PhoneticTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "encoder": { + "$ref": "#/definitions/PhoneticEncoder", + "default": "metaphone", + "description": "The phonetic encoder to use. Default is \"metaphone\"." + }, + "replace": { + "x-ms-client-name": "ReplaceOriginalTokens", + "type": "boolean", + "default": true, + "description": "A value indicating whether encoded tokens should replace original tokens. If false, encoded tokens are added as synonyms. Default is true." + } + }, + "description": "Create tokens for phonetic matches. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-phonetic/org/apache/lucene/analysis/phonetic/package-tree.html" + } + }, + "ShingleTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ShingleTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "maxShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The maximum shingle size. Default and minimum value is 2." + }, + "minShingleSize": { + "type": "integer", + "format": "int32", + "default": 2, + "minimum": 2, + "description": "The minimum shingle size. Default and minimum value is 2. Must be less than the value of maxShingleSize." + }, + "outputUnigrams": { + "type": "boolean", + "default": true, + "description": "A value indicating whether the output stream will contain the input tokens (unigrams) as well as shingles. Default is true." + }, + "outputUnigramsIfNoShingles": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to output unigrams for those times when no shingles are available. This property takes precedence when outputUnigrams is set to false. Default is false." + }, + "tokenSeparator": { + "type": "string", + "default": " ", + "description": "The string to use when joining adjacent tokens to form a shingle. Default is a single space (\" \")." + }, + "filterToken": { + "type": "string", + "default": "_", + "description": "The string to insert for each position at which there is no token. Default is an underscore (\"_\")." + } + }, + "description": "Creates combinations of tokens as a single token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/shingle/ShingleFilter.html" + } + }, + "SnowballTokenFilterLanguage": { + "type": "string", + "enum": [ + "armenian", + "basque", + "catalan", + "danish", + "dutch", + "english", + "finnish", + "french", + "german", + "german2", + "hungarian", + "italian", + "kp", + "lovins", + "norwegian", + "porter", + "portuguese", + "romanian", + "russian", + "spanish", + "swedish", + "turkish" + ], + "x-ms-enum": { + "name": "SnowballTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene Snowball stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene Snowball stemming tokenizer for Basque." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene Snowball stemming tokenizer for Catalan." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene Snowball stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene Snowball stemming tokenizer for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene Snowball stemming tokenizer for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene Snowball stemming tokenizer for French." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene Snowball stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene Snowball stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene Snowball stemming tokenizer for Hungarian." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene Snowball stemming tokenizer for Italian." + }, + { + "value": "kp", + "name": "Kp", + "description": "Selects the Lucene Snowball stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene Snowball stemming tokenizer for Norwegian." + }, + { + "value": "porter", + "name": "Porter", + "description": "Selects the Lucene Snowball stemming tokenizer for English that uses the Porter stemming algorithm." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene Snowball stemming tokenizer for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene Snowball stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene Snowball stemming tokenizer for Russian." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene Snowball stemming tokenizer for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene Snowball stemming tokenizer for Swedish." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene Snowball stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a Snowball token filter." + }, + "SnowballTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SnowballTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/SnowballTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "A filter that stems words using a Snowball-generated stemmer. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/snowball/SnowballFilter.html" + } + }, + "StemmerTokenFilterLanguage": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "dutchKp", + "english", + "lightEnglish", + "minimalEnglish", + "possessiveEnglish", + "porter2", + "lovins", + "finnish", + "lightFinnish", + "french", + "lightFrench", + "minimalFrench", + "galician", + "minimalGalician", + "german", + "german2", + "lightGerman", + "minimalGerman", + "greek", + "hindi", + "hungarian", + "lightHungarian", + "indonesian", + "irish", + "italian", + "lightItalian", + "sorani", + "latvian", + "norwegian", + "lightNorwegian", + "minimalNorwegian", + "lightNynorsk", + "minimalNynorsk", + "portuguese", + "lightPortuguese", + "minimalPortuguese", + "portugueseRslp", + "romanian", + "russian", + "lightRussian", + "spanish", + "lightSpanish", + "swedish", + "lightSwedish", + "turkish" + ], + "x-ms-enum": { + "name": "StemmerTokenFilterLanguage", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the Lucene stemming tokenizer for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the Lucene stemming tokenizer for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the Lucene stemming tokenizer for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the Lucene stemming tokenizer for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the Lucene stemming tokenizer for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the Lucene stemming tokenizer for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the Lucene stemming tokenizer for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the Lucene stemming tokenizer for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the Lucene stemming tokenizer for Dutch." + }, + { + "value": "dutchKp", + "name": "DutchKp", + "description": "Selects the Lucene stemming tokenizer for Dutch that uses the Kraaij-Pohlmann stemming algorithm." + }, + { + "value": "english", + "name": "English", + "description": "Selects the Lucene stemming tokenizer for English." + }, + { + "value": "lightEnglish", + "name": "LightEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does light stemming." + }, + { + "value": "minimalEnglish", + "name": "MinimalEnglish", + "description": "Selects the Lucene stemming tokenizer for English that does minimal stemming." + }, + { + "value": "possessiveEnglish", + "name": "PossessiveEnglish", + "description": "Selects the Lucene stemming tokenizer for English that removes trailing possessives from words." + }, + { + "value": "porter2", + "name": "Porter2", + "description": "Selects the Lucene stemming tokenizer for English that uses the Porter2 stemming algorithm." + }, + { + "value": "lovins", + "name": "Lovins", + "description": "Selects the Lucene stemming tokenizer for English that uses the Lovins stemming algorithm." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the Lucene stemming tokenizer for Finnish." + }, + { + "value": "lightFinnish", + "name": "LightFinnish", + "description": "Selects the Lucene stemming tokenizer for Finnish that does light stemming." + }, + { + "value": "french", + "name": "French", + "description": "Selects the Lucene stemming tokenizer for French." + }, + { + "value": "lightFrench", + "name": "LightFrench", + "description": "Selects the Lucene stemming tokenizer for French that does light stemming." + }, + { + "value": "minimalFrench", + "name": "MinimalFrench", + "description": "Selects the Lucene stemming tokenizer for French that does minimal stemming." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the Lucene stemming tokenizer for Galician." + }, + { + "value": "minimalGalician", + "name": "MinimalGalician", + "description": "Selects the Lucene stemming tokenizer for Galician that does minimal stemming." + }, + { + "value": "german", + "name": "German", + "description": "Selects the Lucene stemming tokenizer for German." + }, + { + "value": "german2", + "name": "German2", + "description": "Selects the Lucene stemming tokenizer that uses the German variant algorithm." + }, + { + "value": "lightGerman", + "name": "LightGerman", + "description": "Selects the Lucene stemming tokenizer for German that does light stemming." + }, + { + "value": "minimalGerman", + "name": "MinimalGerman", + "description": "Selects the Lucene stemming tokenizer for German that does minimal stemming." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the Lucene stemming tokenizer for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the Lucene stemming tokenizer for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian." + }, + { + "value": "lightHungarian", + "name": "LightHungarian", + "description": "Selects the Lucene stemming tokenizer for Hungarian that does light stemming." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the Lucene stemming tokenizer for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the Lucene stemming tokenizer for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the Lucene stemming tokenizer for Italian." + }, + { + "value": "lightItalian", + "name": "LightItalian", + "description": "Selects the Lucene stemming tokenizer for Italian that does light stemming." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the Lucene stemming tokenizer for Sorani." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the Lucene stemming tokenizer for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål)." + }, + { + "value": "lightNorwegian", + "name": "LightNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does light stemming." + }, + { + "value": "minimalNorwegian", + "name": "MinimalNorwegian", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Bokmål) that does minimal stemming." + }, + { + "value": "lightNynorsk", + "name": "LightNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does light stemming." + }, + { + "value": "minimalNynorsk", + "name": "MinimalNynorsk", + "description": "Selects the Lucene stemming tokenizer for Norwegian (Nynorsk) that does minimal stemming." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese." + }, + { + "value": "lightPortuguese", + "name": "LightPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does light stemming." + }, + { + "value": "minimalPortuguese", + "name": "MinimalPortuguese", + "description": "Selects the Lucene stemming tokenizer for Portuguese that does minimal stemming." + }, + { + "value": "portugueseRslp", + "name": "PortugueseRslp", + "description": "Selects the Lucene stemming tokenizer for Portuguese that uses the RSLP stemming algorithm." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the Lucene stemming tokenizer for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the Lucene stemming tokenizer for Russian." + }, + { + "value": "lightRussian", + "name": "LightRussian", + "description": "Selects the Lucene stemming tokenizer for Russian that does light stemming." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the Lucene stemming tokenizer for Spanish." + }, + { + "value": "lightSpanish", + "name": "LightSpanish", + "description": "Selects the Lucene stemming tokenizer for Spanish that does light stemming." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the Lucene stemming tokenizer for Swedish." + }, + { + "value": "lightSwedish", + "name": "LightSwedish", + "description": "Selects the Lucene stemming tokenizer for Swedish that does light stemming." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the Lucene stemming tokenizer for Turkish." + } + ] + }, + "description": "The language to use for a stemmer token filter." + }, + "StemmerTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "language": { + "$ref": "#/definitions/StemmerTokenFilterLanguage", + "description": "The language to use." + } + }, + "required": [ + "language" + ], + "description": "Language specific stemming filter. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search#TokenFilters" + } + }, + "StemmerOverrideTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StemmerOverrideTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "rules": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of stemming rules in the following format: \"word => stem\", for example: \"ran => run\"." + } + }, + "required": [ + "rules" + ], + "description": "Provides the ability to override other stemming filters with custom dictionary-based stemming. Any dictionary-stemmed terms will be marked as keywords so that they will not be stemmed with stemmers down the chain. Must be placed before any stemming filters. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/StemmerOverrideFilter.html" + } + }, + "StopwordsList": { + "type": "string", + "enum": [ + "arabic", + "armenian", + "basque", + "brazilian", + "bulgarian", + "catalan", + "czech", + "danish", + "dutch", + "english", + "finnish", + "french", + "galician", + "german", + "greek", + "hindi", + "hungarian", + "indonesian", + "irish", + "italian", + "latvian", + "norwegian", + "persian", + "portuguese", + "romanian", + "russian", + "sorani", + "spanish", + "swedish", + "thai", + "turkish" + ], + "x-ms-enum": { + "name": "StopwordsList", + "modelAsString": false, + "values": [ + { + "value": "arabic", + "name": "Arabic", + "description": "Selects the stopword list for Arabic." + }, + { + "value": "armenian", + "name": "Armenian", + "description": "Selects the stopword list for Armenian." + }, + { + "value": "basque", + "name": "Basque", + "description": "Selects the stopword list for Basque." + }, + { + "value": "brazilian", + "name": "Brazilian", + "description": "Selects the stopword list for Portuguese (Brazil)." + }, + { + "value": "bulgarian", + "name": "Bulgarian", + "description": "Selects the stopword list for Bulgarian." + }, + { + "value": "catalan", + "name": "Catalan", + "description": "Selects the stopword list for Catalan." + }, + { + "value": "czech", + "name": "Czech", + "description": "Selects the stopword list for Czech." + }, + { + "value": "danish", + "name": "Danish", + "description": "Selects the stopword list for Danish." + }, + { + "value": "dutch", + "name": "Dutch", + "description": "Selects the stopword list for Dutch." + }, + { + "value": "english", + "name": "English", + "description": "Selects the stopword list for English." + }, + { + "value": "finnish", + "name": "Finnish", + "description": "Selects the stopword list for Finnish." + }, + { + "value": "french", + "name": "French", + "description": "Selects the stopword list for French." + }, + { + "value": "galician", + "name": "Galician", + "description": "Selects the stopword list for Galician." + }, + { + "value": "german", + "name": "German", + "description": "Selects the stopword list for German." + }, + { + "value": "greek", + "name": "Greek", + "description": "Selects the stopword list for Greek." + }, + { + "value": "hindi", + "name": "Hindi", + "description": "Selects the stopword list for Hindi." + }, + { + "value": "hungarian", + "name": "Hungarian", + "description": "Selects the stopword list for Hungarian." + }, + { + "value": "indonesian", + "name": "Indonesian", + "description": "Selects the stopword list for Indonesian." + }, + { + "value": "irish", + "name": "Irish", + "description": "Selects the stopword list for Irish." + }, + { + "value": "italian", + "name": "Italian", + "description": "Selects the stopword list for Italian." + }, + { + "value": "latvian", + "name": "Latvian", + "description": "Selects the stopword list for Latvian." + }, + { + "value": "norwegian", + "name": "Norwegian", + "description": "Selects the stopword list for Norwegian." + }, + { + "value": "persian", + "name": "Persian", + "description": "Selects the stopword list for Persian." + }, + { + "value": "portuguese", + "name": "Portuguese", + "description": "Selects the stopword list for Portuguese." + }, + { + "value": "romanian", + "name": "Romanian", + "description": "Selects the stopword list for Romanian." + }, + { + "value": "russian", + "name": "Russian", + "description": "Selects the stopword list for Russian." + }, + { + "value": "sorani", + "name": "Sorani", + "description": "Selects the stopword list for Sorani." + }, + { + "value": "spanish", + "name": "Spanish", + "description": "Selects the stopword list for Spanish." + }, + { + "value": "swedish", + "name": "Swedish", + "description": "Selects the stopword list for Swedish." + }, + { + "value": "thai", + "name": "Thai", + "description": "Selects the stopword list for Thai." + }, + { + "value": "turkish", + "name": "Turkish", + "description": "Selects the stopword list for Turkish." + } + ] + }, + "description": "Identifies a predefined list of language-specific stopwords." + }, + "StopwordsTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.StopwordsTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "stopwords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of stopwords. This property and the stopwords list property cannot both be set." + }, + "stopwordsList": { + "$ref": "#/definitions/StopwordsList", + "default": "english", + "description": "A predefined list of stopwords to use. This property and the stopwords property cannot both be set. Default is English." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to ignore case. If true, all words are converted to lower case first. Default is false." + }, + "removeTrailing": { + "x-ms-client-name": "RemoveTrailingStopWords", + "type": "boolean", + "default": true, + "description": "A value indicating whether to ignore the last search term if it's a stop word. Default is true." + } + }, + "description": "Removes stop words from a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/core/StopFilter.html" + } + }, + "SynonymTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SynonymTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "synonyms": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of synonyms in following one of two formats: 1. incredible, unbelievable, fabulous => amazing - all terms on the left side of => symbol will be replaced with all terms on its right side; 2. incredible, unbelievable, fabulous, amazing - comma separated list of equivalent words. Set the expand option to change how this list is interpreted." + }, + "ignoreCase": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to case-fold input for matching. Default is false." + }, + "expand": { + "type": "boolean", + "default": true, + "description": "A value indicating whether all words in the list of synonyms (if => notation is not used) will map to one another. If true, all words in the list of synonyms (if => notation is not used) will map to one another. The following list: incredible, unbelievable, fabulous, amazing is equivalent to: incredible, unbelievable, fabulous, amazing => incredible, unbelievable, fabulous, amazing. If false, the following list: incredible, unbelievable, fabulous, amazing will be equivalent to: incredible, unbelievable, fabulous, amazing => incredible. Default is true." + } + }, + "required": [ + "synonyms" + ], + "description": "Matches single or multi-word synonyms in a token stream. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/synonym/SynonymFilter.html" + } + }, + "TruncateTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.TruncateTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "length": { + "type": "integer", + "format": "int32", + "default": 300, + "maximum": 300, + "description": "The length at which terms will be truncated. Default and maximum is 300." + } + }, + "description": "Truncates the terms to a specific length. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/TruncateTokenFilter.html" + } + }, + "UniqueTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.UniqueTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "onlyOnSamePosition": { + "type": "boolean", + "default": false, + "description": "A value indicating whether to remove duplicates only at the same position. Default is false." + } + }, + "description": "Filters out tokens with same text as the previous token. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/RemoveDuplicatesTokenFilter.html" + } + }, + "WordDelimiterTokenFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.WordDelimiterTokenFilter", + "allOf": [ + { + "$ref": "#/definitions/TokenFilter" + } + ], + "properties": { + "generateWordParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate part words. If set, causes parts of words to be generated; for example \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "generateNumberParts": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to generate number subwords. Default is true." + }, + "catenateWords": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of word parts will be catenated. For example, if this is set to true, \"Azure-Search\" becomes \"AzureSearch\". Default is false." + }, + "catenateNumbers": { + "type": "boolean", + "default": false, + "description": "A value indicating whether maximum runs of number parts will be catenated. For example, if this is set to true, \"1-2\" becomes \"12\". Default is false." + }, + "catenateAll": { + "type": "boolean", + "default": false, + "description": "A value indicating whether all subword parts will be catenated. For example, if this is set to true, \"Azure-Search-1\" becomes \"AzureSearch1\". Default is false." + }, + "splitOnCaseChange": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split words on caseChange. For example, if this is set to true, \"AzureSearch\" becomes \"Azure\" \"Search\". Default is true." + }, + "preserveOriginal": { + "type": "boolean", + "default": false, + "description": "A value indicating whether original words will be preserved and added to the subword list. Default is false." + }, + "splitOnNumerics": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to split on numbers. For example, if this is set to true, \"Azure1Search\" becomes \"Azure\" \"1\" \"Search\". Default is true." + }, + "stemEnglishPossessive": { + "type": "boolean", + "default": true, + "description": "A value indicating whether to remove trailing \"'s\" for each subword. Default is true." + }, + "protectedWords": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of tokens to protect from being delimited." + } + }, + "description": "Splits words into subwords and performs optional transformations on subword groups. This token filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "http://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/miscellaneous/WordDelimiterFilter.html" + } + }, + "CharFilter": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the char filter." + }, + "name": { + "type": "string", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/custom-analyzers-in-azure-search#index-attribute-reference" + }, + "description": "The name of the char filter. It must only contain letters, digits, spaces, dashes or underscores, can only start and end with alphanumeric characters, and is limited to 128 characters." + } + }, + "required": [ + "@odata.type", + "name" + ], + "description": "Base type for character filters.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "MappingCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.MappingCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "mappings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of mappings of the following format: \"a=>b\" (all occurrences of the character \"a\" will be replaced with character \"b\")." + } + }, + "required": [ + "mappings" + ], + "description": "A character filter that applies mappings defined with the mappings option. Matching is greedy (longest pattern matching at a given point wins). Replacement is allowed to be the empty string. This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/charfilter/MappingCharFilter.html" + } + }, + "PatternReplaceCharFilter": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.PatternReplaceCharFilter", + "allOf": [ + { + "$ref": "#/definitions/CharFilter" + } + ], + "properties": { + "pattern": { + "type": "string", + "description": "A regular expression pattern." + }, + "replacement": { + "type": "string", + "description": "The replacement text." + } + }, + "required": [ + "pattern", + "replacement" + ], + "description": "A character filter that replaces characters in the input string. It uses a regular expression to identify character sequences to preserve and a replacement pattern to identify characters to replace. For example, given the input text \"aa bb aa bb\", pattern \"(aa)\\s+(bb)\", and replacement \"$1#$2\", the result would be \"aa#bb aa#bb\". This character filter is implemented using Apache Lucene.", + "externalDocs": { + "url": "https://lucene.apache.org/core/4_10_3/analyzers-common/org/apache/lucene/analysis/pattern/PatternReplaceCharFilter.html" + } + }, + "Similarity": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string" + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for similarity algorithms. Similarity algorithms are used to calculate scores that tie queries to documents. The higher the score, the more relevant the document is to that specific query. Those scores are used to rank the search results.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "ClassicSimilarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.ClassicSimilarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "description": "Legacy similarity algorithm which uses the Lucene TFIDFSimilarity implementation of TF-IDF. This variation of TF-IDF introduces static document length normalization as well as coordinating factors that penalize documents that only partially match the searched queries." + }, + "BM25Similarity": { + "x-ms-discriminator-value": "#Microsoft.Azure.Search.BM25Similarity", + "allOf": [ + { + "$ref": "#/definitions/Similarity" + } + ], + "properties": { + "k1": { + "type": "number", + "format": "double", + "description": "This property controls the scaling function between the term frequency of each matching terms and the final relevance score of a document-query pair. By default, a value of 1.2 is used. A value of 0.0 means the score does not scale with an increase in term frequency." + }, + "b": { + "type": "number", + "format": "double", + "description": "This property controls how the length of a document affects the relevance score. By default, a value of 0.75 is used. A value of 0.0 means no length normalization is applied, while a value of 1.0 means the score is fully normalized by the length of the document." + } + }, + "description": "Ranking function based on the Okapi BM25 similarity algorithm. BM25 is a TF-IDF-like algorithm that includes length normalization (controlled by the 'b' parameter) as well as term frequency saturation (controlled by the 'k1' parameter)." + }, + "DataSourceCredentials": { + "properties": { + "connectionString": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Data-Source" + }, + "type": "string", + "description": "The connection string for the datasource." + } + }, + "description": "Represents credentials that can be used to connect to a datasource." + }, + "SearchIndexerDataContainer": { + "properties": { + "name": { + "type": "string", + "description": "The name of the table or view (for Azure SQL data source) or collection (for CosmosDB data source) that will be indexed." + }, + "query": { + "type": "string", + "description": "A query that is applied to this data container. The syntax and meaning of this parameter is datasource-specific. Not supported by Azure SQL datasources." + } + }, + "required": [ + "name" + ], + "description": "Represents information about the entity (such as Azure SQL table or CosmosDB collection) that will be indexed." + }, + "DataChangeDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the data change detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data change detection policies." + }, + "HighWaterMarkChangeDetectionPolicy": { + "description": "Defines a data change detection policy that captures changes based on the value of a high water mark column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.HighWaterMarkChangeDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ], + "properties": { + "highWaterMarkColumnName": { + "type": "string", + "description": "The name of the high water mark column." + } + }, + "required": [ + "highWaterMarkColumnName" + ] + }, + "SqlIntegratedChangeTrackingPolicy": { + "description": "Defines a data change detection policy that captures changes using the Integrated Change Tracking feature of Azure SQL Database.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SqlIntegratedChangeTrackingPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataChangeDetectionPolicy" + } + ] + }, + "DataDeletionDetectionPolicy": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the data deletion detection policy." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for data deletion detection policies." + }, + "SoftDeleteColumnDeletionDetectionPolicy": { + "description": "Defines a data deletion detection policy that implements a soft-deletion strategy. It determines whether an item should be deleted based on the value of a designated 'soft delete' column.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.SoftDeleteColumnDeletionDetectionPolicy", + "allOf": [ + { + "$ref": "#/definitions/DataDeletionDetectionPolicy" + } + ], + "properties": { + "softDeleteColumnName": { + "type": "string", + "description": "The name of the column to use for soft-deletion detection." + }, + "softDeleteMarkerValue": { + "type": "string", + "description": "The marker value that identifies an item as deleted." + } + } + }, + "SearchIndexerDataSourceType": { + "type": "string", + "enum": [ + "azuresql", + "cosmosdb", + "azureblob", + "azuretable", + "mysql" + ], + "x-ms-enum": { + "name": "SearchIndexerDataSourceType", + "modelAsString": true, + "values": [ + { + "value": "azuresql", + "name": "AzureSql", + "description": "Indicates an Azure SQL datasource." + }, + { + "value": "cosmosdb", + "name": "CosmosDb", + "description": "Indicates a CosmosDB datasource." + }, + { + "value": "azureblob", + "name": "AzureBlob", + "description": "Indicates a Azure Blob datasource." + }, + { + "value": "azuretable", + "name": "AzureTable", + "description": "Indicates a Azure Table datasource." + }, + { + "value": "mysql", + "name": "MySql", + "description": "Indicates a MySql datasource." + } + ] + }, + "description": "Defines the type of a datasource." + }, + "SearchIndexerDataSource": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the datasource." + }, + "description": { + "type": "string", + "description": "The description of the datasource." + }, + "type": { + "$ref": "#/definitions/SearchIndexerDataSourceType", + "description": "The type of the datasource." + }, + "credentials": { + "$ref": "#/definitions/DataSourceCredentials", + "description": "Credentials for the datasource." + }, + "container": { + "$ref": "#/definitions/SearchIndexerDataContainer", + "description": "The data container for the datasource." + }, + "dataChangeDetectionPolicy": { + "$ref": "#/definitions/DataChangeDetectionPolicy", + "description": "The data change detection policy for the datasource." + }, + "dataDeletionDetectionPolicy": { + "$ref": "#/definitions/DataDeletionDetectionPolicy", + "description": "The data deletion detection policy for the datasource." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the data source." + } + }, + "required": [ + "name", + "type", + "credentials", + "container" + ], + "description": "Represents a datasource definition, which can be used to configure an indexer." + }, + "ListDataSourcesResult": { + "properties": { + "value": { + "x-ms-client-name": "DataSources", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerDataSource" + }, + "description": "The datasources in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Datasources request. If successful, it includes the full definitions of all datasources." + }, + "IndexingSchedule": { + "properties": { + "interval": { + "type": "string", + "format": "duration", + "description": "The interval of time between indexer executions." + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "The time when an indexer should start running." + } + }, + "required": [ + "interval" + ], + "description": "Represents a schedule for indexer execution." + }, + "IndexingParameters": { + "properties": { + "batchSize": { + "type": "integer", + "format": "int32", + "description": "The number of items that are read from the data source and indexed as a single batch in order to improve performance. The default depends on the data source type." + }, + "maxFailedItems": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "The maximum number of items that can fail indexing for indexer execution to still be considered successful. -1 means no limit. Default is 0." + }, + "maxFailedItemsPerBatch": { + "type": "integer", + "format": "int32", + "default": 0, + "description": "The maximum number of items in a single batch that can fail indexing for the batch to still be considered successful. -1 means no limit. Default is 0." + }, + "configuration": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of indexer-specific configuration properties. Each name is the name of a specific property. Each value must be of a primitive type." + } + }, + "description": "Represents parameters for indexer execution." + }, + "FieldMappingFunction": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field mapping function." + }, + "parameters": { + "type": "object", + "additionalProperties": { + "type": "object" + }, + "description": "A dictionary of parameter name/value pairs to pass to the function. Each value must be of a primitive type." + } + }, + "required": [ + "name" + ], + "description": "Represents a function that transforms a value from a data source before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "FieldMapping": { + "properties": { + "sourceFieldName": { + "type": "string", + "description": "The name of the field in the data source." + }, + "targetFieldName": { + "type": "string", + "description": "The name of the target field in the index. Same as the source field name by default." + }, + "mappingFunction": { + "$ref": "#/definitions/FieldMappingFunction", + "description": "A function to apply to each source field value before indexing." + } + }, + "required": [ + "sourceFieldName" + ], + "description": "Defines a mapping between a field in a data source and a target field in an index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "SearchIndexer": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the indexer." + }, + "description": { + "type": "string", + "description": "The description of the indexer." + }, + "dataSourceName": { + "type": "string", + "description": "The name of the datasource from which this indexer reads data." + }, + "skillsetName": { + "type": "string", + "description": "The name of the skillset executing with this indexer." + }, + "targetIndexName": { + "type": "string", + "description": "The name of the index to which this indexer writes data." + }, + "schedule": { + "$ref": "#/definitions/IndexingSchedule", + "description": "The schedule for this indexer." + }, + "parameters": { + "$ref": "#/definitions/IndexingParameters", + "description": "Parameters for indexer execution." + }, + "fieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Defines mappings between fields in the data source and corresponding target fields in the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "outputFieldMappings": { + "type": "array", + "items": { + "$ref": "#/definitions/FieldMapping" + }, + "description": "Output field mappings are applied after enrichment and immediately before indexing.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/search-indexer-field-mappings" + } + }, + "disabled": { + "x-ms-client-name": "IsDisabled", + "type": "boolean", + "default": false, + "description": "A value indicating whether the indexer is disabled. Default is false." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the indexer." + } + }, + "required": [ + "name", + "dataSourceName", + "targetIndexName" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Indexer-operations" + }, + "description": "Represents an indexer." + }, + "ListIndexersResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexers", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexer" + }, + "description": "The indexers in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexers request. If successful, it includes the full definitions of all indexers." + }, + "SearchIndexerError": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item for which indexing failed." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The message describing the error that occurred while processing the item." + }, + "statusCode": { + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The status code indicating why the indexing operation failed. Possible values include: 400 for a malformed input document, 404 for document not found, 409 for a version conflict, 422 when the index is temporarily unavailable, or 503 for when the service is too busy." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the error originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the error to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of errors. This may not be always available." + } + }, + "required": [ + "errorMessage", + "statusCode" + ], + "description": "Represents an item- or document-level indexing error." + }, + "SearchIndexerWarning": { + "properties": { + "key": { + "type": "string", + "readOnly": true, + "description": "The key of the item which generated a warning." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "The message describing the warning that occurred while processing the item." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The name of the source at which the warning originated. For example, this could refer to a particular skill in the attached skillset. This may not be always available." + }, + "details": { + "type": "string", + "readOnly": true, + "description": "Additional, verbose details about the warning to assist in debugging the indexer. This may not be always available." + }, + "documentationLink": { + "type": "string", + "readOnly": true, + "description": "A link to a troubleshooting guide for these classes of warnings. This may not be always available." + } + }, + "required": [ + "message" + ], + "description": "Represents an item-level warning." + }, + "IndexerExecutionResult": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerExecutionStatus", + "readOnly": true, + "description": "The outcome of this indexer execution." + }, + "errorMessage": { + "type": "string", + "readOnly": true, + "description": "The error message indicating the top-level error, if any." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The start time of this indexer execution." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "The end time of this indexer execution, if the execution has already completed." + }, + "errors": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerError" + }, + "description": "The item-level indexing errors." + }, + "warnings": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerWarning" + }, + "description": "The item-level indexing warnings." + }, + "itemsProcessed": { + "x-ms-client-name": "ItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that were processed during this indexer execution. This includes both successfully processed items and items where indexing was attempted but failed." + }, + "itemsFailed": { + "x-ms-client-name": "FailedItemCount", + "type": "integer", + "format": "int32", + "x-nullable": false, + "readOnly": true, + "description": "The number of items that failed to be indexed during this indexer execution." + }, + "initialTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution started." + }, + "finalTrackingState": { + "type": "string", + "readOnly": true, + "description": "Change tracking state with which an indexer execution finished." + } + }, + "required": [ + "status", + "errors", + "warnings", + "itemsProcessed", + "itemsFailed" + ], + "description": "Represents the result of an individual indexer execution." + }, + "IndexerExecutionStatus": { + "type": "string", + "enum": [ + "transientFailure", + "success", + "inProgress", + "reset" + ], + "x-ms-enum": { + "name": "IndexerExecutionStatus", + "modelAsString": false, + "values": [ + { + "value": "transientFailure", + "name": "TransientFailure", + "description": "An indexer invocation has failed, but the failure may be transient. Indexer invocations will continue per schedule." + }, + { + "value": "success", + "name": "Success", + "description": "Indexer execution completed successfully." + }, + { + "value": "inProgress", + "name": "InProgress", + "description": "Indexer execution is in progress." + }, + { + "value": "reset", + "name": "Reset", + "description": "Indexer has been reset." + } + ] + }, + "x-nullable": false, + "description": "Represents the status of an individual indexer execution." + }, + "SearchIndexerStatus": { + "properties": { + "status": { + "$ref": "#/definitions/IndexerStatus", + "readOnly": true, + "description": "Overall indexer status." + }, + "lastResult": { + "$ref": "#/definitions/IndexerExecutionResult", + "readOnly": true, + "description": "The result of the most recent or an in-progress indexer execution." + }, + "executionHistory": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/IndexerExecutionResult" + }, + "description": "History of the recent indexer executions, sorted in reverse chronological order." + }, + "limits": { + "$ref": "#/definitions/SearchIndexerLimits", + "readOnly": true, + "description": "The execution limits for the indexer." + } + }, + "required": [ + "status", + "executionHistory", + "limits" + ], + "description": "Represents the current status and execution history of an indexer." + }, + "IndexerStatus": { + "type": "string", + "enum": [ + "unknown", + "error", + "running" + ], + "x-ms-enum": { + "name": "IndexerStatus", + "modelAsString": false, + "values": [ + { + "value": "unknown", + "name": "Unknown", + "description": "Indicates that the indexer is in an unknown state." + }, + { + "value": "error", + "name": "Error", + "description": "Indicates that the indexer experienced an error that cannot be corrected without human intervention." + }, + { + "value": "running", + "name": "Running", + "description": "Indicates that the indexer is running normally." + } + ] + }, + "x-nullable": false, + "description": "Represents the overall indexer status." + }, + "SearchIndexerLimits": { + "properties": { + "maxRunTime": { + "type": "string", + "format": "duration", + "readOnly": true, + "description": "The maximum duration that the indexer is permitted to run for one execution." + }, + "maxDocumentExtractionSize": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum size of a document, in bytes, which will be considered valid for indexing." + }, + "maxDocumentContentCharactersToExtract": { + "type": "number", + "format": "int64", + "readOnly": true, + "description": "The maximum number of characters that will be extracted from a document picked up for indexing." + } + } + }, + "SearchField": { + "properties": { + "name": { + "type": "string", + "description": "The name of the field, which must be unique within the fields collection of the index or parent field.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + } + }, + "type": { + "$ref": "#/definitions/SearchFieldDataType", + "description": "The data type of the field.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/supported-data-types" + } + }, + "key": { + "type": "boolean", + "description": "A value indicating whether the field uniquely identifies documents in the index. Exactly one top-level field in each index must be chosen as the key field and it must be of type Edm.String. Key fields can be used to look up documents directly and update or delete specific documents. Default is false for simple fields and null for complex fields." + }, + "retrievable": { + "type": "boolean", + "description": "A value indicating whether the field can be returned in a search result. You can disable this option if you want to use a field (for example, margin) as a filter, sorting, or scoring mechanism but do not want the field to be visible to the end user. This property must be true for key fields, and it must be null for complex fields. This property can be changed on existing fields. Enabling this property does not cause any increase in index storage requirements. Default is true for simple fields and null for complex fields." + }, + "searchable": { + "type": "boolean", + "description": "A value indicating whether the field is full-text searchable. This means it will undergo analysis such as word-breaking during indexing. If you set a searchable field to a value like \"sunny day\", internally it will be split into the individual tokens \"sunny\" and \"day\". This enables full-text searches for these terms. Fields of type Edm.String or Collection(Edm.String) are searchable by default. This property must be false for simple fields of other non-string data types, and it must be null for complex fields. Note: searchable fields consume extra space in your index since Azure Cognitive Search will store an additional tokenized version of the field value for full-text searches. If you want to save space in your index and you don't need a field to be included in searches, set searchable to false." + }, + "filterable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $filter queries. filterable differs from searchable in how strings are handled. Fields of type Edm.String or Collection(Edm.String) that are filterable do not undergo word-breaking, so comparisons are for exact matches only. For example, if you set such a field f to \"sunny day\", $filter=f eq 'sunny' will find no matches, but $filter=f eq 'sunny day' will. This property must be null for complex fields. Default is true for simple fields and null for complex fields." + }, + "sortable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in $orderby expressions. By default Azure Cognitive Search sorts results by score, but in many experiences users will want to sort by fields in the documents. A simple field can be sortable only if it is single-valued (it has a single value in the scope of the parent document). Simple collection fields cannot be sortable, since they are multi-valued. Simple sub-fields of complex collections are also multi-valued, and therefore cannot be sortable. This is true whether it's an immediate parent field, or an ancestor field, that's the complex collection. Complex fields cannot be sortable and the sortable property must be null for such fields. The default for sortable is true for single-valued simple fields, false for multi-valued simple fields, and null for complex fields." + }, + "facetable": { + "type": "boolean", + "description": "A value indicating whether to enable the field to be referenced in facet queries. Typically used in a presentation of search results that includes hit count by category (for example, search for digital cameras and see hits by brand, by megapixels, by price, and so on). This property must be null for complex fields. Fields of type Edm.GeographyPoint or Collection(Edm.GeographyPoint) cannot be facetable. Default is true for all other simple fields." + }, + "analyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer to use for the field. This option can be used only with searchable fields and it can't be set together with either searchAnalyzer or indexAnalyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields." + }, + "searchAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at search time for the field. This option can be used only with searchable fields. It must be set together with indexAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. This analyzer can be updated on an existing field. Must be null for complex fields." + }, + "indexAnalyzer": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Language-support" + }, + "$ref": "#/definitions/LexicalAnalyzerName", + "description": "The name of the analyzer used at indexing time for the field. This option can be used only with searchable fields. It must be set together with searchAnalyzer and it cannot be set together with the analyzer option. This property cannot be set to the name of a language analyzer; use the analyzer property instead if you need a language analyzer. Once the analyzer is chosen, it cannot be changed for the field. Must be null for complex fields." + }, + "synonymMaps": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Synonym-Map-operations" + }, + "type": "array", + "items": { + "type": "string" + }, + "description": "A list of the names of synonym maps to associate with this field. This option can be used only with searchable fields. Currently only one synonym map per field is supported. Assigning a synonym map to a field ensures that query terms targeting that field are expanded at query-time using the rules in the synonym map. This attribute can be changed on existing fields. Must be null or an empty collection for complex fields." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "A list of sub-fields if this is a field of type Edm.ComplexType or Collection(Edm.ComplexType). Must be null or empty for simple fields." + } + }, + "required": [ + "name", + "type" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Represents a field in an index definition, which describes the name, data type, and search behavior of a field." + }, + "TextWeights": { + "properties": { + "weights": { + "type": "object", + "additionalProperties": { + "type": "number", + "format": "double", + "x-nullable": false + }, + "description": "The dictionary of per-field weights to boost document scoring. The keys are field names and the values are the weights for each field." + } + }, + "required": [ + "weights" + ], + "description": "Defines weights on index fields for which matches should boost scoring in search queries." + }, + "ScoringFunction": { + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "description": "Indicates the type of function to use. Valid values include magnitude, freshness, distance, and tag. The function type must be lower case." + }, + "fieldName": { + "type": "string", + "description": "The name of the field used as input to the scoring function." + }, + "boost": { + "type": "number", + "format": "double", + "description": "A multiplier for the raw score. Must be a positive number not equal to 1.0." + }, + "interpolation": { + "$ref": "#/definitions/ScoringFunctionInterpolation", + "description": "A value indicating how boosting will be interpolated across document scores; defaults to \"Linear\"." + } + }, + "required": [ + "type", + "fieldName", + "boost" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Base type for functions that can modify document scores during ranking." + }, + "DistanceScoringFunction": { + "x-ms-discriminator-value": "distance", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "distance": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/DistanceScoringParameters", + "description": "Parameter values for the distance scoring function." + } + }, + "required": [ + "distance" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on distance from a geographic location." + }, + "DistanceScoringParameters": { + "properties": { + "referencePointParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the reference location." + }, + "boostingDistance": { + "type": "number", + "format": "double", + "description": "The distance in kilometers from the reference location where the boosting range ends." + } + }, + "required": [ + "referencePointParameter", + "boostingDistance" + ], + "description": "Provides parameter values to a distance scoring function." + }, + "FreshnessScoringFunction": { + "x-ms-discriminator-value": "freshness", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "freshness": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/FreshnessScoringParameters", + "description": "Parameter values for the freshness scoring function." + } + }, + "required": [ + "freshness" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the value of a date-time field." + }, + "FreshnessScoringParameters": { + "properties": { + "boostingDuration": { + "type": "string", + "format": "duration", + "description": "The expiration period after which boosting will stop for a particular document." + } + }, + "required": [ + "boostingDuration" + ], + "description": "Provides parameter values to a freshness scoring function." + }, + "MagnitudeScoringFunction": { + "x-ms-discriminator-value": "magnitude", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "magnitude": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/MagnitudeScoringParameters", + "description": "Parameter values for the magnitude scoring function." + } + }, + "required": [ + "magnitude" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores based on the magnitude of a numeric field." + }, + "MagnitudeScoringParameters": { + "properties": { + "boostingRangeStart": { + "type": "number", + "format": "double", + "description": "The field value at which boosting starts." + }, + "boostingRangeEnd": { + "type": "number", + "format": "double", + "description": "The field value at which boosting ends." + }, + "constantBoostBeyondRange": { + "x-ms-client-name": "ShouldBoostBeyondRangeByConstant", + "type": "boolean", + "description": "A value indicating whether to apply a constant boost for field values beyond the range end value; default is false." + } + }, + "required": [ + "boostingRangeStart", + "boostingRangeEnd" + ], + "description": "Provides parameter values to a magnitude scoring function." + }, + "TagScoringFunction": { + "x-ms-discriminator-value": "tag", + "allOf": [ + { + "$ref": "#/definitions/ScoringFunction" + } + ], + "properties": { + "tag": { + "x-ms-client-name": "Parameters", + "$ref": "#/definitions/TagScoringParameters", + "description": "Parameter values for the tag scoring function." + } + }, + "required": [ + "tag" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines a function that boosts scores of documents with string values matching a given list of tags." + }, + "TagScoringParameters": { + "properties": { + "tagsParameter": { + "type": "string", + "description": "The name of the parameter passed in search queries to specify the list of tags to compare against the target field." + } + }, + "required": [ + "tagsParameter" + ], + "description": "Provides parameter values to a tag scoring function." + }, + "ScoringFunctionInterpolation": { + "type": "string", + "enum": [ + "linear", + "constant", + "quadratic", + "logarithmic" + ], + "x-ms-enum": { + "name": "ScoringFunctionInterpolation", + "modelAsString": false, + "values": [ + { + "value": "linear", + "name": "Linear", + "description": "Boosts scores by a linearly decreasing amount. This is the default interpolation for scoring functions." + }, + { + "value": "constant", + "name": "Constant", + "description": "Boosts scores by a constant factor." + }, + { + "value": "quadratic", + "name": "Quadratic", + "description": "Boosts scores by an amount that decreases quadratically. Boosts decrease slowly for higher scores, and more quickly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + }, + { + "value": "logarithmic", + "name": "Logarithmic", + "description": "Boosts scores by an amount that decreases logarithmically. Boosts decrease quickly for higher scores, and more slowly as the scores decrease. This interpolation option is not allowed in tag scoring functions." + } + ] + }, + "description": "Defines the function used to interpolate score boosting across a range of documents." + }, + "ScoringProfile": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the scoring profile." + }, + "text": { + "x-ms-client-name": "TextWeights", + "$ref": "#/definitions/TextWeights", + "description": "Parameters that boost scoring based on text matches in certain index fields." + }, + "functions": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringFunction" + }, + "description": "The collection of functions that influence the scoring of documents." + }, + "functionAggregation": { + "$ref": "#/definitions/ScoringFunctionAggregation", + "description": "A value indicating how the results of individual scoring functions should be combined. Defaults to \"Sum\". Ignored if there are no scoring functions." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Add-scoring-profiles-to-a-search-index" + }, + "description": "Defines parameters for a search index that influence scoring in search queries." + }, + "ScoringFunctionAggregation": { + "type": "string", + "enum": [ + "sum", + "average", + "minimum", + "maximum", + "firstMatching" + ], + "x-ms-enum": { + "name": "ScoringFunctionAggregation", + "modelAsString": false, + "values": [ + { + "value": "sum", + "name": "Sum", + "description": "Boost scores by the sum of all scoring function results." + }, + { + "value": "average", + "name": "Average", + "description": "Boost scores by the average of all scoring function results." + }, + { + "value": "minimum", + "name": "Minimum", + "description": "Boost scores by the minimum of all scoring function results." + }, + { + "value": "maximum", + "name": "Maximum", + "description": "Boost scores by the maximum of all scoring function results." + }, + { + "value": "firstMatching", + "name": "FirstMatching", + "description": "Boost scores using the first applicable scoring function in the scoring profile." + } + ] + }, + "description": "Defines the aggregation function used to combine the results of all the scoring functions in a scoring profile." + }, + "CorsOptions": { + "properties": { + "allowedOrigins": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of origins from which JavaScript code will be granted access to your index. Can contain a list of hosts of the form {protocol}://{fully-qualified-domain-name}[:{port#}], or a single '*' to allow all origins (not recommended)." + }, + "maxAgeInSeconds": { + "type": "integer", + "format": "int64", + "description": "The duration for which browsers should cache CORS preflight responses. Defaults to 5 minutes." + } + }, + "required": [ + "allowedOrigins" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Index" + }, + "description": "Defines options to control Cross-Origin Resource Sharing (CORS) for an index." + }, + "Suggester": { + "properties": { + "name": { + "type": "string", + "description": "The name of the suggester." + }, + "searchMode": { + "type": "string", + "enum": [ + "analyzingInfixMatching" + ], + "x-ms-enum": { + "name": "SuggesterSearchMode", + "modelAsString": false, + "values": [ + { + "value": "analyzingInfixMatching", + "name": "AnalyzingInfixMatching", + "description": "Matches consecutive whole terms and prefixes in a field. For example, for the field 'The fastest brown fox', the queries 'fast' and 'fastest brow' would both match." + } + ] + }, + "description": "A value indicating the capabilities of the suggester." + }, + "sourceFields": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of field names to which the suggester applies. Each field must be searchable." + } + }, + "required": [ + "name", + "searchMode", + "sourceFields" + ], + "description": "Defines how the Suggest API should apply to a group of fields in the index." + }, + "SearchIndex": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the index." + }, + "fields": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchField" + }, + "description": "The fields of the index." + }, + "scoringProfiles": { + "type": "array", + "items": { + "$ref": "#/definitions/ScoringProfile" + }, + "description": "The scoring profiles for the index." + }, + "defaultScoringProfile": { + "type": "string", + "description": "The name of the scoring profile to use if none is specified in the query. If this property is not set and no scoring profile is specified in the query, then default scoring (tf-idf) will be used." + }, + "corsOptions": { + "$ref": "#/definitions/CorsOptions", + "description": "Options to control Cross-Origin Resource Sharing (CORS) for the index." + }, + "suggesters": { + "type": "array", + "items": { + "$ref": "#/definitions/Suggester" + }, + "description": "The suggesters for the index." + }, + "analyzers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalAnalyzer" + }, + "description": "The analyzers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenizers": { + "type": "array", + "items": { + "$ref": "#/definitions/LexicalTokenizer" + }, + "description": "The tokenizers for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "tokenFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/TokenFilter" + }, + "description": "The token filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "charFilters": { + "type": "array", + "items": { + "$ref": "#/definitions/CharFilter" + }, + "description": "The character filters for the index.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Custom-analyzers-in-Azure-Search" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + } + }, + "similarity": { + "$ref": "#/definitions/Similarity", + "description": "The type of similarity algorithm to be used when scoring and ranking the documents matching a search query. The similarity algorithm can only be defined at index creation time and cannot be modified on existing indexes. If null, the ClassicSimilarity algorithm is used.", + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/index-ranking-similarity" + } + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the index." + } + }, + "required": [ + "name", + "fields" + ], + "description": "Represents a search index definition, which describes the fields and search behavior of an index." + }, + "GetIndexStatisticsResult": { + "properties": { + "documentCount": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The number of documents in the index." + }, + "storageSize": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "readOnly": true, + "description": "The amount of storage in bytes consumed by the index." + } + }, + "required": [ + "documentCount", + "storageSize" + ], + "description": "Statistics for a given index. Statistics are collected periodically and are not guaranteed to always be up-to-date." + }, + "ListIndexesResult": { + "properties": { + "value": { + "x-ms-client-name": "Indexes", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndex" + }, + "description": "The indexes in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List Indexes request. If successful, it includes the full definitions of all indexes." + }, + "SearchIndexerSkillset": { + "properties": { + "name": { + "type": "string", + "description": "The name of the skillset." + }, + "description": { + "type": "string", + "description": "The description of the skillset." + }, + "skills": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchIndexerSkill" + }, + "description": "A list of skills in the skillset." + }, + "cognitiveServices": { + "x-ms-client-name": "CognitiveServicesAccount", + "$ref": "#/definitions/CognitiveServicesAccount", + "description": "Details about cognitive services to be used when running skills." + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the skillset." + } + }, + "required": [ + "name", + "skills" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-tutorial-blob" + }, + "description": "A list of skills." + }, + "CognitiveServicesAccount": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the cognitive service resource attached to a skillset." + }, + "description": { + "type": "string", + "description": "Description of the cognitive service resource attached to a skillset." + } + }, + "required": [ + "@odata.type" + ], + "description": "Base type for describing any cognitive service resource attached to a skillset." + }, + "DefaultCognitiveServicesAccount": { + "description": "An empty object that represents the default cognitive service resource for a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.DefaultCognitiveServices", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ] + }, + "CognitiveServicesAccountKey": { + "description": "A cognitive service resource provisioned with a key that is attached to a skillset.", + "x-ms-discriminator-value": "#Microsoft.Azure.Search.CognitiveServicesByKey", + "allOf": [ + { + "$ref": "#/definitions/CognitiveServicesAccount" + } + ], + "properties": { + "key": { + "type": "string", + "description": "The key used to provision the cognitive service resource attached to a skillset." + } + }, + "required": [ + "key" + ] + }, + "SearchIndexerSkill": { + "discriminator": "@odata.type", + "properties": { + "@odata.type": { + "type": "string", + "description": "Identifies the concrete type of the skill." + }, + "name": { + "type": "string", + "description": "The name of the skill which uniquely identifies it within the skillset. A skill with no name defined will be given a default name of its 1-based index in the skills array, prefixed with the character '#'." + }, + "description": { + "type": "string", + "description": "The description of the skill which describes the inputs, outputs, and usage of the skill." + }, + "context": { + "type": "string", + "description": "Represents the level at which operations take place, such as the document root or document content (for example, /document or /document/content). The default is /document." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "Inputs of the skills could be a column in the source data set, or the output of an upstream skill." + }, + "outputs": { + "type": "array", + "items": { + "$ref": "#/definitions/OutputFieldMappingEntry" + }, + "description": "The output of a skill is either a field in a search index, or a value that can be consumed as an input by another skill." + } + }, + "required": [ + "@odata.type", + "inputs", + "outputs" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-predefined-skills" + }, + "description": "Base type for skills." + }, + "InputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the input." + }, + "source": { + "type": "string", + "description": "The source of the input." + }, + "sourceContext": { + "type": "string", + "description": "The source context used for selecting recursive inputs." + }, + "inputs": { + "type": "array", + "items": { + "$ref": "#/definitions/InputFieldMappingEntry" + }, + "description": "The recursive inputs used when creating a complex type." + } + }, + "required": [ + "name" + ], + "description": "Input field mapping for a skill." + }, + "OutputFieldMappingEntry": { + "properties": { + "name": { + "type": "string", + "description": "The name of the output defined by the skill." + }, + "targetName": { + "type": "string", + "description": "The target name of the output. It is optional and default to name." + } + }, + "required": [ + "name" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/naming-rules" + }, + "description": "Output field mapping for a skill." + }, + "ConditionalSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ConditionalSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-conditional" + }, + "description": "A skill that enables scenarios that require a Boolean operation to determine the data to assign to an output." + }, + "KeyPhraseExtractionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.KeyPhraseExtractionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/KeyPhraseExtractionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "maxKeyPhraseCount": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "A number indicating how many key phrases to return. If absent, all identified key phrases will be returned." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-keyphrases" + }, + "description": "A skill that uses text analytics for key phrase extraction." + }, + "OcrSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.OcrSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/OcrSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "detectOrientation": { + "x-ms-client-name": "ShouldDetectOrientation", + "type": "boolean", + "default": false, + "description": "A value indicating to turn orientation detection on or not. Default is false." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-ocr" + }, + "description": "A skill that extracts text from image files." + }, + "ImageAnalysisSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Vision.ImageAnalysisSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/ImageAnalysisSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "visualFeatures": { + "type": "array", + "items": { + "$ref": "#/definitions/VisualFeature", + "x-nullable": false + }, + "description": "A list of visual features." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/ImageDetail", + "x-nullable": false + }, + "description": "A string indicating which domain-specific details to return." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-image-analysis" + }, + "description": "A skill that analyzes image files. It extracts a rich set of visual features based on the image content." + }, + "LanguageDetectionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.LanguageDetectionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-language-detection" + }, + "description": "A skill that detects the language of input text and reports a single language code for every document submitted on the request. The language code is paired with a score indicating the confidence of the analysis." + }, + "ShaperSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Util.ShaperSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-shaper" + }, + "description": "A skill for reshaping the outputs. It creates a complex type to support composite fields (also known as multipart fields)." + }, + "MergeSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.MergeSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "insertPreTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the start of the merged text. By default, the tag is an empty space." + }, + "insertPostTag": { + "type": "string", + "default": " ", + "description": "The tag indicates the end of the merged text. By default, the tag is an empty space." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textmerger" + }, + "description": "A skill for merging two or more strings into a single unified string, with an optional user-defined delimiter separating each component part." + }, + "EntityRecognitionSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.EntityRecognitionSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/EntityCategory", + "x-nullable": false + }, + "description": "A list of entity categories that should be extracted." + }, + "defaultLanguageCode": { + "$ref": "#/definitions/EntityRecognitionSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "includeTypelessEntities": { + "type": "boolean", + "x-nullable": true, + "description": "Determines whether or not to include entities which are well known but don't conform to a pre-defined type. If this configuration is not set (default), set to null or set to false, entities which don't conform to one of the pre-defined types will not be surfaced." + }, + "minimumPrecision": { + "type": "number", + "format": "double", + "x-nullable": true, + "description": "A value between 0 and 1 that be used to only include entities whose confidence score is greater than the value specified. If not set (default), or if explicitly set to null, all entities will be included." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-entity-recognition" + }, + "description": "Text analytics entity recognition." + }, + "SentimentSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SentimentSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SentimentSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-sentiment" + }, + "description": "Text analytics positive-negative sentiment analysis, scored as a floating point value in a range of zero to 1." + }, + "SplitSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.SplitSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultLanguageCode": { + "$ref": "#/definitions/SplitSkillLanguage", + "description": "A value indicating which language code to use. Default is en." + }, + "textSplitMode": { + "$ref": "#/definitions/TextSplitMode", + "x-nullable": false, + "description": "A value indicating which split mode to perform." + }, + "maximumPageLength": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired maximum page length. Default is 10000." + } + }, + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-textsplit" + }, + "description": "A skill to split a string into chunks of text." + }, + "TextTranslationSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Text.TranslationSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "defaultToLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents into for documents that don't specify the to language explicitly. " + }, + "defaultFromLanguageCode": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents from for documents that don't specify the from language explicitly." + }, + "suggestedFrom": { + "$ref": "#/definitions/TextTranslationSkillLanguage", + "description": "The language code to translate documents from when neither the fromLanguageCode input nor the defaultFromLanguageCode parameter are provided, and the automatic language detection is unsuccessful. Default is en." + } + }, + "required": [ + "defaultToLanguageCode" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-skill-text-translation" + }, + "description": "A skill to translate text from one language to another." + }, + "WebApiSkill": { + "x-ms-discriminator-value": "#Microsoft.Skills.Custom.WebApiSkill", + "allOf": [ + { + "$ref": "#/definitions/SearchIndexerSkill" + } + ], + "properties": { + "uri": { + "type": "string", + "description": "The url for the Web API." + }, + "httpHeaders": { + "$ref": "#/definitions/WebApiHttpHeaders", + "description": "The headers required to make the http request." + }, + "httpMethod": { + "type": "string", + "description": "The method for the http request." + }, + "timeout": { + "type": "string", + "format": "duration", + "description": "The desired timeout for the request. Default is 30 seconds." + }, + "batchSize": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The desired batch size which indicates number of documents." + }, + "degreeOfParallelism": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "If set, the number of parallel calls that can be made to the Web API." + } + }, + "required": [ + "uri" + ], + "externalDocs": { + "url": "https://docs.microsoft.com/azure/search/cognitive-search-custom-skill-web-api" + }, + "description": "A skill that can call a Web API endpoint, allowing you to extend a skillset by having it call your custom code." + }, + "WebApiHttpHeaders": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "A dictionary of http request headers." + }, + "ListSkillsetsResult": { + "properties": { + "value": { + "x-ms-client-name": "Skillsets", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SearchIndexerSkillset" + }, + "description": "The skillsets defined in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a list skillset request. If successful, it includes the full definitions of all skillsets." + }, + "TextSplitMode": { + "type": "string", + "enum": [ + "pages", + "sentences" + ], + "x-ms-enum": { + "name": "TextSplitMode", + "modelAsString": true, + "values": [ + { + "value": "pages", + "name": "Pages", + "description": "Split the text into individual pages." + }, + { + "value": "sentences", + "name": "Sentences", + "description": "Split the text into individual sentences." + } + ] + }, + "description": "A value indicating which split mode to perform." + }, + "VisualFeature": { + "type": "string", + "enum": [ + "adult", + "brands", + "categories", + "description", + "faces", + "objects", + "tags" + ], + "x-ms-enum": { + "name": "VisualFeature", + "modelAsString": true, + "values": [ + { + "value": "adult", + "name": "Adult", + "description": "Visual features recognized as adult persons." + }, + { + "value": "brands", + "name": "Brands", + "description": "Visual features recognized as commercial brands." + }, + { + "value": "categories", + "name": "Categories", + "description": "Categories." + }, + { + "value": "description", + "name": "Description", + "description": "Description." + }, + { + "value": "faces", + "name": "Faces", + "description": "Visual features recognized as people faces." + }, + { + "value": "objects", + "name": "Objects", + "description": "Visual features recognized as objects." + }, + { + "value": "tags", + "name": "Tags", + "description": "Tags." + } + ] + }, + "description": "The strings indicating what visual feature types to return." + }, + "ImageDetail": { + "type": "string", + "enum": [ + "celebrities", + "landmarks" + ], + "x-ms-enum": { + "name": "ImageDetail", + "modelAsString": true, + "values": [ + { + "value": "celebrities", + "name": "Celebrities", + "description": "Details recognized as celebrities." + }, + { + "value": "landmarks", + "name": "Landmarks", + "description": "Details recognized as landmarks." + } + ] + }, + "description": "A string indicating which domain-specific details to return." + }, + "EntityCategory": { + "type": "string", + "enum": [ + "location", + "organization", + "person", + "quantity", + "datetime", + "url", + "email" + ], + "x-ms-enum": { + "name": "EntityCategory", + "modelAsString": true, + "values": [ + { + "value": "location", + "name": "Location", + "description": "Entities describing a physical location." + }, + { + "value": "organization", + "name": "Organization", + "description": "Entities describing an organization." + }, + { + "value": "person", + "name": "Person", + "description": "Entities describing a person." + }, + { + "value": "quantity", + "name": "Quantity", + "description": "Entities describing a quantity." + }, + { + "value": "datetime", + "name": "Datetime", + "description": "Entities describing a date and time." + }, + { + "value": "url", + "name": "Url", + "description": "Entities describing a URL." + }, + { + "value": "email", + "name": "Email", + "description": "Entities describing an email address." + } + ] + }, + "description": "A string indicating what entity categories to return." + }, + "SentimentSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "it", + "no", + "pl", + "pt-PT", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "SentimentSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "The language codes supported for input text by SentimentSkill." + }, + "KeyPhraseExtractionSkillLanguage": { + "type": "string", + "enum": [ + "da", + "nl", + "en", + "fi", + "fr", + "de", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv" + ], + "x-ms-enum": { + "name": "KeyPhraseExtractionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + } + ] + }, + "description": "The language codes supported for input text by KeyPhraseExtractionSkill." + }, + "OcrSkillLanguage": { + "type": "string", + "enum": [ + "zh-Hans", + "zh-Hant", + "cs", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "nb", + "pl", + "pt", + "ru", + "es", + "sv", + "tr", + "ar", + "ro", + "sr-Cyrl", + "sr-Latn", + "sk" + ], + "x-ms-enum": { + "name": "OcrSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "zh-Hans", + "description": "Chinese-Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese-Traditional" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "nb", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic, Serbia)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin, Serbia)" + }, + { + "value": "sk", + "description": "Slovak" + } + ] + }, + "description": "The language codes supported for input by OcrSkill." + }, + "SplitSkillLanguage": { + "type": "string", + "enum": [ + "da", + "de", + "en", + "es", + "fi", + "fr", + "it", + "ko", + "pt" + ], + "x-ms-enum": { + "name": "SplitSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "da", + "description": "Danish" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "pt", + "description": "Portuguese" + } + ] + }, + "description": "The language codes supported for input text by SplitSkill." + }, + "EntityRecognitionSkillLanguage": { + "type": "string", + "enum": [ + "ar", + "cs", + "zh-Hans", + "zh-Hant", + "da", + "nl", + "en", + "fi", + "fr", + "de", + "el", + "hu", + "it", + "ja", + "ko", + "no", + "pl", + "pt-PT", + "pt-BR", + "ru", + "es", + "sv", + "tr" + ], + "x-ms-enum": { + "name": "EntityRecognitionSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "zh-Hans", + "description": "Chinese-Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese-Traditional" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "no", + "description": "Norwegian (Bokmaal)" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt-PT", + "description": "Portuguese (Portugal)" + }, + { + "value": "pt-BR", + "description": "Portuguese (Brazil)" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "tr", + "description": "Turkish" + } + ] + }, + "description": "The language codes supported for input text by EntityRecognitionSkill." + }, + "TextTranslationSkillLanguage": { + "type": "string", + "enum": [ + "af", + "ar", + "bn", + "bs", + "bg", + "yue", + "ca", + "zh-Hans", + "zh-Hant", + "hr", + "cs", + "da", + "nl", + "en", + "et", + "fj", + "fil", + "fi", + "fr", + "de", + "el", + "ht", + "he", + "hi", + "mww", + "hu", + "is", + "id", + "it", + "ja", + "sw", + "tlh", + "ko", + "lv", + "lt", + "mg", + "ms", + "mt", + "nb", + "fa", + "pl", + "pt", + "otq", + "ro", + "ru", + "sm", + "sr-Cyrl", + "sr-Latn", + "sk", + "sl", + "es", + "sv", + "ty", + "ta", + "te", + "th", + "to", + "tr", + "uk", + "ur", + "vi", + "cy", + "yua" + ], + "x-ms-enum": { + "name": "TextTranslationSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "af", + "description": "Afrikaans" + }, + { + "value": "ar", + "description": "Arabic" + }, + { + "value": "bn", + "description": "Bangla" + }, + { + "value": "bs", + "description": "Bosnian (Latin)" + }, + { + "value": "bg", + "description": "Bulgarian" + }, + { + "value": "yue", + "description": "Cantonese (Traditional)" + }, + { + "value": "ca", + "description": "Catalan" + }, + { + "value": "zh-Hans", + "description": "Chinese Simplified" + }, + { + "value": "zh-Hant", + "description": "Chinese Traditional" + }, + { + "value": "hr", + "description": "Croatian" + }, + { + "value": "cs", + "description": "Czech" + }, + { + "value": "da", + "description": "Danish" + }, + { + "value": "nl", + "description": "Dutch" + }, + { + "value": "en", + "description": "English" + }, + { + "value": "et", + "description": "Estonian" + }, + { + "value": "fj", + "description": "Fijian" + }, + { + "value": "fil", + "description": "Filipino" + }, + { + "value": "fi", + "description": "Finnish" + }, + { + "value": "fr", + "description": "French" + }, + { + "value": "de", + "description": "German" + }, + { + "value": "el", + "description": "Greek" + }, + { + "value": "ht", + "description": "Haitian Creole" + }, + { + "value": "he", + "description": "Hebrew" + }, + { + "value": "hi", + "description": "Hindi" + }, + { + "value": "mww", + "description": "Hmong Daw" + }, + { + "value": "hu", + "description": "Hungarian" + }, + { + "value": "is", + "description": "Icelandic" + }, + { + "value": "id", + "description": "Indonesian" + }, + { + "value": "it", + "description": "Italian" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "sw", + "description": "Kiswahili" + }, + { + "value": "tlh", + "description": "Klingon" + }, + { + "value": "ko", + "description": "Korean" + }, + { + "value": "lv", + "description": "Latvian" + }, + { + "value": "lt", + "description": "Lithuanian" + }, + { + "value": "mg", + "description": "Malagasy" + }, + { + "value": "ms", + "description": "Malay" + }, + { + "value": "mt", + "description": "Maltese" + }, + { + "value": "nb", + "description": "Norwegian" + }, + { + "value": "fa", + "description": "Persian" + }, + { + "value": "pl", + "description": "Polish" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "otq", + "description": "Queretaro Otomi" + }, + { + "value": "ro", + "description": "Romanian" + }, + { + "value": "ru", + "description": "Russian" + }, + { + "value": "sm", + "description": "Samoan" + }, + { + "value": "sr-Cyrl", + "description": "Serbian (Cyrillic)" + }, + { + "value": "sr-Latn", + "description": "Serbian (Latin)" + }, + { + "value": "sk", + "description": "Slovak" + }, + { + "value": "sl", + "description": "Slovenian" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "sv", + "description": "Swedish" + }, + { + "value": "ty", + "description": "Tahitian" + }, + { + "value": "ta", + "description": "Tamil" + }, + { + "value": "te", + "description": "Telugu" + }, + { + "value": "th", + "description": "Thai" + }, + { + "value": "to", + "description": "Tongan" + }, + { + "value": "tr", + "description": "Turkish" + }, + { + "value": "uk", + "description": "Ukrainian" + }, + { + "value": "ur", + "description": "Urdu" + }, + { + "value": "vi", + "description": "Vietnamese" + }, + { + "value": "cy", + "description": "Welsh" + }, + { + "value": "yua", + "description": "Yucatec Maya" + } + ] + }, + "description": "The language codes supported for input text by TextTranslationSkill." + }, + "ImageAnalysisSkillLanguage": { + "type": "string", + "enum": [ + "en", + "es", + "ja", + "pt", + "zh" + ], + "x-ms-enum": { + "name": "ImageAnalysisSkillLanguage", + "modelAsString": true, + "values": [ + { + "value": "en", + "description": "English" + }, + { + "value": "es", + "description": "Spanish" + }, + { + "value": "ja", + "description": "Japanese" + }, + { + "value": "pt", + "description": "Portuguese" + }, + { + "value": "zh", + "description": "Chinese" + } + ] + }, + "description": "The language codes supported for input by ImageAnalysisSkill." + }, + "SynonymMap": { + "properties": { + "name": { + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Naming-rules" + }, + "type": "string", + "description": "The name of the synonym map." + }, + "format": { + "type": "string", + "enum": [ + "solr" + ], + "x-ms-enum": { + "name": "SynonymMapFormat", + "modelAsString": false, + "values": [ + { + "value": "solr", + "name": "Solr", + "description": "Selects the SOLR format for synonym maps." + } + ] + }, + "description": "The format of the synonym map. Only the 'solr' format is currently supported." + }, + "synonyms": { + "type": "string", + "description": "A series of synonym rules in the specified synonym map format. The rules must be separated by newlines.", + "externalDocs": { + "url": "https://docs.microsoft.com/rest/api/searchservice/Create-Synonym-Map#SynonymMapFormat" + } + }, + "encryptionKey": { + "$ref": "#/definitions/SearchResourceEncryptionKey", + "description": "A description of an encryption key that you create in Azure Key Vault. This key is used to provide an additional level of encryption-at-rest for your data when you want full assurance that no one, not even Microsoft, can decrypt your data in Azure Cognitive Search. Once you have encrypted your data, it will always remain encrypted. Azure Cognitive Search will ignore attempts to set this property to null. You can change this property as needed if you want to rotate your encryption key; Your data will be unaffected. Encryption with customer-managed keys is not available for free search services, and is only available for paid services created on or after January 1, 2019.", + "externalDocs": { + "url": "https://aka.ms/azure-search-encryption-with-cmk" + } + }, + "@odata.etag": { + "x-ms-client-name": "ETag", + "type": "string", + "description": "The ETag of the synonym map." + } + }, + "required": [ + "name", + "format", + "synonyms" + ], + "description": "Represents a synonym map definition." + }, + "ListSynonymMapsResult": { + "properties": { + "value": { + "x-ms-client-name": "SynonymMaps", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SynonymMap" + }, + "description": "The synonym maps in the Search service." + } + }, + "required": [ + "value" + ], + "description": "Response from a List SynonymMaps request. If successful, it includes the full definitions of all synonym maps." + }, + "SearchResourceEncryptionKey": { + "properties": { + "keyVaultKeyName": { + "x-ms-client-name": "keyName", + "type": "string", + "description": "The name of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultKeyVersion": { + "x-ms-client-name": "keyVersion", + "type": "string", + "description": "The version of your Azure Key Vault key to be used to encrypt your data at rest." + }, + "keyVaultUri": { + "x-ms-client-name": "vaultUri", + "type": "string", + "description": "The URI of your Azure Key Vault, also referred to as DNS name, that contains the key to be used to encrypt your data at rest. An example URI might be https://my-keyvault-name.vault.azure.net." + }, + "accessCredentials": { + "$ref": "#/definitions/AzureActiveDirectoryApplicationCredentials", + "description": "Optional Azure Active Directory credentials used for accessing your Azure Key Vault. Not required if using managed identity instead.", + "externalDocs": { + "url": "https://aka.ms/azure-search-msi" + } + } + }, + "required": [ + "keyVaultKeyName", + "keyVaultKeyVersion", + "keyVaultUri" + ], + "description": "A customer-managed encryption key in Azure Key Vault. Keys that you create and manage can be used to encrypt or decrypt data-at-rest in Azure Cognitive Search, such as indexes and synonym maps." + }, + "AzureActiveDirectoryApplicationCredentials": { + "properties": { + "applicationId": { + "type": "string", + "description": "An AAD Application ID that was granted the required access permissions to the Azure Key Vault that is to be used when encrypting your data at rest. The Application ID should not be confused with the Object ID for your AAD Application." + }, + "applicationSecret": { + "type": "string", + "description": "The authentication key of the specified AAD application." + } + }, + "required": [ + "applicationId" + ], + "description": "Credentials of a registered application created for your search service, used for authenticated access to the encryption keys stored in Azure Key Vault." + }, + "ServiceStatistics": { + "properties": { + "counters": { + "$ref": "#/definitions/ServiceCounters", + "description": "Service level resource counters." + }, + "limits": { + "$ref": "#/definitions/ServiceLimits", + "description": "Service level general limits." + } + }, + "required": [ + "counters", + "limits" + ], + "description": "Response from a get service statistics request. If successful, it includes service level counters and limits." + }, + "ServiceCounters": { + "properties": { + "documentCount": { + "x-ms-client-name": "documentCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of documents across all indexes in the service." + }, + "indexesCount": { + "x-ms-client-name": "indexCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexes." + }, + "indexersCount": { + "x-ms-client-name": "indexerCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of indexers." + }, + "dataSourcesCount": { + "x-ms-client-name": "dataSourceCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of data sources." + }, + "storageSize": { + "x-ms-client-name": "storageSizeCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total size of used storage in bytes." + }, + "synonymMaps": { + "x-ms-client-name": "synonymMapCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of synonym maps." + }, + "skillsetCount": { + "x-ms-client-name": "skillsetCounter", + "$ref": "#/definitions/ResourceCounter", + "description": "Total number of skillsets." + } + }, + "required": [ + "documentCount", + "indexesCount", + "indexersCount", + "dataSourcesCount", + "storageSize", + "synonymMaps", + "skillsetCount" + ], + "description": "Represents service-level resource counters and quotas." + }, + "ServiceLimits": { + "properties": { + "maxFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum allowed fields per index." + }, + "maxFieldNestingDepthPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum depth which you can nest sub-fields in an index, including the top-level complex field. For example, a/b/c has a nesting depth of 3." + }, + "maxComplexCollectionFieldsPerIndex": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of fields of type Collection(Edm.ComplexType) allowed in an index." + }, + "maxComplexObjectsInCollectionsPerDocument": { + "type": "integer", + "format": "int32", + "x-nullable": true, + "description": "The maximum number of objects in complex collections allowed per document." + } + }, + "description": "Represents various service level limits." + }, + "ResourceCounter": { + "properties": { + "usage": { + "type": "integer", + "format": "int64", + "x-nullable": false, + "description": "The resource usage amount." + }, + "quota": { + "type": "integer", + "format": "int64", + "x-nullable": true, + "description": "The resource amount quota." + } + }, + "required": [ + "usage" + ], + "description": "Represents a resource's usage and quota." + }, + "SearchError": { + "properties": { + "code": { + "type": "string", + "readOnly": true, + "description": "One of a server-defined set of error codes." + }, + "message": { + "type": "string", + "readOnly": true, + "description": "A human-readable representation of the error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/SearchError" + }, + "readOnly": true, + "description": "An array of details about specific errors that led to this reported error." + } + }, + "required": [ + "message" + ], + "description": "Describes an error condition for the Azure Cognitive Search API." + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ClientRequestIdParameter": { + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "format": "uuid", + "description": "The tracking ID sent with the request to help with debugging.", + "x-ms-client-request-id": true, + "x-ms-parameter-grouping": { + "name": "request-options" + }, + "x-ms-parameter-location": "method" + }, + "IfMatchParameter": { + "name": "If-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-Match condition. The operation will be performed only if the ETag on the server matches this value.", + "x-ms-parameter-location": "method" + }, + "IfNoneMatchParameter": { + "name": "If-None-Match", + "in": "header", + "required": false, + "type": "string", + "description": "Defines the If-None-Match condition. The operation will be performed only if the ETag on the server does not match this value.", + "x-ms-parameter-location": "method" + }, + "PreferHeaderParameter": { + "name": "Prefer", + "in": "header", + "required": true, + "type": "string", + "enum": [ + "return=representation" + ], + "description": "For HTTP PUT requests, instructs the service to return the created/updated resource on success.", + "x-ms-parameter-location": "method" + }, + "EndpointParameter": { + "name": "endpoint", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "description": "The endpoint URL of the search service.", + "x-ms-parameter-location": "client" + } + } +} diff --git a/specification/search/data-plane/Azure.Search/readme.md b/specification/search/data-plane/Azure.Search/readme.md index 3d2cb4bc6377..82139a0477fb 100644 --- a/specification/search/data-plane/Azure.Search/readme.md +++ b/specification/search/data-plane/Azure.Search/readme.md @@ -26,6 +26,180 @@ These are the global settings for SearchServiceClient and SearchIndexClient. title: SearchClient opt-in-extensible-enums: true openapi-type: data-plane + +directive: + - where: + - $.definitions.AnalyzedTokenInfo.properties.endOffset + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.AnalyzedTokenInfo.properties.position + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.AnalyzedTokenInfo.properties.startOffset + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.AnalyzedTokenInfo.properties.token + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.AutocompleteItem.properties.queryPlusText + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.AutocompleteItem.properties.text + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.AutocompleteResult.properties.value + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.GetIndexStatisticsResult.properties.documentCount + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.GetIndexStatisticsResult.properties.storageSize + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.IndexDocumentsResult.properties.value + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.IndexerExecutionResult.properties.errors + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.IndexerExecutionResult.properties.itemsFailed + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.IndexerExecutionResult.properties.itemsProcessed + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.IndexerExecutionResult.properties.status + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.IndexerExecutionResult.properties.warnings + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.IndexingResult.properties.key + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.IndexingResult.properties.status + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.IndexingResult.properties.statusCode + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.ListDataSourcesResult.properties.value + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.ListIndexersResult.properties.value + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.ListIndexesResult.properties.value + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.ListSkillsetsResult.properties.value + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.ListSynonymMapsResult.properties.value + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SearchDocumentsResult.properties.value + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SearchError.properties.message + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SearchIndexerError.properties.errorMessage + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SearchIndexerError.properties.statusCode + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SearchIndexerStatus.properties.executionHistory + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SearchIndexerStatus.properties.limits + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SearchIndexerStatus.properties.status + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SearchIndexerWarning.properties.message + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SearchResult.properties["@search.score"] + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SuggestDocumentsResult.properties.value + suppress: + - RequiredReadOnlyProperties + - where: + - $.definitions.SuggestResult.properties["@search.text"] + suppress: + - RequiredReadOnlyProperties +``` + +### Tag: package-2020-06-searchservice-preview + +These settings apply only when `--tag=package-2020-06-searchservice-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06-searchservice-preview' +input-file: +- preview/2020-06-30-Preview/searchservice.json +``` + +### Tag: package-2020-06-searchindex-preview + +These settings apply only when `--tag=package-2020-06-searchindex-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06-searchindex-preview' +input-file: +- preview/2020-06-30-Preview/searchindex.json +``` + +### Tag: package-2020-06-searchservice + +These settings apply only when `--tag=package-2020-06-searchservice` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06-searchservice' +input-file: +- preview/2020-06-30/searchservice.json +``` + +### Tag: package-2020-06-searchindex + +These settings apply only when `--tag=package-2020-06-searchindex` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06-searchindex' +input-file: +- preview/2020-06-30/searchindex.json ``` ### Tag: package-2019-05-searchservice-preview @@ -545,10 +719,10 @@ require: $(this-folder)/../../../../profiles/readme.md # all the input files across all versions input-file: - - $(this-folder)/preview/2019-05-06-preview/searchservice.json - - $(this-folder)/preview/2019-05-06-preview/searchindex.json - - $(this-folder)/stable/2019-05-06/searchservice.json - - $(this-folder)/stable/2019-05-06/searchindex.json + - $(this-folder)/preview/2020-06-30-Preview/searchservice.json + - $(this-folder)/preview/2020-06-30-Preview/searchindex.json + - $(this-folder)/preview/2020-06-30/searchservice.json + - $(this-folder)/preview/2020-06-30/searchindex.json ``` From 5e3fc2effd40724654b4920a78e807d6fab7f735 Mon Sep 17 00:00:00 2001 From: Anirban Sarkar <33848291+asarkar84@users.noreply.github.com> Date: Wed, 24 Jun 2020 19:02:21 -0700 Subject: [PATCH 198/318] Removing read only property to allow update operations as per the actual implementation (#9874) * Correcting the swagger to accept downloadToken similar to other download operations Correcting the swagger to accept downloadToken similar to other download operations * Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. * Removing reonly property to allow update operations Removing reonly property to allow update operations Co-authored-by: Anirban Sarkar --- .../stable/2020-05-01/billing.json | 15 +++++---------- 1 file changed, 5 insertions(+), 10 deletions(-) diff --git a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json index 873581679036..410b96e9e49a 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/stable/2020-05-01/billing.json @@ -5689,18 +5689,15 @@ }, "principalId": { "description": "The principal id of the user to whom the role was assigned.", - "type": "string", - "readOnly": true + "type": "string" }, "principalTenantId": { "description": "The principal tenant id of the user to whom the role was assigned.", - "type": "string", - "readOnly": true + "type": "string" }, "roleDefinitionId": { "description": "The ID of the role definition.", - "type": "string", - "readOnly": true + "type": "string" }, "scope": { "description": "The scope at which the role was assigned.", @@ -5709,13 +5706,11 @@ }, "userAuthenticationType": { "description": "The authentication type.", - "type": "string", - "readOnly": true + "type": "string" }, "userEmailAddress": { "description": "The email address of the user.", - "type": "string", - "readOnly": true + "type": "string" } } }, From 0177103c83a85f025a7719dc130cf70fe910ec51 Mon Sep 17 00:00:00 2001 From: Meha Kaushik Date: Thu, 25 Jun 2020 01:18:17 -0700 Subject: [PATCH 199/318] Update CosmosDB codeowners (#9867) To get the users notified whenever a PR is created in CosmosDB --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index 3548df4fa2ef..a003a61b4135 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -15,7 +15,7 @@ /specification/containerinstance/ @novinc /specification/containerregistry/ @djyou /specification/containerservice/ @yangl900 -/specification/cosmos-db/ @dmakwana +/specification/cosmos-db/ @dmakwana @MehaKaushik @wmengmsft @shurd /specification/customer-insights/ @tjlvtao /specification/datafactory/ @zhangyd2015 /specification/datalake-analytics/ @ro-joowan From 496d55d8616e9f4172d3753459045b001762d39f Mon Sep 17 00:00:00 2001 From: Landon Smith Date: Thu, 25 Jun 2020 01:32:53 -0700 Subject: [PATCH 200/318] Add missing private link fields for CDN version 2020-04-15 (#9858) * Add missing private link fields for CDN version 2020-04-15. * Fix examples for CDN endpoint get, list, and update in 2020-04-15 * Fix CDN Endpoints_Update example. --- .../Microsoft.Cdn/stable/2020-04-15/cdn.json | 16 +++++++++++++++ .../2020-04-15/examples/Endpoints_Create.json | 20 +++++++++++++++---- .../2020-04-15/examples/Endpoints_Get.json | 5 ++++- .../examples/Endpoints_ListByProfile.json | 5 ++++- .../2020-04-15/examples/Endpoints_Update.json | 10 ++++++++-- 5 files changed, 48 insertions(+), 8 deletions(-) diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json index 72cf5b68f35b..5d621303e558 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json @@ -4227,6 +4227,22 @@ "enabled": { "description": "Origin is enabled for load balancing or not. By default, origin is always enabled.", "type": "boolean" + }, + "privateLinkAlias": { + "description": "The Alias of the Private Link resource. Populating this optional field indicates that this origin is 'Private'", + "type": "string" + }, + "privateLinkResourceId": { + "description": "The Resource Id of the Private Link resource. Populating this optional field indicates that this backend is 'Private'", + "type": "string" + }, + "privateLinkLocation": { + "description": "The location of the Private Link resource. Required only if 'privateLinkResourceId' is populated", + "type": "string" + }, + "privateLinkApprovalMessage": { + "description": "A custom message to be included in the approval request to connect to the Private Link.", + "type": "string" } }, "x-ms-azure-resource": true diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Create.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Create.json index 81fce9324123..90f9f58d5ccc 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Create.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Create.json @@ -86,7 +86,10 @@ "originHostHeader": "www.someDomain1.net", "priority": 1, "weight": 50, - "enabled": true + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" } }, { @@ -162,7 +165,10 @@ "originHostHeader": "www.someDomain1.net", "priority": 1, "weight": 50, - "enabled": true + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" } }, { @@ -298,7 +304,10 @@ "originHostHeader": "www.someDomain1.net", "priority": 1, "weight": 50, - "enabled": true + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" } }, { @@ -434,7 +443,10 @@ "originHostHeader": "www.someDomain1.net", "priority": 1, "weight": 50, - "enabled": true + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" } }, { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Get.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Get.json index 039687fc7b8d..07ce9e40f462 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Get.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Get.json @@ -33,7 +33,10 @@ "originHostHeader": "www.someDomain2.net", "priority": 2, "weight": 50, - "enabled": true + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" } } ], diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ListByProfile.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ListByProfile.json index f5cb3c0f6fe2..1dddea533433 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ListByProfile.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_ListByProfile.json @@ -34,7 +34,10 @@ "originHostHeader": "www.someDomain2.net", "priority": 2, "weight": 50, - "enabled": true + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" } } ], diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Update.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Update.json index bad861f930d3..2f2e1d04ca5c 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Update.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/examples/Endpoints_Update.json @@ -40,7 +40,10 @@ "originHostHeader": "www.someDomain2.net", "priority": 2, "weight": 50, - "enabled": true + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" } } ], @@ -101,7 +104,10 @@ "originHostHeader": "www.someDomain2.net", "priority": 2, "weight": 50, - "enabled": true + "enabled": true, + "privateLinkResourceId": "/subscriptions/subid/resourcegroups/rg1/providers/Microsoft.Network/privateLinkServices/pls1", + "privateLinkLocation": "eastus", + "privateLinkApprovalMessage": "Please approve the connection request for this Private Link" } } ], From 6cee4b53fc5632b224417d75169a1591b9fe2957 Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Thu, 25 Jun 2020 11:30:57 -0700 Subject: [PATCH 201/318] Swagger refactor, small addition (#9834) * Swagger refactor, small addition * Ran prettier * Adding custom word and fixing spelling mistake * Updates to the swagger * Removing empty objects * Removing x-ms-discriminators x4 * Also updated the iotcentralapps json * Ran prettier * Updating the README * Modifying readme again --- custom-words.txt | 1 + .../examples/devices_components_get.json | 31 + .../devices_modules_components_get.json | 26 + .../examples/devices_modules_get.json | 33 + .../2019-10-28-preview/iotcentral.json | 1846 +++++++++-------- .../2019-10-28-preview/iotcentralapps.json | 52 +- specification/iotcentral/data-plane/readme.md | 41 +- 7 files changed, 1115 insertions(+), 915 deletions(-) create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_components_get.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_modules_components_get.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_modules_get.json diff --git a/custom-words.txt b/custom-words.txt index ebb305ade177..9ca95409c6fe 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1748,6 +1748,7 @@ WGXM whitelisted Whitelisting Whitelistings +whitespaces Whois Widevine windowsazuremediaservices diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_components_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_components_get.json new file mode 100644 index 000000000000..8c1d95e58b49 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_components_get.json @@ -0,0 +1,31 @@ +{ + "title": "Get components from a device", + "description": "Get the list of components in a device.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain", + "device_id": "device1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@id": "", + "@type": [ + "InterfaceInstance" + ], + "name": "LocationTracking" + }, + { + "@id": "", + "@type": [ + "InterfaceInstance" + ], + "name": "EnvironmentSensing" + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_modules_components_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_modules_components_get.json new file mode 100644 index 000000000000..c43347e5aab8 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_modules_components_get.json @@ -0,0 +1,26 @@ +{ + "title": "Get components from a module in an Edge device", + "description": "Get a list of components from a module in an IoT Edge device.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain", + "device_id": "edgedevice1", + "module_name": "edgemodule" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@id": "", + "@type": [ + "InterfaceInstance" + ], + "name": "interfaceA", + "displayName": "InterfaceA" + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_modules_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_modules_get.json new file mode 100644 index 000000000000..06bfb2a01738 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/devices_modules_get.json @@ -0,0 +1,33 @@ +{ + "title": "Get modules from an Edge device", + "description": "Get the list of modules in an IoT Edge device.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain", + "device_id": "edgedevice1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "@id": "", + "@type": [ + "Relationship", + "SemanticType/EdgeModule" + ], + "name": "Environment" + }, + { + "@id": "", + "@type": [ + "Relationship", + "SemanticType/EdgeModule" + ], + "name": "Camera" + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json index b6f625803b3a..e6db1b5e77a2 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json @@ -5,6 +5,18 @@ "title": "Azure IoT Central", "description": "Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale." }, + "host": "apps.azureiotcentral.com", + "x-ms-parameterized-host": { + "hostTemplate": "{subdomain}.{centralDnsSuffixInPath}", + "parameters": [ + { + "$ref": "#/parameters/CentralDnsSuffixInPath" + }, + { + "$ref": "#/parameters/Subdomain" + } + ] + }, "basePath": "/api/preview", "schemes": [ "https" @@ -62,167 +74,6 @@ "value" ] }, - "Attestation": { - "type": "object", - "properties": { - "type": { - "description": "Type of the attestation.", - "type": "string" - } - }, - "required": [ - "type" - ], - "discriminator": "type" - }, - "SymmetricKeyAttestation": { - "x-ms-discriminator-value": "SymmetricKeyAttestation", - "allOf": [ - { - "$ref": "#/definitions/Attestation" - }, - { - "type": "object", - "properties": { - "symmetricKey": { - "description": "The symmetric key credentials for this attestation.", - "$ref": "#/definitions/SymmetricKey" - } - }, - "required": [ - "symmetricKey" - ] - } - ] - }, - "X509Attestation": { - "x-ms-discriminator-value": "X509Attestation", - "allOf": [ - { - "$ref": "#/definitions/Attestation" - }, - { - "type": "object", - "properties": { - "x509": { - "description": "The X.509 credentials for this attestation.", - "$ref": "#/definitions/X509" - } - }, - "required": [ - "x509" - ] - } - ] - }, - "TpmAttestation": { - "x-ms-discriminator-value": "TpmAttestation", - "allOf": [ - { - "$ref": "#/definitions/Attestation" - }, - { - "type": "object", - "properties": { - "tpm": { - "description": "The TPM credentials for this attestation.", - "$ref": "#/definitions/Tpm" - } - }, - "required": [ - "tpm" - ] - } - ] - }, - "ObjectSchema": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - }, - { - "type": "object", - "properties": { - "fields": { - "description": "The property fields of this object type.", - "type": "array", - "items": { - "$ref": "#/definitions/SchemaField" - } - } - }, - "required": [ - "fields" - ] - } - ] - }, - "EnumSchema": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - }, - { - "type": "object", - "properties": { - "valueSchema": { - "description": "The schema for values of this enum type." - }, - "enumValues": { - "description": "The discreet named values of this enum type.", - "type": "array", - "items": { - "$ref": "#/definitions/EnumValue" - } - } - }, - "required": [ - "valueSchema", - "enumValues" - ] - } - ] - }, - "EnumValue": { - "allOf": [ - { - "$ref": "#/definitions/NamedEntity" - }, - { - "type": "object", - "properties": { - "enumValue": { - "description": "The resolved value of this enum entry." - } - }, - "required": [ - "enumValue" - ] - } - ] - }, - "MapSchema": { - "allOf": [ - { - "$ref": "#/definitions/Entity" - }, - { - "type": "object", - "properties": { - "mapKey": { - "description": "The schema for keys of this map type." - }, - "mapValue": { - "description": "The schema for values of this map type." - } - }, - "required": [ - "mapKey", - "mapValue" - ] - } - ] - }, "ArraySchema": { "allOf": [ { @@ -241,31 +92,18 @@ } ] }, - "SchemaField": { - "allOf": [ - { - "$ref": "#/definitions/NamedEntity" - }, - { - "type": "object", - "properties": { - "schema": { - "description": "The schema of this field." - }, - "displayUnit": { - "description": "The display name of the unit of this field.", - "type": "string" - }, - "unit": { - "description": "The unit of this field.", - "type": "string" - } - }, - "required": [ - "schema" - ] + "Attestation": { + "type": "object", + "properties": { + "type": { + "description": "Type of the attestation.", + "type": "string" } - ] + }, + "required": [ + "type" + ], + "discriminator": "type" }, "Capability": { "allOf": [ @@ -285,18 +123,9 @@ "unit": { "description": "The unit of this field.", "type": "string" - } - } - }, - { - "type": "object", - "properties": { + }, "commandType": { "description": "The call pattern of this command.", - "x-ms-enum": { - "name": "CommandTypes", - "modelAsString": true - }, "type": "string", "enum": [ "synchronous", @@ -310,21 +139,11 @@ "response": { "description": "The response definition for this command.", "$ref": "#/definitions/SchemaField" - } - } - }, - { - "type": "object", - "properties": { + }, "writable": { "description": "Whether this property is writable.", "type": "boolean" - } - } - }, - { - "type": "object", - "properties": { + }, "target": { "description": "The target capability models for this relationship.", "type": "array", @@ -339,111 +158,65 @@ } ] }, - "Interface": { + "CapabilityModel": { "allOf": [ { - "$ref": "#/definitions/Entity" + "$ref": "#/definitions/Interface" }, { "type": "object", "properties": { - "contents": { - "description": "The data definitions contained by the interface.", + "implements": { + "description": "The component implemented by the capability model.", "type": "array", "items": { - "$ref": "#/definitions/Capability" + "$ref": "#/definitions/Component" } } } } ] }, - "Component": { + "CapabilityReference": { "allOf": [ { - "$ref": "#/definitions/NamedEntity" + "$ref": "#/definitions/Entity" }, { "type": "object", "properties": { - "schema": { - "description": "The interface used by this component.", - "$ref": "#/definitions/Interface" + "component": { + "description": "The name of the component being referenced.", + "type": "string" + }, + "reference": { + "description": "The name of the capability being referenced.", + "type": "string" } }, "required": [ - "schema" + "component", + "reference" ] } ] }, - "CapabilityModel": { + "Component": { "allOf": [ { - "$ref": "#/definitions/Interface" + "$ref": "#/definitions/NamedEntity" }, { "type": "object", "properties": { - "implements": { - "description": "The component implemented by the capability model.", - "type": "array", - "items": { - "$ref": "#/definitions/Component" - } + "schema": { + "description": "The interface used by this component.", + "$ref": "#/definitions/Interface" } - } - } - ] - }, - "Endpoint": { - "type": "object", - "properties": { - "type": { - "description": "Type of the endpoint.", - "type": "string" - }, - "connectionString": { - "description": "Information for connecting to the endpoint.", - "type": "string" - }, - "name": { - "description": "Name of the entity to send data to.", - "type": "string" - } - }, - "required": [ - "type", - "connectionString", - "name" - ], - "discriminator": "type" - }, - "StorageEndpoint": { - "allOf": [ - { - "$ref": "#/definitions/Endpoint" - } - ] - }, - "EventHubsEndpoint": { - "allOf": [ - { - "$ref": "#/definitions/Endpoint" - } - ] - }, - "ServiceBusQueueEndpoint": { - "allOf": [ - { - "$ref": "#/definitions/Endpoint" - } - ] - }, - "ServiceBusTopicEndpoint": { - "allOf": [ - { - "$ref": "#/definitions/Endpoint" + }, + "required": [ + "schema" + ] } ] }, @@ -554,6 +327,11 @@ } } }, + "DeviceCloudProperties": { + "description": "Cloud property values associated with the device.", + "type": "object", + "additionalProperties": true + }, "DeviceCollection": { "type": "object", "properties": { @@ -573,11 +351,6 @@ "value" ] }, - "DeviceCloudProperties": { - "description": "Cloud property values associated with the device.", - "additionalProperties": true, - "type": "object" - }, "DeviceCommand": { "type": "object", "properties": { @@ -645,7 +418,8 @@ }, "DeviceProperties": { "description": "Property values associated with the device.", - "type": "object" + "type": "object", + "additionalProperties": true }, "DeviceTelemetry": { "type": "object", @@ -720,88 +494,28 @@ "value" ] }, - "SymmetricKey": { - "type": "object", - "properties": { - "primaryKey": { - "description": "The primary key for this credential.", - "type": "string" - }, - "secondaryKey": { - "description": "The secondary key for this credential.", - "type": "string" - } - }, - "required": [ - "primaryKey", - "secondaryKey" - ] - }, - "Tpm": { + "Endpoint": { "type": "object", "properties": { - "endorsementKey": { - "description": "The TPM endorsement key for this credential.", + "type": { + "description": "Type of the endpoint.", "type": "string" - } - }, - "required": [ - "endorsementKey" - ] - }, - "X509": { - "type": "object", - "properties": { - "clientCertificates": { - "description": "The X.509 client certificates for this credential.", - "$ref": "#/definitions/X509Certificates" - } - }, - "required": [ - "clientCertificates" - ] - }, - "X509Certificates": { - "type": "object", - "properties": { - "primary": { - "description": "The primary X.509 certificate for this credential.", - "$ref": "#/definitions/X509Certificate" }, - "secondary": { - "description": "The secondary X.509 certificate for this credential.", - "$ref": "#/definitions/X509Certificate" - } - }, - "required": [ - "primary" - ] - }, - "X509Certificate": { - "type": "object", - "properties": { - "certificate": { - "description": "The string representation of this certificate.", + "connectionString": { + "description": "Information for connecting to the endpoint.", "type": "string" }, - "info": { - "description": "Information about this certificate.", - "readOnly": true, - "$ref": "#/definitions/X509CertificateInfo" - } - } - }, - "X509CertificateInfo": { - "type": "object", - "properties": { - "sha1Thumbprint": { - "description": "The SHA-1 hash value of the certificate.", + "name": { + "description": "Name of the entity to send data to.", "type": "string" } }, "required": [ - "sha1Thumbprint" - ] + "type", + "connectionString", + "name" + ], + "discriminator": "type" }, "Entity": { "type": "object", @@ -838,7 +552,7 @@ "@type" ] }, - "NamedEntity": { + "EnumSchema": { "allOf": [ { "$ref": "#/definitions/Entity" @@ -846,68 +560,73 @@ { "type": "object", "properties": { - "name": { - "description": "The programmatic name of the named entity.", - "type": "string" + "valueSchema": { + "description": "The schema for values of this enum type." + }, + "enumValues": { + "description": "The discreet named values of this enum type.", + "type": "array", + "items": { + "$ref": "#/definitions/EnumValue" + } } }, "required": [ - "name" + "valueSchema", + "enumValues" ] } ] }, - "Permission": { - "type": "object", - "properties": { - "roles": { - "description": "List of role IDs that specify the permissions to access the application.", - "type": "array", - "items": { - "type": "string" + "EnumValue": { + "allOf": [ + { + "$ref": "#/definitions/NamedEntity" + }, + { + "type": "object", + "properties": { + "enumValue": { + "description": "The resolved value of this enum entry." + } }, - "minItems": 1, - "maxItems": 1 + "required": [ + "enumValue" + ] } - }, - "required": [ - "roles" ] }, - "Role": { - "type": "object", - "properties": { - "id": { - "description": "Unique ID of the role.", - "type": "string", - "readOnly": true - }, - "displayName": { - "description": "Display name of the role.", - "type": "string" + "EventHubsEndpoint": { + "allOf": [ + { + "$ref": "#/definitions/Endpoint" } - } + ] }, - "RoleCollection": { - "type": "object", - "properties": { - "value": { - "description": "The collection of roles.", - "type": "array", - "items": { - "$ref": "#/definitions/Role" - } + "InitialValue": { + "allOf": [ + { + "$ref": "#/definitions/Entity" }, - "nextLink": { - "description": "URL to get the next page of roles.", - "type": "string" + { + "type": "object", + "properties": { + "capability": { + "description": "The reference to the capability for which an initial value is being provided.", + "$ref": "#/definitions/CapabilityReference" + }, + "value": { + "description": "The initial value of the capability." + } + }, + "required": [ + "capability", + "value" + ] } - }, - "required": [ - "value" ] }, - "SolutionModel": { + "Interface": { "allOf": [ { "$ref": "#/definitions/Entity" @@ -915,32 +634,18 @@ { "type": "object", "properties": { - "cloudProperties": { - "description": "The cloud properties defined by the solution model.", + "contents": { + "description": "The data definitions contained by the interface.", "type": "array", "items": { "$ref": "#/definitions/Capability" } - }, - "initialValues": { - "description": "The initial values defined by the solution model.", - "type": "array", - "items": { - "$ref": "#/definitions/InitialValue" - } - }, - "overrides": { - "description": "The overrides defined by the solution model.", - "type": "array", - "items": { - "$ref": "#/definitions/Override" - } } } } ] }, - "InitialValue": { + "MapSchema": { "allOf": [ { "$ref": "#/definitions/Entity" @@ -948,17 +653,76 @@ { "type": "object", "properties": { - "capability": { - "description": "The reference to the capability for which an initial value is being provided.", - "$ref": "#/definitions/CapabilityReference" + "mapKey": { + "description": "The schema for keys of this map type." }, - "value": { - "description": "The initial value of the capability." + "mapValue": { + "description": "The schema for values of this map type." } }, "required": [ - "capability", - "value" + "mapKey", + "mapValue" + ] + } + ] + }, + "NamedEntity": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + }, + { + "type": "object", + "properties": { + "name": { + "description": "The programmatic name of the named entity.", + "type": "string" + } + }, + "required": [ + "name" + ] + } + ] + }, + "NamedEntityCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of named entities.", + "type": "array", + "items": { + "$ref": "#/definitions/NamedEntity" + } + }, + "nextLink": { + "description": "URL to get the next page of named entities.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "ObjectSchema": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + }, + { + "type": "object", + "properties": { + "fields": { + "description": "The property fields of this object type.", + "type": "array", + "items": { + "$ref": "#/definitions/SchemaField" + } + } + }, + "required": [ + "fields" ] } ] @@ -998,54 +762,233 @@ } ] }, - "ValueDetail": { + "Permission": { + "type": "object", + "properties": { + "roles": { + "description": "List of role IDs that specify the permissions to access the application.", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "roles" + ] + }, + "Role": { + "type": "object", + "properties": { + "id": { + "description": "Unique ID of the role.", + "type": "string", + "readOnly": true + }, + "displayName": { + "description": "Display name of the role.", + "type": "string" + } + } + }, + "RoleCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of roles.", + "type": "array", + "items": { + "$ref": "#/definitions/Role" + } + }, + "nextLink": { + "description": "URL to get the next page of roles.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, + "SchemaField": { "allOf": [ { - "$ref": "#/definitions/Entity" + "$ref": "#/definitions/NamedEntity" }, { "type": "object", "properties": { - "falseName": { - "description": "The string representation of a false value.", + "schema": { + "description": "The schema of this field." + }, + "displayUnit": { + "description": "The display name of the unit of this field.", "type": "string" }, - "trueName": { - "description": "The string representation of a true value.", + "unit": { + "description": "The unit of this field.", "type": "string" } - } + }, + "required": [ + "schema" + ] + } + ] + }, + "ServiceBusQueueEndpoint": { + "allOf": [ + { + "$ref": "#/definitions/Endpoint" + } + ] + }, + "ServiceBusTopicEndpoint": { + "allOf": [ + { + "$ref": "#/definitions/Endpoint" + } + ] + }, + "SolutionModel": { + "allOf": [ + { + "$ref": "#/definitions/Entity" }, { "type": "object", "properties": { - "hideTime": { - "description": "Specifies that the time portion of the date-time value should be hidden.", - "type": "boolean" + "cloudProperties": { + "description": "The cloud properties defined by the solution model.", + "type": "array", + "items": { + "$ref": "#/definitions/Capability" + } + }, + "initialValues": { + "description": "The initial values defined by the solution model.", + "type": "array", + "items": { + "$ref": "#/definitions/InitialValue" + } + }, + "overrides": { + "description": "The overrides defined by the solution model.", + "type": "array", + "items": { + "$ref": "#/definitions/Override" + } } } + } + ] + }, + "StorageEndpoint": { + "allOf": [ + { + "$ref": "#/definitions/Endpoint" + } + ] + }, + "SymmetricKey": { + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary key for this credential.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary key for this credential.", + "type": "string" + } + }, + "required": [ + "primaryKey", + "secondaryKey" + ] + }, + "SymmetricKeyAttestation": { + "x-ms-discriminator-value": "SymmetricKeyAttestation", + "allOf": [ + { + "$ref": "#/definitions/Attestation" + }, + { + "type": "object", + "properties": { + "symmetricKey": { + "description": "The symmetric key credentials for this attestation.", + "$ref": "#/definitions/SymmetricKey" + } + }, + "required": [ + "symmetricKey" + ] + } + ] + }, + "Tpm": { + "type": "object", + "properties": { + "endorsementKey": { + "description": "The TPM endorsement key for this credential.", + "type": "string" + } + }, + "required": [ + "endorsementKey" + ] + }, + "TpmAttestation": { + "x-ms-discriminator-value": "TpmAttestation", + "allOf": [ + { + "$ref": "#/definitions/Attestation" }, { "type": "object", "properties": { + "tpm": { + "description": "The TPM credentials for this attestation.", + "$ref": "#/definitions/Tpm" + } + }, + "required": [ + "tpm" + ] + } + ] + }, + "ValueDetail": { + "allOf": [ + { + "$ref": "#/definitions/Entity" + }, + { + "type": "object", + "properties": { + "falseName": { + "description": "The string representation of a false value.", + "type": "string" + }, + "trueName": { + "description": "The string representation of a true value.", + "type": "string" + }, + "hideTime": { + "description": "Specifies that the time portion of the date-time value should be hidden.", + "type": "boolean" + }, "severity": { "description": "Specifies the severity of the event.", - "x-ms-enum": { - "name": "EventSeverity", - "modelAsString": true - }, "type": "string", "enum": [ "error", "warning", "information" ] - } - } - }, - { - "type": "object", - "properties": { + }, "decimalPlaces": { "description": "The number of decimal places that should be displayed for the number.", "type": "integer" @@ -1057,12 +1000,7 @@ "minValue": { "description": "The minimum expected value of the number.", "type": "number" - } - } - }, - { - "type": "object", - "properties": { + }, "maxLength": { "description": "The maximum expected length of the string.", "type": "integer" @@ -1072,36 +1010,83 @@ "type": "integer" }, "trimWhitespace": { - "description": "Specifies the visual and storage treatment of white spaces in the string.", + "description": "Specifies the visual and storage treatment of whitespaces in the string.", "type": "boolean" } } } ] }, - "CapabilityReference": { + "X509": { + "type": "object", + "properties": { + "clientCertificates": { + "description": "The X.509 client certificates for this credential.", + "$ref": "#/definitions/X509Certificates" + } + } + }, + "X509Attestation": { + "x-ms-discriminator-value": "X509Attestation", "allOf": [ { - "$ref": "#/definitions/Entity" + "$ref": "#/definitions/Attestation" }, { "type": "object", "properties": { - "component": { - "description": "The name of the component being referenced.", - "type": "string" - }, - "reference": { - "description": "The name of the capability being referenced.", - "type": "string" + "x509": { + "description": "The X.509 credentials for this attestation.", + "$ref": "#/definitions/X509" } }, "required": [ - "component", - "reference" + "x509" ] } ] + }, + "X509Certificate": { + "type": "object", + "properties": { + "certificate": { + "description": "The string representation of this certificate.", + "type": "string" + }, + "info": { + "description": "Information about this certificate.", + "readOnly": true, + "$ref": "#/definitions/X509CertificateInfo" + } + } + }, + "X509CertificateInfo": { + "type": "object", + "properties": { + "sha1Thumbprint": { + "description": "The SHA-1 hash value of the certificate.", + "type": "string" + } + }, + "required": [ + "sha1Thumbprint" + ] + }, + "X509Certificates": { + "type": "object", + "properties": { + "primary": { + "description": "The primary X.509 certificate for this credential.", + "$ref": "#/definitions/X509Certificate" + }, + "secondary": { + "description": "The secondary X.509 certificate for this credential.", + "$ref": "#/definitions/X509Certificate" + } + }, + "required": [ + "primary" + ] } }, "paths": { @@ -1128,15 +1113,6 @@ } }, "/apiTokens/{token_id}": { - "parameters": [ - { - "in": "path", - "name": "token_id", - "description": "Unique ID for the API token.", - "type": "string", - "required": true - } - ], "get": { "operationId": "ApiTokens_Get", "summary": "Get an API token by ID.", @@ -1145,6 +1121,15 @@ "$ref": "./examples/apitoken_get.json" } }, + "parameters": [ + { + "in": "path", + "name": "token_id", + "description": "Unique ID for the API token.", + "type": "string", + "required": true + } + ], "responses": { "200": { "description": "Success", @@ -1171,13 +1156,13 @@ "required": true }, { - "name": "body", "in": "body", + "name": "body", "description": "API token body.", - "required": true, "schema": { "$ref": "#/definitions/ApiToken" - } + }, + "required": true } ], "responses": { @@ -1192,6 +1177,11 @@ "delete": { "operationId": "ApiTokens_Remove", "summary": "Delete an API token.", + "x-ms-examples": { + "Delete API token": { + "$ref": "./examples/apitoken_delete.json" + } + }, "parameters": [ { "in": "path", @@ -1201,11 +1191,6 @@ "required": true } ], - "x-ms-examples": { - "Delete API token": { - "$ref": "./examples/apitoken_delete.json" - } - }, "responses": { "204": { "description": "Success" @@ -1236,15 +1221,6 @@ } }, "/continuousDataExports/{export_id}": { - "parameters": [ - { - "in": "path", - "name": "export_id", - "description": "Unique ID for the continuous data export.", - "type": "string", - "required": true - } - ], "get": { "operationId": "ContinuousDataExports_Get", "summary": "Get a continuous data export by ID.", @@ -1253,6 +1229,15 @@ "$ref": "./examples/continuousdataexports_get.json" } }, + "parameters": [ + { + "in": "path", + "name": "export_id", + "description": "Unique ID for the continuous data export.", + "type": "string", + "required": true + } + ], "responses": { "200": { "description": "Success", @@ -1279,13 +1264,13 @@ "required": true }, { - "name": "body", "in": "body", + "name": "body", "description": "Data export body.", - "required": true, "schema": { "$ref": "#/definitions/ContinuousDataExport" - } + }, + "required": true } ], "responses": { @@ -1300,6 +1285,11 @@ "delete": { "operationId": "ContinuousDataExports_Remove", "summary": "Delete a continuous data export.", + "x-ms-examples": { + "Delete export": { + "$ref": "./examples/continuousdataexports_delete.json" + } + }, "parameters": [ { "in": "path", @@ -1309,11 +1299,6 @@ "required": true } ], - "x-ms-examples": { - "Delete export": { - "$ref": "./examples/continuousdataexports_delete.json" - } - }, "responses": { "204": { "description": "Success" @@ -1347,42 +1332,22 @@ "get": { "operationId": "DeviceTemplates_Get", "summary": "Get a device template by ID", - "parameters": [ - { - "$ref": "#/parameters/DeviceTemplateId" - } - ], "x-ms-examples": { "Get a device template by Id": { "$ref": "./examples/devicetemplates_get.json" } }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/DeviceTemplate" - } - } - } - }, - "delete": { - "operationId": "DeviceTemplates_Remove", - "summary": "Delete a device template", - "description": "Delete an existing device template by device ID.", "parameters": [ { "$ref": "#/parameters/DeviceTemplateId" } ], - "x-ms-examples": { - "Delete a device template by Id": { - "$ref": "./examples/devicetemplates_delete.json" - } - }, "responses": { - "204": { - "description": "Success" + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceTemplate" + } } } }, @@ -1399,13 +1364,13 @@ "$ref": "#/parameters/DeviceTemplateId" }, { - "name": "body", "in": "body", + "name": "body", "description": "Device template body.", - "required": true, "schema": { "$ref": "#/definitions/DeviceTemplate" - } + }, + "required": true } ], "responses": { @@ -1416,54 +1381,74 @@ } } } + }, + "delete": { + "operationId": "DeviceTemplates_Remove", + "summary": "Delete a device template", + "description": "Delete an existing device template by device ID.", + "x-ms-examples": { + "Delete a device template by Id": { + "$ref": "./examples/devicetemplates_delete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DeviceTemplateId" + } + ], + "responses": { + "204": { + "description": "Success" + } + } } }, - "/deviceTemplates/{device_template_id}/merged": { + "/deviceTemplates/{device_template_id}/devices": { "get": { - "operationId": "DeviceTemplates_GetMerged", - "summary": "Get a merged device template by ID", + "operationId": "DeviceTemplates_ListDevices", + "summary": "Get devices for a template", + "x-ms-examples": { + "List devices associated to a device template": { + "$ref": "./examples/devices_list_by_template.json" + } + }, "parameters": [ { "$ref": "#/parameters/DeviceTemplateId" } ], - "x-ms-examples": { - "Get a merged device template by Id": { - "$ref": "./examples/devicetemplates_get_merged.json" - } + "x-ms-pageable": { + "nextLinkName": "nextLink" }, "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DeviceTemplate" + "$ref": "#/definitions/DeviceCollection" } } } } }, - "/deviceTemplates/{device_template_id}/devices": { + "/deviceTemplates/{device_template_id}/merged": { "get": { - "operationId": "DeviceTemplates_ListDevices", - "summary": "Get devices for a template", + "operationId": "DeviceTemplates_GetMerged", + "summary": "Get a merged device template by ID", + "x-ms-examples": { + "Get a merged device template by Id": { + "$ref": "./examples/devicetemplates_get_merged.json" + } + }, "parameters": [ { "$ref": "#/parameters/DeviceTemplateId" } ], - "x-ms-examples": { - "List devices associated to a device template": { - "$ref": "./examples/devices_list_by_template.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DeviceCollection" + "$ref": "#/definitions/DeviceTemplate" } } } @@ -1496,16 +1481,16 @@ "operationId": "Devices_Get", "summary": "Get a device by ID", "description": "Get details about an existing device by device ID.", - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - } - ], "x-ms-examples": { "Get device by Id": { "$ref": "./examples/devices_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + } + ], "responses": { "200": { "description": "Success", @@ -1529,13 +1514,13 @@ "$ref": "#/parameters/DeviceId" }, { - "name": "body", "in": "body", + "name": "body", "description": "Device body.", - "required": true, "schema": { "$ref": "#/definitions/Device" - } + }, + "required": true } ], "responses": { @@ -1551,79 +1536,24 @@ "operationId": "Devices_Remove", "summary": "Delete a device", "description": "Delete an existing device by device ID.", - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - } - ], "x-ms-examples": { "Delete device": { "$ref": "./examples/devices_delete.json" } }, - "responses": { - "204": { - "description": "Success" - } - } - } - }, - "/roles": { - "get": { - "operationId": "Roles_List", - "summary": "Get the list of roles in an application.", - "x-ms-examples": { - "List roles": { - "$ref": "./examples/roles_list.json" - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/RoleCollection" - } - } - } - } - }, - "/roles/{role_id}": { - "get": { - "operationId": "Roles_Get", - "summary": "Get a role by ID.", "parameters": [ { - "in": "path", - "name": "role_id", - "description": "Unique ID for the role.", - "type": "string", - "required": true + "$ref": "#/parameters/DeviceId" } ], - "x-ms-examples": { - "Get role by Id": { - "$ref": "./examples/roles_get.json" - } - }, "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/Role" - } + "204": { + "description": "Success" } } } }, "/devices/{device_id}/attestation": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - } - ], "get": { "operationId": "Devices_GetAttestation", "summary": "Get device attestation", @@ -1632,6 +1562,11 @@ "$ref": "./examples/devices_attestations_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + } + ], "responses": { "200": { "description": "Success", @@ -1644,31 +1579,31 @@ "put": { "operationId": "Devices_SetAttestation", "summary": "Create or update an individual device attestation", + "x-ms-examples": { + "Create or update device attestation - Symmetric Key": { + "$ref": "./examples/devices_attestations_set_symmetricKey.json" + }, + "Create or update device attestation - TPM": { + "$ref": "./examples/devices_attestations_set_tpm.json" + }, + "Create or update device attestation - X509": { + "$ref": "./examples/devices_attestations_set_x509.json" + } + }, "parameters": [ { "$ref": "#/parameters/DeviceId" }, { - "name": "body", "in": "body", + "name": "body", "description": "Individual device attestation body.", - "required": true, "schema": { "$ref": "#/definitions/Attestation" - } + }, + "required": true } ], - "x-ms-examples": { - "Create or update device attestation - Symmetric Key": { - "$ref": "./examples/devices_attestations_set_symmetricKey.json" - }, - "Create or update device attestation - X509": { - "$ref": "./examples/devices_attestations_set_x509.json" - }, - "Create or update device attestation - TPM": { - "$ref": "./examples/devices_attestations_set_tpm.json" - } - }, "responses": { "200": { "description": "Success", @@ -1681,16 +1616,16 @@ "delete": { "operationId": "Devices_RemoveAttestation", "summary": "Remove an individual device attestation", - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - } - ], "x-ms-examples": { "Delete device attestation": { "$ref": "./examples/devices_attestations_delete.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + } + ], "responses": { "204": { "description": "Success" @@ -1699,11 +1634,6 @@ } }, "/devices/{device_id}/cloudProperties": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - } - ], "get": { "operationId": "Devices_GetCloudProperties", "summary": "Get device cloud properties", @@ -1713,6 +1643,11 @@ "$ref": "./examples/devices_cloudproperties_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + } + ], "responses": { "200": { "description": "Success", @@ -1727,51 +1662,78 @@ "summary": "Update device cloud properties", "description": "Update all cloud property values of a device by device ID.", "x-ms-examples": { - "Update cloud properties": { - "$ref": "./examples/devices_cloudproperties_update.json" + "Update cloud properties": { + "$ref": "./examples/devices_cloudproperties_update.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + }, + { + "in": "body", + "name": "body", + "description": "Device properties.", + "schema": { + "$ref": "#/definitions/DeviceCloudProperties" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceCloudProperties" + } + } + } + } + }, + "/devices/{device_id}/components": { + "get": { + "operationId": "Devices_ListComponents", + "summary": "List the components present in a device", + "x-ms-examples": { + "List components": { + "$ref": "./examples/devices_components_get.json" } }, "parameters": [ { - "name": "body", - "in": "body", - "description": "Device properties.", - "required": true, - "schema": { - "$ref": "#/definitions/DeviceCloudProperties" - } + "$ref": "#/parameters/DeviceId" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DeviceCloudProperties" + "$ref": "#/definitions/NamedEntityCollection" } } } } }, "/devices/{device_id}/components/{component_name}/commands/{command_name}": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, - { - "$ref": "#/parameters/ComponentName" - }, - { - "$ref": "#/parameters/CommandName" - } - ], "get": { "operationId": "Devices_GetComponentCommandHistory", - "summary": "Get command history for a component of the device", + "summary": "Get device command history", "x-ms-examples": { "Get command history": { "$ref": "./examples/devices_commandshistory_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ComponentName" + }, + { + "$ref": "#/parameters/CommandName" + } + ], "x-ms-pageable": { "nextLinkName": "nextLink" }, @@ -1786,24 +1748,33 @@ }, "post": { "operationId": "Devices_ExecuteComponentCommand", - "summary": "Execute a command on a component of a device", + "summary": "Execute a device command", "description": "Execute a command on a device.", + "x-ms-examples": { + "Send command": { + "$ref": "./examples/devices_commands_send.json" + } + }, "parameters": [ { - "name": "body", + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ComponentName" + }, + { + "$ref": "#/parameters/CommandName" + }, + { "in": "body", + "name": "body", "description": "Device command body.", - "required": true, "schema": { "$ref": "#/definitions/DeviceCommand" - } + }, + "required": true } ], - "x-ms-examples": { - "Send command": { - "$ref": "./examples/devices_commands_send.json" - } - }, "responses": { "201": { "description": "Success", @@ -1814,74 +1785,98 @@ } } }, - "/devices/{device_id}/modules/{module_name}/components/{component_name}/commands/{command_name}": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, - { - "$ref": "#/parameters/ModuleName" - }, - { - "$ref": "#/parameters/ComponentName" - }, - { - "$ref": "#/parameters/CommandName" - } - ], + "/devices/{device_id}/components/{component_name}/properties": { "get": { - "operationId": "Devices_GetModuleComponentCommandHistory", - "summary": "Get module command history", + "operationId": "Devices_GetComponentProperties", + "summary": "Get device properties for a specific component", "x-ms-examples": { - "Get command history within module": { - "$ref": "./examples/modules_commandshistory_get.json" + "Get properties on components": { + "$ref": "./examples/devices_properties_components_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ComponentName" + } + ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DeviceCommandCollection" + "$ref": "#/definitions/DeviceProperties" } } } }, - "post": { - "operationId": "Devices_ExecuteModuleComponentCommand", - "summary": "Execute a module command", - "description": "Execute a command on a module.", + "put": { + "operationId": "Devices_UpdateComponentProperties", + "summary": "Update device properties for a specific component", + "x-ms-examples": { + "Update properties on components": { + "$ref": "./examples/devices_properties_components_set.json" + } + }, "parameters": [ { - "name": "body", + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ComponentName" + }, + { "in": "body", - "description": "Device command body.", - "required": true, + "name": "body", + "description": "Device properties.", "schema": { - "$ref": "#/definitions/DeviceCommand" - } + "$ref": "#/definitions/DeviceProperties" + }, + "required": true } ], + "responses": { + "202": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceProperties" + } + } + } + } + }, + "/devices/{device_id}/components/{component_name}/telemetry/{telemetry_name}": { + "get": { + "operationId": "Devices_GetComponentTelemetryValue", + "summary": "Get device telemetry value", "x-ms-examples": { - "Send command to module": { - "$ref": "./examples/modules_commands_send.json" + "Get telemetry": { + "$ref": "./examples/devices_telemetry_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ComponentName" + }, + { + "$ref": "#/parameters/TelemetryName" + } + ], "responses": { - "201": { + "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DeviceCommand" + "$ref": "#/definitions/DeviceTelemetry" } } } } }, "/devices/{device_id}/credentials": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - } - ], "get": { "operationId": "Devices_GetCredentials", "summary": "Get device credentials", @@ -1890,6 +1885,11 @@ "$ref": "./examples/devicecredentials_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + } + ], "responses": { "200": { "description": "Success", @@ -1900,77 +1900,154 @@ } } }, - "/devices/{device_id}/properties": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" + "/devices/{device_id}/modules": { + "get": { + "operationId": "Devices_ListModules", + "summary": "List the modules present in a device", + "x-ms-examples": { + "List modules": { + "$ref": "./examples/devices_modules_get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NamedEntityCollection" + } + } } - ], + } + }, + "/devices/{device_id}/modules/{module_name}/components": { "get": { - "operationId": "Devices_GetProperties", - "summary": "Get device properties", - "description": "Get all property values of a device by device ID.", + "operationId": "Devices_ListModuleComponents", + "summary": "List the components present in a module", "x-ms-examples": { - "Get properties": { - "$ref": "./examples/devices_properties_get.json" + "List module components": { + "$ref": "./examples/devices_modules_components_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ModuleName" + } + ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DeviceProperties" + "$ref": "#/definitions/NamedEntityCollection" + } + } + } + } + }, + "/devices/{device_id}/modules/{module_name}/components/{component_name}/commands/{command_name}": { + "get": { + "operationId": "Devices_GetModuleComponentCommandHistory", + "summary": "Get module command history", + "x-ms-examples": { + "Get command history within module": { + "$ref": "./examples/modules_commandshistory_get.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ModuleName" + }, + { + "$ref": "#/parameters/ComponentName" + }, + { + "$ref": "#/parameters/CommandName" + } + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceCommandCollection" } } } }, - "put": { - "operationId": "Devices_UpdateProperties", - "summary": "Update device properties", - "description": "Update all property values of a device by device ID.", + "post": { + "operationId": "Devices_ExecuteModuleComponentCommand", + "summary": "Execute a module command", + "description": "Execute a command on a module.", "x-ms-examples": { - "Update properties": { - "$ref": "./examples/devices_properties_update.json" + "Send command to module": { + "$ref": "./examples/modules_commands_send.json" } }, "parameters": [ { - "name": "body", + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ModuleName" + }, + { + "$ref": "#/parameters/ComponentName" + }, + { + "$ref": "#/parameters/CommandName" + }, + { "in": "body", - "description": "Device properties.", - "required": true, + "name": "body", + "description": "Device command body.", "schema": { - "$ref": "#/definitions/DeviceProperties" - } + "$ref": "#/definitions/DeviceCommand" + }, + "required": true } ], "responses": { - "202": { + "201": { "description": "Success", "schema": { - "$ref": "#/definitions/DeviceProperties" + "$ref": "#/definitions/DeviceCommand" } } } } }, - "/devices/{device_id}/components/{component_name}/properties": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, - { - "$ref": "#/parameters/ComponentName" - } - ], + "/devices/{device_id}/modules/{module_name}/components/{component_name}/properties": { "get": { - "operationId": "Devices_GetComponentProperties", - "summary": "Get device properties for a specific component", - "x-ms-examples": { - "Get properties on components": { - "$ref": "./examples/devices_properties_components_get.json" + "operationId": "Devices_GetModuleComponentProperties", + "summary": "Get module properties for a specific component", + "x-ms-examples": { + "Get properties of a module": { + "$ref": "./examples/modules_properties_components_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ModuleName" + }, + { + "$ref": "#/parameters/ComponentName" + } + ], "responses": { "200": { "description": "Success", @@ -1981,22 +2058,31 @@ } }, "put": { - "operationId": "Devices_UpdateComponentProperties", - "summary": "Update device properties for a specific component", + "operationId": "Devices_UpdateModuleComponentProperties", + "summary": "Update module properties for a specific component", "x-ms-examples": { - "Update properties on components": { - "$ref": "./examples/devices_properties_components_set.json" + "Update properties of a module within a component": { + "$ref": "./examples/modules_properties_components_set.json" } }, "parameters": [ { - "name": "body", + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ModuleName" + }, + { + "$ref": "#/parameters/ComponentName" + }, + { "in": "body", - "description": "Device properties.", - "required": true, + "name": "body", + "description": "Module properties.", "schema": { "$ref": "#/definitions/DeviceProperties" - } + }, + "required": true } ], "responses": { @@ -2009,15 +2095,40 @@ } } }, - "/devices/{device_id}/modules/{module_name}/properties": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" + "/devices/{device_id}/modules/{module_name}/components/{component_name}/telemetry/{telemetry_name}": { + "get": { + "operationId": "Devices_GetModuleComponentTelemetryValue", + "summary": "Get module telemetry value", + "x-ms-examples": { + "Get telemetry from module": { + "$ref": "./examples/modules_telemetry_get.json" + } }, - { - "$ref": "#/parameters/ModuleName" + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ModuleName" + }, + { + "$ref": "#/parameters/ComponentName" + }, + { + "$ref": "#/parameters/TelemetryName" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/DeviceTelemetry" + } + } } - ], + } + }, + "/devices/{device_id}/modules/{module_name}/properties": { "get": { "operationId": "Devices_GetModuleProperties", "summary": "Get module properties", @@ -2027,6 +2138,14 @@ "$ref": "./examples/modules_properties_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ModuleName" + } + ], "responses": { "200": { "description": "Success", @@ -2040,22 +2159,28 @@ "operationId": "Devices_UpdateModuleProperties", "summary": "Update module properties", "description": "Update all property values of a module.", + "x-ms-examples": { + "Update properties of a module": { + "$ref": "./examples/modules_properties_update.json" + } + }, "parameters": [ { - "name": "body", + "$ref": "#/parameters/DeviceId" + }, + { + "$ref": "#/parameters/ModuleName" + }, + { "in": "body", + "name": "body", "description": "Module properties.", - "required": true, "schema": { "$ref": "#/definitions/DeviceProperties" - } + }, + "required": true } ], - "x-ms-examples": { - "Update properties of a module": { - "$ref": "./examples/modules_properties_update.json" - } - }, "responses": { "202": { "description": "Success", @@ -2066,26 +2191,21 @@ } } }, - "/devices/{device_id}/modules/{module_name}/components/{component_name}/properties": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, - { - "$ref": "#/parameters/ModuleName" - }, - { - "$ref": "#/parameters/ComponentName" - } - ], + "/devices/{device_id}/properties": { "get": { - "operationId": "Devices_GetModuleComponentProperties", - "summary": "Get module properties for a specific component", + "operationId": "Devices_GetProperties", + "summary": "Get device properties", + "description": "Get all property values of a device by device ID.", "x-ms-examples": { - "Get properties of a module": { - "$ref": "./examples/modules_properties_components_get.json" + "Get properties": { + "$ref": "./examples/devices_properties_get.json" } }, + "parameters": [ + { + "$ref": "#/parameters/DeviceId" + } + ], "responses": { "200": { "description": "Success", @@ -2096,24 +2216,28 @@ } }, "put": { - "operationId": "Devices_UpdateModuleComponentProperties", - "summary": "Update module properties for a specific component", + "operationId": "Devices_UpdateProperties", + "summary": "Update device properties", + "description": "Update all property values of a device by device ID.", + "x-ms-examples": { + "Update properties": { + "$ref": "./examples/devices_properties_update.json" + } + }, "parameters": [ { - "name": "body", + "$ref": "#/parameters/DeviceId" + }, + { "in": "body", - "description": "Module properties.", - "required": true, + "name": "body", + "description": "Device properties.", "schema": { "$ref": "#/definitions/DeviceProperties" - } + }, + "required": true } ], - "x-ms-examples": { - "Update properties of a module within a component": { - "$ref": "./examples/modules_properties_components_set.json" - } - }, "responses": { "202": { "description": "Success", @@ -2124,64 +2248,51 @@ } } }, - "/devices/{device_id}/components/{component_name}/telemetry/{telemetry_name}": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, - { - "$ref": "#/parameters/ComponentName" - }, - { - "$ref": "#/parameters/TelemetryName" - } - ], + "/roles": { "get": { - "operationId": "Devices_GetComponentTelemetryValue", - "summary": "Get device telemetry value", + "operationId": "Roles_List", + "summary": "Get the list of roles in an application.", "x-ms-examples": { - "Get telemetry": { - "$ref": "./examples/devices_telemetry_get.json" + "List roles": { + "$ref": "./examples/roles_list.json" } }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DeviceTelemetry" + "$ref": "#/definitions/RoleCollection" } } } } }, - "/devices/{device_id}/modules/{module_name}/components/{component_name}/telemetry/{telemetry_name}": { - "parameters": [ - { - "$ref": "#/parameters/DeviceId" - }, - { - "$ref": "#/parameters/ModuleName" - }, - { - "$ref": "#/parameters/ComponentName" - }, - { - "$ref": "#/parameters/TelemetryName" - } - ], + "/roles/{role_id}": { "get": { - "operationId": "Devices_GetModuleComponentTelemetryValue", - "summary": "Get module telemetry value", + "operationId": "Roles_Get", + "summary": "Get a role by ID.", "x-ms-examples": { - "Get telemetry from module": { - "$ref": "./examples/modules_telemetry_get.json" + "Get role by Id": { + "$ref": "./examples/roles_get.json" } }, + "parameters": [ + { + "in": "path", + "name": "role_id", + "description": "Unique ID for the role.", + "type": "string", + "required": true + } + ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/DeviceTelemetry" + "$ref": "#/definitions/Role" } } } @@ -2189,50 +2300,52 @@ } }, "parameters": { - "DeviceTemplateId": { + "CentralDnsSuffixInPath": { "in": "path", - "name": "device_template_id", - "description": "Unique ID of the device template.", - "x-ms-parameter-location": "method", + "name": "centralDnsSuffixInPath", + "description": "The DNS suffix used as the base for all Azure IoT Central service requests.", + "x-ms-parameter-location": "client", "type": "string", + "x-ms-skip-url-encoding": true, + "default": "azureiotcentral.com", "required": true }, - "DeviceId": { + "CommandName": { "in": "path", - "name": "device_id", - "description": "Unique ID of the device.", + "name": "command_name", + "description": "Name of this device command.", "x-ms-parameter-location": "method", "type": "string", "required": true }, - "ModuleName": { + "ComponentName": { "in": "path", - "name": "module_name", - "description": "Name of the device module.", + "name": "component_name", + "description": "Name of the component. In the device template editor in your app, this is the interface instance name.", "x-ms-parameter-location": "method", "type": "string", "required": true }, - "ComponentName": { + "DeviceId": { "in": "path", - "name": "component_name", - "description": "Name of the component. In the device template editor in your app, this is the interface instance name.", + "name": "device_id", + "description": "Unique ID of the device.", "x-ms-parameter-location": "method", "type": "string", "required": true }, - "CommandName": { + "DeviceTemplateId": { "in": "path", - "name": "command_name", - "description": "Name of this device command.", + "name": "device_template_id", + "description": "Unique ID of the device template.", "x-ms-parameter-location": "method", "type": "string", "required": true }, - "TelemetryName": { + "ModuleName": { "in": "path", - "name": "telemetry_name", - "description": "Name of this device telemetry.", + "name": "module_name", + "description": "Name of the device module.", "x-ms-parameter-location": "method", "type": "string", "required": true @@ -2240,23 +2353,26 @@ "Subdomain": { "in": "path", "name": "subdomain", - "description": "Application subdomain.", + "description": "The application subdomain.", "x-ms-parameter-location": "client", "type": "string", "required": true }, - "CentralDnsSuffixInPath": { - "name": "centralDnsSuffixInPath", + "TelemetryName": { "in": "path", - "required": true, + "name": "telemetry_name", + "description": "Name of this device telemetry.", + "x-ms-parameter-location": "method", "type": "string", - "default": "azureiotcentral.com", - "x-ms-skip-url-encoding": true, - "description": "The DNS suffix used as the base for all Azure IoT Central service requests.", - "x-ms-parameter-location": "client" + "required": true } }, "securityDefinitions": { + "APIKeyHeader": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + }, "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", @@ -2267,15 +2383,9 @@ } } }, - "x-ms-parameterized-host": { - "hostTemplate": "{subdomain}.{centralDnsSuffixInPath}", - "parameters": [ - { - "$ref": "#/parameters/Subdomain" - }, - { - "$ref": "#/parameters/CentralDnsSuffixInPath" - } - ] - } + "security": [ + { + "APIKeyHeader": [] + } + ] } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json index 51e8c8ea2184..f8ad6cee92c4 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "version": "preview", - "title": "Azure IoT Central", + "title": "Azure IoT Central Applications", "description": "Azure IoT Central is a service that makes it easy to connect, monitor, and manage your IoT devices at scale." }, "host": "apps.azureiotcentral.com", @@ -52,6 +52,10 @@ "items": { "$ref": "#/definitions/Application" } + }, + "nextLink": { + "description": "URL to get the next page of applications.", + "type": "string" } }, "required": [ @@ -64,6 +68,14 @@ "get": { "operationId": "Applications_List", "summary": "Get the list of applications accessible to the signed-in user", + "x-ms-examples": { + "List applications": { + "$ref": "./examples/application_list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, "responses": { "200": { "description": "Success", @@ -71,14 +83,6 @@ "$ref": "#/definitions/ApplicationCollection" } } - }, - "x-ms-pageable": { - "nextLinkName": null - }, - "x-ms-examples": { - "List applications": { - "$ref": "./examples/application_list.json" - } } } }, @@ -86,6 +90,11 @@ "get": { "operationId": "Applications_Get", "summary": "Get an application by ID", + "x-ms-examples": { + "Get application": { + "$ref": "./examples/application_get.json" + } + }, "parameters": [ { "in": "path", @@ -102,26 +111,28 @@ "$ref": "#/definitions/Application" } } - }, - "x-ms-examples": { - "Get application": { - "$ref": "./examples/application_get.json" - } } } } }, "parameters": { - "Subdomain": { + "CentralDnsSuffixInPath": { "in": "path", - "name": "subdomain", - "description": "Application subdomain.", + "name": "centralDnsSuffixInPath", + "description": "The DNS suffix used as the base for all Azure IoT Central service requests.", "x-ms-parameter-location": "client", "type": "string", + "x-ms-skip-url-encoding": true, + "default": "azureiotcentral.com", "required": true } }, "securityDefinitions": { + "APIKeyHeader": { + "type": "apiKey", + "in": "header", + "name": "Authorization" + }, "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", @@ -131,5 +142,10 @@ "user_impersonation": "impersonate your user account" } } - } + }, + "security": [ + { + "APIKeyHeader": [] + } + ] } diff --git a/specification/iotcentral/data-plane/readme.md b/specification/iotcentral/data-plane/readme.md index 3927cea53f3b..29406dbbaf09 100644 --- a/specification/iotcentral/data-plane/readme.md +++ b/specification/iotcentral/data-plane/readme.md @@ -1,83 +1,66 @@ # IoT Central - API client generation - > see https://aka.ms/autorest - This is the AutoRest configuration file for MonitorClient. - - - --- ## Getting Started To build the SDK for MonitorClient, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - > `autorest` - To see additional help and options, run: - > `autorest --help` --- - ## Configuration These are the global settings for the IoT Central API. - ``` yaml openapi-type: data-plane tag: package-2019-10-28-preview ``` - ### Tag: package-2019-10-28-preview - These settings apply only when `--tag=package-2019-10-28-preview` is specified on the command line. -``` yaml $(tag) == 'package-2019-10-28-preview' -input-file: -- Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json -- Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json +```yaml $(package-2019-10-28-preview-global) +input-file: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json +``` +```yaml $(package-2019-10-28-preview-app) +input-file: Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +``` + +```yaml +batch: + - package-2019-10-28-preview-global : true + - package-2019-10-28-preview-app: true ``` ```yaml version: latest clear-output-folder: true - # azure-validator: true semantic-validator: true - azure-arm: true add-credentials: true generate-metadata: true license-header: MICROSOFT_MIT_NO_VERSION - csharp: namespace: Microsoft.Azure.IotCentral output-folder: client/csharp/Microsoft.Azure.IotCentral - nodejs: package-name: azure-iotcentral package-version: 1.0.0 output-folder: client/nodejs ``` ## Multi-API/Profile support for AutoRest v3 generators - AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - This block is updated by an automatic script. Edits may be lost! - ``` yaml $(tag) == 'all-api-versions' /* autogenerated */ # include the azure profile definitions from the standard location require: $(this-folder)/../../../profiles/readme.md - # all the input files across all versions input-file: - $(this-folder)/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json - $(this-folder)/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json - ``` - If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. - ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` - +``` \ No newline at end of file From c1ea6061afbf42227de2a66f5c8801c4362d2793 Mon Sep 17 00:00:00 2001 From: jadrefke Date: Thu, 25 Jun 2020 14:00:50 -0700 Subject: [PATCH 202/318] [AzureSearch] Make skillsetCount optional for 2020-GA API service stats (#9966) * make skillsetCount optional for 2020-GA API * remove extra comma Co-authored-by: Austin Drefke --- .../Azure.Search/preview/2020-06-30/searchservice.json | 3 +-- 1 file changed, 1 insertion(+), 2 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json index 3bccedc1fe49..6643d136084e 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json @@ -8501,8 +8501,7 @@ "indexersCount", "dataSourcesCount", "storageSize", - "synonymMaps", - "skillsetCount" + "synonymMaps" ], "description": "Represents service-level resource counters and quotas." }, From 5917ebaf0b5bd6ed5297721afe90709a08097754 Mon Sep 17 00:00:00 2001 From: vasanthrajams <60414148+vasanthrajams@users.noreply.github.com> Date: Thu, 25 Jun 2020 17:08:28 -0700 Subject: [PATCH 203/318] Mark backup & restore operations as long running (#9898) * Adding 7.2-preview version (#8397) * Adding 7.2-preview version Signed-off-by: vasanthrajams * Resolve PR feedback * Fix output-folder for go code generation Co-authored-by: Heath Stewart * Marking backup/restore/selective key restore operation as LRO In this PR, marking the all long running operations appropriately using x-ms-long-running-operation. Signed-off-by: vasanthrajams * pretty check Co-authored-by: Heath Stewart Co-authored-by: vasanthrajams --- .../preview/7.2-preview/backuprestore.json | 34 +++++++++++++------ ...mple.json => Restore-pending-example.json} | 0 2 files changed, 23 insertions(+), 11 deletions(-) rename specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/{FullRestore-pending-example.json => Restore-pending-example.json} (100%) diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/backuprestore.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/backuprestore.json index 9a6587443dd8..bcfd1860d89c 100644 --- a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/backuprestore.json +++ b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/backuprestore.json @@ -33,6 +33,10 @@ "FullBackup" ], "operationId": "FullBackup", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "description": "Creates a full backup using a user-provided SAS token to an Azure blob storage container.", "parameters": [ { @@ -124,6 +128,10 @@ "FullRestore" ], "operationId": "FullRestoreOperation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "description": "Restores all key materials using the SAS token pointing to a previously stored Azure Blob storage backup folder", "parameters": [ { @@ -152,7 +160,7 @@ } }, "schema": { - "$ref": "#/definitions/FullRestoreOperation" + "$ref": "#/definitions/RestoreOperation" } }, "default": { @@ -174,15 +182,15 @@ "tags": [ "FullRestore" ], - "operationId": "FullRestoreStatus", - "description": "Returns the status of full restore operation", + "operationId": "RestoreStatus", + "description": "Returns the status of restore operation", "parameters": [ { "name": "jobId", "in": "path", "required": true, "type": "string", - "description": "The Job Id returned part of the full restore operation" + "description": "The Job Id returned part of the restore operation" }, { "$ref": "#/parameters/ApiVersionParameter" @@ -192,7 +200,7 @@ "200": { "description": "OK - Returns the full restore status", "schema": { - "$ref": "#/definitions/FullRestoreOperation" + "$ref": "#/definitions/RestoreOperation" } }, "default": { @@ -203,8 +211,8 @@ } }, "x-ms-examples": { - "Full restore status": { - "$ref": "./examples/FullRestore-pending-example.json" + "Restore status": { + "$ref": "./examples/Restore-pending-example.json" } } } @@ -215,6 +223,10 @@ "Keys" ], "operationId": "SelectiveKeyRestoreOperation", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, "description": "Restores all key versions of a given key using user supplied SAS token pointing to a previously stored Azure Blob storage backup folder", "parameters": [ { @@ -381,7 +393,7 @@ }, "description": "Full backup operation" }, - "FullRestoreOperation": { + "RestoreOperation": { "properties": { "status": { "type": "string", @@ -393,11 +405,11 @@ }, "error": { "$ref": "common.json#/definitions/Error", - "description": "Error encountered, if any, during the full restore operation." + "description": "Error encountered, if any, during the restore operation." }, "jobId": { "type": "string", - "description": "Identifier for the full restore operation." + "description": "Identifier for the restore operation." }, "startTime": { "type": "integer", @@ -410,7 +422,7 @@ "description": "The end time of the restore operation" } }, - "description": "Full restore operation" + "description": "Restore operation" } }, "parameters": { diff --git a/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/FullRestore-pending-example.json b/specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/Restore-pending-example.json similarity index 100% rename from specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/FullRestore-pending-example.json rename to specification/keyvault/data-plane/Microsoft.KeyVault/preview/7.2-preview/examples/Restore-pending-example.json From 0bc7853cb4d824bb6c310344dcc1b5f77cbe6bdd Mon Sep 17 00:00:00 2001 From: jadrefke Date: Thu, 25 Jun 2020 17:24:18 -0700 Subject: [PATCH 204/318] remove skillset counter entirely until it comes back as retired (#9968) Co-authored-by: Austin Drefke --- .../Azure.Search/preview/2020-06-30/searchservice.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json index 6643d136084e..0e4871756a44 100644 --- a/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json +++ b/specification/search/data-plane/Azure.Search/preview/2020-06-30/searchservice.json @@ -8488,11 +8488,6 @@ "x-ms-client-name": "synonymMapCounter", "$ref": "#/definitions/ResourceCounter", "description": "Total number of synonym maps." - }, - "skillsetCount": { - "x-ms-client-name": "skillsetCounter", - "$ref": "#/definitions/ResourceCounter", - "description": "Total number of skillsets." } }, "required": [ From 59119f0c05c9c5ec8510a56dcb70e3a5fb04fb1b Mon Sep 17 00:00:00 2001 From: Rahul Singh <53578268+rahuls-microsoft@users.noreply.github.com> Date: Thu, 25 Jun 2020 18:48:46 -0700 Subject: [PATCH 205/318] Updating BatchAI provider name in example to MachineLearningServices (#9967) * 1.Breaking Change - Removing duplicate autoQuotaIncreaseState from supportTicketAction. 2. Removing state=enabledForPreview. 3. Updating Example. * Updating Provider name in example. --- .../2019-07-19/examples/getMachineLearningServicesUsages.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getMachineLearningServicesUsages.json b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getMachineLearningServicesUsages.json index 824b3eef7d4e..fcdb3c1e7182 100644 --- a/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getMachineLearningServicesUsages.json +++ b/specification/reservations/resource-manager/Microsoft.Capacity/preview/2019-07-19/examples/getMachineLearningServicesUsages.json @@ -1,7 +1,7 @@ { "parameters": { "subscriptionId": "00000000-0000-0000-0000-000000000000", - "providerId": "Microsoft.BatchAI", + "providerId": "Microsoft.MachineLearningServices", "location": "eastus", "api-version": "2019-07-19-preview" }, From 5e57ac19b64be7b833e4b30337add378a29e14b4 Mon Sep 17 00:00:00 2001 From: datr93 <43795914+datr93@users.noreply.github.com> Date: Thu, 25 Jun 2020 23:50:28 -0700 Subject: [PATCH 206/318] add resource id (#9955) * add resource id * examples backwards * fix prettier --- .../preview/2019-01-23-preview/desktopvirtualization.json | 5 +++++ .../2019-01-23-preview/examples/SessionHost_Delete.json | 3 ++- .../2019-01-23-preview/examples/SessionHost_Get.json | 3 ++- .../2019-01-23-preview/examples/SessionHost_List.json | 6 ++++-- .../2019-01-23-preview/examples/SessionHost_Update.json | 3 ++- .../preview/2019-09-24-preview/desktopvirtualization.json | 5 +++++ .../2019-09-24-preview/examples/SessionHost_Delete.json | 4 +++- .../2019-09-24-preview/examples/SessionHost_Get.json | 4 +++- .../2019-09-24-preview/examples/SessionHost_List.json | 8 ++++++-- .../2019-09-24-preview/examples/SessionHost_Update.json | 4 +++- .../preview/2019-12-10-preview/desktopvirtualization.json | 5 +++++ .../2019-12-10-preview/examples/SessionHost_Delete.json | 3 ++- .../2019-12-10-preview/examples/SessionHost_Get.json | 3 ++- .../2019-12-10-preview/examples/SessionHost_List.json | 6 ++++-- .../2019-12-10-preview/examples/SessionHost_Update.json | 3 ++- 15 files changed, 50 insertions(+), 15 deletions(-) diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json index 35d3387dcbf0..9057fd8119ba 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json @@ -2700,6 +2700,11 @@ "description": "Allow a new session." }, "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { "type": "string", "description": "Resource Id of SessionHost's underlying virtual machine.", "readOnly": true diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json index 864b4679d0dd..a0fb8de17874 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Delete.json @@ -25,7 +25,8 @@ "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", - "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, "204": {} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json index b7479a52e40c..cdf7f8c1d3a2 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Get.json @@ -25,7 +25,8 @@ "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", - "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json index d3785e2a04da..4dffe5b95b7f 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_List.json @@ -26,7 +26,8 @@ "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", - "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, { @@ -46,7 +47,8 @@ "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", - "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json index 199ee8fb5420..fa38d983465f 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/examples/SessionHost_Update.json @@ -31,7 +31,8 @@ "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", - "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json index ebef3d61d55a..57941b12e443 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json @@ -2719,6 +2719,11 @@ "description": "Allow a new session." }, "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { "type": "string", "description": "Resource Id of SessionHost's underlying virtual machine.", "readOnly": true diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Delete.json index 1b0c26c20792..9a8b84e064d4 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Delete.json @@ -24,7 +24,9 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, "204": {} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Get.json index 9b1c5f90bf63..4ebf983e1b15 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Get.json @@ -24,7 +24,9 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_List.json index 164fcaccad86..45f5784ec15c 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_List.json @@ -25,7 +25,9 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, { @@ -44,7 +46,9 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Update.json index 379d98bbebcd..42a06c3969a6 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/examples/SessionHost_Update.json @@ -30,7 +30,9 @@ "sxSStackVersion": "rdp-sxs190816002", "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", - "updateErrorMessage": "" + "updateErrorMessage": "", + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json index 4e3df1be3b22..8b7462444aea 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json @@ -2742,6 +2742,11 @@ "description": "Allow a new session." }, "virtualMachineId": { + "type": "string", + "description": "Virtual Machine Id of SessionHost's underlying virtual machine.", + "readOnly": true + }, + "resourceId": { "type": "string", "description": "Resource Id of SessionHost's underlying virtual machine.", "readOnly": true diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json index 38eb21d3c27d..12cae16ead92 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Delete.json @@ -25,7 +25,8 @@ "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", - "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, "204": {} diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json index b573d742ae87..7c4fc2180b4b 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Get.json @@ -25,7 +25,8 @@ "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", - "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json index ccd0e643edf1..12ba5cafb4f2 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_List.json @@ -26,7 +26,8 @@ "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", - "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } }, { @@ -46,7 +47,8 @@ "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", - "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" + "virtualMachineId": "39491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost2" } } ] diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json index f97b52c68eb4..9353b6accd08 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/examples/SessionHost_Update.json @@ -31,7 +31,8 @@ "updateState": "Succeeded", "lastUpdateTime": "2008-09-22T14:01:54.9571247Z", "updateErrorMessage": "", - "virtualMachineId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" + "virtualMachineId": "29491b54-c033-4dec-b09a-18bf0ebafaef", + "resourceId": "/subscriptions/daefabc0-95b4-48b3-b645-8a753a63c4fa/resourceGroups/resourceGroup1/providers/Microsoft.Compute/virtualMachines/sessionHost1" } } } From 0b912b12aece3c101951c96e1ecf6ffdbee94ad4 Mon Sep 17 00:00:00 2001 From: aymanjarrousms <49946733+aymanjarrousms@users.noreply.github.com> Date: Fri, 26 Jun 2020 14:53:58 +0300 Subject: [PATCH 207/318] multi-cloud connector in azure security center (#9429) * aws connector in asc including API and examples - draft 1 * adding 'state' to the connector * when deleting aws connector that is not exist, return 404 * Updating connector is in put * aws connector status updated to enum * deleting post option in aws connector * aws connector adding state to the example files * adding description to aws connector * Renaming awsConnectors to connectors * renaming example files to connector without aws * aws dropped from the connector and adding connector type * update examples of connector based in the new schema * adding proxy to arc onboarding * updating example files * fixing typo * fixing arc to hybridComputeAutoProvision * update connectors.json (#1) * fixing file structure * updating examples * fixing connectorType to authenticationType * adding another block of properites * making two parts in the connector settings * updating required fields * Adding permission list * fixing error * changing name object * fixing permission name * adding all service principal fields * update documentation of app serivce secret * creating examples * location changed to region * create example changed to createupdate * moving account id insode the connection object * remove name fields in hybrid compute * Adding base for aws onboarding * two put and update examples * fixing examples based new body * fixing connector name * fixing aws connctor example * fixing readme and link to example file * adding correct example file * fixin example extension * fixing discriminator * provisioningState is required prop * fixing link in readme file * fixing typo in connectorName * fixing provisioningState * fixin authenticationType to authenticationType * removing readonly fields from examples * fixing credential fields * remove id from create * run Prettier on the files * running prettier * create two different x-ms-enum * update examples of connectors * update readme file * removing custom from secure score * fifixng enum permission prop * fixing extra space in readme * Adding gcp connector * adding gcp example * update example of get list * fixing name * running prettier * fixing errors of build * removing null values from examples * taking secureScore.json new file * all secret fields marked as format password * remove required fields * Adding relavent required fields * remove password format * writeonly fields are returned with value * fixing gcp connector fields * fixing delete response * fiximng examples to return empty string on writeonly fields * fixing delete response in the example * change structure of authentication * fixing inheretence in aws * fixing structure of cred in aws and gcp * write only fields are empty strings in the response of the examples * after Prettier check * clarifing the documentation of two fields * fixing documentation of region field in hybrid compute. Co-authored-by: Ayman Jarrous Co-authored-by: adzamri <49613774+adzamri@users.noreply.github.com> --- cSpell.json | 3 +- .../2020-01-01-preview/connectors.json | 618 ++++++++++++++++++ ...sumeRoleConnectorSubscription_example.json | 65 ++ ...eAwsCredConnectorSubscription_example.json | 65 ++ ...dentialsConnectorSubscription_example.json | 80 +++ .../DeleteConnectorSubscription_example.json | 11 + .../GetConnectorSubscription_example.json | 43 ++ .../GetListConnectorSubscription_example.json | 116 ++++ .../security/resource-manager/readme.md | 8 +- 9 files changed, 1007 insertions(+), 2 deletions(-) create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/connectors.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateAwsAssumeRoleConnectorSubscription_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateAwsCredConnectorSubscription_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateGcpCredentialsConnectorSubscription_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/DeleteConnectorSubscription_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/GetConnectorSubscription_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/GetListConnectorSubscription_example.json diff --git a/cSpell.json b/cSpell.json index 8cf7fe1c77ee..21bf185fc445 100644 --- a/cSpell.json +++ b/cSpell.json @@ -2,6 +2,7 @@ "version": "0.1", "language": "en", "words": [ + "Creds" ], "dictionaryDefinitions": [ { @@ -636,4 +637,4 @@ ] } ] -} +} \ No newline at end of file diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/connectors.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/connectors.json new file mode 100644 index 000000000000..665e132c03d2 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/connectors.json @@ -0,0 +1,618 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2020-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/connectors": { + "get": { + "x-ms-examples": { + "Get all Cloud accounts connectors of a subscription": { + "$ref": "./examples/Connectors/GetListConnectorSubscription_example.json" + } + }, + "tags": [ + "Connectors" + ], + "description": "Cloud accounts connectors of a subscription", + "operationId": "Connectors_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectorSettingList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/connectors/{connectorName}": { + "get": { + "x-ms-examples": { + "Details of a specific cloud account connector": { + "$ref": "./examples/Connectors/GetConnectorSubscription_example.json" + } + }, + "tags": [ + "Connectors" + ], + "description": "Details of a specific cloud account connector", + "operationId": "Connectors_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ConnectorName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectorSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "AwsCred - Create a cloud account connector for a subscription": { + "$ref": "./examples/Connectors/CreateUpdateAwsCredConnectorSubscription_example.json" + }, + "AwsAssumeRole - Create a cloud account connector for a subscription": { + "$ref": "./examples/Connectors/CreateUpdateAwsAssumeRoleConnectorSubscription_example.json" + }, + "gcpCredentials - Create a cloud account connector for a subscription": { + "$ref": "./examples/Connectors/CreateUpdateGcpCredentialsConnectorSubscription_example.json" + } + }, + "tags": [ + "Connectors" + ], + "description": "Create a cloud account connector or update an existing one. Connect to your AWS cloud account using either account credentials or role-based authentication.", + "operationId": "Connectors_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ConnectorName" + }, + { + "$ref": "#/parameters/ConnectorSetting" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ConnectorSetting" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a cloud account connector from a subscription": { + "$ref": "./examples/Connectors/DeleteConnectorSubscription_example.json" + } + }, + "tags": [ + "Connectors" + ], + "description": "Delete a cloud account connector from a subscription", + "operationId": "Connectors_Delete", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ConnectorName" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "204": { + "description": "The connector is not found" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ConnectorSettingList": { + "type": "object", + "description": "For a subscription, list of all cloud account connectors and their settings", + "properties": { + "value": { + "description": "List of all the cloud account connector settings", + "type": "array", + "items": { + "$ref": "#/definitions/ConnectorSetting" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "ConnectorSetting": { + "type": "object", + "description": "The connector setting", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Connector setting data", + "$ref": "#/definitions/ConnectorSettingProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "ConnectorSettingProperties": { + "type": "object", + "description": "Describes properties of an connector setting", + "properties": { + "hybridComputeSettings": { + "description": "Settings for hybrid compute management, these settings are relevant only Arc autoProvision (Hybrid Compute).", + "type": "object", + "$ref": "#/definitions/HybridComputeSettingsProperties" + }, + "authenticationDetails": { + "description": "Settings for authentication management, these settings are relevant only for the cloud connector.", + "type": "object", + "$ref": "#/definitions/AuthenticationDetailsProperties" + } + } + }, + "HybridComputeSettingsProperties": { + "type": "object", + "description": "Settings for hybrid compute management", + "properties": { + "hybridComputeProvisioningState": { + "description": "State of the service principal and its secret", + "type": "string", + "readOnly": true, + "enum": [ + "Valid", + "Invalid", + "Expired" + ], + "x-ms-enum": { + "name": "hybridComputeProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Valid", + "description": "Valid service principal details." + }, + { + "value": "Invalid", + "description": "Invalid service principal details." + }, + { + "value": "Expired", + "description": "the service principal details are expired" + } + ] + } + }, + "autoProvision": { + "type": "string", + "description": "Whether or not to automatically install Azure Arc (hybrid compute) agents on machines", + "enum": [ + "On", + "Off" + ], + "x-ms-enum": { + "name": "autoProvision", + "modelAsString": true, + "values": [ + { + "value": "On", + "description": "Install missing Azure Arc agent on VMs automatically" + }, + { + "value": "Off", + "description": "Do not install Azure Arc agent on the VMs automatically" + } + ] + } + }, + "resourceGroupName": { + "type": "string", + "description": "The name of the resource group where Arc (Hybrid Compute) connectors are connected." + }, + "region": { + "type": "string", + "description": "The location where the meta data of machines will be stored", + "x-ms-mutability": [ + "create", + "read" + ] + }, + "proxyServer": { + "type": "object", + "description": "For a non-Azure machine that is not connected directly to the internet, specify a proxy server that the non-Azure machine can use.", + "$ref": "#/definitions/ProxyServerProperties" + }, + "servicePrincipal": { + "description": "An object to access resources that are secured by an Azure AD tenant.", + "type": "object", + "$ref": "#/definitions/ServicePrincipalProperties" + } + }, + "required": [ + "autoProvision" + ] + }, + "ServicePrincipalProperties": { + "type": "object", + "description": "Details of the service principal.", + "properties": { + "applicationId": { + "type": "string", + "description": "Application id of service principal." + }, + "secret": { + "type": "string", + "description": "A secret string that the application uses to prove its identity, also can be referred to as application password (write only)." + } + } + }, + "AuthenticationDetailsProperties": { + "type": "object", + "description": "Settings for cloud authentication management", + "discriminator": "authenticationType", + "properties": { + "authenticationProvisioningState": { + "description": "State of the multi-cloud connector", + "type": "string", + "readOnly": true, + "enum": [ + "Valid", + "Invalid", + "Expired", + "IncorrectPolicy" + ], + "x-ms-enum": { + "name": "authenticationProvisioningState", + "modelAsString": true, + "values": [ + { + "value": "Valid", + "description": "Valid connector" + }, + { + "value": "Invalid", + "description": "Invalid connector" + }, + { + "value": "Expired", + "description": "the connection is expired" + }, + { + "value": "IncorrectPolicy", + "description": "Incorrect policy of the connector" + } + ] + } + }, + "grantedPermissions": { + "description": "The permissions detected in the cloud account.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PermissionProperty" + } + }, + "authenticationType": { + "description": "Connect to your cloud account, for AWS use either account credentials or role-based authentication. For GCP use account organization credentials.", + "type": "string", + "enum": [ + "awsCreds", + "awsAssumeRole", + "gcpCredentials" + ], + "x-ms-enum": { + "name": "authenticationType", + "modelAsString": true, + "values": [ + { + "value": "awsCreds", + "description": "AWS cloud account connector user credentials authentication" + }, + { + "value": "awsAssumeRole", + "description": "AWS account connector assume role authentication" + }, + { + "value": "gcpCredentials", + "description": "GCP account connector service to service authentication" + } + ] + } + } + }, + "required": [ + "authenticationType" + ] + }, + "AwsCredsAuthenticationDetailsProperties": { + "type": "object", + "description": "AWS cloud account connector based credentials, the credentials is composed of access key id and secret key, for more details, refer to Creating an IAM User in Your AWS Account (write only)", + "x-ms-discriminator-value": "awsCreds", + "allOf": [ + { + "$ref": "#/definitions/AuthenticationDetailsProperties" + } + ], + "properties": { + "accountId": { + "description": "The ID of the cloud account", + "type": "string", + "readOnly": true + }, + "awsAccessKeyId": { + "type": "string", + "description": "Public key element of the AWS credential object (write only)" + }, + "awsSecretAccessKey": { + "type": "string", + "description": "Secret key element of the AWS credential object (write only)" + } + }, + "required": [ + "awsAccessKeyId", + "awsSecretAccessKey" + ] + }, + "AwAssumeRoleAuthenticationDetailsProperties": { + "type": "object", + "description": "AWS cloud account connector based assume role, the role enables delegating access to your AWS resources. The role is composed of role arn and external id, for more details, refer to Creating a Role to Delegate Permissions to an IAM User (write only)", + "x-ms-discriminator-value": "awsAssumeRole", + "allOf": [ + { + "$ref": "#/definitions/AuthenticationDetailsProperties" + } + ], + "properties": { + "accountId": { + "description": "The ID of the cloud account", + "type": "string", + "readOnly": true + }, + "awsAssumeRoleArn": { + "type": "string", + "description": "Assumed role ID is an identifier that you can use to create temporary security credentials." + }, + "awsExternalId": { + "type": "string", + "description": "A unique identifier that is required when you assume a role in another account." + } + }, + "required": [ + "awsAssumeRoleArn", + "awsExternalId" + ] + }, + "GcpCredentialsDetailsProperties": { + "type": "object", + "description": "GCP cloud account connector based service to service credentials, the credentials is composed of organization id and json api key (write only)", + "x-ms-discriminator-value": "gcpCredentials", + "allOf": [ + { + "$ref": "#/definitions/AuthenticationDetailsProperties" + } + ], + "properties": { + "organizationId": { + "description": "The Organization ID of the GCP cloud account", + "type": "string" + }, + "type": { + "type": "string", + "description": "Type field of the API key (write only)" + }, + "projectId": { + "type": "string", + "description": "Project Id field of the API key (write only)" + }, + "privateKeyId": { + "type": "string", + "description": "Private key Id field of the API key (write only)" + }, + "privateKey": { + "type": "string", + "description": "Private key field of the API key (write only)" + }, + "clientEmail": { + "type": "string", + "description": "Client email field of the API key (write only)" + }, + "clientId": { + "type": "string", + "description": "Client Id field of the API key (write only)" + }, + "authUri": { + "type": "string", + "description": "Auth Uri field of the API key (write only)" + }, + "tokenUri": { + "type": "string", + "description": "Token Uri field of the API key (write only)" + }, + "authProviderX509CertUrl": { + "type": "string", + "description": "Auth provider x509 certificate url field of the API key (write only)" + }, + "clientX509CertUrl": { + "type": "string", + "description": "Client x509 certificate url field of the API key (write only)" + } + }, + "required": [ + "organizationId", + "type", + "projectId", + "privateKeyId", + "privateKey", + "clientEmail", + "clientId", + "authUri", + "tokenUri", + "authProviderX509CertUrl", + "clientX509CertUrl" + ] + }, + "PermissionProperty": { + "description": "A permission detected in the cloud account.", + "type": "string", + "readOnly": true, + "enum": [ + "AWS::AWSSecurityHubReadOnlyAccess", + "AWS::SecurityAudit", + "AWS::AmazonSSMAutomationRole", + "GCP::Security Center Admin Viewer" + ], + "x-ms-enum": { + "name": "PermissionProperty", + "modelAsString": true, + "values": [ + { + "value": "AWS::AWSSecurityHubReadOnlyAccess", + "description": "This permission provides read only access to AWS Security Hub resources." + }, + { + "value": "AWS::SecurityAudit", + "description": "This permission grants access to read security configuration metadata." + }, + { + "value": "AWS::AmazonSSMAutomationRole", + "description": "The permission provides for EC2 Automation service to execute activities defined within Automation documents." + }, + { + "value": "GCP::Security Center Admin Viewer", + "description": "This permission provides read only access to GCP Security Command Center." + } + ] + } + }, + "ProxyServerProperties": { + "type": "object", + "description": "For a non-Azure machine that is not connected directly to the internet, specify a proxy server that the non-Azure machine can use.", + "properties": { + "ip": { + "type": "string", + "description": "Proxy server IP" + }, + "port": { + "type": "string", + "description": "Proxy server port" + } + } + } + }, + "parameters": { + "ConnectorName": { + "name": "connectorName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the cloud account connector", + "x-ms-parameter-location": "method" + }, + "ConnectorSetting": { + "name": "connectorSetting", + "in": "body", + "required": true, + "description": "Settings for the cloud account connector", + "schema": { + "$ref": "#/definitions/ConnectorSetting" + }, + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateAwsAssumeRoleConnectorSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateAwsAssumeRoleConnectorSubscription_example.json new file mode 100644 index 000000000000..a4405f77bf03 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateAwsAssumeRoleConnectorSubscription_example.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2020-01-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "connectorName": "aws_dev2", + "connectorSetting": { + "properties": { + "hybridComputeSettings": { + "autoProvision": "On", + "resourceGroupName": "AwsConnectorRG", + "region": "West US 2", + "proxyServer": { + "ip": "167.220.197.140", + "port": "34" + }, + "servicePrincipal": { + "applicationId": "ad9bcd79-be9c-45ab-abd8-80ca1654a7d1", + "secret": "x2yS:FnCHssRkH0@CJY5pATzlEs@r5m." + } + }, + "authenticationDetails": { + "authenticationType": "awsAssumeRole", + "awsAssumeRoleArn": "arn:aws:iam::81231569658:role/AscConnector", + "awsExternalId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/connectors/aws_dev2", + "name": "aws_dev2", + "type": "Microsoft.Security/connectors", + "properties": { + "hybridComputeSettings": { + "hybridComputeProvisioningState": "Valid", + "autoProvision": "On", + "resourceGroupName": "AwsConnectorRG", + "region": "West US 2", + "proxyServer": { + "ip": "167.220.197.140", + "port": "34" + }, + "servicePrincipal": { + "applicationId": "ad9bcd79-be9c-45ab-abd8-80ca1654a7d1" + } + }, + "authenticationDetails": { + "authenticationProvisioningState": "Valid", + "grantedPermissions": [ + "AWS::AWSSecurityHubReadOnlyAccess", + "AWS::SecurityAudit", + "AWS::AmazonSSMAutomationRole" + ], + "authenticationType": "awsAssumeRole", + "accountId": "81231569658", + "awsAssumeRoleArn": "arn:aws:iam::81231569658:role/AscConnector", + "awsExternalId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateAwsCredConnectorSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateAwsCredConnectorSubscription_example.json new file mode 100644 index 000000000000..8e89a390a07c --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateAwsCredConnectorSubscription_example.json @@ -0,0 +1,65 @@ +{ + "parameters": { + "api-version": "2020-01-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "connectorName": "aws_dev1", + "connectorSetting": { + "properties": { + "hybridComputeSettings": { + "autoProvision": "On", + "resourceGroupName": "AwsConnectorRG", + "region": "West US 2", + "proxyServer": { + "ip": "167.220.197.140", + "port": "34" + }, + "servicePrincipal": { + "applicationId": "ad9bcd79-be9c-45ab-abd8-80ca1654a7d1", + "secret": "x2yS:FnCHssRkH0@CJY5pATzlEs@r5m." + } + }, + "authenticationDetails": { + "authenticationType": "awsCreds", + "awsAccessKeyId": "AKIARPZCNODDNAEQFSOE", + "awsSecretAccessKey": "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" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/connectors/aws_dev1", + "name": "aws_dev1", + "type": "Microsoft.Security/connectors", + "properties": { + "hybridComputeSettings": { + "hybridComputeProvisioningState": "Valid", + "autoProvision": "On", + "resourceGroupName": "AwsConnectorRG", + "region": "West US 2", + "proxyServer": { + "ip": "287.221.107.152", + "port": "34" + }, + "servicePrincipal": { + "applicationId": "ad9bcd79-be9c-45ab-abd8-80ca1654a7d1" + } + }, + "authenticationDetails": { + "authenticationProvisioningState": "Valid", + "grantedPermissions": [ + "AWS::AWSSecurityHubReadOnlyAccess", + "AWS::SecurityAudit", + "AWS::AmazonSSMAutomationRole" + ], + "authenticationType": "awsCreds", + "accountId": "922315681122", + "awsAccessKeyId": "", + "awsSecretAccessKey": "" + } + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateGcpCredentialsConnectorSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateGcpCredentialsConnectorSubscription_example.json new file mode 100644 index 000000000000..5574f86fbdb1 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/CreateUpdateGcpCredentialsConnectorSubscription_example.json @@ -0,0 +1,80 @@ +{ + "parameters": { + "api-version": "2020-01-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "connectorName": "gcp_dev", + "connectorSetting": { + "properties": { + "hybridComputeSettings": { + "autoProvision": "On", + "resourceGroupName": "GcpConnectorRG", + "region": "West US 2", + "proxyServer": { + "ip": "201.120.185.132", + "port": "34" + }, + "servicePrincipal": { + "applicationId": "ad9bcd79-be9c-45ab-abd8-80ca1654a7d1", + "secret": "x2yS:FnCHssRkH0@CJY5pATzlEs@r5m." + } + }, + "authenticationDetails": { + "authenticationType": "gcpCredentials", + "organizationId": "AscDemoOrg", + "type": "service_account", + "projectId": "asc-project-1234", + "privateKeyId": "6efg587hra2568as34d22326b044cc20dc2af", + "privateKey": "-----BEGIN PRIVATE KEY-----\nMIIEvQIBADANBgkqhkiG9w0BAQEFAASCBKcwggSjAgEAAoIBAQCpxYHcLzcDZ6/Q\nAeQZnQXM5GTb3p09Xsbjo2T2F61b6I7FZiQXBrbw3Zf0CUCkkqTTpD5xifl82yQ6\n89V7SAe8hxI7esAcVDhm/aJMqzVjHLISAU2L3li1sn0jjY2oYtndwN6bRivP8O6t\n9F+W6E0zMlbCxtpZEHLbb6WxlJJrwEQ0MPH2yOCwZUQi6NHksAtEzX2nNKJNyUC7\nQyBVHHMm34H2bmZwsuQp3y2otpcJ9tJnVmYfC3k/w4x2L+DIK7JnQP/C1wQqu2du\nc0w6sydF6RhLoHButrVdYRJTdfK4k03SsSTyMqZ+f7LNnKw3xenzw1VmEpk8mvoQ\nt08tCBOrAgMBAAECggEAByzz6iyMtLYjNjV+QJ7kad6VbL2iA8AHxANZ9xTVHPdd\nYXaJu/dqsA+NpqDlfI8+LDva782XH/HbPCqmMUnAGfXTjXQIvqnIoIHD5F2wKfpC\nhIRNlMXXFgbvRxtqi11yO+80+XcjzuwuCmgzyhsTeEB+bkkdXXpWgHPdmv3emnM6\nMQM9Zgrug0UndPmiUwKOcJSU4PlmlTpHEV4vA6JfA4bvphy9m1jxO5qWeah5yym2\n6FP5BRIDF98kFrDnSXJjajwgLCQ+MypFQXyax6XkxDxuKXbng1bv7eZDjqazIChk\nm0y14X0s0jnWc+AX8vfeSf7d+EsGdVinEwR1aAawEQKBgQDqDB0qxcIQ1oI1Kww8\n9vXefTiuWsf47F+fJ/DIOEbiRfE8IdCgmOABvcqJIoxW/DFMBEdLCcx73Km7pOmd\nKg1ddScnaO8cOj2v/Ub+fAqVrA4ki4ViYP0A7/Nogga3Jr/x3ey5bitrIfFImteS\nCgBHBzZvoQpvO4lB2tKVgo2P9wKBgQC5sgTEq4sasRGSAY6lIoJno0I8w28a/16D\nes60XQeY1ger8uTGwlT02v/u/arDUmRLPClpujXq6gK29KvtRCHy7JkpGbqW2bZs\nPFKKWR7Tk3XPKYyjv94AIi5/xoFeDhS4lpAvy3Z5tQhYS6wqWKvT6yZQ3kM+Hfxs\npHgvu3mU7QKBgQC9/E1k3hj1cBtMK4CIsHPPQljTd4+iacYJPPPAo6YuoVX8WPqw\nksgrwbN59Fh1d8xQh5yTtgWOegYx8uFMGcm1lpbM7+pBQKm4hWGuzGQPMRZd5f/F\nZzOZIi61I+9tlv/yxxIVR+/ozCm/pSneO04UWi9/F/uPZYW6tnWAtfRR6wKBgGsZ\n8MQaCK4JaI/klAhMghgSQnbXZXKVzUZaA3Rln6cX8u7KtgapOOTMlwaZie8Dy1LV\nTTFstAJcm9o3/h1nyYjZy3C4JTUyNpPwqs6enjf7edxVI4eidwFutZD+xcigqHTa\naikW2atSrZB3fMIjyF7+5meH+hKOqvNiXOty3qn1AoGAZuVxYQy5FVq3YZxzr3Aa\nAm0ShoXTF6QYIbsaUiUGoa/NlHcw9V/lj4AqBRbxbaYMD+hz2J/od9cb268eJKY8\n3b6MvaUqdNhNnWodJXLhgtmGEHDKmTppz2JSTx/tVzCfhFdcOC79StZvcKLhtoFQ\n+/3lEw6NCIXzm5E4+dtJG4k=\n-----END PRIVATE KEY-----\n", + "clientEmail": "asc-135@asc-project-1234.iam.gserviceaccount.com", + "clientId": "105889053725632919854", + "authUri": "https://accounts.google.com/o/oauth2/auth", + "tokenUri": "https://oauth2.googleapis.com/token", + "authProviderX509CertUrl": "https://www.googleapis.com/oauth2/v1/certs", + "clientX509CertUrl": "https://www.googleapis.com/robot/v1/metadata/x509/asc-135%40asc-project-1234.iam.gserviceaccount.com" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/connectors/gcp_dev", + "name": "gcp_dev", + "type": "Microsoft.Security/connectors", + "properties": { + "hybridComputeSettings": { + "hybridComputeProvisioningState": "Valid", + "autoProvision": "On", + "resourceGroupName": "GcpConnectorRG", + "region": "West US 2", + "proxyServer": { + "ip": "201.120.185.132", + "port": "34" + }, + "servicePrincipal": { + "applicationId": "ad9bcd79-be9c-45ab-abd8-80ca1654a7d1" + } + }, + "authenticationDetails": { + "authenticationProvisioningState": "Valid", + "grantedPermissions": [ + "GCP::Security Center Admin Viewer" + ], + "authenticationType": "gcpCredentials", + "organizationId": "AscDemoOrg", + "type": "", + "projectId": "", + "privateKeyId": "", + "privateKey": "", + "clientEmail": "", + "clientId": "", + "authUri": "", + "tokenUri": "", + "authProviderX509CertUrl": "", + "clientX509CertUrl": "" + } + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/DeleteConnectorSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/DeleteConnectorSubscription_example.json new file mode 100644 index 000000000000..b387c969aaa5 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/DeleteConnectorSubscription_example.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-01-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "connectorName": "aws_dev1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/GetConnectorSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/GetConnectorSubscription_example.json new file mode 100644 index 000000000000..d5dc6f6126dc --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/GetConnectorSubscription_example.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-01-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "connectorName": "aws_dev1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/connectors/aws_dev1", + "name": "aws_dev1", + "type": "Microsoft.Security/connectors", + "properties": { + "hybridComputeSettings": { + "hybridComputeProvisioningState": "Valid", + "autoProvision": "On", + "resourceGroupName": "AwsConnectorRG", + "region": "West US 2", + "proxyServer": { + "ip": "287.221.107.152", + "port": "34" + }, + "servicePrincipal": { + "applicationId": "ad9bcd79-be9c-45ab-abd8-80ca1654a7d1" + } + }, + "authenticationDetails": { + "authenticationProvisioningState": "Valid", + "grantedPermissions": [ + "AWS::AWSSecurityHubReadOnlyAccess", + "AWS::SecurityAudit", + "AWS::AmazonSSMAutomationRole" + ], + "authenticationType": "awsCreds", + "accountId": "922315681122", + "awsAccessKeyId": "", + "awsSecretAccessKey": "" + } + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/GetListConnectorSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/GetListConnectorSubscription_example.json new file mode 100644 index 000000000000..3f2ffbc17f7a --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/preview/2020-01-01-preview/examples/Connectors/GetListConnectorSubscription_example.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2020-01-01-preview", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/connectors/aws_dev1", + "name": "aws_dev1", + "type": "Microsoft.Security/connectors", + "properties": { + "hybridComputeSettings": { + "hybridComputeProvisioningState": "Valid", + "autoProvision": "On", + "resourceGroupName": "AwsConnectorRG", + "region": "West US 2", + "proxyServer": { + "ip": "287.221.107.152", + "port": "34" + }, + "servicePrincipal": { + "applicationId": "ad9bcd79-be9c-45ab-abd8-80ca1654a7d1" + } + }, + "authenticationDetails": { + "authenticationProvisioningState": "Valid", + "grantedPermissions": [ + "AWS::AWSSecurityHubReadOnlyAccess", + "AWS::SecurityAudit", + "AWS::AmazonSSMAutomationRole" + ], + "authenticationType": "awsCreds", + "accountId": "922315681122", + "awsAccessKeyId": "", + "awsSecretAccessKey": "" + } + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/connectors/aws_dev2", + "name": "aws_dev2", + "type": "Microsoft.Security/connectors", + "properties": { + "hybridComputeSettings": { + "hybridComputeProvisioningState": "Valid", + "autoProvision": "On", + "resourceGroupName": "AwsConnectorRG", + "region": "West US 2", + "proxyServer": { + "ip": "167.210.187.160", + "port": "34" + }, + "servicePrincipal": { + "applicationId": "ad9bcd79-be9c-45ab-abd8-80ca1654a7d1" + } + }, + "authenticationDetails": { + "authenticationProvisioningState": "Valid", + "grantedPermissions": [ + "AWS::AWSSecurityHubReadOnlyAccess", + "AWS::SecurityAudit", + "AWS::AmazonSSMAutomationRole" + ], + "authenticationType": "awsAssumeRole", + "accountId": "81231569658", + "awsAssumeRoleArn": "arn:aws:iam::81231569658:role/AscConnector", + "awsExternalId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + } + } + }, + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/connectors/gcp_dev", + "name": "gcp_dev", + "type": "Microsoft.Security/connectors", + "properties": { + "hybridComputeSettings": { + "hybridComputeProvisioningState": "Valid", + "autoProvision": "On", + "resourceGroupName": "GcpConnectorRG", + "region": "West US 2", + "proxyServer": { + "ip": "201.120.185.132", + "port": "34" + }, + "servicePrincipal": { + "applicationId": "ad9bcd79-be9c-45ab-abd8-80ca1654a7d1" + } + }, + "authenticationDetails": { + "authenticationProvisioningState": "Valid", + "grantedPermissions": [ + "GCP::Security Center Admin Viewer" + ], + "authenticationType": "gcpCredentials", + "organizationId": "AscDemoOrg", + "type": "", + "projectId": "", + "privateKeyId": "", + "privateKey": "", + "clientEmail": "", + "clientId": "", + "authUri": "", + "tokenUri": "", + "authProviderX509CertUrl": "", + "clientX509CertUrl": "" + } + } + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index ea3392274978..59da08fd7551 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -60,6 +60,7 @@ These settings apply only when `--tag=package-composite-v1` is specified on the ``` yaml $(tag) == 'package-composite-v1' input-file: - Microsoft.Security/preview/2020-01-01-preview/secureScore.json +- Microsoft.Security/preview/2020-01-01-preview/connectors.json - Microsoft.Security/preview/2019-01-01-preview/automations.json - Microsoft.Security/preview/2019-01-01-preview/subAssessments.json - Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json @@ -97,6 +98,7 @@ These settings apply only when `--tag=package-composite-v2` is specified on the ``` yaml $(tag) == 'package-composite-v2' input-file: - Microsoft.Security/preview/2020-01-01-preview/secureScore.json +- Microsoft.Security/preview/2020-01-01-preview/connectors.json - Microsoft.Security/preview/2019-01-01-preview/automations.json - Microsoft.Security/preview/2019-01-01-preview/subAssessments.json - Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json @@ -167,6 +169,7 @@ input-file: - Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json - Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json - Microsoft.Security/preview/2020-01-01-preview/secureScore.json +- Microsoft.Security/preview/2020-01-01-preview/connectors.json # Needed when there is more than one input file override-info: @@ -242,6 +245,7 @@ These settings apply only when `--tag=package-2020-01-preview-only` is specified ``` yaml $(tag) == 'package-2020-01-preview-only' input-file: - Microsoft.Security/preview/2020-01-01-preview/secureScore.json +- Microsoft.Security/preview/2020-01-01-preview/connectors.json # Needed when there is more than one input file override-info: @@ -385,13 +389,15 @@ AutoRest V3 generators require the use of `--tag=all-api-versions` to select api This block is updated by an automatic script. Edits may be lost! -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ + +``` yaml $(tag) == 'all-api-versions' /*autogenerated*/ # include the azure profile definitions from the standard location require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/Microsoft.Security/preview/2020-01-01-preview/secureScore.json + - $(this-folder)/Microsoft.Security/preview/2020-01-01-preview/connectors.json - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/automations.json - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/subAssessments.json - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/regulatoryCompliance.json From 3030d867f5d943d1ba39bda4eee3ff776c8f229d Mon Sep 17 00:00:00 2001 From: Vishnu Priya Ananthu Sundaram Date: Fri, 26 Jun 2020 19:21:19 -0700 Subject: [PATCH 208/318] [Azure Stack] Updates to Azs.Compute.Admin spec for autorest config (#9032) * Cumulative commit message: commit 4ec980f9748c6ee9a98389fff0b3941fc8f1fc63 (azure/stackadmin) Author: Yuxing Zhou Date: Wed Mar 18 15:14:57 2020 +0800 [Azure Stack] Add scaleUnit and volumeLabel parameter to Disks_List (#8733) * add scaleUnit and volumeLabel to Disks_List * fix ref location * update parameter description commit c70efa60201b0925ca77831ca5a366d0f5467387 Author: bganapa Date: Tue Feb 25 19:33:53 2020 -0800 Updating ReadMe to include (this-folder) commit ac2ee5503620ba820d56fc739fd964eff4daa115 Author: Yuxing Zhou Date: Mon Feb 17 08:52:02 2020 +0800 Add TargetScaleUnitParameter and TargetVolumeLabelParameter (#8409) commit 79944a31588af85709579279e236c7d60b122d98 Author: hannah-murphy-0 <60626670+hannah-murphy-0@users.noreply.github.com> Date: Thu Feb 13 17:25:47 2020 -0800 Adding publisher field to VMExtension model (#8398) commit 8ef2c06649fb573679f0d2d4999591d5621d7219 Merge: 4691c2aba b53a498fc Author: bganapa Date: Tue Feb 4 22:11:56 2020 -0800 git merge upstream/master commit 9e551f0eab4057d4c2f54c333c7aa2a1a564c125 Author: bganapa Date: Tue Nov 12 11:44:22 2019 -0800 Reset to Stackadmin2 (#7766) * Add autorest config to readme.md * Fix path reference --- .../2015-12-01-preview/VMExtensions.json | 4 +++ .../compute/readme.azsautogen.md | 13 +++++++ .../resource-manager/compute/readme.md | 36 ++++++------------- 3 files changed, 27 insertions(+), 26 deletions(-) create mode 100644 specification/azsadmin/resource-manager/compute/readme.azsautogen.md diff --git a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json index e3ddfb5dadba..933404e75268 100644 --- a/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json +++ b/specification/azsadmin/resource-manager/compute/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json @@ -224,6 +224,10 @@ "description": "Target virtual machine operating system type necessary for deploying the extension handler.", "$ref": "PlatformImages.json#/definitions/OsType" }, + "publisher": { + "description": "The publisher of the VM Extension", + "type": "string" + }, "computeRole": { "description": "Compute role", "type": "string" diff --git a/specification/azsadmin/resource-manager/compute/readme.azsautogen.md b/specification/azsadmin/resource-manager/compute/readme.azsautogen.md new file mode 100644 index 000000000000..7376b5eb69c3 --- /dev/null +++ b/specification/azsadmin/resource-manager/compute/readme.azsautogen.md @@ -0,0 +1,13 @@ +# AutoRest v3 generators + +> see https://aka.ms/autorest + +``` yaml +input-file: + - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json + - Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json + - Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json + - Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json +``` diff --git a/specification/azsadmin/resource-manager/compute/readme.md b/specification/azsadmin/resource-manager/compute/readme.md index 26cb9b4ef55a..2bed47d25cc2 100644 --- a/specification/azsadmin/resource-manager/compute/readme.md +++ b/specification/azsadmin/resource-manager/compute/readme.md @@ -56,32 +56,16 @@ csharp: clear-output-folder: true ``` -## Multi-API/Profile support for AutoRest v3 generators +# AutoRest v3 generators -AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. - -This block is updated by an automatic script. Edits may be lost! - -``` yaml $(tag) == 'all-api-versions' /* autogenerated */ -# include the azure profile definitions from the standard location -require: $(this-folder)/../../../../profiles/readme.md - -# all the input files across all versions -input-file: - - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json - - $(this-folder)/Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json - -``` - -If there are files that should not be in the `all-api-versions` set, -uncomment the `exclude-file` section below and add the file paths. +> see https://aka.ms/autorest -``` yaml $(tag) == 'all-api-versions' -#exclude-file: -# - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json +``` yaml +input-file: + - Microsoft.Compute.Admin/preview/2015-12-01-preview/Compute.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/PlatformImages.json + - Microsoft.Compute.Admin/preview/2018-02-09/Quotas.json + - Microsoft.Compute.Admin/preview/2015-12-01-preview/VMExtensions.json + - Microsoft.Compute.Admin/preview/2018-07-30-preview/Disks.json + - Microsoft.Compute.Admin/preview/2018-07-30-preview/DiskMigrationJobs.json ``` - From f49ffcfb4080f47947d0b4f59b4fdd15b270b718 Mon Sep 17 00:00:00 2001 From: Dania Etienne Date: Sat, 27 Jun 2020 22:58:34 -0400 Subject: [PATCH 209/318] package-templatespecs-2019-06-preview tag added (#9934) * package-templatespecs-2019-06-preview tag added * Fixed SDK generation * removed extra deployment scripts tag * Fixed SDK Generation * Spelling err Co-authored-by: Dania Etienne --- .../resources/resource-manager/readme.md | 2 ++ .../resource-manager/readme.python.md | 25 +++++++++++++++++++ 2 files changed, 27 insertions(+) diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 7ae41c1ac69c..358f01e9d22b 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -615,6 +615,7 @@ swagger-to-sdk: - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#resources - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#subscriptions - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#links + - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#templatespecs - python ./scripts/multiapi_init_gen.py azure-mgmt-resource#deploymentscripts - repo: azure-sdk-for-python-track2 - repo: azure-sdk-for-java @@ -676,6 +677,7 @@ require: $(this-folder)/../../../profiles/readme.md input-file: - $(this-folder)/Microsoft.Resources/stable/2020-01-01/subscriptions.json - $(this-folder)/Microsoft.Resources/preview/2019-10-01-preview/deploymentScripts.json + - $(this-folder)/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json - $(this-folder)/Microsoft.Features/stable/2015-12-01/features.json - $(this-folder)/Microsoft.Authorization/stable/2016-09-01/locks.json - $(this-folder)/Microsoft.Authorization/stable/2015-01-01/locks.json diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index 709ec28a6bf9..e21a9796e1f3 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -58,6 +58,7 @@ batch: - tag: package-subscriptions-2018-06 - tag: package-subscriptions-2016-06 - tag: package-deploymentscripts-2019-10-preview + - tag: package-templatespecs-2019-06-preview ``` ```yaml $(multiapi) && $(track2) @@ -101,6 +102,8 @@ batch: - multiapiscript-subscriptions: true - tag: package-deploymentscripts-2019-10-preview - multiapiscript-deploymentscripts: true + - tag: package-templatespecs-2019-06-preview + - multiapiscript-templatespecs: true ``` ```yaml $(multiapiscript-features) @@ -138,6 +141,15 @@ clear-output-folder: false perform-load: false ``` + +```yaml $(multiapiscript-templatespecs) +multiapiscript: true +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/templatespecs +clear-output-folder: false +perform-load: false +``` + + ```yaml $(multiapiscript-locks) multiapiscript: true output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/locks @@ -541,3 +553,16 @@ python: namespace: azure.mgmt.resource.deploymentscripts.v2019_10_preview output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/deploymentscripts/v2019_10_preview ``` + +### Tag: package-templatespecs-2019-06-preview and python + +These settings apply only when `--tag=package-templatespecs-2019-06-preview` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-templatespecs-2019-06-preview' +namespace: azure.mgmt.resource.templatespecs.v2019_06_preview +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/templatespecs/v2019_06_preview +python: + namespace: azure.mgmt.resource.templatespecs.v2019_06_preview + output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/templatespecs/v2019_06_preview +``` From c8ab8562ce2e5427fcbb28408623104e825c00c7 Mon Sep 17 00:00:00 2001 From: Liran Chen <1437075+liranc@users.noreply.github.com> Date: Sun, 28 Jun 2020 06:00:18 +0300 Subject: [PATCH 210/318] [Hub Generated] Review request for Microsoft.Security to add version stable/2019-08-01 (#9653) * iotAlertType * alert type example * add alertType to readme * Autorest warnings * Autorest warnings (2) * fix description * iotAlert * examples * autorest warnings * added to readme * update example * removed vendor * fix example types * Updates * remove vendor * fix def reference * updates * limit and properties property * Remove alert type list * extended properties vs entities * Description * entities * Ran prettier * format * Added totalCount, fixed nextLink example * Update types * move examples * List alert types * example paths * Update tags * warnings * fix example * prettier * case sensitive * Example name Co-authored-by: Liran Chen --- ...uritySolutionsSecurityAggregatedAlert.json | 2 +- ...ySolutionsSecurityAggregatedAlertList.json | 4 +- ...IoTSecuritySolutionsSecurityAnalytics.json | 2 +- ...ecuritySolutionsSecurityAnalyticsList.json | 2 +- ...curitySolutionsSecurityRecommendation.json | 2 +- ...tySolutionsSecurityRecommendationList.json | 4 +- .../IotAlertTypes/GetIoTAlertType.json | 29 ++ .../IotAlertTypes/GetIoTAlertTypeList.json | 32 ++ .../examples/IotAlerts/GetIoTAlert.json | 36 ++ .../examples/IotAlerts/GetIoTAlertList.json | 45 +++ .../stable/2019-08-01/iotAlertTypes.json | 317 ++++++++++++++++++ .../stable/2019-08-01/iotAlerts.json | 279 +++++++++++++++ .../security/resource-manager/readme.md | 10 + 13 files changed, 756 insertions(+), 8 deletions(-) create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlertTypes/GetIoTAlertType.json create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlertTypes/GetIoTAlertTypeList.json create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlert.json create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlertList.json create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlertTypes.json create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlerts.json diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAggregatedAlert.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAggregatedAlert.json index e5a4a8ad0a32..15000c2b1292 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAggregatedAlert.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAggregatedAlert.json @@ -11,7 +11,7 @@ "body": { "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/IoT_Bruteforce_Fail/2019-02-02", "name": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/IoT_Bruteforce_Fail/2019-02-02", - "type": "Microsoft.Security/IoTSecurityAggregatedAlert", + "type": "Microsoft.Security/iotSecuritySolutions/analyticsModels/aggregatedAlerts", "properties": { "alertType": "IoT_Bruteforce_Fail", "alertDisplayName": "Failed Bruteforce", diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAggregatedAlertList.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAggregatedAlertList.json index a29bcea8950d..efdb32bef5d3 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAggregatedAlertList.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAggregatedAlertList.json @@ -12,7 +12,7 @@ { "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/IoT_Bruteforce_Fail/2019-02-02", "name": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/IoT_Bruteforce_Fail/2019-02-02", - "type": "Microsoft.Security/IoTSecurityAggregatedAlert", + "type": "Microsoft.Security/iotSecuritySolutions/analyticsModels/aggregatedAlerts", "properties": { "alertType": "IoT_Bruteforce_Fail", "alertDisplayName": "Failed Bruteforce", @@ -43,7 +43,7 @@ { "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/IoT_Bruteforce_Success/2019-02-02", "name": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/IoT_Bruteforce_Success/2019-02-02", - "type": "Microsoft.Security/IoTSecurityAggregatedAlert", + "type": "Microsoft.Security/iotSecuritySolutions/analyticsModels/aggregatedAlerts", "properties": { "alertType": "IoT_Bruteforce_Success", "alertDisplayName": "Successful Bruteforce", diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalytics.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalytics.json index a7337a494529..d46451067bc4 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalytics.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalytics.json @@ -10,7 +10,7 @@ "body": { "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default", "name": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default", - "type": "Microsoft.Security/IoTSecuritySolutionAnalyticsModel", + "type": "Microsoft.Security/iotSecuritySolutions/analyticsModels", "properties": { "metrics": { "high": 5, diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalyticsList.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalyticsList.json index aa75fced7adf..05f3130b231d 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalyticsList.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityAnalyticsList.json @@ -12,7 +12,7 @@ { "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default", "name": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/MyGroup/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default", - "type": "Microsoft.Security/IoTSecuritySolutionAnalyticsModelList", + "type": "Microsoft.Security/iotSecuritySolutions/analyticsModels", "properties": { "metrics": { "high": 5, diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityRecommendation.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityRecommendation.json index 51b44a0c90c2..82d08f53e634 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityRecommendation.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityRecommendation.json @@ -11,7 +11,7 @@ "body": { "id": "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/IoTEdgeResources/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/OpenPortsOnDevice", "name": "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/IoTEdgeResources/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/OpenPortsOnDevice", - "type": "Microsoft.Security/IoTSecurityAggregatedRecommendation", + "type": "Microsoft.Security/iotSecuritySolutions/analyticsModels/aggregatedRecommendations", "properties": { "recommendationName": "OpenPortsOnDevice", "recommendationDisplayName": "Permissive firewall policy in one of the chains was found", diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityRecommendationList.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityRecommendationList.json index 3a331b30297d..84e6845afc78 100644 --- a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityRecommendationList.json +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IoTSecuritySolutionsAnalytics/GetIoTSecuritySolutionsSecurityRecommendationList.json @@ -12,7 +12,7 @@ { "id": "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/IoTEdgeResources/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/OpenPortsOnDevice", "name": "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/IoTEdgeResources/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/OpenPortsOnDevice", - "type": "Microsoft.Security/IoTSecurityAggregatedRecommendation", + "type": "Microsoft.Security/iotSecuritySolutions/analyticsModels/aggregatedRecommendations", "properties": { "recommendationName": "OpenPortsOnDevice", "recommendationDisplayName": "Permissive firewall policy in one of the chains was found", @@ -29,7 +29,7 @@ { "id": "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/IoTEdgeResources/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/TooLargeIPRange", "name": "/subscriptions/075423e9-7d33-4166-8bdf-3920b04e3735/resourceGroups/IoTEdgeResources/providers/Microsoft.Security/IoTSecuritySolutions/Locations/eastus/default/IoT_InstallAgent", - "type": "Microsoft.Security/IoTSecurityAggregatedRecommendation", + "type": "Microsoft.Security/iotSecuritySolutions/analyticsModels/aggregatedRecommendations", "properties": { "recommendationName": "TooLargeIPRange", "recommendationDisplayName": "Permissive firewall policy in one of the chains was found", diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlertTypes/GetIoTAlertType.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlertTypes/GetIoTAlertType.json new file mode 100644 index 000000000000..59ef397db7a3 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlertTypes/GetIoTAlertType.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2019-08-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myGroup", + "solutionName": "mySolution", + "iotAlertTypeName": "IoT_PrivilegedContainer" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotAlertTypes/IoT_PrivilegedContainer", + "name": "IoT_PrivilegedContainer", + "type": "Microsoft.Security/iotSecuritySolutions/iotAlertTypes", + "properties": { + "alertDisplayName": "Privileged container detected", + "severity": "Medium", + "description": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine.", + "providerName": "IoTSecurity", + "remediationSteps": [ + "If the container doesn't need to run in privileged mode, remove the privileges from the container." + ], + "intent": "Exploitation,Execution", + "vendorName": "Microsoft" + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlertTypes/GetIoTAlertTypeList.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlertTypes/GetIoTAlertTypeList.json new file mode 100644 index 000000000000..e4cab077fa81 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlertTypes/GetIoTAlertTypeList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2019-08-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myGroup", + "solutionName": "mySolution" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotAlertTypes", + "name": "IoT_PrivilegedContainer", + "type": "Microsoft.Security/iotSecuritySolutions/iotAlertTypes", + "properties": { + "alertDisplayName": "Privileged container detected", + "severity": "Medium", + "description": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine.", + "providerName": "IoTSecurity", + "remediationSteps": [ + "If the container doesn't need to run in privileged mode, remove the privileges from the container." + ], + "intent": "Exploitation,Execution", + "vendorName": "Microsoft" + } + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlert.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlert.json new file mode 100644 index 000000000000..a93e1cf0bc37 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlert.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2019-08-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myGroup", + "solutionName": "mySolution", + "iotAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" + }, + "responses": { + "200": { + "body": { + "properties": { + "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "compromisedEntity": "device-1", + "alertType": "IoT_PrivilegedContainer", + "startTimeUtc": "2020-05-13T06:32:25Z", + "endTimeUtc": "2020-05-13T06:32:25Z", + "entities": [ + { + "$id": "1", + "CommandLine": "docker run --privileged", + "Type": "process" + } + ], + "extendedProperties": { + "CommandLine": "docker run --privileged", + "User Name": "aUser", + "UserId": "", + "ParentProcessId": 1593, + "DeviceId": "device-1" + } + } + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlertList.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlertList.json new file mode 100644 index 000000000000..af86889cbe2f --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/examples/IotAlerts/GetIoTAlertList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-08-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myGroup", + "solutionName": "mySolution", + "alertType": "IoT_PrivilegedContainer", + "startTimeUtc>": "2020-05-12T06:32:25Z", + "startTimeUtc<": "2020-05-14T06:32:25Z", + "$limit": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "systemAlertId": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "compromisedEntity": "device-1", + "alertType": "IoT_PrivilegedContainer", + "startTimeUtc": "2020-05-13T06:32:25Z", + "endTimeUtc": "2020-05-13T06:32:25Z", + "entities": [ + { + "$id": "1", + "CommandLine": "docker run --privileged", + "Type": "process" + } + ], + "extendedProperties": { + "CommandLine": "docker run --privileged", + "User Name": "aUser", + "UserId": "", + "ParentProcessId": 1593, + "DeviceId": "device-1" + } + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myGroup/providers/Microsoft.Security/iotSecuritySolutions/mySolution/iotAlerts?api-version=2019-08-01&alertType=IoT_PrivilegedContainer&startTimeUtc>=2020-05-12T06:32:25Z&startTimeUtc<=2020-05-14T06:32:25Z&$limit=1&$skipToken=903e76ff-17eb-4bac-ac8a-2bc31ab68fd8", + "totalCount": 23 + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlertTypes.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlertTypes.json new file mode 100644 index 000000000000..a98dca5b354b --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlertTypes.json @@ -0,0 +1,317 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2019-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/iotAlertTypes": { + "get": { + "x-ms-examples": { + "Get IoT Alert Types": { + "$ref": "./examples/IotAlertTypes/GetIoTAlertTypeList.json" + } + }, + "tags": [ + "IoT Security Alert Types" + ], + "description": "List IoT alert types", + "operationId": "IotAlertTypes_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SolutionName" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IotAlertTypeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/iotAlertTypes/{iotAlertTypeName}": { + "get": { + "x-ms-examples": { + "Get IoT Alert Type": { + "$ref": "./examples/IotAlertTypes/GetIoTAlertType.json" + } + }, + "tags": [ + "IoT Security Alert Types" + ], + "operationId": "IotAlertTypes_Get", + "description": "Get IoT alert type", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SolutionName" + }, + { + "in": "path", + "name": "iotAlertTypeName", + "required": true, + "type": "string", + "description": "Name of the alert type" + } + ], + "responses": { + "200": { + "description": "IoT alert type", + "schema": { + "$ref": "#/definitions/IotAlertType" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "IotAlertTypeList": { + "type": "object", + "description": "List of alert types", + "properties": { + "value": { + "type": "array", + "description": "List data", + "items": { + "$ref": "#/definitions/IotAlertType" + } + } + } + }, + "IotAlertType": { + "type": "object", + "description": "IoT alert type.", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Alert type properties", + "$ref": "#/definitions/IotAlertTypeProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + } + ] + }, + "IotAlertTypeProperties": { + "type": "object", + "description": "IoT alert type information.", + "properties": { + "alertDisplayName": { + "readOnly": true, + "type": "string", + "example": "Privileged container detected", + "description": "The display name of the alert" + }, + "severity": { + "readOnly": true, + "type": "string", + "example": "Medium", + "description": "The severity of the alert", + "enum": [ + "Informational", + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "alertSeverity", + "modelAsString": true, + "values": [ + { + "value": "Informational" + }, + { + "value": "Low" + }, + { + "value": "Medium" + }, + { + "value": "High" + } + ] + } + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the suspected vulnerability and meaning.", + "example": "Machine logs indicate that a privileged Docker container is running. A privileged container has full access to host resources. If compromised, a malicious actor can use the privileged container to gain access to the host machine." + }, + "providerName": { + "readOnly": true, + "type": "string", + "example": "IoTSecurity", + "description": "The name of the alert provider or internal partner" + }, + "vendorName": { + "readOnly": true, + "type": "string", + "example": "Microsoft", + "description": "The name of the vendor that raise the alert" + }, + "intent": { + "readOnly": true, + "type": "string", + "example": "Exploitation,Execution", + "description": "Kill chain related intent behind the alert. Could contain multiple enum values (separated by commas)", + "enum": [ + "Unknown", + "PreAttack", + "InitialAccess", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Execution", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact", + "Probing", + "Exploitation" + ], + "x-ms-enum": { + "name": "alertIntent", + "modelAsString": true, + "values": [ + { + "value": "Unknown" + }, + { + "value": "PreAttack" + }, + { + "value": "InitialAccess" + }, + { + "value": "Persistence" + }, + { + "value": "PrivilegeEscalation" + }, + { + "value": "DefenseEvasion" + }, + { + "value": "CredentialAccess" + }, + { + "value": "Discovery" + }, + { + "value": "LateralMovement" + }, + { + "value": "Execution" + }, + { + "value": "Collection" + }, + { + "value": "Exfiltration" + }, + { + "value": "CommandAndControl" + }, + { + "value": "Impact" + }, + { + "value": "Probing" + }, + { + "value": "Exploitation" + } + ] + } + }, + "remediationSteps": { + "readOnly": true, + "description": "Manual action items to take to remediate the alert", + "type": "array", + "items": { + "type": "string", + "example": "If the container doesn't need to run in privileged mode, remove the privileges from the container." + } + } + } + } + }, + "parameters": { + "SolutionName": { + "name": "solutionName", + "in": "path", + "required": true, + "description": "The name of the IoT Security solution.", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlerts.json b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlerts.json new file mode 100644 index 000000000000..b51e7a792f22 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2019-08-01/iotAlerts.json @@ -0,0 +1,279 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2019-08-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/iotAlerts": { + "get": { + "x-ms-examples": { + "Get IoT Alerts": { + "$ref": "./examples/IotAlerts/GetIoTAlertList.json" + } + }, + "tags": [ + "IoT Security Alerts" + ], + "description": "List IoT alerts", + "operationId": "IotAlerts_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SolutionName" + }, + { + "in": "query", + "name": "startTimeUtc>", + "x-ms-client-name": "minStartTimeUtc", + "required": false, + "type": "string", + "description": "Filter by minimum startTimeUtc (ISO 8601 format)" + }, + { + "in": "query", + "name": "startTimeUtc<", + "x-ms-client-name": "maxStartTimeUtc", + "required": false, + "type": "string", + "description": "Filter by maximum startTimeUtc (ISO 8601 format)" + }, + { + "in": "query", + "name": "alertType", + "required": false, + "type": "string", + "description": "Filter by alert type" + }, + { + "in": "query", + "name": "$limit", + "required": false, + "type": "integer", + "format": "int32", + "description": "Limit the number of items returned in a single page" + }, + { + "in": "query", + "name": "$skipToken", + "required": false, + "type": "string", + "description": "Skip token used for pagination" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/IotAlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/iotAlerts/{iotAlertId}": { + "get": { + "x-ms-examples": { + "Get IoT Alert": { + "$ref": "./examples/IotAlerts/GetIoTAlert.json" + } + }, + "tags": [ + "IoT Security Alerts" + ], + "operationId": "IotAlerts_Get", + "description": "Get IoT alert", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/SolutionName" + }, + { + "in": "path", + "name": "iotAlertId", + "required": true, + "type": "string", + "description": "Id of the alert" + } + ], + "responses": { + "200": { + "description": "IoT alert", + "schema": { + "$ref": "#/definitions/IotAlert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "IotAlertList": { + "description": "List of IoT alerts", + "type": "object", + "properties": { + "value": { + "description": "List data", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/IotAlert" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "When available, follow the URI to get the next page of data" + }, + "totalCount": { + "readOnly": true, + "format": "int32", + "type": "integer", + "description": "Total count of alerts that conforms with the given filter options (not affected by page size)" + } + } + }, + "IotAlert": { + "type": "object", + "description": "IoT alert", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Alert properties", + "$ref": "#/definitions/IotAlertProperties" + } + } + }, + "IotAlertProperties": { + "type": "object", + "description": "IoT alert properties", + "properties": { + "systemAlertId": { + "description": "Holds the product canonical identifier of the alert within the scope of a product", + "readOnly": true, + "type": "string", + "example": "903e76ff-17eb-4bac-ac8a-2bc31ab68fd8" + }, + "compromisedEntity": { + "description": "Display name of the main entity being reported on", + "readOnly": true, + "type": "string", + "example": "device-1" + }, + "alertType": { + "description": "The type name of the alert", + "readOnly": true, + "type": "string", + "example": "IoT_PrivilegedContainer" + }, + "startTimeUtc": { + "description": "The impact start time of the alert (the time of the first event or activity included in the alert)", + "readOnly": true, + "type": "string", + "example": "2020-05-13T06:32:25Z" + }, + "endTimeUtc": { + "description": "The impact end time of the alert (the time of the last event or activity included in the alert)", + "readOnly": true, + "type": "string", + "example": "2020-05-13T06:32:25Z" + }, + "entities": { + "description": "A list of entities related to the alert", + "type": "array", + "items": { + "type": "object" + }, + "example": [ + { + "$id": "1", + "CommandLine": "docker run --privileged", + "Type": "process" + } + ] + }, + "extendedProperties": { + "type": "object", + "description": "A bag of fields which extends the alert information", + "example": { + "CommandLine": "docker run --privileged", + "User Name": "aUser", + "UserId": "", + "ParentProcessId": 1593, + "DeviceId": "device-1" + } + } + } + } + }, + "parameters": { + "SolutionName": { + "name": "solutionName", + "in": "path", + "required": true, + "description": "The name of the IoT Security solution.", + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 59da08fd7551..14664abb714f 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -36,6 +36,10 @@ directive: from: iotSecuritySolutionAnalytics.json where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/analyticsModels"].get' reason: The list returns limited number of items + - suppress: PageableOperation + from: alertTypes.json + where: '$.paths["/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/iotSecuritySolutions/{solutionName}/alertTypes"].get' + reason: The list returns limited number of items ``` ### Basic Information @@ -145,6 +149,8 @@ input-file: - Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json - Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json - Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json +- Microsoft.Security/stable/2019-08-01/iotAlertTypes.json +- Microsoft.Security/stable/2019-08-01/iotAlerts.json - Microsoft.Security/preview/2015-06-01-preview/locations.json - Microsoft.Security/preview/2015-06-01-preview/operations.json - Microsoft.Security/preview/2015-06-01-preview/tasks.json @@ -300,6 +306,8 @@ These settings apply only when `--tag=package-2019-08-only` is specified on the input-file: - Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json - Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json +- Microsoft.Security/stable/2019-08-01/iotAlertTypes.json +- Microsoft.Security/stable/2019-08-01/iotAlerts.json # Needed when there is more than one input file override-info: @@ -432,6 +440,8 @@ input-file: - $(this-folder)/Microsoft.Security/stable/2019-08-01/deviceSecurityGroups.json - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotSecuritySolutions.json - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotSecuritySolutionAnalytics.json + - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotAlertTypes.json + - $(this-folder)/Microsoft.Security/stable/2019-08-01/iotAlerts.json - $(this-folder)/Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json - $(this-folder)/Microsoft.Security/stable/2020-01-01/assessmentMetadata.json - $(this-folder)/Microsoft.Security/stable/2020-01-01/assessments.json From e25f138dbe795eca448233c45afb2957b8a1f077 Mon Sep 17 00:00:00 2001 From: najagasi <49212852+najagasi@users.noreply.github.com> Date: Sat, 27 Jun 2020 20:30:54 -0700 Subject: [PATCH 211/318] Lower case skiptoken param for correctly displaying in swagger (#9956) Co-authored-by: Namrata Jagasia --- .../PolicyEvents_QueryManagementGroupScopeNextLink.json | 2 +- ...ts_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json | 2 +- .../examples/PolicyEvents_QueryResourceGroupScopeNextLink.json | 2 +- .../examples/PolicyEvents_QueryResourceScopeNextLink.json | 2 +- ...nts_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json | 2 +- ...nts_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json | 2 +- ..._QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json | 2 +- .../examples/PolicyEvents_QuerySubscriptionScopeNextLink.json | 2 +- .../PolicyStates_QueryManagementGroupScopeNextLink.json | 2 +- ...es_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json | 2 +- .../examples/PolicyStates_QueryResourceGroupScopeNextLink.json | 2 +- .../examples/PolicyStates_QueryResourceScopeNextLink.json | 2 +- ...tes_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json | 2 +- ...tes_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json | 2 +- ..._QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json | 2 +- .../examples/PolicyStates_QuerySubscriptionScopeNextLink.json | 2 +- .../PolicyEvents_QueryManagementGroupScopeNextLink.json | 2 +- ...ts_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json | 2 +- .../examples/PolicyEvents_QueryResourceGroupScopeNextLink.json | 2 +- .../examples/PolicyEvents_QueryResourceScopeNextLink.json | 2 +- ...nts_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json | 2 +- ...nts_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json | 2 +- ..._QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json | 2 +- .../examples/PolicyEvents_QuerySubscriptionScopeNextLink.json | 2 +- .../PolicyStates_QueryManagementGroupScopeNextLink.json | 2 +- ...es_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json | 2 +- .../examples/PolicyStates_QueryResourceGroupScopeNextLink.json | 2 +- .../examples/PolicyStates_QueryResourceScopeNextLink.json | 2 +- ...tes_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json | 2 +- ...tes_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json | 2 +- ..._QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json | 2 +- .../examples/PolicyStates_QuerySubscriptionScopeNextLink.json | 2 +- 32 files changed, 32 insertions(+), 32 deletions(-) diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json index 2601de7b93e5..d684bbabf6f8 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json @@ -4,7 +4,7 @@ "managementGroupsNamespace": "Microsoft.Management", "managementGroupName": "myManagementGroup", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json index 72823e4ff9cf..e9c799fb0f2f 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json @@ -6,7 +6,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyAssignmentName": "myPolicyAssignment", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json index cf8cd04d13f0..e8e382243513 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json @@ -4,7 +4,7 @@ "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", "resourceGroupName": "myResourceGroup", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceScopeNextLink.json index 67866db89076..31d7d21b27a7 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QueryResourceScopeNextLink.json @@ -3,7 +3,7 @@ "policyEventsResource": "default", "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json index 69b634579055..f9af7f2abbc4 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json index 3fc60d7a3a1c..4ccd0e551d27 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json index 55fa3363f75a..1ebc94234ad2 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json index c87eb684900a..23c67a6810b5 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json @@ -3,7 +3,7 @@ "policyEventsResource": "default", "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryManagementGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryManagementGroupScopeNextLink.json index 9e9ad020887f..4b69d867cdc2 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryManagementGroupScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryManagementGroupScopeNextLink.json @@ -4,7 +4,7 @@ "managementGroupsNamespace": "Microsoft.Management", "managementGroupName": "myManagementGroup", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json index 900833c0da86..a524d47c3bcb 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json @@ -6,7 +6,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyAssignmentName": "myPolicyAssignment", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupScopeNextLink.json index 7555abf977df..48b1c99250c7 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceGroupScopeNextLink.json @@ -4,7 +4,7 @@ "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", "resourceGroupName": "myResourceGroup", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceScopeNextLink.json index be286ead7381..b7a89670dc9e 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QueryResourceScopeNextLink.json @@ -3,7 +3,7 @@ "policyStatesResource": "default", "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json index 4411d95cc2d7..83c5cf5997c7 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json index 94f65e67ab79..90ef402bc1e9 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json index a587122bb850..79d81cc3ad9e 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionScopeNextLink.json index 7d164b166fe2..f297ea38ef95 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/preview/2018-07-01-preview/examples/PolicyStates_QuerySubscriptionScopeNextLink.json @@ -3,7 +3,7 @@ "policyStatesResource": "latest", "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", "api-version": "2018-07-01-preview", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json index 35e65b711864..f06c11ec14b9 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryManagementGroupScopeNextLink.json @@ -4,7 +4,7 @@ "managementGroupsNamespace": "Microsoft.Management", "managementGroupName": "myManagementGroup", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json index 45e0bd6a396e..d2ef96960e66 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json @@ -6,7 +6,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyAssignmentName": "myPolicyAssignment", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json index aaa00e7e5dd2..74b6f139c396 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceGroupScopeNextLink.json @@ -4,7 +4,7 @@ "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", "resourceGroupName": "myResourceGroup", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceScopeNextLink.json index edc6d3d1448a..2c843f96e600 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QueryResourceScopeNextLink.json @@ -3,7 +3,7 @@ "policyEventsResource": "default", "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json index af28e1c64a17..31b44a52eaf4 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json index 5e83b32ebebd..752fcac07d59 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json index 04873b559997..fa9105092fb6 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json index 232c6e27597e..db909237f51c 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyEvents_QuerySubscriptionScopeNextLink.json @@ -3,7 +3,7 @@ "policyEventsResource": "default", "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLink.json index ab5e1ea52d23..d14eabedc64b 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryManagementGroupScopeNextLink.json @@ -4,7 +4,7 @@ "managementGroupsNamespace": "Microsoft.Management", "managementGroupName": "myManagementGroup", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json index d107a6a9be18..47973328fa88 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceGroupLevelPolicyAssignmentScopeNextLink.json @@ -6,7 +6,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyAssignmentName": "myPolicyAssignment", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceGroupScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceGroupScopeNextLink.json index c3fa3fe3023f..3f0ffdac69f9 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceGroupScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceGroupScopeNextLink.json @@ -4,7 +4,7 @@ "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", "resourceGroupName": "myResourceGroup", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceScopeNextLink.json index 66b643857d0b..3c44f1bcc9e1 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QueryResourceScopeNextLink.json @@ -3,7 +3,7 @@ "policyStatesResource": "default", "resourceId": "subscriptions/fff10b27-fff3-fff5-fff8-fffbe01e86a5/resourceGroups/myResourceGroup/providers/Microsoft.ClassicCompute/domainNames/myDomainName", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json index 7c197f729eef..36b15704ae3d 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyAssignmentScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyAssignmentName": "ec8f9645-8ecb-4abb-9c0b-5292f19d4003", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json index 556b9b42ec99..53a2f31c22a4 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicyDefinitionScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policyDefinitionName": "24813039-7534-408a-9842-eb99f45721b1", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json index f5928e9bc5a7..fabe7a565e54 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionLevelPolicySetDefinitionScopeNextLink.json @@ -5,7 +5,7 @@ "authorizationNamespace": "Microsoft.Authorization", "policySetDefinitionName": "3e3807c1-65c9-49e0-a406-82d8ae3e338c", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { diff --git a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionScopeNextLink.json b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionScopeNextLink.json index 018894716955..2fa56e87a7c3 100644 --- a/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionScopeNextLink.json +++ b/specification/policyinsights/resource-manager/Microsoft.PolicyInsights/stable/2019-10-01/examples/PolicyStates_QuerySubscriptionScopeNextLink.json @@ -3,7 +3,7 @@ "policyStatesResource": "latest", "subscriptionId": "fffedd8f-ffff-fffd-fffd-fffed2f84852", "api-version": "2019-10-01", - "$skipToken": "WpmWfBSvPhkAK6QD" + "$skiptoken": "WpmWfBSvPhkAK6QD" }, "responses": { "200": { From 279ea12047355040deb5528dc22b2379cc379e17 Mon Sep 17 00:00:00 2001 From: "Kaihui (Kerwin) Sun" Date: Sun, 28 Jun 2020 14:02:27 +0800 Subject: [PATCH 212/318] Add 202 to operation checkPrivateLinkServiceVisibility (#9800) * add 202 to operation checkPrivateLinkServiceVisibility * update examples --- .../CheckPrivateLinkServiceVisibility.json | 3 ++- ...rivateLinkServiceVisibilityByResourceGroup.json | 3 ++- .../stable/2019-04-01/privateLinkService.json | 14 ++++++++++++++ .../CheckPrivateLinkServiceVisibility.json | 3 ++- ...rivateLinkServiceVisibilityByResourceGroup.json | 3 ++- .../stable/2019-06-01/privateLinkService.json | 14 ++++++++++++++ .../CheckPrivateLinkServiceVisibility.json | 3 ++- ...rivateLinkServiceVisibilityByResourceGroup.json | 3 ++- .../stable/2019-07-01/privateLinkService.json | 14 ++++++++++++++ .../CheckPrivateLinkServiceVisibility.json | 3 ++- ...rivateLinkServiceVisibilityByResourceGroup.json | 3 ++- .../stable/2019-08-01/privateLinkService.json | 14 ++++++++++++++ .../CheckPrivateLinkServiceVisibility.json | 3 ++- ...rivateLinkServiceVisibilityByResourceGroup.json | 3 ++- .../stable/2019-09-01/privateLinkService.json | 14 ++++++++++++++ .../CheckPrivateLinkServiceVisibility.json | 3 ++- ...rivateLinkServiceVisibilityByResourceGroup.json | 3 ++- .../stable/2019-11-01/privateLinkService.json | 14 ++++++++++++++ .../CheckPrivateLinkServiceVisibility.json | 3 ++- ...rivateLinkServiceVisibilityByResourceGroup.json | 3 ++- .../stable/2019-12-01/privateLinkService.json | 14 ++++++++++++++ .../CheckPrivateLinkServiceVisibility.json | 3 ++- ...rivateLinkServiceVisibilityByResourceGroup.json | 3 ++- .../stable/2020-03-01/privateLinkService.json | 14 ++++++++++++++ .../CheckPrivateLinkServiceVisibility.json | 3 ++- ...rivateLinkServiceVisibilityByResourceGroup.json | 3 ++- .../stable/2020-04-01/privateLinkService.json | 14 ++++++++++++++ .../CheckPrivateLinkServiceVisibility.json | 3 ++- ...rivateLinkServiceVisibilityByResourceGroup.json | 3 ++- .../stable/2020-05-01/privateLinkService.json | 14 ++++++++++++++ 30 files changed, 180 insertions(+), 20 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/CheckPrivateLinkServiceVisibility.json index 20a055c2c1f6..8cb5caa3931c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/CheckPrivateLinkServiceVisibility.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/CheckPrivateLinkServiceVisibility.json @@ -12,6 +12,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json index bf14cf2cc546..95f965f74e25 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -13,6 +13,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/privateLinkService.json index 2c83b38d7560..50c461a20ad0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/privateLinkService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-04-01/privateLinkService.json @@ -463,8 +463,15 @@ "schema": { "$ref": "#/definitions/PrivateLinkServiceVisibility" } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" @@ -516,8 +523,15 @@ "schema": { "$ref": "#/definitions/PrivateLinkServiceVisibility" } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/examples/CheckPrivateLinkServiceVisibility.json index b2a6af0b8579..063e1d401e3a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/examples/CheckPrivateLinkServiceVisibility.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/examples/CheckPrivateLinkServiceVisibility.json @@ -12,6 +12,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json index 71aed28e49ff..692d337ec3a2 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -13,6 +13,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/privateLinkService.json index e353c3b3854a..67470d8bcf7f 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/privateLinkService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-06-01/privateLinkService.json @@ -463,8 +463,15 @@ "schema": { "$ref": "#/definitions/PrivateLinkServiceVisibility" } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" @@ -516,8 +523,15 @@ "schema": { "$ref": "#/definitions/PrivateLinkServiceVisibility" } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/examples/CheckPrivateLinkServiceVisibility.json index d071067f2657..6e4a8313aa55 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/examples/CheckPrivateLinkServiceVisibility.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/examples/CheckPrivateLinkServiceVisibility.json @@ -12,6 +12,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json index e8a83a3d9b13..8ad99c7c7214 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -13,6 +13,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/privateLinkService.json index c773f0407dda..8a5f52168f92 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/privateLinkService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-07-01/privateLinkService.json @@ -463,8 +463,15 @@ "schema": { "$ref": "#/definitions/PrivateLinkServiceVisibility" } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" @@ -516,8 +523,15 @@ "schema": { "$ref": "#/definitions/PrivateLinkServiceVisibility" } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/examples/CheckPrivateLinkServiceVisibility.json index 2df87c4d8b80..f4bedb2a0270 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/examples/CheckPrivateLinkServiceVisibility.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/examples/CheckPrivateLinkServiceVisibility.json @@ -12,6 +12,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json index 5ae8958bcb49..45bc8d5026ff 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -13,6 +13,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/privateLinkService.json index 9d62becd6bdd..3f4e4bcee5ce 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/privateLinkService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-08-01/privateLinkService.json @@ -463,8 +463,15 @@ "schema": { "$ref": "#/definitions/PrivateLinkServiceVisibility" } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" @@ -516,8 +523,15 @@ "schema": { "$ref": "#/definitions/PrivateLinkServiceVisibility" } + }, + "202": { + "description": "Accepted and the operation will complete asynchronously." } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/examples/CheckPrivateLinkServiceVisibility.json index c310e51407ea..4202a5a24138 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/examples/CheckPrivateLinkServiceVisibility.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/examples/CheckPrivateLinkServiceVisibility.json @@ -12,6 +12,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json index 85cc866a1fc2..fdf7cea84c27 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -13,6 +13,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/privateLinkService.json index 19096cbeeece..cec17b5902d2 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/privateLinkService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-09-01/privateLinkService.json @@ -579,6 +579,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -586,6 +589,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" @@ -638,6 +645,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -645,6 +655,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/examples/CheckPrivateLinkServiceVisibility.json index 839d0dcb97ee..3ef322382eea 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/examples/CheckPrivateLinkServiceVisibility.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/examples/CheckPrivateLinkServiceVisibility.json @@ -12,6 +12,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json index 3b0377a37bdc..6028c9b5c951 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -13,6 +13,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/privateLinkService.json index 5f90e7b95d5f..0b53a6395ba7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/privateLinkService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-11-01/privateLinkService.json @@ -579,6 +579,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -586,6 +589,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" @@ -638,6 +645,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -645,6 +655,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/examples/CheckPrivateLinkServiceVisibility.json index 20d242f7e96f..32314f36f0ba 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/examples/CheckPrivateLinkServiceVisibility.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/examples/CheckPrivateLinkServiceVisibility.json @@ -12,6 +12,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json index d1cd2b0973e1..ce5df209a968 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -13,6 +13,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/privateLinkService.json index 43c093cf8cb5..ddefe78a18bc 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/privateLinkService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2019-12-01/privateLinkService.json @@ -579,6 +579,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -586,6 +589,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" @@ -638,6 +645,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -645,6 +655,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/examples/CheckPrivateLinkServiceVisibility.json index 8a4799272297..4adf0b539783 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/examples/CheckPrivateLinkServiceVisibility.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/examples/CheckPrivateLinkServiceVisibility.json @@ -12,6 +12,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json index 737a5872527e..1ff519b80f53 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -13,6 +13,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/privateLinkService.json index d0fc0aba4b5d..8e6e8c2a7816 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/privateLinkService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/privateLinkService.json @@ -579,6 +579,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -586,6 +589,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" @@ -638,6 +645,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -645,6 +655,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckPrivateLinkServiceVisibility.json index 695f10456142..59136d23a2a7 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckPrivateLinkServiceVisibility.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckPrivateLinkServiceVisibility.json @@ -12,6 +12,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json index 982f94e780c0..fe50aee4096c 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -13,6 +13,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/privateLinkService.json index 9af7deeed685..d10ad9249709 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/privateLinkService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/privateLinkService.json @@ -579,6 +579,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -586,6 +589,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" @@ -638,6 +645,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -645,6 +655,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibility.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibility.json index 90eae91deb38..299c5dfe937a 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibility.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibility.json @@ -12,6 +12,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json index db32cdcb2184..2ee00862beb3 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json @@ -13,6 +13,7 @@ "body": { "visible": true } - } + }, + "202": {} } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateLinkService.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateLinkService.json index cdaf84b39ac3..e99b351dae8d 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateLinkService.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/privateLinkService.json @@ -579,6 +579,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -586,6 +589,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibility.json" @@ -638,6 +645,9 @@ "$ref": "#/definitions/PrivateLinkServiceVisibility" } }, + "202": { + "description": "Accepted and the operation will complete asynchronously." + }, "default": { "description": "Error response describing why the operation failed.", "schema": { @@ -645,6 +655,10 @@ } } }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, "x-ms-examples": { "Check private link service visibility": { "$ref": "./examples/CheckPrivateLinkServiceVisibilityByResourceGroup.json" From 25e560ebadae221d60e3c301da937720b888affb Mon Sep 17 00:00:00 2001 From: Guanyu Wang Date: Sat, 27 Jun 2020 23:09:53 -0700 Subject: [PATCH 213/318] [READY FOR REVIEW]AML workspace delete should be async (#9973) * AML workspace delete should be async * update operation type * Fix old examples * Fix old examples * re-add 200 Co-authored-by: Guanyu Wang --- .../examples/deleteWorkspace.json | 1 + .../examples/updateAKSCompute.json | 1 - .../examples/updateBatchAICompute.json | 15 ++++++--------- .../machineLearningServices.json | 4 ++++ .../examples/deleteWorkspace.json | 1 + .../examples/updateAKSCompute.json | 1 - .../examples/updateAmlCompute.json | 12 ++++-------- .../machineLearningServices.json | 4 ++++ .../examples/deleteWorkspace.json | 1 + .../machineLearningServices.json | 4 ++++ .../2018-11-19/examples/deleteWorkspace.json | 1 + .../2018-11-19/examples/updateAKSCompute.json | 1 - .../2018-11-19/examples/updateAmlCompute.json | 12 ++++-------- .../2018-11-19/machineLearningServices.json | 4 ++++ .../2019-05-01/examples/deleteWorkspace.json | 1 + .../2019-05-01/examples/updateAKSCompute.json | 1 - .../2019-05-01/examples/updateAmlCompute.json | 12 ++++-------- .../2019-05-01/machineLearningServices.json | 4 ++++ .../2019-06-01/examples/deleteWorkspace.json | 1 + .../2019-06-01/examples/updateAKSCompute.json | 1 - .../2019-06-01/examples/updateAmlCompute.json | 12 ++++-------- .../2019-06-01/machineLearningServices.json | 4 ++++ .../2019-11-01/examples/deleteWorkspace.json | 1 + .../2019-11-01/examples/updateAKSCompute.json | 1 - .../2019-11-01/examples/updateAmlCompute.json | 12 ++++-------- .../2019-11-01/machineLearningServices.json | 4 ++++ .../2020-01-01/examples/deleteWorkspace.json | 1 + .../2020-01-01/examples/updateAKSCompute.json | 1 - .../2020-01-01/examples/updateAmlCompute.json | 12 ++++-------- .../2020-01-01/machineLearningServices.json | 4 ++++ .../2020-03-01/examples/deleteWorkspace.json | 1 + .../2020-03-01/machineLearningServices.json | 4 ++++ .../2020-04-01/examples/deleteWorkspace.json | 1 + .../2020-04-01/machineLearningServices.json | 4 ++++ 34 files changed, 80 insertions(+), 64 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteWorkspace.json index 452b097c5492..7fa394143539 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/deleteWorkspace.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateAKSCompute.json index 9aef142daae8..6ad3832da23e 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateAKSCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateAKSCompute.json @@ -6,7 +6,6 @@ "computeName": "compute123", "api-version": "2018-03-01-preview", "parameters": { - "id": "compute123", "location": "eastus", "properties": { "description": "some compute", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateBatchAICompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateBatchAICompute.json index eb9e7a49b81c..0d7c6dfb1685 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateBatchAICompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/examples/updateBatchAICompute.json @@ -8,17 +8,14 @@ "parameters": { "location": "eastus", "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.BatchAI/clusters/compute123-ccb488844dcc2", "computeType": "BatchAI", "properties": { - "description": "some compute", - "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.BatchAI/clusters/compute123-ccb488844dcc2", - "computeType": "BatchAI", - "properties": { - "scaleSettings": { - "maxNodeCount": 4, - "minNodeCount": 4, - "autoScaleEnabled": false - } + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "autoScaleEnabled": false } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json index 8868b1aa282e..f1602f26e8e8 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json @@ -172,6 +172,7 @@ "$ref": "./examples/deleteWorkspace.json" } }, + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -190,6 +191,9 @@ "200": { "description": "The request was successful; the request was well-formed and received properly." }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, "204": { "description": "The machine learning workspace does not exist in the subscription." }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/deleteWorkspace.json index a973a13a3e93..7141dc1b26aa 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/deleteWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/deleteWorkspace.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/updateAKSCompute.json index 42e71959ac35..462f8925bb66 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/updateAKSCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/updateAKSCompute.json @@ -6,7 +6,6 @@ "computeName": "compute123", "api-version": "2020-02-18-preview", "parameters": { - "id": "compute123", "location": "eastus", "properties": { "description": "some compute", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/updateAmlCompute.json index 8c543528291a..a7cdc2ece7ce 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/updateAmlCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/examples/updateAmlCompute.json @@ -10,14 +10,10 @@ "properties": { "computeType": "AmlCompute", "properties": { - "description": "some compute", - "computeType": "AmlCompute", - "properties": { - "scaleSettings": { - "maxNodeCount": 4, - "minNodeCount": 4, - "nodeIdleTimeBeforeScaleDown": "PT5M" - } + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/machineLearningServices.json index 6bde4dba311c..a13a680b6c17 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-02-18-preview/machineLearningServices.json @@ -179,6 +179,7 @@ "$ref": "./examples/deleteWorkspace.json" } }, + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -197,6 +198,9 @@ "200": { "description": "The request was successful; the request was well-formed and received properly." }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, "204": { "description": "The machine learning workspace does not exist in the subscription." }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/examples/deleteWorkspace.json index 9b433ad2b4c6..a0d061baa0b5 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/examples/deleteWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/examples/deleteWorkspace.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json index 0b6a2b9f8378..7e5360f90b5d 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json @@ -176,6 +176,7 @@ "$ref": "./examples/deleteWorkspace.json" } }, + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -194,6 +195,9 @@ "200": { "description": "The request was successful; the request was well-formed and received properly." }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, "204": { "description": "The machine learning workspace does not exist in the subscription." }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteWorkspace.json index df23a8b03400..3bbf285d179f 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/deleteWorkspace.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAKSCompute.json index cf0a568baef6..64cf0238e98a 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAKSCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAKSCompute.json @@ -6,7 +6,6 @@ "computeName": "compute123", "api-version": "2018-11-19", "parameters": { - "id": "compute123", "location": "eastus", "properties": { "description": "some compute", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAmlCompute.json index 760f79ab8979..9f004603fee5 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAmlCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/examples/updateAmlCompute.json @@ -10,14 +10,10 @@ "properties": { "computeType": "AmlCompute", "properties": { - "description": "some compute", - "computeType": "AmlCompute", - "properties": { - "scaleSettings": { - "maxNodeCount": 4, - "minNodeCount": 4, - "nodeIdleTimeBeforeScaleDown": "PT5M" - } + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json index 0178bb7c73d3..6f46121ab2a0 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json @@ -179,6 +179,7 @@ "$ref": "./examples/deleteWorkspace.json" } }, + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -197,6 +198,9 @@ "200": { "description": "The request was successful; the request was well-formed and received properly." }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, "204": { "description": "The machine learning workspace does not exist in the subscription." }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/deleteWorkspace.json index 690c28f0d699..7a5ad5daab6f 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/deleteWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/deleteWorkspace.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/updateAKSCompute.json index 01f0f9684575..d3eade578cde 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/updateAKSCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/updateAKSCompute.json @@ -6,7 +6,6 @@ "computeName": "compute123", "api-version": "2019-05-01", "parameters": { - "id": "compute123", "location": "eastus", "properties": { "description": "some compute", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/updateAmlCompute.json index bcb7cf3c8c31..78c9b90b7c5e 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/updateAmlCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/examples/updateAmlCompute.json @@ -10,14 +10,10 @@ "properties": { "computeType": "AmlCompute", "properties": { - "description": "some compute", - "computeType": "AmlCompute", - "properties": { - "scaleSettings": { - "maxNodeCount": 4, - "minNodeCount": 4, - "nodeIdleTimeBeforeScaleDown": "PT5M" - } + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/machineLearningServices.json index 03836d3773af..c7a4eb0bf9cb 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-05-01/machineLearningServices.json @@ -179,6 +179,7 @@ "$ref": "./examples/deleteWorkspace.json" } }, + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -197,6 +198,9 @@ "200": { "description": "The request was successful; the request was well-formed and received properly." }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, "204": { "description": "The machine learning workspace does not exist in the subscription." }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/deleteWorkspace.json index 7c045e6ba190..5766708520d4 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/deleteWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/deleteWorkspace.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/updateAKSCompute.json index 06d4d48cc9d0..c6fca0871dfc 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/updateAKSCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/updateAKSCompute.json @@ -6,7 +6,6 @@ "computeName": "compute123", "api-version": "2019-06-01", "parameters": { - "id": "compute123", "location": "eastus", "properties": { "description": "some compute", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/updateAmlCompute.json index e382eaaf4291..13d25772019d 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/updateAmlCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/examples/updateAmlCompute.json @@ -10,14 +10,10 @@ "properties": { "computeType": "AmlCompute", "properties": { - "description": "some compute", - "computeType": "AmlCompute", - "properties": { - "scaleSettings": { - "maxNodeCount": 4, - "minNodeCount": 4, - "nodeIdleTimeBeforeScaleDown": "PT5M" - } + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/machineLearningServices.json index 8f6d8aa125f2..45d5b91d5962 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-06-01/machineLearningServices.json @@ -179,6 +179,7 @@ "$ref": "./examples/deleteWorkspace.json" } }, + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -197,6 +198,9 @@ "200": { "description": "The request was successful; the request was well-formed and received properly." }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, "204": { "description": "The machine learning workspace does not exist in the subscription." }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/deleteWorkspace.json index b9e0d6fd045c..47d865aa4bca 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/deleteWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/deleteWorkspace.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/updateAKSCompute.json index 98cc1580c1a5..256483e2f0a0 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/updateAKSCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/updateAKSCompute.json @@ -6,7 +6,6 @@ "computeName": "compute123", "api-version": "2019-11-01", "parameters": { - "id": "compute123", "location": "eastus", "properties": { "description": "some compute", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/updateAmlCompute.json index a724186e04cb..8ce20dc8c9a4 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/updateAmlCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/examples/updateAmlCompute.json @@ -10,14 +10,10 @@ "properties": { "computeType": "AmlCompute", "properties": { - "description": "some compute", - "computeType": "AmlCompute", - "properties": { - "scaleSettings": { - "maxNodeCount": 4, - "minNodeCount": 4, - "nodeIdleTimeBeforeScaleDown": "PT5M" - } + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/machineLearningServices.json index dbd23458bf96..502516ec031b 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2019-11-01/machineLearningServices.json @@ -179,6 +179,7 @@ "$ref": "./examples/deleteWorkspace.json" } }, + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -197,6 +198,9 @@ "200": { "description": "The request was successful; the request was well-formed and received properly." }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, "204": { "description": "The machine learning workspace does not exist in the subscription." }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/deleteWorkspace.json index 713ec2db9120..d63ffcd7442c 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/deleteWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/deleteWorkspace.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/updateAKSCompute.json index 1496c63962ed..4130c8597bda 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/updateAKSCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/updateAKSCompute.json @@ -6,7 +6,6 @@ "computeName": "compute123", "api-version": "2020-01-01", "parameters": { - "id": "compute123", "location": "eastus", "properties": { "description": "some compute", diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/updateAmlCompute.json index cd1485a874da..7483abcecead 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/updateAmlCompute.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/examples/updateAmlCompute.json @@ -10,14 +10,10 @@ "properties": { "computeType": "AmlCompute", "properties": { - "description": "some compute", - "computeType": "AmlCompute", - "properties": { - "scaleSettings": { - "maxNodeCount": 4, - "minNodeCount": 4, - "nodeIdleTimeBeforeScaleDown": "PT5M" - } + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" } } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/machineLearningServices.json index 1336b63c5e89..9401b1a3060f 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-01-01/machineLearningServices.json @@ -179,6 +179,7 @@ "$ref": "./examples/deleteWorkspace.json" } }, + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -197,6 +198,9 @@ "200": { "description": "The request was successful; the request was well-formed and received properly." }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, "204": { "description": "The machine learning workspace does not exist in the subscription." }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-03-01/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-03-01/examples/deleteWorkspace.json index 9b433ad2b4c6..a0d061baa0b5 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-03-01/examples/deleteWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-03-01/examples/deleteWorkspace.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json index d4c9ffc24905..33dfae205955 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json @@ -176,6 +176,7 @@ "$ref": "./examples/deleteWorkspace.json" } }, + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -194,6 +195,9 @@ "200": { "description": "The request was successful; the request was well-formed and received properly." }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, "204": { "description": "The machine learning workspace does not exist in the subscription." }, diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/deleteWorkspace.json index 3544758731c8..e73ff7b6601a 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/deleteWorkspace.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/examples/deleteWorkspace.json @@ -7,6 +7,7 @@ }, "responses": { "200": {}, + "202": {}, "204": {} } } diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json index 2ce9a0fb59f7..094ed64eef22 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json @@ -176,6 +176,7 @@ "$ref": "./examples/deleteWorkspace.json" } }, + "x-ms-long-running-operation": true, "parameters": [ { "$ref": "#/parameters/APIVersionParameter" @@ -194,6 +195,9 @@ "200": { "description": "The request was successful; the request was well-formed and received properly." }, + "202": { + "description": "The request was accepted; the request was well-formed and received properly." + }, "204": { "description": "The machine learning workspace does not exist in the subscription." }, From da1e2f004597af9ac5222aaca2d9e300f2eb611f Mon Sep 17 00:00:00 2001 From: Abyssknight <501835725@qq.com> Date: Sun, 28 Jun 2020 14:44:25 +0800 Subject: [PATCH 214/318] change containerinstance typescript sdk path (#9977) Co-authored-by: Shixun Guan --- .../containerinstance/resource-manager/readme.typescript.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/containerinstance/resource-manager/readme.typescript.md b/specification/containerinstance/resource-manager/readme.typescript.md index 48302990c6c1..918915d508f9 100644 --- a/specification/containerinstance/resource-manager/readme.typescript.md +++ b/specification/containerinstance/resource-manager/readme.typescript.md @@ -7,7 +7,7 @@ Please also specify `--typescript-sdks-folder= Date: Sun, 28 Jun 2020 12:01:24 +0300 Subject: [PATCH 215/318] Add version 2020-02-02-preview to SecurityAlertPolicies APIs (#9565) * Add version 2020-02-02-preview to SecurityAlertPolicies APIs * update examples files * fix confilect in readme file * fix create example file * fix create exmple of mangedserver * run prettier tool * fix examples files * remove changes of syncMembers * fix readme * Add operations to 2020-02-02 version --- .../DatabaseSecurityAlertPolicies.json | 406 ++++++++++++++++++ .../ManagedServerSecurityAlertPolicies.json | 371 ++++++++++++++++ .../ServerSecurityAlertPolicies.json | 371 ++++++++++++++++ .../examples/DatabaseSecurityAlertCreate.json | 37 ++ .../examples/DatabaseSecurityAlertGet.json | 23 + .../DatabaseSecurityAlertListByDatabase.json | 26 ++ .../ManagedServerSecurityAlertCreate.json | 27 ++ .../ManagedServerSecurityAlertGet.json | 22 + ...agedServerSecurityAlertListByInstance.json | 25 ++ .../examples/ServerSecurityAlertsCreate.json | 27 ++ .../examples/ServerSecurityAlertsGet.json | 22 + .../ServerSecurityAlertsListByServer.json | 25 ++ .../2020-02-02-preview/operations.json | 202 +++++++++ specification/sql/resource-manager/readme.md | 22 + 14 files changed, 1606 insertions(+) create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/DatabaseSecurityAlertPolicies.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ManagedServerSecurityAlertPolicies.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ServerSecurityAlertPolicies.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertCreate.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertGet.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertListByDatabase.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertCreate.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertGet.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertListByInstance.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsCreate.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsGet.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsListByServer.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/operations.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/DatabaseSecurityAlertPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/DatabaseSecurityAlertPolicies.json new file mode 100644 index 000000000000..92c1c89ddeb4 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/DatabaseSecurityAlertPolicies.json @@ -0,0 +1,406 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-02-02-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "DatabaseSecurityAlertPolicies" + ], + "description": "Gets a database's security alert policy.", + "operationId": "DatabaseSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the security alert policy is defined.", + "required": true, + "type": "string" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the database security alert policy.", + "schema": { + "$ref": "#/definitions/DatabaseSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidDatabaseSecurityAlertPolicyCreateRequest - The create database Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 DatabaseSecurityAlertPolicyInProgress - Set database security alert policy is already in progress\n\n * 409 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetDatabaseSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-examples": { + "Get a database's threat detection policy": { + "$ref": "./examples/DatabaseSecurityAlertGet.json" + } + } + }, + "put": { + "tags": [ + "DatabaseSecurityAlertPolicies" + ], + "description": "Creates or updates a database's security alert policy.", + "operationId": "DatabaseSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the security alert policy is defined.", + "required": true, + "type": "string" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The database security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseSecurityAlertPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully set the database security alert policy.", + "schema": { + "$ref": "#/definitions/DatabaseSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidDatabaseSecurityAlertPolicyCreateRequest - The create database Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 DatabaseSecurityAlertPolicyInProgress - Set database security alert policy is already in progress\n\n * 409 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetDatabaseSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + }, + "201": { + "description": "Successfully created the database security alert policy.", + "schema": { + "$ref": "#/definitions/DatabaseSecurityAlertPolicy" + } + } + }, + "x-ms-examples": { + "Update a database's threat detection policy with minimal parameters": { + "$ref": "./examples/DatabaseSecurityAlertCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/databases/{databaseName}/securityAlertPolicies": { + "get": { + "tags": [ + "DatabaseSecurityAlertPolicies" + ], + "description": "Gets a list of database's security alert policies.", + "operationId": "DatabaseSecurityAlertPolicies_ListByDatabase", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string" + }, + { + "name": "databaseName", + "in": "path", + "description": "The name of the database for which the security alert policy is defined.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the database security alert policy.", + "schema": { + "$ref": "#/definitions/DatabaseSecurityAlertListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 UpdateNotAllowedOnPausedDatabase - User attempted to perform an update on a paused database.\n\n * 400 InvalidDatabaseSecurityAlertPolicyCreateRequest - The create database Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 DatabaseSecurityAlertPolicyInProgress - Set database security alert policy is already in progress\n\n * 409 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertDatabaseSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetDatabaseSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get the database's threat detection policies": { + "$ref": "./examples/DatabaseSecurityAlertListByDatabase.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertsPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityAlertsPolicyState", + "modelAsString": false + } + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "Resource": { + "description": "ARM resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "DatabaseSecurityAlertPolicy": { + "description": "A database security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertsPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "DatabaseSecurityAlertListResult": { + "description": "A list of the database's security alert policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseSecurityAlertPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ManagedServerSecurityAlertPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ManagedServerSecurityAlertPolicies.json new file mode 100644 index 000000000000..0742d7b8e48c --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ManagedServerSecurityAlertPolicies.json @@ -0,0 +1,371 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-02-02-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ManagedServerSecurityAlertPolicies" + ], + "description": "Get a managed server's threat detection policy.", + "operationId": "ManagedServerSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the managed server threat detection policy.", + "schema": { + "$ref": "#/definitions/ManagedServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-examples": { + "Get a managed server's threat detection policy": { + "$ref": "./examples/ManagedServerSecurityAlertGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedServerSecurityAlertPolicies" + ], + "description": "Creates or updates a threat detection policy.", + "operationId": "ManagedServerSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The managed server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedServerSecurityAlertPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the threat detection policy.", + "schema": { + "$ref": "#/definitions/ManagedServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later" + }, + "202": { + "description": "Created request to set the server threat detection policy." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's threat detection policy with all parameters": { + "$ref": "./examples/ManagedServerSecurityAlertCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/securityAlertPolicies": { + "get": { + "tags": [ + "ManagedServerSecurityAlertPolicies" + ], + "description": "Get the managed server's threat detection policies.", + "operationId": "ManagedServerSecurityAlertPolicies_ListByInstance", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the managed server threat detection policies.", + "schema": { + "$ref": "#/definitions/ManagedServerSecurityAlertPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Get the managed server's threat detection policies": { + "$ref": "./examples/ManagedServerSecurityAlertListByInstance.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertsPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityAlertsPolicyState", + "modelAsString": false + } + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "Resource": { + "description": "ARM resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "ManagedServerSecurityAlertPolicy": { + "description": "A managed server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertsPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ManagedServerSecurityAlertPolicyListResult": { + "description": "A list of the managed Server's security alert policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedServerSecurityAlertPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ServerSecurityAlertPolicies.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ServerSecurityAlertPolicies.json new file mode 100644 index 000000000000..b43ba41edaca --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/ServerSecurityAlertPolicies.json @@ -0,0 +1,371 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-02-02-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get a server's security alert policy.", + "operationId": "ServerSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 UpdateNotAllowedOnServerContainingPausedDWDatabase - Setting server Threat Detection settings is not allowed on a server with a paused Data Warehouse database\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-examples": { + "Get a server's threat detection policy": { + "$ref": "./examples/ServerSecurityAlertsGet.json" + } + } + }, + "put": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Creates or updates a threat detection policy.", + "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the threat detection policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 UpdateNotAllowedOnServerContainingPausedDWDatabase - Setting server Threat Detection settings is not allowed on a server with a paused Data Warehouse database\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later" + }, + "202": { + "description": "Created request to set the server threat detection policy." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's threat detection policy with minimal parameters": { + "$ref": "./examples/ServerSecurityAlertsCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/servers/{serverName}/securityAlertPolicies": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get the server's threat detection policies.", + "operationId": "ServerSecurityAlertPolicies_ListByServer", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policies.", + "schema": { + "$ref": "#/definitions/LogicalServerSecurityAlertPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 UpdateNotAllowedOnServerContainingPausedDWDatabase - Setting server Threat Detection settings is not allowed on a server with a paused Data Warehouse database\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the server's threat detection policies": { + "$ref": "./examples/ServerSecurityAlertsListByServer.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertsPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled or a policy has not been applied yet on the specific database.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SecurityAlertsPolicyState", + "modelAsString": false + } + }, + "creationTime": { + "format": "date-time", + "description": "Specifies the UTC creation time of the policy.", + "type": "string", + "readOnly": true + } + } + }, + "Resource": { + "description": "ARM resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "ServerSecurityAlertPolicy": { + "description": "A server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertsPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "LogicalServerSecurityAlertPolicyListResult": { + "description": "A list of the server's security alert policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "BlobAuditingPolicyNameParameter": { + "name": "blobAuditingPolicyName", + "in": "path", + "description": "The name of the blob auditing policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "VirtualClusterNameParameter": { + "name": "virtualClusterName", + "in": "path", + "description": "The name of the virtual cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertCreate.json new file mode 100644 index 000000000000..256ce2945593 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertCreate.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "databaseName": "testdb", + "securityAlertPolicyName": "default", + "api-version": "2020-02-02-preview", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/securityAlertPolicies", + "properties": { + "state": "Enabled" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/securityAlertPolicies", + "properties": { + "state": "Enabled" + } + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertGet.json new file mode 100644 index 000000000000..39d70f7603e3 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-6852", + "serverName": "securityalert-2080", + "databaseName": "testdb", + "securityAlertPolicyName": "default", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Sql/servers/securityalert-2080/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/securityAlertPolicies", + "properties": { + "state": "Enabled", + "creationTime": "2020-04-03T04:41:33.937Z" + } + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertListByDatabase.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertListByDatabase.json new file mode 100644 index 000000000000..254adf741f33 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/DatabaseSecurityAlertListByDatabase.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-6852", + "serverName": "securityalert-2080", + "databaseName": "testdb", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-6852/providers/Microsoft.Sql/servers/securityalert-2080/databases/testdb", + "name": "default", + "type": "Microsoft.Sql/servers/databases/securityAlertPolicies", + "properties": { + "state": "Enabled", + "creationTime": "2020-04-03T04:41:33.937Z" + } + } + ] + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertCreate.json new file mode 100644 index 000000000000..b211c573ce60 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertCreate.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "managedInstanceName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2020-02-01-preview", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440", + "name": "Default", + "type": "Microsoft.Sql/managedInstances/securityAlertPolicies", + "properties": { + "state": "Enabled" + } + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertGet.json new file mode 100644 index 000000000000..a4dd2f5b23a6 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "managedInstanceName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440", + "name": "Default", + "type": "Microsoft.Sql/managedInstances/securityAlertPolicies", + "properties": { + "state": "Disabled", + "creationTime": "2020-04-03T04:41:33.937Z" + } + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertListByInstance.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertListByInstance.json new file mode 100644 index 000000000000..95abc4cd4eda --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedServerSecurityAlertListByInstance.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "managedInstanceName": "securityalert-6440", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/managedInstances/securityalert-6440", + "name": "Default", + "type": "Microsoft.Sql/managedInstances/securityAlertPolicies", + "properties": { + "state": "Disabled", + "creationTime": "2020-04-03T04:41:33.937Z" + } + } + ] + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsCreate.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsCreate.json new file mode 100644 index 000000000000..1b2fdd656f05 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsCreate.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2020-02-02-preview", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies/default", + "name": "Default", + "type": "Microsoft.Sql/servers/securityAlertPolicies", + "properties": { + "state": "Enabled" + } + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsGet.json new file mode 100644 index 000000000000..aee14c28b8ff --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies/default", + "name": "Default", + "type": "Microsoft.Sql/servers/securityAlertPolicies", + "properties": { + "state": "Enabled", + "creationTime": "2020-04-03T04:41:33.937Z" + } + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsListByServer.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsListByServer.json new file mode 100644 index 000000000000..cc23a11dfd93 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ServerSecurityAlertsListByServer.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.Sql/servers/securityalert-6440/securityAlertPolicies", + "name": "Default", + "type": "Microsoft.Sql/servers/securityAlertPolicies", + "properties": { + "state": "Enabled", + "creationTime": "2020-04-03T04:41:33.937Z" + } + } + ] + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/operations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/operations.json new file mode 100644 index 000000000000..14c45bbfb444 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/operations.json @@ -0,0 +1,202 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-02-02-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Sql/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available SQL Rest API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "*** Error Responses: ***" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list SQL operations.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "SQL REST API operation definition.", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string", + "readOnly": true + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The localized display information for this particular operation / action.", + "readOnly": true + }, + "origin": { + "description": "The intended executor of the operation.", + "enum": [ + "user", + "system" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "OperationOrigin", + "modelAsString": true + } + }, + "properties": { + "description": "Additional descriptions for the operation.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true, + "x-ms-client-flatten": false + } + } + }, + "OperationDisplay": { + "description": "Display metadata associated with the operation.", + "type": "object", + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version to use for the request.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "description": "The name of the server.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineInstanceNameParameter": { + "name": "sqlVirtualMachineInstanceName", + "in": "path", + "description": "The name of the SqlVirtualMachineInstance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlVirtualMachineContainerNameParameter": { + "name": "sqlVirtualMachineContainerName", + "in": "path", + "description": "The name of the SqlVirtualMachineContainer.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 2af3444b6aca..7af58229e572 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -478,6 +478,28 @@ override-info: The following packages are each composed of all apis from only one api-version. +### Tag: package-pure-2020-02-preview + +These settings apply only when `--tag=package-pure-2020-02-preview` is specified on the command line. + +This section contains all input swagger files for version 2020-02-02-preview. All APIs of that version must be added this section when the API is ready for production. + +APIs must only be added to this section when the API is publicly available in at least 1 production region and at least 1 generated client has been tested end-to-end. + +These can be regenerated by running the following PowerShell script from this readme file's folder: `dir .\Microsoft.Sql\preview\2020-02-02-preview\ -File | Resolve-Path -Relative | % { " - $_".Replace("\", "/") }` + +``` yaml $(tag) == 'package-pure-2020-02-preview' +input-file: +- Microsoft.Sql/preview/2020-02-02-preview/DatabaseSecurityAlertPolicies.json +- Microsoft.Sql/preview/2020-02-02-preview/ManagedServerSecurityAlertPolicies.json +- Microsoft.Sql/preview/2020-02-02-preview/ServerSecurityAlertPolicies.json +- Microsoft.Sql/preview/2020-02-02-preview/operations.json + +# Needed when there is more than one input file +override-info: + title: SqlManagementClient + ``` + ### Tag: package-pure-2019-06-preview These settings apply only when `--tag=package-pure-2019-06-preview` is specified on the command line. From b118409de4304ebfe0ad46e4b84269256a43a24b Mon Sep 17 00:00:00 2001 From: Rogelio Delgadillo <35089121+r-delgadillo@users.noreply.github.com> Date: Sun, 28 Jun 2020 02:02:45 -0700 Subject: [PATCH 216/318] Add app sku as part of update request (#9845) --- .../Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json index 8958ac279f14..f7887e217709 100644 --- a/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json +++ b/specification/iotcentral/resource-manager/Microsoft.IoTCentral/stable/2018-09-01/iotcentral.json @@ -574,6 +574,10 @@ "type": "string" } }, + "sku": { + "description": "A valid instance SKU.", + "$ref": "#/definitions/AppSkuInfo" + }, "properties": { "description": "The common properties of an IoT Central application.", "x-ms-client-flatten": true, From 655af799d7e83c728a72e20dbabdb3da365bba67 Mon Sep 17 00:00:00 2001 From: aim-for-better Date: Sun, 28 Jun 2020 17:12:26 +0800 Subject: [PATCH 217/318] [HDInsight] Update swagger to support private link feature (#9659) * Update swagger to support network isolation options * Fix prettier check failure * Update network feature Co-authored-by: Zhenyu Zhou --- .../preview/2015-03-01-preview/cluster.json | 40 +++++ ...sightClusterWithCustomNetworkSettings.json | 160 ++++++++++++++++++ .../stable/2018-06-01-preview/cluster.json | 40 +++++ ...sightClusterWithCustomNetworkSettings.json | 160 ++++++++++++++++++ 4 files changed, 400 insertions(+) create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateHDInsightClusterWithCustomNetworkSettings.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/CreateHDInsightClusterWithCustomNetworkSettings.json diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json index 382dea9eab19..a67e4f60e3d8 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json @@ -65,6 +65,9 @@ }, "Create cluster with TLS 1.2": { "$ref": "./examples/CreateHDInsightClusterWithTLS12.json" + }, + "Create cluster with custom network settings": { + "$ref": "./examples/CreateHDInsightClusterWithCustomNetworkSettings.json" } }, "parameters": [ @@ -924,6 +927,35 @@ }, "description": "The storage profile." }, + "NetworkSettings": { + "properties": { + "publicNetworkAccess": { + "type": "string", + "description": "Specifies whether public network access is enabled for inbound and outbound, or outbound only.", + "enum": [ + "InboundAndOutbound", + "OutboundOnly" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "outboundOnlyPublicNetworkAccessType": { + "type": "string", + "description": "The mechanism through which the cluster will have outbound access to the public network.", + "enum": [ + "PublicLoadBalancer", + "UDR" + ], + "x-ms-enum": { + "name": "OutboundOnlyPublicNetworkAccessType", + "modelAsString": true + } + } + }, + "description": "The network settings." + }, "ClusterCreateProperties": { "description": "The cluster create parameters.", "properties": { @@ -982,6 +1014,10 @@ "minSupportedTlsVersion": { "type": "string", "description": "The minimal supported tls version." + }, + "networkSettings": { + "$ref": "#/definitions/NetworkSettings", + "description": "The network settings." } } }, @@ -1162,6 +1198,10 @@ "minSupportedTlsVersion": { "type": "string", "description": "The minimal supported tls version." + }, + "networkSettings": { + "$ref": "#/definitions/NetworkSettings", + "description": "The network settings." } }, "required": [ diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateHDInsightClusterWithCustomNetworkSettings.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateHDInsightClusterWithCustomNetworkSettings.json new file mode 100644 index 000000000000..5214925f2139 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateHDInsightClusterWithCustomNetworkSettings.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subId", + "parameters": { + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "clusterDefinition": { + "kind": "hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage", + "isDefault": true, + "container": "containername", + "key": "storage account key" + } + ] + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + }, + { + "name": "workernode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + } + ] + }, + "networkSettings": { + "publicNetworkAccess": "OutboundOnly", + "outboundOnlyPublicNetworkAccessType": "PublicLoadBalancer" + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "East US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "tags": null, + "properties": { + "clusterVersion": "3.6.1000.67", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.6.1000.67.2005040905.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + }, + { + "name": "workernode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + } + ] + }, + "networkSettings": { + "publicNetworkAccess": "OutboundOnly", + "outboundOnlyPublicNetworkAccessType": "PublicLoadBalancer" + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2020-06-09T12:25:43.48", + "quotaInfo": { + "coresUsed": 16 + }, + "tier": "Standard" + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json index dbf01ce3ff32..09d5ab955690 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json @@ -65,6 +65,9 @@ }, "Create cluster with TLS 1.2": { "$ref": "./examples/CreateHDInsightClusterWithTLS12.json" + }, + "Create cluster with custom network settings": { + "$ref": "./examples/CreateHDInsightClusterWithCustomNetworkSettings.json" } }, "parameters": [ @@ -924,6 +927,35 @@ }, "description": "The storage profile." }, + "NetworkSettings": { + "properties": { + "publicNetworkAccess": { + "type": "string", + "description": "Specifies whether public network access is enabled for inbound and outbound, or outbound only.", + "enum": [ + "InboundAndOutbound", + "OutboundOnly" + ], + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + }, + "outboundOnlyPublicNetworkAccessType": { + "type": "string", + "description": "The mechanism through which the cluster will have outbound access to the public network.", + "enum": [ + "PublicLoadBalancer", + "UDR" + ], + "x-ms-enum": { + "name": "OutboundOnlyPublicNetworkAccessType", + "modelAsString": true + } + } + }, + "description": "The network settings." + }, "ClusterCreateProperties": { "description": "The cluster create parameters.", "properties": { @@ -982,6 +1014,10 @@ "minSupportedTlsVersion": { "type": "string", "description": "The minimal supported tls version." + }, + "networkSettings": { + "$ref": "#/definitions/NetworkSettings", + "description": "The network settings." } } }, @@ -1162,6 +1198,10 @@ "minSupportedTlsVersion": { "type": "string", "description": "The minimal supported tls version." + }, + "networkSettings": { + "$ref": "#/definitions/NetworkSettings", + "description": "The network settings." } }, "required": [ diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/CreateHDInsightClusterWithCustomNetworkSettings.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/CreateHDInsightClusterWithCustomNetworkSettings.json new file mode 100644 index 000000000000..cfd07c8507e9 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/CreateHDInsightClusterWithCustomNetworkSettings.json @@ -0,0 +1,160 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subId", + "parameters": { + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "clusterDefinition": { + "kind": "hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage", + "isDefault": true, + "container": "containername", + "key": "storage account key" + } + ] + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + }, + { + "name": "workernode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********", + "sshProfile": { + "publicKeys": [ + { + "certificateData": "**********" + } + ] + } + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + } + ] + }, + "networkSettings": { + "publicNetworkAccess": "OutboundOnly", + "outboundOnlyPublicNetworkAccessType": "PublicLoadBalancer" + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "East US", + "etag": "fdf2a6e8-ce83-42cc-8c2d-0ceb11a370ff", + "tags": null, + "properties": { + "clusterVersion": "3.6.1000.67", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.6.1000.67.2005040905.json", + "kind": "hadoop" + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + }, + { + "name": "workernode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_d3" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + }, + "virtualNetworkProfile": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname", + "subnet": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnetname/subnets/vnetsubnet" + } + } + ] + }, + "networkSettings": { + "publicNetworkAccess": "OutboundOnly", + "outboundOnlyPublicNetworkAccessType": "PublicLoadBalancer" + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2020-06-09T12:25:43.48", + "quotaInfo": { + "coresUsed": 16 + }, + "tier": "Standard" + } + } + } + } +} From 48d0ce36f0360b83d63e152e4676462b9051a137 Mon Sep 17 00:00:00 2001 From: Shenglong Li Date: Sun, 28 Jun 2020 22:43:24 -0700 Subject: [PATCH 218/318] [Resources] Add support for MG and tenant level What-If (#9942) * Add MG and tenant level What-If APIs * Add ScopedDeploymentWhatIf to 2019-07-01 * Revert 2019-07-01 and 2019-08-01 --- ...PostDeploymentWhatIfOnManagementGroup.json | 87 +++++++++++ .../PostDeploymentWhatIfOnTenant.json | 86 +++++++++++ .../stable/2019-10-01/resources.json | 144 ++++++++++++++++++ ...PostDeploymentWhatIfOnManagementGroup.json | 87 +++++++++++ .../PostDeploymentWhatIfOnTenant.json | 86 +++++++++++ .../stable/2020-06-01/resources.json | 144 ++++++++++++++++++ 6 files changed, 634 insertions(+) create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnManagementGroup.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnTenant.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnManagementGroup.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnTenant.json diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnManagementGroup.json new file mode 100644 index 000000000000..1cd198965ea5 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnManagementGroup.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "groupId": "myManagementGruop", + "deploymentName": "exampleDeploymentName", + "api-version": "2019-10-01", + "parameters": { + "location": "eastus", + "properties": { + "templateLink": "https://example.com/exampleTemplate.json", + "parameters": {}, + "mode": "Incremental" + } + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "properties": { + "changes": [ + { + "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "changeType": "Modify", + "before": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", + "enforcementMode": "Default" + } + }, + "after": { + "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "changeType": "Modify", + "before": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", + "enforcementMode": "DoNotEnforce" + } + }, + "delta": [ + { + "path": "properties.enforcementMode", + "propertyChangeType": "Modify", + "before": "Default", + "after": "DoNotEnforce" + } + ] + } + }, + { + "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "changeType": "Create", + "after": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment2", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000002", + "enforcementMode": "Default" + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnTenant.json new file mode 100644 index 000000000000..0bec2f85bc53 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnTenant.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "deploymentName": "exampleDeploymentName", + "api-version": "2019-10-01", + "parameters": { + "location": "eastus", + "properties": { + "templateLink": "https://example.com/exampleTemplate.json", + "parameters": {}, + "mode": "Incremental" + } + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "properties": { + "changes": [ + { + "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "changeType": "Modify", + "before": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", + "enforcementMode": "Default" + } + }, + "after": { + "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "changeType": "Modify", + "before": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", + "enforcementMode": "DoNotEnforce" + } + }, + "delta": [ + { + "path": "properties.enforcementMode", + "propertyChangeType": "Modify", + "before": "Default", + "after": "DoNotEnforce" + } + ] + } + }, + { + "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "changeType": "Create", + "after": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment2", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000002", + "enforcementMode": "Default" + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json index 399946292489..1ba31b5ac962 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/resources.json @@ -609,6 +609,68 @@ } } }, + "/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_WhatIfAtTenantScope", + "description": "Returns changes that will be made by the deployment if executed at the scope of the tenant group.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopedDeploymentWhatIf" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns What-If operation status", + "schema": { + "$ref": "#/definitions/WhatIfOperationResult" + } + }, + "202": { + "description": "Accepted - Returns URL in Location header to query for long-running operation status.", + "headers": { + "Location": { + "type": "string", + "description": "URL to get status of this long-running operation." + }, + "Retry-After": { + "type": "string", + "description": "Number of seconds to wait before polling for status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Predict template changes at management group scope": { + "$ref": "./examples/PostDeploymentWhatIfOnTenant.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, "/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { "post": { "tags": [ @@ -926,6 +988,71 @@ } } }, + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_WhatIfAtManagementGroupScope", + "description": "Returns changes that will be made by the deployment if executed at the scope of the management group.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopedDeploymentWhatIf" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns What-If operation status", + "schema": { + "$ref": "#/definitions/WhatIfOperationResult" + } + }, + "202": { + "description": "Accepted - Returns URL in Location header to query for long-running operation status.", + "headers": { + "Location": { + "type": "string", + "description": "URL to get status of this long-running operation." + }, + "Retry-After": { + "type": "string", + "description": "Number of seconds to wait before polling for status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Predict template changes at management group scope": { + "$ref": "./examples/PostDeploymentWhatIfOnManagementGroup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { "post": { "tags": [ @@ -4384,6 +4511,23 @@ ], "description": "Deployment What-if operation parameters." }, + "ScopedDeploymentWhatIf": { + "properties": { + "location": { + "type": "string", + "description": "The location to store the deployment data." + }, + "properties": { + "$ref": "#/definitions/DeploymentWhatIfProperties", + "description": "The deployment properties." + } + }, + "required": [ + "location", + "properties" + ], + "description": "Deployment What-if operation parameters." + }, "DeploymentWhatIfProperties": { "properties": { "whatIfSettings": { diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnManagementGroup.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnManagementGroup.json new file mode 100644 index 000000000000..426618aeeee3 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnManagementGroup.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "groupId": "myManagementGruop", + "deploymentName": "exampleDeploymentName", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "templateLink": "https://example.com/exampleTemplate.json", + "parameters": {}, + "mode": "Incremental" + } + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "properties": { + "changes": [ + { + "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "changeType": "Modify", + "before": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", + "enforcementMode": "Default" + } + }, + "after": { + "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "changeType": "Modify", + "before": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", + "enforcementMode": "DoNotEnforce" + } + }, + "delta": [ + { + "path": "properties.enforcementMode", + "propertyChangeType": "Modify", + "before": "Default", + "after": "DoNotEnforce" + } + ] + } + }, + { + "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "changeType": "Create", + "after": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment2", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000002", + "enforcementMode": "Default" + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnTenant.json new file mode 100644 index 000000000000..7fefa1ffb815 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnTenant.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "deploymentName": "exampleDeploymentName", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "templateLink": "https://example.com/exampleTemplate.json", + "parameters": {}, + "mode": "Incremental" + } + } + }, + "responses": { + "200": { + "body": { + "status": "Succeeded", + "properties": { + "changes": [ + { + "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "changeType": "Modify", + "before": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", + "enforcementMode": "Default" + } + }, + "after": { + "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "changeType": "Modify", + "before": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", + "enforcementMode": "DoNotEnforce" + } + }, + "delta": [ + { + "path": "properties.enforcementMode", + "propertyChangeType": "Modify", + "before": "Default", + "after": "DoNotEnforce" + } + ] + } + }, + { + "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "changeType": "Create", + "after": { + "apiVersion": "2019-06-01", + "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "type": "Microsoft.Authorization/policyAssignments", + "name": "myPolicyAssignment2", + "location": "westus2", + "properties": { + "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000002", + "enforcementMode": "Default" + } + } + } + ] + } + } + }, + "202": { + "headers": { + "Location": "/subscriptions/4d0ca63b-7939-4c9c-afbe-5fafae501724/operationresults/ZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZZ" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json index 70bfb6588665..345aa0c0b8b1 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/resources.json @@ -609,6 +609,68 @@ } } }, + "/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_WhatIfAtTenantScope", + "description": "Returns changes that will be made by the deployment if executed at the scope of the tenant group.", + "parameters": [ + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopedDeploymentWhatIf" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns What-If operation status", + "schema": { + "$ref": "#/definitions/WhatIfOperationResult" + } + }, + "202": { + "description": "Accepted - Returns URL in Location header to query for long-running operation status.", + "headers": { + "Location": { + "type": "string", + "description": "URL to get status of this long-running operation." + }, + "Retry-After": { + "type": "string", + "description": "Number of seconds to wait before polling for status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Predict template changes at management group scope": { + "$ref": "./examples/PostDeploymentWhatIfOnTenant.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, "/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { "post": { "tags": [ @@ -926,6 +988,71 @@ } } }, + "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/whatIf": { + "post": { + "tags": [ + "Deployments" + ], + "operationId": "Deployments_WhatIfAtManagementGroupScope", + "description": "Returns changes that will be made by the deployment if executed at the scope of the management group.", + "parameters": [ + { + "$ref": "#/parameters/GroupIdParameter" + }, + { + "$ref": "#/parameters/DeploymentNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ScopedDeploymentWhatIf" + }, + "description": "Parameters to validate." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns What-If operation status", + "schema": { + "$ref": "#/definitions/WhatIfOperationResult" + } + }, + "202": { + "description": "Accepted - Returns URL in Location header to query for long-running operation status.", + "headers": { + "Location": { + "type": "string", + "description": "URL to get status of this long-running operation." + }, + "Retry-After": { + "type": "string", + "description": "Number of seconds to wait before polling for status." + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Predict template changes at management group scope": { + "$ref": "./examples/PostDeploymentWhatIfOnManagementGroup.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + } + } + }, "/providers/Microsoft.Management/managementGroups/{groupId}/providers/Microsoft.Resources/deployments/{deploymentName}/exportTemplate": { "post": { "tags": [ @@ -4397,6 +4524,23 @@ ], "description": "Deployment What-if operation parameters." }, + "ScopedDeploymentWhatIf": { + "properties": { + "location": { + "type": "string", + "description": "The location to store the deployment data." + }, + "properties": { + "$ref": "#/definitions/DeploymentWhatIfProperties", + "description": "The deployment properties." + } + }, + "required": [ + "location", + "properties" + ], + "description": "Deployment What-if operation parameters." + }, "DeploymentWhatIfProperties": { "properties": { "whatIfSettings": { From f79ae99764d320175950233a2a8faf6543fa1219 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Mon, 29 Jun 2020 16:36:38 +0800 Subject: [PATCH 219/318] Add go SDK configuration for hsm (#9984) --- .../resource-manager/readme.go.md | 26 +++++++++++++++++++ .../resource-manager/readme.md | 2 +- 2 files changed, 27 insertions(+), 1 deletion(-) create mode 100644 specification/hardwaresecuritymodules/resource-manager/readme.go.md diff --git a/specification/hardwaresecuritymodules/resource-manager/readme.go.md b/specification/hardwaresecuritymodules/resource-manager/readme.go.md new file mode 100644 index 000000000000..d346e30613a2 --- /dev/null +++ b/specification/hardwaresecuritymodules/resource-manager/readme.go.md @@ -0,0 +1,26 @@ +## Go + +These settings apply only when `--go` is specified on the command line. + +```yaml $(go) +go: + license-header: MICROSOFT_APACHE_NO_VERSION + namespace: hardwaresecuritymodules + clear-output-folder: true +``` + +### Go multi-api + +```yaml $(go) && $(multiapi) +batch: + - tag: package-2018-10 +``` + +### Tag: package-2018-10 and go + +These settings apply only when `--tag=package-2018-10 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag)=='package-2018-10' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2018-10-31-preview/$(namespace) +``` \ No newline at end of file diff --git a/specification/hardwaresecuritymodules/resource-manager/readme.md b/specification/hardwaresecuritymodules/resource-manager/readme.md index 33848571baec..59a76b0d23c6 100644 --- a/specification/hardwaresecuritymodules/resource-manager/readme.md +++ b/specification/hardwaresecuritymodules/resource-manager/readme.md @@ -30,7 +30,7 @@ tag: package-2018-10 ``` -### Tag: package-2018-02 +### Tag: package-2018-10 These settings apply only when `--tag=package-2018-10` is specified on the command line. From 379847f2a8e8927a5d6c950e22d080fd04815277 Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Mon, 29 Jun 2020 11:54:25 +0200 Subject: [PATCH 220/318] fixed track2 generation (#9848) --- .../stable/2019-07-01/gallery.json | 15 --------------- 1 file changed, 15 deletions(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json index ad40111669f1..6f0081100c90 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2019-07-01/gallery.json @@ -2542,21 +2542,6 @@ "UpdateResource": { "description": "The Update Resource model definition.", "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Resource Id" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "Resource name" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "Resource type" - }, "tags": { "type": "object", "additionalProperties": { From 95409b6efc0f467ff6ecb5bcd74487380507c72b Mon Sep 17 00:00:00 2001 From: Karthik Subramanian Date: Mon, 29 Jun 2020 13:22:19 -0700 Subject: [PATCH 221/318] Changes for the new GA api-version (2020-07-31) (#9509) * Fix or suppress spec violations Fix R2016 by making PATCH body properties optional. Suppress the remaining 4 violations that are confirmed as false positives. * Try removing 2nd top-level heading, which _may_ have been causing a linter warning. * Fix extra indention which prevented linter from running. * Added dataStringComparisonBehavior parameter to reference data put/update spec. * Fixed grammar. * adding partitionkeyProperty to environmentInfo * changing property name * changing modelAsString * Initial checkin of spec. Unchanged from GA release other than version. * Remove .orig files * Fix validation error by removing IoTHub ES from List ES example response * Add extra example that was missing from preview spec. * Add long-term environment to resource hierarchy, and update examples. * Switch to model-as-string for enums. Restore EnvironmentResource's inheritance from TrackedResource. * Upsate sku description * Add new TSI preview api-version to readme.md. * Add suppressions for false-positive linter failures. * Test suppression failures * Adding preview package tag to several other places in readme.md * Add preview package to the readme.go.md file * Remove invalid required property from EnvironmentCreateOrUpdateParameters * Initial version of data plane swagger spec for PAYG (Preview) SKU. * Added missing Readme.md * Fixed name of readme * Fixed path to swagger json * Attempt to fix readme * Apply suggestions from code review Co-Authored-By: dmdenmsft * Update timeseriesinsights.json * Update timeseriesinsights.json * Added link to oav issue * Added new GA data plane API version. * Update readme.md * updated readme to contain preview version. * Fix bug in file reference. * Replace Guid with string for hierarchy and type ID (remove uuid restriction) * Fixes as per PR comments. Instances, Types, Heirarchies operation name : _Get to _List. * Fix hierarchies file names. Co-authored-by: Eric Dettinger Co-authored-by: Ravi Kumar Suresh Babu Co-authored-by: ravikumarsureshbabu Co-authored-by: Dmitry Denisov Co-authored-by: Nick Schonning Co-authored-by: Ric Serradas Co-authored-by: Richard Wydrowski --- .../timeseriesinsights.json | 2 +- .../2020-07-31/examples/AvailabilityGet.json | 34 + .../examples/AvailabilityGetEmpty.json | 11 + .../examples/ColdStoreAvailabilityGet.json | 35 + .../examples/ColdStoreEventSchemaGet.json | 45 + .../ColdStoreQueryAggregateSeriesPage1.json | 62 + .../ColdStoreQueryAggregateSeriesPage2.json | 145 + .../ColdStoreQueryGetEventsPage1.json | 40 + .../ColdStoreQueryGetEventsPage2.json | 87 + .../ColdStoreQueryGetEventsPage3.json | 60 + .../ColdStoreQueryGetEventsPage4.json | 42 + .../ColdStoreQueryGetSeriesPage1.json | 43 + .../ColdStoreQueryGetSeriesPage2.json | 76 + .../ColdStoreQueryGetSeriesPage3.json | 55 + .../2020-07-31/examples/EventSchemaGet.json | 44 + .../examples/EventSchemaGetEmpty.json | 19 + .../examples/HierarchiesBatchDeleteByIds.json | 22 + .../HierarchiesBatchDeleteByNames.json | 22 + .../examples/HierarchiesBatchGetByIds.json | 46 + .../examples/HierarchiesBatchGetByNames.json | 46 + .../examples/HierarchiesBatchPut.json | 64 + .../examples/HierarchiesListPage1.json | 25 + .../examples/HierarchiesListPage2.json | 26 + .../examples/HierarchiesListPage3.json | 14 + .../examples/InstancesBatchDeleteByIds.json | 36 + .../examples/InstancesBatchDeleteByNames.json | 30 + .../examples/InstancesBatchGetByIds.json | 44 + .../examples/InstancesBatchGetByNames.json | 41 + .../examples/InstancesBatchPut.json | 39 + .../examples/InstancesBatchUpdate.json | 39 + .../examples/InstancesListPage1.json | 33 + .../examples/InstancesListPage2.json | 33 + .../examples/InstancesListPage3.json | 14 + .../2020-07-31/examples/InstancesSuggest.json | 30 + .../2020-07-31/examples/ModelSettingsGet.json | 22 + .../examples/ModelSettingsUpdateName.json | 25 + .../examples/QueryAggregateSeriesPage1.json | 61 + .../examples/QueryAggregateSeriesPage2.json | 144 + ...esWithCategoricalInterpolatedVariable.json | 250 ++ ...ggregateSeriesWithCategoricalVariable.json | 238 ++ ...ggregateSeriesWithSampleInterpolation.json | 114 + .../examples/QueryGetEventsPage1.json | 39 + .../examples/QueryGetEventsPage2.json | 86 + .../examples/QueryGetEventsPage3.json | 59 + .../examples/QueryGetEventsPage4.json | 41 + .../examples/QueryGetEventsWithTakePage1.json | 40 + .../examples/QueryGetEventsWithTakePage2.json | 86 + .../examples/QueryGetSeriesPage1.json | 42 + .../examples/QueryGetSeriesPage2.json | 75 + .../examples/QueryGetSeriesPage3.json | 54 + .../examples/QueryGetSeriesWithTakePage1.json | 43 + .../examples/QueryGetSeriesWithTakePage2.json | 75 + .../examples/SearchInstancesDefault.json | 48 + .../SearchInstancesExpandHierarchiesOnly.json | 59 + ...InstancesHierarchiesDefaultInputPage1.json | 106 + ...InstancesHierarchiesDefaultInputPage2.json | 77 + ...InstancesHierarchiesDefaultInputPage3.json | 66 + .../examples/SearchInstancesOneLevel.json | 49 + .../examples/SearchInstancesRecursive.json | 58 + .../SearchInstancesUntilChildren.json | 66 + .../examples/TypesBatchDeleteByIds.json | 22 + .../examples/TypesBatchDeleteByNames.json | 22 + .../examples/TypesBatchGetByIds.json | 60 + .../examples/TypesBatchGetByNames.json | 59 + .../2020-07-31/examples/TypesBatchPut.json | 90 + .../2020-07-31/examples/TypesListPage1.json | 29 + .../2020-07-31/examples/TypesListPage2.json | 32 + .../2020-07-31/examples/TypesListPage3.json | 14 + .../examples/WarmStoreAvailabilityGet.json | 35 + .../examples/WarmStoreEventSchemaGet.json | 45 + .../WarmStoreQueryAggregateSeriesPage.json | 144 + .../WarmStoreQueryGetEventsPage1.json | 40 + .../WarmStoreQueryGetEventsPage2.json | 87 + .../WarmStoreQueryGetEventsPage3.json | 60 + .../WarmStoreQueryGetEventsPage4.json | 42 + .../WarmStoreQueryGetSeriesPage1.json | 43 + .../WarmStoreQueryGetSeriesPage2.json | 76 + .../WarmStoreQueryGetSeriesPage3.json | 55 + .../stable/2020-07-31/timeseriesinsights.json | 2517 +++++++++++++++++ .../timeseriesinsights/data-plane/readme.md | 11 +- 80 files changed, 6904 insertions(+), 6 deletions(-) create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/AvailabilityGet.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/AvailabilityGetEmpty.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreAvailabilityGet.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreEventSchemaGet.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryAggregateSeriesPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryAggregateSeriesPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage3.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage4.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage3.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/EventSchemaGet.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/EventSchemaGetEmpty.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchDeleteByIds.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchDeleteByNames.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchGetByIds.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchGetByNames.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchPut.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage3.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchDeleteByIds.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchDeleteByNames.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchGetByIds.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchGetByNames.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchPut.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchUpdate.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage3.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesSuggest.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ModelSettingsGet.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ModelSettingsUpdateName.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithCategoricalVariable.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithSampleInterpolation.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage3.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage4.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsWithTakePage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsWithTakePage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage3.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesWithTakePage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesWithTakePage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesDefault.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesExpandHierarchiesOnly.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage3.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesOneLevel.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesRecursive.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesUntilChildren.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchDeleteByIds.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchDeleteByNames.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchGetByIds.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchGetByNames.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchPut.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage3.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreAvailabilityGet.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreEventSchemaGet.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryAggregateSeriesPage.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage3.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage4.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage1.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage2.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage3.json create mode 100644 specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/timeseriesinsights.json diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json index e8bbd560e3b4..a52536af3c7c 100644 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json @@ -539,7 +539,7 @@ "$ref": "./examples/InstancesBatchGetByIds.json" }, "InstancesBatchGetByNames": { - "$ref": "./examples/InstancesBatchGetByIds.json" + "$ref": "./examples/InstancesBatchGetByNames.json" }, "InstancesBatchUpdate": { "$ref": "./examples/InstancesBatchUpdate.json" diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/AvailabilityGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/AvailabilityGet.json new file mode 100644 index 000000000000..e35b777fce52 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/AvailabilityGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "clientRequestId": "A72703F6-C0B1-49EF-854A-59F1994F54E7", + "clientSessionId": "AlertCalculation_W7" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "0d59d156-2807-4952-87bb-0e074417dbfb" + }, + "body": { + "availability": { + "intervalSize": "PT1H", + "distribution": { + "2019-03-27T04:00:00Z": 432447, + "2019-03-27T05:00:00Z": 432340, + "2019-03-27T06:00:00Z": 432451, + "2019-03-27T07:00:00Z": 432436, + "2019-03-26T13:00:00Z": 386247, + "2019-03-27T00:00:00Z": 436968, + "2019-03-27T01:00:00Z": 432509, + "2019-03-27T02:00:00Z": 432487 + }, + "range": { + "from": "2019-03-14T06:38:27.153Z", + "to": "2019-03-27T03:57:11.697Z" + } + } + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/AvailabilityGetEmpty.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/AvailabilityGetEmpty.json new file mode 100644 index 000000000000..02a63f296055 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/AvailabilityGetEmpty.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreAvailabilityGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreAvailabilityGet.json new file mode 100644 index 000000000000..1d5a5a68eb48 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreAvailabilityGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "clientRequestId": "A72703F6-C0B1-49EF-854A-59F1994F54E7", + "clientSessionId": "AlertCalculation_W7" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "0d59d156-2807-4952-87bb-0e074417dbfb" + }, + "body": { + "availability": { + "intervalSize": "PT1H", + "distribution": { + "2019-03-27T04:00:00Z": 432447, + "2019-03-27T05:00:00Z": 432340, + "2019-03-27T06:00:00Z": 432451, + "2019-03-27T07:00:00Z": 432436, + "2019-03-26T13:00:00Z": 386247, + "2019-03-27T00:00:00Z": 436968, + "2019-03-27T01:00:00Z": 432509, + "2019-03-27T02:00:00Z": 432487 + }, + "range": { + "from": "2019-03-14T06:38:27.153Z", + "to": "2019-03-27T03:57:11.697Z" + } + } + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreEventSchemaGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreEventSchemaGet.json new file mode 100644 index 000000000000..facc465246b3 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreEventSchemaGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchSpan": { + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-08-31T00:00:00.000Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Room", + "type": "String" + }, + { + "name": "DeviceId", + "type": "Double" + }, + { + "name": "Temperature", + "type": "Double" + }, + { + "name": "Pressure", + "type": "Double" + }, + { + "name": "Status", + "type": "String" + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryAggregateSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryAggregateSeriesPage1.json new file mode 100644 index 000000000000..d345efbb864b --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryAggregateSeriesPage1.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "aggregateSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "interval": "PT1M", + "inlineVariables": { + "Count": { + "kind": "aggregate", + "filter": null, + "aggregation": { + "tsx": "count()" + } + }, + "MinTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "min($value)" + } + }, + "MaxTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "max($value)" + } + } + }, + "projectedVariables": [ + "Count", + "MinTemperature", + "MaxTemperature" + ] + } + } + }, + "responses": { + "200": { + "body": { + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryAggregateSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryAggregateSeriesPage2.json new file mode 100644 index 000000000000..48fc4902a025 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryAggregateSeriesPage2.json @@ -0,0 +1,145 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "aggregateSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "interval": "PT1M", + "inlineVariables": { + "Count": { + "kind": "aggregate", + "filter": null, + "aggregation": { + "tsx": "count()" + } + }, + "MinTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "min($value)" + } + }, + "MaxTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "max($value)" + } + } + }, + "projectedVariables": [ + "Count", + "MinTemperature", + "MaxTemperature" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:00Z", + "2016-08-01T00:01:00Z", + "2016-08-01T00:02:00Z", + "2016-08-01T00:03:00Z", + "2016-08-01T00:04:00Z", + "2016-08-01T00:05:00Z", + "2016-08-01T00:06:00Z", + "2016-08-01T00:07:00Z", + "2016-08-01T00:08:00Z", + "2016-08-01T00:09:00Z", + "2016-08-01T00:10:00Z" + ], + "properties": [ + { + "name": "Count", + "type": "Long", + "values": [ + 50, + 60, + 60, + 60, + 60, + 60, + 60, + 60, + 60, + 60, + null + ] + }, + { + "name": "AverageTemperature", + "type": "Double", + "values": [ + 71.25, + 85.0, + 82.5, + 80.0, + 89.166666666666671, + 75.0, + 90.0, + 75.833333333333329, + 85.0, + 82.5, + null + ] + }, + { + "name": "MinTemperature", + "type": "Double", + "values": [ + 65.125, + 77.625, + 65.125, + 72.625, + 65.125, + 67.625, + 82.625, + 65.125, + 77.625, + 65.125, + null + ] + }, + { + "name": "MaxTemperature", + "type": "Double", + "values": [ + 77.375, + 92.375, + 99.875, + 87.375, + 99.875, + 82.375, + 97.375, + 99.875, + 92.375, + 99.875, + null + ] + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage1.json new file mode 100644 index 000000000000..37529aefea13 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage1.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage2.json new file mode 100644 index 000000000000..526871620036 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage2.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:10Z", + "2016-08-01T00:00:11Z", + "2016-08-01T00:00:12Z", + "2016-08-01T00:00:13Z", + "2016-08-01T00:00:14Z", + "2016-08-01T00:00:15Z", + "2016-08-01T00:00:16Z", + "2016-08-01T00:00:17Z", + "2016-08-01T00:00:18Z", + "2016-08-01T00:00:19Z" + ], + "properties": [ + { + "name": "Building", + "type": "String", + "values": [ + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium" + ] + }, + { + "name": "Temperature", + "type": "Double", + "values": [ + 65.125, + 65.375, + 65.625, + 65.875, + 66.125, + 66.375, + 66.625, + 66.875, + 67.125, + 67.375 + ] + } + ], + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage3.json new file mode 100644 index 000000000000..49fa1aedf6a3 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage3.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:20Z" + ], + "properties": [ + { + "name": "Building", + "type": "String", + "values": [ + "Millenium" + ] + }, + { + "name": "Temperature", + "type": "Double", + "values": [ + 67.575 + ] + } + ], + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage4.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage4.json new file mode 100644 index 000000000000..969da41b7536 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetEventsPage4.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [], + "properties": [], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage1.json new file mode 100644 index 000000000000..c7cbf052cfcd --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage1.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ] + } + } + }, + "responses": { + "200": { + "body": { + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage2.json new file mode 100644 index 000000000000..187c988495b5 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage2.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:10Z", + "2016-08-01T00:00:11Z", + "2016-08-01T00:00:12Z", + "2016-08-01T00:00:13Z", + "2016-08-01T00:00:14Z", + "2016-08-01T00:00:15Z", + "2016-08-01T00:00:16Z", + "2016-08-01T00:00:17Z", + "2016-08-01T00:00:18Z", + "2016-08-01T00:00:19Z", + "2016-08-01T00:00:20Z" + ], + "properties": [ + { + "name": "temperatures", + "type": "Double", + "values": [ + 65.125, + 65.375, + 65.625, + 65.875, + 66.125, + 66.375, + 66.625, + 66.875, + 67.125, + 67.375, + 67.625 + ] + } + ], + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage3.json new file mode 100644 index 000000000000..f3647241c3a4 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ColdStoreQueryGetSeriesPage3.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "coldstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:21Z" + ], + "properties": [ + { + "name": "temperatures", + "type": "Double", + "values": [ + 67.825 + ] + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/EventSchemaGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/EventSchemaGet.json new file mode 100644 index 000000000000..421da68104df --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/EventSchemaGet.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchSpan": { + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-08-31T00:00:00.000Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Room", + "type": "String" + }, + { + "name": "DeviceId", + "type": "Double" + }, + { + "name": "Temperature", + "type": "Double" + }, + { + "name": "Pressure", + "type": "Double" + }, + { + "name": "Status", + "type": "String" + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/EventSchemaGetEmpty.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/EventSchemaGetEmpty.json new file mode 100644 index 000000000000..e7010afefc5c --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/EventSchemaGetEmpty.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchSpan": { + "from": "2016-08-01T00:00:00.000Z", + "to": "2016-08-31T00:00:00.000Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": [] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchDeleteByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchDeleteByIds.json new file mode 100644 index 000000000000..05f5a95f2058 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchDeleteByIds.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "delete": { + "hierarchyIds": [ + "a28fd14c-6b98-4ab5-9301-3840f142d30e" + ] + } + } + }, + "responses": { + "200": { + "body": { + "delete": [ + null + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchDeleteByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchDeleteByNames.json new file mode 100644 index 000000000000..2e45d0470356 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchDeleteByNames.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "delete": { + "names": [ + "WindFarm" + ] + } + } + }, + "responses": { + "200": { + "body": { + "delete": [ + null + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchGetByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchGetByIds.json new file mode 100644 index 000000000000..b3b26c66f481 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchGetByIds.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "get": { + "hierarchyIds": [ + "6e292e54-9a26-4be1-9034-607d71492707", + "a28fd14c-6b98-4ab5-9301-3840f142d30e" + ] + } + } + }, + "responses": { + "200": { + "body": { + "get": [ + { + "hierarchy": { + "id": "6e292e54-9a26-4be1-9034-607d71492707", + "name": "Location", + "source": { + "instanceFieldNames": [ + "state", + "city" + ] + } + } + }, + { + "hierarchy": { + "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e", + "name": "ManufactureDate", + "source": { + "instanceFieldNames": [ + "year", + "month" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchGetByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchGetByNames.json new file mode 100644 index 000000000000..f111f85c3853 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchGetByNames.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "get": { + "names": [ + "Location", + "ManufactureDate" + ] + } + } + }, + "responses": { + "200": { + "body": { + "get": [ + { + "hierarchy": { + "id": "6e292e54-9a26-4be1-9034-607d71492707", + "name": "Location", + "source": { + "instanceFieldNames": [ + "state", + "city" + ] + } + } + }, + { + "hierarchy": { + "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e", + "name": "ManufactureDate", + "source": { + "instanceFieldNames": [ + "year", + "month" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchPut.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchPut.json new file mode 100644 index 000000000000..931ca0ae0f9b --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesBatchPut.json @@ -0,0 +1,64 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "put": [ + { + "id": "6e292e54-9a26-4be1-9034-607d71492707", + "name": "Location", + "source": { + "instanceFieldNames": [ + "state", + "city" + ] + } + }, + { + "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e", + "name": "ManufactureDate", + "source": { + "instanceFieldNames": [ + "year", + "month" + ] + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "put": [ + { + "hierarchy": { + "id": "6e292e54-9a26-4be1-9034-607d71492707", + "name": "Location", + "source": { + "instanceFieldNames": [ + "state", + "city" + ] + } + }, + "error": null + }, + { + "hierarchy": { + "id": "a28fd14c-6b98-4ab5-9301-3840f142d30e", + "name": "ManufactureDate", + "source": { + "instanceFieldNames": [ + "year", + "month" + ] + } + }, + "error": null + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage1.json new file mode 100644 index 000000000000..8dfb82e3afa2 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage1.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" + }, + "responses": { + "200": { + "body": { + "hierarchies": [ + { + "id": "6e292e54-9a26-4be1-9034-607d71492707", + "name": "Location", + "source": { + "instanceFieldNames": [ + "state", + "city" + ] + } + } + ], + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage2.json new file mode 100644 index 000000000000..a49d1ae28287 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage2.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + }, + "responses": { + "200": { + "body": { + "hierarchies": [ + { + "id": "6e292e54-9a26-4be1-9034-607d71492707", + "name": "Location", + "source": { + "instanceFieldNames": [ + "state", + "city" + ] + } + } + ], + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage3.json new file mode 100644 index 000000000000..1b74797f5a8d --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/HierarchiesListPage3.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" + }, + "responses": { + "200": { + "body": { + "hierarchies": [] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchDeleteByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchDeleteByIds.json new file mode 100644 index 000000000000..30f202fe23e2 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchDeleteByIds.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "delete": { + "timeSeriesIds": [ + [ + "2da181d7-8346-4cf2-bd94-a17742237429", + "T1" + ], + [ + "18672e3d-2beb-4007-9846-042b09ef3c72", + "T2" + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "delete": [ + null, + { + "code": "InvalidInput", + "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.", + "innerError": { + "code": "CannotDeleteInstance" + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchDeleteByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchDeleteByNames.json new file mode 100644 index 000000000000..bc6efe5dc6f1 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchDeleteByNames.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "delete": { + "names": [ + "F2W6.GF", + "F1W7.GS1" + ] + } + } + }, + "responses": { + "200": { + "body": { + "delete": [ + null, + { + "code": "InvalidInput", + "message": "Time series instance with ID '[\"18672e3d-2beb-4007-9846-042b09ef3c72\", \"T2\"]' cannot be deleted. There are already ingested events associated with this time series ID.", + "innerError": { + "code": "CannotDeleteInstance" + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchGetByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchGetByIds.json new file mode 100644 index 000000000000..d3384ffc4ae2 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchGetByIds.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "get": { + "timeSeriesIds": [ + [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ] + ] + } + } + }, + "responses": { + "200": { + "body": { + "get": [ + { + "instance": { + "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", + "name": "F1W7.GS1", + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "description": "ContosoFarm1W7_GenSpeed1", + "hierarchyIds": [ + "33d72529-dd73-4c31-93d8-ae4e6cb5605d" + ], + "instanceFields": { + "Name": "GeneratorSpeed", + "Plant": "Contoso Plant 1", + "Unit": "W7", + "System": "Generator System" + } + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchGetByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchGetByNames.json new file mode 100644 index 000000000000..5203b15a7324 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchGetByNames.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "get": { + "names": [ + "F1W7.GS1" + ] + } + } + }, + "responses": { + "200": { + "body": { + "get": [ + { + "instance": { + "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", + "name": "F1W7.GS1", + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "description": "ContosoFarm1W7_GenSpeed1", + "hierarchyIds": [ + "33d72529-dd73-4c31-93d8-ae4e6cb5605d" + ], + "instanceFields": { + "Name": "GeneratorSpeed", + "Plant": "Contoso Plant 1", + "Unit": "W7", + "System": "Generator System" + } + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchPut.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchPut.json new file mode 100644 index 000000000000..6e51a98733e8 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchPut.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "put": [ + { + "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", + "name": "F1W7.GS1", + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "description": "ContosoFarm1W7_GenSpeed1", + "hierarchyIds": [ + "33d72529-dd73-4c31-93d8-ae4e6cb5605d" + ], + "instanceFields": { + "Name": "GeneratorSpeed", + "Plant": "Contoso Plant 1", + "Unit": "W7", + "System": "Generator System" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "put": [ + { + "error": null + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchUpdate.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchUpdate.json new file mode 100644 index 000000000000..a52bd9e523ef --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesBatchUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "update": [ + { + "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", + "name": "F1W7.GS1", + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "description": "ContosoFarm1W7_GenSpeed1", + "hierarchyIds": [ + "33d72529-dd73-4c31-93d8-ae4e6cb5605d" + ], + "instanceFields": { + "Name": "GeneratorSpeed", + "Plant": "Contoso Plant 1", + "Unit": "W7", + "System": "Generator System" + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "update": [ + { + "error": null + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage1.json new file mode 100644 index 000000000000..f58bccbe7bf4 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage1.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" + }, + "responses": { + "200": { + "body": { + "instances": [ + { + "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", + "name": "F1W7.GS1", + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "description": "ContosoFarm1W7_GenSpeed1", + "hierarchyIds": [ + "33d72529-dd73-4c31-93d8-ae4e6cb5605d" + ], + "instanceFields": { + "Name": "GeneratorSpeed", + "Plant": "Contoso Plant 1", + "Unit": "W7", + "System": "Generator System" + } + } + ], + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage2.json new file mode 100644 index 000000000000..353140ee2ad9 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage2.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + }, + "responses": { + "200": { + "body": { + "instances": [ + { + "typeId": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", + "timeSeriesId": [ + "fe984fd0-f632-49ab-990e-3ded259e29b8", + "T1" + ], + "description": "ContosoFarm1W6_GridVoltage3", + "hierarchyIds": [ + "33d72529-dd73-4c31-93d8-ae4e6cb5605d" + ], + "instanceFields": { + "Name": "GridVoltagePhase3", + "Plant": "Contoso Plant 1", + "Unit": "W6", + "System": "Generator System" + } + } + ], + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage3.json new file mode 100644 index 000000000000..cef59753fb99 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesListPage3.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" + }, + "responses": { + "200": { + "body": { + "instances": [] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesSuggest.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesSuggest.json new file mode 100644 index 000000000000..aaa6985e1037 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/InstancesSuggest.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchString": "flo", + "take": 3 + } + }, + "responses": { + "200": { + "body": { + "suggestions": [ + { + "searchString": "floor 100", + "highlightedSearchString": "floor 100" + }, + { + "searchString": "sensor on floor 0", + "highlightedSearchString": "sensor on floor 0" + }, + { + "searchString": "sensor on floor 1", + "highlightedSearchString": "sensor on floor 1" + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ModelSettingsGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ModelSettingsGet.json new file mode 100644 index 000000000000..51947ffa1057 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ModelSettingsGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" + }, + "responses": { + "200": { + "body": { + "modelSettings": { + "name": "DefaultModel", + "timeSeriesIdProperties": [ + { + "name": "DeviceId", + "type": "String" + } + ], + "defaultTypeId": "5AB70D71-A8CD-410E-B70D-6F04AB9C132C" + } + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ModelSettingsUpdateName.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ModelSettingsUpdateName.json new file mode 100644 index 000000000000..84b703fc89c0 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/ModelSettingsUpdateName.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "name": "Thermostats" + } + }, + "responses": { + "200": { + "body": { + "modelSettings": { + "name": "Thermostats", + "timeSeriesIdProperties": [ + { + "name": "DeviceId", + "type": "String" + } + ], + "defaultTypeId": "5AB70D71-A8CD-410E-B70D-6F04AB9C132C" + } + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesPage1.json new file mode 100644 index 000000000000..997acfa812d0 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesPage1.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "aggregateSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "interval": "PT1M", + "inlineVariables": { + "Count": { + "kind": "aggregate", + "filter": null, + "aggregation": { + "tsx": "count()" + } + }, + "MinTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "min($value)" + } + }, + "MaxTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "max($value)" + } + } + }, + "projectedVariables": [ + "Count", + "MinTemperature", + "MaxTemperature" + ] + } + } + }, + "responses": { + "200": { + "body": { + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesPage2.json new file mode 100644 index 000000000000..2af045d28325 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesPage2.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "aggregateSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "interval": "PT1M", + "inlineVariables": { + "Count": { + "kind": "aggregate", + "filter": null, + "aggregation": { + "tsx": "count()" + } + }, + "MinTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "min($value)" + } + }, + "MaxTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "max($value)" + } + } + }, + "projectedVariables": [ + "Count", + "MinTemperature", + "MaxTemperature" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:00Z", + "2016-08-01T00:01:00Z", + "2016-08-01T00:02:00Z", + "2016-08-01T00:03:00Z", + "2016-08-01T00:04:00Z", + "2016-08-01T00:05:00Z", + "2016-08-01T00:06:00Z", + "2016-08-01T00:07:00Z", + "2016-08-01T00:08:00Z", + "2016-08-01T00:09:00Z", + "2016-08-01T00:10:00Z" + ], + "properties": [ + { + "name": "Count", + "type": "Long", + "values": [ + 50, + 60, + 60, + 60, + 60, + 60, + 60, + 60, + 60, + 60, + null + ] + }, + { + "name": "AverageTemperature", + "type": "Double", + "values": [ + 71.25, + 85.0, + 82.5, + 80.0, + 89.166666666666671, + 75.0, + 90.0, + 75.833333333333329, + 85.0, + 82.5, + null + ] + }, + { + "name": "MinTemperature", + "type": "Double", + "values": [ + 65.125, + 77.625, + 65.125, + 72.625, + 65.125, + 67.625, + 82.625, + 65.125, + 77.625, + 65.125, + null + ] + }, + { + "name": "MaxTemperature", + "type": "Double", + "values": [ + 77.375, + 92.375, + 99.875, + 87.375, + 99.875, + 82.375, + 97.375, + 99.875, + 92.375, + 99.875, + null + ] + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json new file mode 100644 index 000000000000..04d175664d8c --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json @@ -0,0 +1,250 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "aggregateSeries": { + "searchSpan": { + "from": "2019-10-10T23:41:04.021Z", + "to": "2019-10-10T23:42:22.846Z" + }, + "timeSeriesId": [ + "Sensor_58" + ], + "interval": "PT2S", + "inlineVariables": { + "Status_String": { + "kind": "categorical", + "value": { + "tsx": "$event.[Status].String" + }, + "interpolation": { + "kind": "Step", + "boundary": { + "span": "PT5S" + } + }, + "categories": [ + { + "label": "Good", + "values": [ + "Good", + "Very Good", + "Excellent" + ] + }, + { + "label": "Bad", + "values": [ + "Bad", + "OK" + ] + }, + { + "label": "Other", + "values": [ + "Other" + ] + } + ], + "defaultCategory": { + "label": "Unknown" + } + }, + "Status_Long": { + "kind": "categorical", + "value": { + "tsx": "tolong($event.[Status].Double)" + }, + "interpolation": { + "kind": "Step", + "boundary": { + "span": "PT5S" + } + }, + "categories": [ + { + "label": "Good", + "values": [ + 0, + 1, + 2 + ] + }, + { + "label": "Bad", + "values": [ + 3, + 4 + ] + }, + { + "label": "Other", + "values": [ + 5 + ] + } + ], + "defaultCategory": { + "label": "Unknown" + } + } + }, + "projectedVariables": [ + "Status_String", + "Status_Long" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2019-10-10T23:41:04Z", + "2019-10-10T23:41:06Z", + "2019-10-10T23:41:08Z", + "2019-10-10T23:41:10Z", + "2019-10-10T23:41:12Z", + "2019-10-10T23:41:14Z", + "2019-10-10T23:41:16Z", + "2019-10-10T23:41:18Z", + "2019-10-10T23:41:20Z", + "2019-10-10T23:41:22Z" + ], + "properties": [ + { + "values": [ + 0.203, + 0.141, + 0.268, + 0.398, + 0.402, + 0.047, + 0.1245, + 0.75, + 0.206, + 0.2635 + ], + "name": "Status_String[Good]", + "type": "Double" + }, + { + "values": [ + 0.266, + 0.1955, + 0.242, + 0.148, + 0.25, + 0.055, + 0.6295, + 0.109, + 0.41, + 0.2125 + ], + "name": "Status_String[Bad]", + "type": "Double" + }, + { + "values": [ + 0.5205, + 0.6635, + 0.49, + 0.454, + 0.348, + 0.898, + 0.246, + 0.141, + 0.384, + 0.524 + ], + "name": "Status_String[Other]", + "type": "Double" + }, + { + "values": [ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0 + ], + "name": "Status_String[Unknown]", + "type": "Double" + }, + { + "values": [ + 0.203, + 0.141, + 0.268, + 0.398, + 0.402, + 0.047, + 0.1245, + 0.75, + 0.206, + 0.2635 + ], + "name": "Status_Long[Good]", + "type": "Double" + }, + { + "values": [ + 0.266, + 0.1955, + 0.242, + 0.148, + 0.25, + 0.055, + 0.6295, + 0.109, + 0.41, + 0.2125 + ], + "name": "Status_Long[Bad]", + "type": "Double" + }, + { + "values": [ + 0.5205, + 0.6635, + 0.49, + 0.454, + 0.348, + 0.898, + 0.246, + 0.141, + 0.384, + 0.524 + ], + "name": "Status_Long[Other]", + "type": "Double" + }, + { + "values": [ + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0, + 0.0 + ], + "name": "Status_Long[Unknown]", + "type": "Double" + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithCategoricalVariable.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithCategoricalVariable.json new file mode 100644 index 000000000000..bb0e7ab6eaed --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithCategoricalVariable.json @@ -0,0 +1,238 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "aggregateSeries": { + "searchSpan": { + "from": "2019-10-10T23:42:00.000Z", + "to": "2019-10-10T23:42:20.000Z" + }, + "timeSeriesId": [ + "Sensor_58" + ], + "interval": "PT2S", + "inlineVariables": { + "Status_String": { + "kind": "categorical", + "value": { + "tsx": "$event.[Status].String" + }, + "categories": [ + { + "label": "Good", + "values": [ + "Good", + "Very Good", + "Excellent" + ] + }, + { + "label": "Bad", + "values": [ + "Bad", + "OK" + ] + }, + { + "label": "Other", + "values": [ + "Other" + ] + } + ], + "defaultCategory": { + "label": "Unknown" + } + }, + "Status_Long": { + "kind": "categorical", + "value": { + "tsx": "tolong($event.[Status].Double)" + }, + "categories": [ + { + "label": "Good", + "values": [ + 0, + 1, + 2 + ] + }, + { + "label": "Bad", + "values": [ + 3, + 4 + ] + }, + { + "label": "Other", + "values": [ + 5 + ] + } + ], + "defaultCategory": { + "label": "Unknown" + } + } + }, + "projectedVariables": [ + "Status_String", + "Status_Long" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2019-10-10T23:42:00Z", + "2019-10-10T23:42:02Z", + "2019-10-10T23:42:04Z", + "2019-10-10T23:42:06Z", + "2019-10-10T23:42:08Z", + "2019-10-10T23:42:10Z", + "2019-10-10T23:42:12Z", + "2019-10-10T23:42:14Z", + "2019-10-10T23:42:16Z", + "2019-10-10T23:42:18Z" + ], + "properties": [ + { + "values": [ + 5, + 8, + 4, + 6, + 9, + 8, + 3, + 6, + 5, + 8 + ], + "name": "Status_String[Good]", + "type": "Long" + }, + { + "values": [ + 4, + 3, + 3, + 5, + 5, + 3, + 9, + 7, + 7, + 7 + ], + "name": "Status_String[Bad]", + "type": "Long" + }, + { + "values": [ + 11, + 9, + 13, + 9, + 6, + 9, + 8, + 7, + 8, + 5 + ], + "name": "Status_String[Other]", + "type": "Long" + }, + { + "values": [ + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0 + ], + "name": "Status_String[Unknown]", + "type": "Long" + }, + { + "values": [ + 5, + 8, + 4, + 6, + 9, + 8, + 3, + 6, + 5, + 8 + ], + "name": "Status_Long[Good]", + "type": "Long" + }, + { + "values": [ + 4, + 3, + 3, + 5, + 5, + 3, + 9, + 7, + 7, + 7 + ], + "name": "Status_Long[Bad]", + "type": "Long" + }, + { + "values": [ + 11, + 9, + 13, + 9, + 6, + 9, + 8, + 7, + 8, + 5 + ], + "name": "Status_Long[Other]", + "type": "Long" + }, + { + "values": [ + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0, + 0 + ], + "name": "Status_Long[Unknown]", + "type": "Long" + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithSampleInterpolation.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithSampleInterpolation.json new file mode 100644 index 000000000000..6a017b31820b --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryAggregateSeriesWithSampleInterpolation.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "aggregateSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "interval": "PT1M", + "inlineVariables": { + "LinearSampleInterpolation": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "interpolation": { + "kind": "Linear", + "boundary": { + "span": "P1D" + } + }, + "aggregation": { + "tsx": "left($value)" + } + }, + "StepSampleInterpolation": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "interpolation": { + "kind": "Step", + "boundary": { + "span": "P1D" + } + }, + "aggregation": { + "tsx": "left($value)" + } + } + }, + "projectedVariables": [ + "LinearSampleInterpolation", + "StepSampleInterpolation" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:00Z", + "2016-08-01T00:01:00Z", + "2016-08-01T00:02:00Z", + "2016-08-01T00:03:00Z", + "2016-08-01T00:04:00Z", + "2016-08-01T00:05:00Z", + "2016-08-01T00:06:00Z", + "2016-08-01T00:07:00Z", + "2016-08-01T00:08:00Z", + "2016-08-01T00:09:00Z", + "2016-08-01T00:10:00Z" + ], + "properties": [ + { + "name": "LinearSampleInterpolation", + "type": "Double", + "values": [ + 50.0, + 60.0, + 60.0, + 60.0, + 60.0, + 60.0, + 60.0, + 60.0, + 60.0, + 60.0, + 62.0 + ] + }, + { + "name": "StepSampleInterpolation", + "type": "Double", + "values": [ + 71.25, + 85.0, + 82.5, + 80.0, + 89.166666666666671, + 75.0, + 90.0, + 75.833333333333329, + 85.0, + 82.5, + 84.0 + ] + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage1.json new file mode 100644 index 000000000000..8c28ab076f8f --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage1.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage2.json new file mode 100644 index 000000000000..c3652a10c406 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage2.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:10Z", + "2016-08-01T00:00:11Z", + "2016-08-01T00:00:12Z", + "2016-08-01T00:00:13Z", + "2016-08-01T00:00:14Z", + "2016-08-01T00:00:15Z", + "2016-08-01T00:00:16Z", + "2016-08-01T00:00:17Z", + "2016-08-01T00:00:18Z", + "2016-08-01T00:00:19Z" + ], + "properties": [ + { + "name": "Building", + "type": "String", + "values": [ + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium" + ] + }, + { + "name": "Temperature", + "type": "Double", + "values": [ + 65.125, + 65.375, + 65.625, + 65.875, + 66.125, + 66.375, + 66.625, + 66.875, + 67.125, + 67.375 + ] + } + ], + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage3.json new file mode 100644 index 000000000000..d3843320e9a2 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage3.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:20Z" + ], + "properties": [ + { + "name": "Building", + "type": "String", + "values": [ + "Millenium" + ] + }, + { + "name": "Temperature", + "type": "Double", + "values": [ + 67.575 + ] + } + ], + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage4.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage4.json new file mode 100644 index 000000000000..72e40843571e --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsPage4.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [], + "properties": [], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsWithTakePage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsWithTakePage1.json new file mode 100644 index 000000000000..650521a24d67 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsWithTakePage1.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ], + "take": 10 + } + } + }, + "responses": { + "200": { + "body": { + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsWithTakePage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsWithTakePage2.json new file mode 100644 index 000000000000..ad9790791da8 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetEventsWithTakePage2.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ], + "take": 10 + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:10Z", + "2016-08-01T00:00:11Z", + "2016-08-01T00:00:12Z", + "2016-08-01T00:00:13Z", + "2016-08-01T00:00:14Z", + "2016-08-01T00:00:15Z", + "2016-08-01T00:00:16Z", + "2016-08-01T00:00:17Z", + "2016-08-01T00:00:18Z", + "2016-08-01T00:00:19Z" + ], + "properties": [ + { + "name": "Building", + "type": "String", + "values": [ + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium" + ] + }, + { + "name": "Temperature", + "type": "Double", + "values": [ + 65.125, + 65.375, + 65.625, + 65.875, + 66.125, + 66.375, + 66.625, + 66.875, + 67.125, + 67.375 + ] + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage1.json new file mode 100644 index 000000000000..1f35b4aabbb3 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage1.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ] + } + } + }, + "responses": { + "200": { + "body": { + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage2.json new file mode 100644 index 000000000000..e71d2892d013 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage2.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:10Z", + "2016-08-01T00:00:11Z", + "2016-08-01T00:00:12Z", + "2016-08-01T00:00:13Z", + "2016-08-01T00:00:14Z", + "2016-08-01T00:00:15Z", + "2016-08-01T00:00:16Z", + "2016-08-01T00:00:17Z", + "2016-08-01T00:00:18Z", + "2016-08-01T00:00:19Z", + "2016-08-01T00:00:20Z" + ], + "properties": [ + { + "name": "temperatures", + "type": "Double", + "values": [ + 65.125, + 65.375, + 65.625, + 65.875, + 66.125, + 66.375, + 66.625, + 66.875, + 67.125, + 67.375, + 67.625 + ] + } + ], + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage3.json new file mode 100644 index 000000000000..f8e062a11210 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesPage3.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:21Z" + ], + "properties": [ + { + "name": "temperatures", + "type": "Double", + "values": [ + 67.825 + ] + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesWithTakePage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesWithTakePage1.json new file mode 100644 index 000000000000..0ac165ab78ef --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesWithTakePage1.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ], + "take": 10 + } + } + }, + "responses": { + "200": { + "body": { + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesWithTakePage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesWithTakePage2.json new file mode 100644 index 000000000000..ffce8804a4fa --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/QueryGetSeriesWithTakePage2.json @@ -0,0 +1,75 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ], + "take": 10 + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:10Z", + "2016-08-01T00:00:11Z", + "2016-08-01T00:00:12Z", + "2016-08-01T00:00:13Z", + "2016-08-01T00:00:14Z", + "2016-08-01T00:00:15Z", + "2016-08-01T00:00:16Z", + "2016-08-01T00:00:17Z", + "2016-08-01T00:00:18Z", + "2016-08-01T00:00:19Z", + "2016-08-01T00:00:20Z" + ], + "properties": [ + { + "name": "temperatures", + "type": "Double", + "values": [ + 65.125, + 65.375, + 65.625, + 65.875, + 66.125, + 66.375, + 66.625, + 66.875, + 67.125, + 67.375, + 67.625 + ] + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesDefault.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesDefault.json new file mode 100644 index 000000000000..6df5ad349d51 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesDefault.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchString": "floor 100" + } + }, + "responses": { + "200": { + "body": { + "instances": { + "hits": [ + { + "timeSeriesId": [ + "Id1One", + "Id2One", + "1.0" + ], + "name": "instance1", + "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "hierarchyIds": [ + "1643004c-0a84-48a5-80e5-7688c5ae9295" + ], + "highlights": null + }, + { + "timeSeriesId": [ + "Id1Two", + "Id2Two", + "2.0" + ], + "name": "instance2", + "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "hierarchyIds": [ + "1643004c-0a84-48a5-80e5-7688c5ae9295" + ], + "highlights": null + } + ], + "hitCount": 2, + "continuationToken": null + }, + "hierarchyNodes": null + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesExpandHierarchiesOnly.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesExpandHierarchiesOnly.json new file mode 100644 index 000000000000..c8ffe2694aea --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesExpandHierarchiesOnly.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchString": "floor 100", + "path": [ + "Location" + ], + "instances": null, + "hierarchies": { + "expand": { + "kind": "UntilChildren" + }, + "sort": { + "by": "Name" + }, + "pageSize": 2 + } + } + }, + "responses": { + "200": { + "body": { + "instances": { + "hits": [], + "hitCount": 0, + "continuationToken": null + }, + "hierarchyNodes": { + "hits": [ + { + "name": "California", + "cumulativeInstanceCount": 2, + "hierarchyNodes": { + "hits": [ + { + "name": "San Diego", + "cumulativeInstanceCount": 1, + "hierarchyNodes": null + }, + { + "name": "San Francisco", + "cumulativeInstanceCount": 1, + "hierarchyNodes": null + } + ], + "hitCount": 2, + "continuationToken": null + } + } + ], + "hitCount": 1, + "continuationToken": null + } + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage1.json new file mode 100644 index 000000000000..4948caff9494 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage1.json @@ -0,0 +1,106 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchString": "floor 100", + "path": null, + "instances": { + "recursive": true, + "sort": { + "by": "Rank" + }, + "highlights": true, + "pageSize": 1 + }, + "hierarchies": { + "expand": { + "kind": "UntilChildren" + }, + "sort": { + "by": "CumulativeInstanceCount" + }, + "pageSize": 1 + } + } + }, + "responses": { + "200": { + "body": { + "instances": { + "hits": [ + { + "timeSeriesId": [ + "Id1Two", + "Id2Two", + "2.0" + ], + "name": "instance2", + "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "hierarchyIds": [ + "1643004c-0a84-48a5-80e5-7688c5ae9295" + ], + "highlights": { + "timeSeriesId": [ + "Id1Two", + "Id2Two", + "2.0" + ], + "typeName": "DefaultType", + "name": "instance2", + "description": "floor 100", + "hierarchyIds": [ + "1643004c-0a84-48a5-80e5-7688c5ae9295" + ], + "hierarchyNames": [ + "Location" + ], + "instanceFieldNames": [ + "state", + "city" + ], + "instanceFieldValues": [ + "California", + "San Francisco" + ] + } + } + ], + "hitCount": 2, + "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=" + }, + "hierarchyNodes": { + "hits": [ + { + "name": "Location", + "cumulativeInstanceCount": 2, + "hierarchyNodes": { + "hits": [ + { + "name": "California", + "cumulativeInstanceCount": 2, + "hierarchyNodes": { + "hits": [ + { + "name": "San Francisco", + "cumulativeInstanceCount": 1, + "hierarchyNodes": null + } + ], + "hitCount": 2, + "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=" + } + } + ], + "hitCount": 1, + "continuationToken": null + } + } + ], + "hitCount": 1, + "continuationToken": null + } + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage2.json new file mode 100644 index 000000000000..38e53340928c --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage2.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "c3sic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNTE3MDUxOTg0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=", + "parameters": { + "searchString": "floor 100", + "path": null, + "instances": { + "recursive": true, + "sort": { + "by": "Rank" + }, + "highlights": true, + "pageSize": 1 + }, + "hierarchies": { + "expand": { + "kind": "UntilChildren" + }, + "sort": { + "by": "CumulativeInstanceCount" + }, + "pageSize": 1 + } + } + }, + "responses": { + "200": { + "body": { + "instances": { + "hits": [ + { + "timeSeriesId": [ + "Id1One", + "Id2One", + "1.0" + ], + "name": "instance1", + "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "hierarchyIds": [ + "1643004c-0a84-48a5-80e5-7688c5ae9295" + ], + "highlights": { + "timeSeriesId": [ + "Id1One", + "Id2One", + "1.0" + ], + "typeName": "DefaultType", + "name": "instance1", + "description": "floor 100", + "hierarchyIds": [ + "1643004c-0a84-48a5-80e5-7688c5ae9295" + ], + "hierarchyNames": [ + "Location" + ], + "instanceFieldNames": [ + "state", + "city" + ], + "instanceFieldValues": [ + "California", + "Los Angeles" + ] + } + } + ], + "hitCount": 2, + "continuationToken": null + }, + "hierarchyNodes": null + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage3.json new file mode 100644 index 000000000000..0f93212034d4 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesHierarchiesDefaultInputPage3.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=", + "parameters": { + "searchString": "floor 100", + "path": null, + "instances": { + "recursive": true, + "sort": { + "by": "Rank" + }, + "highlights": true, + "pageSize": 1 + }, + "hierarchies": { + "expand": { + "kind": "UntilChildren" + }, + "sort": { + "by": "CumulativeInstanceCount" + }, + "pageSize": 1 + } + } + }, + "responses": { + "200": { + "body": { + "instances": null, + "hierarchyNodes": { + "hits": [ + { + "name": "Location", + "cumulativeInstanceCount": 2, + "hierarchyNodes": { + "hits": [ + { + "name": "California", + "cumulativeInstanceCount": 2, + "hierarchyNodes": { + "hits": [ + { + "name": "San Diego", + "cumulativeInstanceCount": 1, + "hierarchyNodes": null + } + ], + "hitCount": 2, + "continuationToken": "aHsic2tpcCI6MiwidGFrZSI6MiwicmVxdWVzdEhhc2hDb2RlIjotNzA4NTgyODU0LCJlbnZpcm9ubWVudElkIjoiYmY0M2YxMzMtM2Y2OC00ZWMwLWJjYjQtZmQ2NDUzMGU0MjU2In0=" + } + } + ], + "hitCount": 1, + "continuationToken": null + } + } + ], + "hitCount": 1, + "continuationToken": null + } + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesOneLevel.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesOneLevel.json new file mode 100644 index 000000000000..7d98d6af2fd5 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesOneLevel.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchString": "floor 100", + "path": null, + "instances": { + "recursive": false, + "sort": { + "by": "DisplayName" + }, + "highlights": false, + "pageSize": 2 + }, + "hierarchies": { + "expand": { + "kind": "OneLevel" + }, + "sort": { + "by": "Name" + }, + "pageSize": 2 + } + } + }, + "responses": { + "200": { + "body": { + "instances": { + "hits": [], + "hitCount": 0, + "continuationToken": null + }, + "hierarchyNodes": { + "hits": [ + { + "name": "Location", + "cumulativeInstanceCount": 2, + "hierarchyNodes": null + } + ], + "hitCount": 1, + "continuationToken": null + } + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesRecursive.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesRecursive.json new file mode 100644 index 000000000000..9cccb4d46c81 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesRecursive.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchString": "floor 100", + "path": null, + "instances": { + "recursive": true, + "sort": { + "by": "DisplayName" + }, + "highlights": false, + "pageSize": 2 + }, + "hierarchies": null + } + }, + "responses": { + "200": { + "body": { + "instances": { + "hits": [ + { + "timeSeriesId": [ + "Id1One", + "Id2One", + "1.0" + ], + "name": "instance1", + "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "hierarchyIds": [ + "1643004c-0a84-48a5-80e5-7688c5ae9295" + ], + "highlights": null + }, + { + "timeSeriesId": [ + "Id1Two", + "Id2Two", + "2.0" + ], + "name": "instance2", + "typeId": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "hierarchyIds": [ + "1643004c-0a84-48a5-80e5-7688c5ae9295" + ], + "highlights": null + } + ], + "hitCount": 2, + "continuationToken": null + }, + "hierarchyNodes": null + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesUntilChildren.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesUntilChildren.json new file mode 100644 index 000000000000..5375c7cff987 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/SearchInstancesUntilChildren.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchString": "floor 100", + "path": [ + "Location" + ], + "instances": { + "recursive": false, + "sort": { + "by": "DisplayName" + }, + "highlights": false, + "pageSize": 2 + }, + "hierarchies": { + "expand": { + "kind": "UntilChildren" + }, + "sort": { + "by": "Name" + }, + "pageSize": 2 + } + } + }, + "responses": { + "200": { + "body": { + "instances": { + "hits": [], + "hitCount": 0, + "continuationToken": null + }, + "hierarchyNodes": { + "hits": [ + { + "name": "California", + "cumulativeInstanceCount": 2, + "hierarchyNodes": { + "hits": [ + { + "name": "San Diego", + "cumulativeInstanceCount": 1, + "hierarchyNodes": null + }, + { + "name": "San Francisco", + "cumulativeInstanceCount": 1, + "hierarchyNodes": null + } + ], + "hitCount": 2, + "continuationToken": null + } + } + ], + "hitCount": 1, + "continuationToken": null + } + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchDeleteByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchDeleteByIds.json new file mode 100644 index 000000000000..08f9e11ed9c7 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchDeleteByIds.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "delete": { + "typeIds": [ + "9250f816-faed-44c4-88e6-630e5eefa38b" + ] + } + } + }, + "responses": { + "200": { + "body": { + "delete": [ + null + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchDeleteByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchDeleteByNames.json new file mode 100644 index 000000000000..322f784a1429 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchDeleteByNames.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "delete": { + "names": [ + "TemperatureSensor" + ] + } + } + }, + "responses": { + "200": { + "body": { + "delete": [ + null + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchGetByIds.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchGetByIds.json new file mode 100644 index 000000000000..142255a289bd --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchGetByIds.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "get": { + "typeIds": [ + "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8" + ], + "names": null + } + } + }, + "responses": { + "200": { + "body": { + "get": [ + { + "timeSeriesType": { + "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "name": "DefaultType", + "description": "Default type", + "variables": { + "EventCount": { + "kind": "aggregate", + "filter": null, + "aggregation": { + "tsx": "count()" + } + } + } + }, + "error": null + }, + { + "timeSeriesType": { + "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", + "name": "TemperatureSensor", + "description": "This is a temperature sensor.", + "variables": { + "AverageTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature.Double" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + } + }, + "error": null + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchGetByNames.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchGetByNames.json new file mode 100644 index 000000000000..15adb495973b --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchGetByNames.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "get": { + "names": [ + "DefaultType", + "TemperatureSensor" + ] + } + } + }, + "responses": { + "200": { + "body": { + "get": [ + { + "timeSeriesType": { + "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "name": "DefaultType", + "description": "Default type", + "variables": { + "EventCount": { + "kind": "aggregate", + "filter": null, + "aggregation": { + "tsx": "count()" + } + } + } + }, + "error": null + }, + { + "timeSeriesType": { + "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", + "name": "TemperatureSensor", + "description": "This is a temperature sensor.", + "variables": { + "AverageTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature.Double" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + } + }, + "error": null + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchPut.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchPut.json new file mode 100644 index 000000000000..477cf918b454 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesBatchPut.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "put": [ + { + "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "name": "DefaultType", + "description": "My Default type", + "variables": { + "EventCount": { + "kind": "aggregate", + "filter": null, + "aggregation": { + "tsx": "count()" + } + } + } + }, + { + "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", + "name": "OutdoorTemperatureSensor", + "description": "This is an outdoor temperature sensor.", + "variables": { + "AverageTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature.Double" + }, + "filter": { + "tsx": "$event.Mode.String = 'outdoor'" + }, + "aggregation": { + "tsx": "avg($value)" + } + } + } + } + ] + } + }, + "responses": { + "200": { + "body": { + "put": [ + { + "timeSeriesType": { + "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "name": "DefaultType", + "description": "My Default type", + "variables": { + "EventCount": { + "kind": "aggregate", + "filter": null, + "aggregation": { + "tsx": "count()" + } + } + } + }, + "error": null + }, + { + "timeSeriesType": { + "id": "c1cb7a33-ed9b-4cf1-9958-f3162fed8ee8", + "name": "OutdoorTemperatureSensor", + "description": "This is an outdoor temperature sensor.", + "variables": { + "AverageTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature.Double" + }, + "filter": { + "tsx": "$event.Mode.String = 'outdoor'" + }, + "aggregation": { + "tsx": "avg($value)" + } + } + } + }, + "error": null + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage1.json new file mode 100644 index 000000000000..ac645e3cca78 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage1.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com" + }, + "responses": { + "200": { + "body": { + "types": [ + { + "id": "1be09af9-f089-4d6b-9f0b-48018b5f7393", + "name": "DefaultType", + "description": "My Default type", + "variables": { + "EventCount": { + "kind": "aggregate", + "filter": null, + "aggregation": { + "tsx": "count()" + } + } + } + } + ], + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage2.json new file mode 100644 index 000000000000..429eaa25abd5 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage2.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + }, + "responses": { + "200": { + "body": { + "types": [ + { + "id": "9b84e946-7b36-4aa0-9d26-71bf48cb2aff", + "name": "TurbineSensor", + "description": "Wind turbine sensor", + "variables": { + "Value": { + "kind": "numeric", + "value": { + "tsx": "$event.value.Double" + }, + "aggregation": { + "tsx": "avg($value)" + } + } + } + } + ], + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage3.json new file mode 100644 index 000000000000..fcc38d7984b8 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/TypesListPage3.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrASI6MTAwMH0=" + }, + "responses": { + "200": { + "body": { + "types": [] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreAvailabilityGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreAvailabilityGet.json new file mode 100644 index 000000000000..5f6118a28d39 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreAvailabilityGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "warmstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "clientRequestId": "A72703F6-C0B1-49EF-854A-59F1994F54E7", + "clientSessionId": "AlertCalculation_W7" + }, + "responses": { + "200": { + "headers": { + "x-ms-request-id": "0d59d156-2807-4952-87bb-0e074417dbfb" + }, + "body": { + "availability": { + "intervalSize": "PT1H", + "distribution": { + "2019-03-27T04:00:00Z": 432447, + "2019-03-27T05:00:00Z": 432340, + "2019-03-27T06:00:00Z": 432451, + "2019-03-27T07:00:00Z": 432436, + "2019-03-26T13:00:00Z": 386247, + "2019-03-27T00:00:00Z": 436968, + "2019-03-27T01:00:00Z": 432509, + "2019-03-27T02:00:00Z": 432487 + }, + "range": { + "from": "2019-03-14T06:38:27.153Z", + "to": "2019-03-27T03:57:11.697Z" + } + } + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreEventSchemaGet.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreEventSchemaGet.json new file mode 100644 index 000000000000..65f5a8afe736 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreEventSchemaGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "warmstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "searchSpan": { + "from": "2018-08-01T00:00:00.000Z", + "to": "2018-08-31T00:00:00.000Z" + } + } + }, + "responses": { + "200": { + "body": { + "properties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Room", + "type": "String" + }, + { + "name": "DeviceId", + "type": "Double" + }, + { + "name": "Temperature", + "type": "Double" + }, + { + "name": "Pressure", + "type": "Double" + }, + { + "name": "Status", + "type": "String" + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryAggregateSeriesPage.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryAggregateSeriesPage.json new file mode 100644 index 000000000000..77fbd8de5a20 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryAggregateSeriesPage.json @@ -0,0 +1,144 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "warmstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "aggregateSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "interval": "PT1M", + "inlineVariables": { + "Count": { + "kind": "aggregate", + "filter": null, + "aggregation": { + "tsx": "count()" + } + }, + "MinTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "min($value)" + } + }, + "MaxTemperature": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "max($value)" + } + } + }, + "projectedVariables": [ + "Count", + "MinTemperature", + "MaxTemperature" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:00Z", + "2016-08-01T00:01:00Z", + "2016-08-01T00:02:00Z", + "2016-08-01T00:03:00Z", + "2016-08-01T00:04:00Z", + "2016-08-01T00:05:00Z", + "2016-08-01T00:06:00Z", + "2016-08-01T00:07:00Z", + "2016-08-01T00:08:00Z", + "2016-08-01T00:09:00Z", + "2016-08-01T00:10:00Z" + ], + "properties": [ + { + "name": "Count", + "type": "Long", + "values": [ + 50, + 60, + 60, + 60, + 60, + 60, + 60, + 60, + 60, + 60, + null + ] + }, + { + "name": "AverageTemperature", + "type": "Double", + "values": [ + 71.25, + 85.0, + 82.5, + 80.0, + 89.166666666666671, + 75.0, + 90.0, + 75.833333333333329, + 85.0, + 82.5, + null + ] + }, + { + "name": "MinTemperature", + "type": "Double", + "values": [ + 65.125, + 77.625, + 65.125, + 72.625, + 65.125, + 67.625, + 82.625, + 65.125, + 77.625, + 65.125, + null + ] + }, + { + "name": "MaxTemperature", + "type": "Double", + "values": [ + 77.375, + 92.375, + 99.875, + 87.375, + 99.875, + 82.375, + 97.375, + 99.875, + 92.375, + 99.875, + null + ] + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage1.json new file mode 100644 index 000000000000..c0a3fb5eb4f7 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage1.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "warmstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage2.json new file mode 100644 index 000000000000..0aaf5fe47f38 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage2.json @@ -0,0 +1,87 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "warmstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:10Z", + "2016-08-01T00:00:11Z", + "2016-08-01T00:00:12Z", + "2016-08-01T00:00:13Z", + "2016-08-01T00:00:14Z", + "2016-08-01T00:00:15Z", + "2016-08-01T00:00:16Z", + "2016-08-01T00:00:17Z", + "2016-08-01T00:00:18Z", + "2016-08-01T00:00:19Z" + ], + "properties": [ + { + "name": "Building", + "type": "String", + "values": [ + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium", + "Millenium" + ] + }, + { + "name": "Temperature", + "type": "Double", + "values": [ + 65.125, + 65.375, + 65.625, + 65.875, + 66.125, + 66.375, + 66.625, + 66.875, + 67.125, + 67.375 + ] + } + ], + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage3.json new file mode 100644 index 000000000000..2e40d479c4a9 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage3.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "warmstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:20Z" + ], + "properties": [ + { + "name": "Building", + "type": "String", + "values": [ + "Millenium" + ] + }, + { + "name": "Temperature", + "type": "Double", + "values": [ + 67.575 + ] + } + ], + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage4.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage4.json new file mode 100644 index 000000000000..a0d8ca70da06 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetEventsPage4.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "warmstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAbCDewidGFrZSI6MTAwMH0=", + "parameters": { + "getEvents": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": { + "tsx": "($event.Value.Double != null) OR ($event.Status.String = 'Good')" + }, + "projectedProperties": [ + { + "name": "Building", + "type": "String" + }, + { + "name": "Temperature", + "type": "Double" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [], + "properties": [], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage1.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage1.json new file mode 100644 index 000000000000..2fa6c4d19a86 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage1.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "warmstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ] + } + } + }, + "responses": { + "200": { + "body": { + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage2.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage2.json new file mode 100644 index 000000000000..cc1608228a42 --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage2.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "warmstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAwMCwidGFrZSI6MTAwMH0=", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:10Z", + "2016-08-01T00:00:11Z", + "2016-08-01T00:00:12Z", + "2016-08-01T00:00:13Z", + "2016-08-01T00:00:14Z", + "2016-08-01T00:00:15Z", + "2016-08-01T00:00:16Z", + "2016-08-01T00:00:17Z", + "2016-08-01T00:00:18Z", + "2016-08-01T00:00:19Z", + "2016-08-01T00:00:20Z" + ], + "properties": [ + { + "name": "temperatures", + "type": "Double", + "values": [ + 65.125, + 65.375, + 65.625, + 65.875, + 66.125, + 66.375, + 66.625, + 66.875, + 67.125, + 67.375, + 67.625 + ] + } + ], + "progress": 50.0, + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=" + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage3.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage3.json new file mode 100644 index 000000000000..82709af293ff --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/examples/WarmStoreQueryGetSeriesPage3.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "api-version": "2020-07-31", + "storeType": "warmstore", + "environmentFqdn": "10000000-0000-0000-0000-100000000109.env.timeseries.azure.com", + "continuationToken": "aXsic2tpcCI6MTAxYZwidGFrZSI6MTAwMH0=", + "parameters": { + "getSeries": { + "timeSeriesId": [ + "006dfc2d-0324-4937-998c-d16f3b4f1952", + "T1" + ], + "searchSpan": { + "from": "2016-08-01T00:00:00Z", + "to": "2016-08-01T00:16:50Z" + }, + "filter": null, + "inlineVariables": { + "temperatures": { + "kind": "numeric", + "value": { + "tsx": "$event.Temperature" + }, + "filter": null, + "aggregation": { + "tsx": "avg($value)" + } + } + }, + "projectedVariables": [ + "temperatures" + ] + } + } + }, + "responses": { + "200": { + "body": { + "timestamps": [ + "2016-08-01T00:00:21Z" + ], + "properties": [ + { + "name": "temperatures", + "type": "Double", + "values": [ + 67.825 + ] + } + ], + "progress": 100.0 + } + } + } +} diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/timeseriesinsights.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/timeseriesinsights.json new file mode 100644 index 000000000000..c957f645a35f --- /dev/null +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/stable/2020-07-31/timeseriesinsights.json @@ -0,0 +1,2517 @@ +{ + "swagger": "2.0", + "info": { + "title": "TimeSeriesInsightsClient", + "description": "Time Series Insights environment data plane client for GA (GA L1 SKU) environments.", + "version": "2020-07-31" + }, + "x-ms-parameterized-host": { + "hostTemplate": "{environmentFqdn}", + "useSchemePrefix": true, + "positionInOperation": "first", + "parameters": [ + { + "$ref": "#/parameters/EnvironmentFqdn" + } + ] + }, + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/availability": { + "get": { + "tags": [ + "Query" + ], + "operationId": "Query_GetAvailability", + "description": "Returns the time range and distribution of event count over the event timestamp ($ts). This API can be used to provide landing experience of navigating to the environment.", + "x-ms-examples": { + "AvailabilityGet": { + "$ref": "./examples/AvailabilityGet.json" + }, + "ColdStoreAvailabilityGet": { + "$ref": "./examples/ColdStoreAvailabilityGet.json" + }, + "WarmStoreAvailabilityGet": { + "$ref": "./examples/WarmStoreAvailabilityGet.json" + }, + "AvailabilityGetEmpty": { + "$ref": "./examples/AvailabilityGetEmpty.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StoreType" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/AvailabilityResponse" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/eventSchema": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_GetEventSchema", + "description": "Returns environment event schema for a given search span. Event schema is a set of property definitions. Event schema may not be contain all persisted properties when there are too many properties.", + "x-ms-examples": { + "EventSchemaGet": { + "$ref": "./examples/EventSchemaGet.json" + }, + "EventSchemaGetEmpty": { + "$ref": "./examples/EventSchemaGetEmpty.json" + }, + "ColdStoreEventSchemaGet": { + "$ref": "./examples/ColdStoreEventSchemaGet.json" + }, + "WarmStoreEventSchemaGet": { + "$ref": "./examples/WarmStoreEventSchemaGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StoreType" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GetEventSchemaRequest" + }, + "description": "Parameters to get event schema." + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/EventSchema" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/timeseries/modelSettings": { + "get": { + "tags": [ + "ModelSettings" + ], + "operationId": "ModelSettings_Get", + "description": "Returns the model settings which includes model display name, Time Series ID properties and default type ID. Every pay-as-you-go environment has a model that is automatically created.", + "x-ms-examples": { + "ModelSettingsGet": { + "$ref": "./examples/ModelSettingsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/ModelSettingsResponse" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + }, + "patch": { + "tags": [ + "ModelSettings" + ], + "operationId": "ModelSettings_Update", + "description": "Updates time series model settings - either the model name or default type ID.", + "x-ms-examples": { + "ModelSettingsUpdateName": { + "$ref": "./examples/ModelSettingsUpdateName.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/UpdateModelSettingsRequest" + }, + "description": "Model settings update request body." + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation returns new full model settings.", + "schema": { + "$ref": "#/definitions/ModelSettingsResponse" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/timeseries/query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_Execute", + "description": "Executes Time Series Query in pages of results - Get Events, Get Series or Aggregate Series.", + "x-ms-examples": { + "QueryAggregateSeriesPage1": { + "$ref": "./examples/QueryAggregateSeriesPage1.json" + }, + "QueryAggregateSeriesPage2": { + "$ref": "./examples/QueryAggregateSeriesPage2.json" + }, + "ColdStoreQueryAggregateSeriesPage1": { + "$ref": "./examples/ColdStoreQueryAggregateSeriesPage1.json" + }, + "ColdStoreQueryAggregateSeriesPage2": { + "$ref": "./examples/ColdStoreQueryAggregateSeriesPage2.json" + }, + "WarmStoreQueryAggregateSeriesPage": { + "$ref": "./examples/WarmStoreQueryAggregateSeriesPage.json" + }, + "QueryAggregateSeriesWithSampleInterpolation": { + "$ref": "./examples/QueryAggregateSeriesWithSampleInterpolation.json" + }, + "QueryAggregateSeriesWithCategoricalVariable": { + "$ref": "./examples/QueryAggregateSeriesWithCategoricalVariable.json" + }, + "QueryAggregateSeriesWithCategoricalInterpolatedVariable": { + "$ref": "./examples/QueryAggregateSeriesWithCategoricalInterpolatedVariable.json" + }, + "QueryGetEventsPage1": { + "$ref": "./examples/QueryGetEventsPage1.json" + }, + "QueryGetEventsPage2": { + "$ref": "./examples/QueryGetEventsPage2.json" + }, + "QueryGetEventsPage3": { + "$ref": "./examples/QueryGetEventsPage3.json" + }, + "QueryGetEventsPage4": { + "$ref": "./examples/QueryGetEventsPage4.json" + }, + "ColdStoreQueryGetEventsPage1": { + "$ref": "./examples/ColdStoreQueryGetEventsPage1.json" + }, + "ColdStoreQueryGetEventsPage2": { + "$ref": "./examples/ColdStoreQueryGetEventsPage2.json" + }, + "ColdStoreQueryGetEventsPage3": { + "$ref": "./examples/ColdStoreQueryGetEventsPage3.json" + }, + "ColdStoreQueryGetEventsPage4": { + "$ref": "./examples/ColdStoreQueryGetEventsPage4.json" + }, + "WarmStoreQueryGetEventsPage1": { + "$ref": "./examples/WarmStoreQueryGetEventsPage1.json" + }, + "WarmStoreQueryGetEventsPage2": { + "$ref": "./examples/WarmStoreQueryGetEventsPage2.json" + }, + "WarmStoreQueryGetEventsPage3": { + "$ref": "./examples/WarmStoreQueryGetEventsPage3.json" + }, + "WarmStoreQueryGetEventsPage4": { + "$ref": "./examples/WarmStoreQueryGetEventsPage4.json" + }, + "QueryGetEventsWithTakePage1": { + "$ref": "./examples/QueryGetEventsWithTakePage1.json" + }, + "QueryGetEventsWithTakePage2": { + "$ref": "./examples/QueryGetEventsWithTakePage2.json" + }, + "QueryGetSeriesPage1": { + "$ref": "./examples/QueryGetSeriesPage1.json" + }, + "QueryGetSeriesPage2": { + "$ref": "./examples/QueryGetSeriesPage2.json" + }, + "QueryGetSeriesPage3": { + "$ref": "./examples/QueryGetSeriesPage3.json" + }, + "QueryGetSeriesWithTakePage1": { + "$ref": "./examples/QueryGetSeriesWithTakePage1.json" + }, + "QueryGetSeriesWithTakePage2": { + "$ref": "./examples/QueryGetSeriesWithTakePage2.json" + }, + "ColdStoreQueryGetSeriesPage1": { + "$ref": "./examples/ColdStoreQueryGetSeriesPage1.json" + }, + "ColdStoreQueryGetSeriesPage2": { + "$ref": "./examples/ColdStoreQueryGetSeriesPage2.json" + }, + "ColdStoreQueryGetSeriesPage3": { + "$ref": "./examples/ColdStoreQueryGetSeriesPage3.json" + }, + "WarmStoreQueryGetSeriesPage1": { + "$ref": "./examples/WarmStoreQueryGetSeriesPage1.json" + }, + "WarmStoreQueryGetSeriesPage2": { + "$ref": "./examples/WarmStoreQueryGetSeriesPage2.json" + }, + "WarmStoreQueryGetSeriesPage3": { + "$ref": "./examples/WarmStoreQueryGetSeriesPage3.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/StoreType" + }, + { + "$ref": "#/parameters/ContinuationToken" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryRequest" + }, + "description": "Time series query request body." + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful query.", + "schema": { + "$ref": "#/definitions/QueryResultPage" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/timeseries/instances": { + "get": { + "tags": [ + "TimeSeriesInstances" + ], + "operationId": "TimeSeriesInstances_List", + "description": "Gets time series instances in pages.", + "x-ms-examples": { + "InstancesListPage1": { + "$ref": "./examples/InstancesListPage1.json" + }, + "InstancesListPage2": { + "$ref": "./examples/InstancesListPage2.json" + }, + "InstancesListPage3": { + "$ref": "./examples/InstancesListPage3.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ContinuationToken" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/GetInstancesPage" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/timeseries/instances/$batch": { + "post": { + "tags": [ + "TimeSeriesInstances" + ], + "operationId": "TimeSeriesInstances_ExecuteBatch", + "description": "Executes a batch get, create, update, delete operation on multiple time series instances.", + "x-ms-examples": { + "InstancesBatchDeleteByIds": { + "$ref": "./examples/InstancesBatchDeleteByIds.json" + }, + "InstancesBatchDeleteByNames": { + "$ref": "./examples/InstancesBatchDeleteByNames.json" + }, + "InstancesBatchGetByIds": { + "$ref": "./examples/InstancesBatchGetByIds.json" + }, + "InstancesBatchGetByNames": { + "$ref": "./examples/InstancesBatchGetByNames.json" + }, + "InstancesBatchUpdate": { + "$ref": "./examples/InstancesBatchUpdate.json" + }, + "InstancesBatchPut": { + "$ref": "./examples/InstancesBatchPut.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InstancesBatchRequest" + }, + "description": "Time series instances suggest request body." + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/InstancesBatchResponse" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/timeseries/instances/suggest": { + "post": { + "tags": [ + "TimeSeriesInstances" + ], + "operationId": "TimeSeriesInstances_Suggest", + "description": "Suggests keywords based on time series instance attributes to be later used in Search Instances.", + "x-ms-examples": { + "InstancesSuggest": { + "$ref": "./examples/InstancesSuggest.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/InstancesSuggestRequest" + }, + "description": "Time series instances suggest request body." + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/InstancesSuggestResponse" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/timeseries/instances/search": { + "post": { + "tags": [ + "TimeSeriesInstances" + ], + "operationId": "TimeSeriesInstances_Search", + "description": "Partial list of hits on search for time series instances based on instance attributes.", + "x-ms-examples": { + "SearchInstancesHierarchiesDefaultInputPage1": { + "$ref": "./examples/SearchInstancesHierarchiesDefaultInputPage1.json" + }, + "SearchInstancesHierarchiesDefaultInputPage2": { + "$ref": "./examples/SearchInstancesHierarchiesDefaultInputPage2.json" + }, + "SearchInstancesHierarchiesDefaultInputPage3": { + "$ref": "./examples/SearchInstancesHierarchiesDefaultInputPage3.json" + }, + "SearchInstancesUntilChildren": { + "$ref": "./examples/SearchInstancesUntilChildren.json" + }, + "SearchInstancesDefault": { + "$ref": "./examples/SearchInstancesDefault.json" + }, + "SearchInstancesExpandHierarchiesOnly": { + "$ref": "./examples/SearchInstancesExpandHierarchiesOnly.json" + }, + "SearchInstancesRecursive": { + "$ref": "./examples/SearchInstancesRecursive.json" + }, + "SearchInstancesOneLevel": { + "$ref": "./examples/SearchInstancesOneLevel.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ContinuationToken" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SearchInstancesRequest" + }, + "description": "Time series instances search request body." + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful search response.", + "schema": { + "$ref": "#/definitions/SearchInstancesResponsePage" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/timeseries/types": { + "get": { + "tags": [ + "TimeSeriesTypes" + ], + "operationId": "TimeSeriesTypes_List", + "description": "Gets time series types in pages.", + "x-ms-examples": { + "TypesListPage1": { + "$ref": "./examples/TypesListPage1.json" + }, + "TypesListPage2": { + "$ref": "./examples/TypesListPage2.json" + }, + "TypesListPage3": { + "$ref": "./examples/TypesListPage3.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ContinuationToken" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/GetTypesPage" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/timeseries/types/$batch": { + "post": { + "tags": [ + "TimeSeriesTypes" + ], + "operationId": "TimeSeriesTypes_ExecuteBatch", + "description": "Executes a batch get, create, update, delete operation on multiple time series types.", + "x-ms-examples": { + "TypesBatchGetByIds": { + "$ref": "./examples/TypesBatchGetByIds.json" + }, + "TypesBatchGetByNames": { + "$ref": "./examples/TypesBatchGetByNames.json" + }, + "TypesBatchPut": { + "$ref": "./examples/TypesBatchPut.json" + }, + "TypesBatchDeleteByIds": { + "$ref": "./examples/TypesBatchDeleteByIds.json" + }, + "TypesBatchDeleteByNames": { + "$ref": "./examples/TypesBatchDeleteByNames.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TypesBatchRequest" + }, + "description": "Time series types batch request body." + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/TypesBatchResponse" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/timeseries/hierarchies": { + "get": { + "tags": [ + "TimeSeriesHierarchies" + ], + "operationId": "TimeSeriesHierarchies_List", + "description": "Returns time series hierarchies definitions in pages.", + "x-ms-examples": { + "HierarchiesListPage1": { + "$ref": "./examples/HierarchiesListPage1.json" + }, + "HierarchiesListPage2": { + "$ref": "./examples/HierarchiesListPage2.json" + }, + "HierarchiesListPage3": { + "$ref": "./examples/HierarchiesListPage3.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/ContinuationToken" + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/GetHierarchiesPage" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + }, + "/timeseries/hierarchies/$batch": { + "post": { + "tags": [ + "TimeSeriesHierarchies" + ], + "operationId": "TimeSeriesHierarchies_ExecuteBatch", + "description": "Executes a batch get, create, update, delete operation on multiple time series hierarchy definitions.", + "x-ms-examples": { + "HierarchiesBatchGetByIds": { + "$ref": "./examples/HierarchiesBatchGetByIds.json" + }, + "HierarchiesBatchGetByNames": { + "$ref": "./examples/HierarchiesBatchGetByNames.json" + }, + "HierarchiesBatchPut": { + "$ref": "./examples/HierarchiesBatchPut.json" + }, + "HierarchiesBatchDeleteByIds": { + "$ref": "./examples/HierarchiesBatchDeleteByIds.json" + }, + "HierarchiesBatchDeleteByNames": { + "$ref": "./examples/HierarchiesBatchDeleteByNames.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/HierarchiesBatchRequest" + }, + "description": "Time series hierarchies batch request body." + }, + { + "$ref": "#/parameters/ClientRequestId" + }, + { + "$ref": "#/parameters/ClientSessionId" + } + ], + "responses": { + "200": { + "description": "Successful operation.", + "schema": { + "$ref": "#/definitions/HierarchiesBatchResponse" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + }, + "default": { + "description": "Unexpected error.", + "schema": { + "$ref": "#/definitions/TsiError" + }, + "headers": { + "x-ms-request-id": { + "x-ms-client-name": "serverRequestId", + "type": "string", + "description": "Server-generated request ID. Can be used to contact support to investigate a request." + } + } + } + } + } + } + }, + "definitions": { + "AvailabilityResponse": { + "description": "Response of Get Availability operation. When environment has no data, availability property is null.", + "type": "object", + "properties": { + "availability": { + "description": "Event availability information when environment contains events. When environment has no data yet, this property is null or not present.", + "readOnly": true, + "$ref": "#/definitions/Availability" + } + } + }, + "Availability": { + "description": "Event availability information when environment contains events. Contains time range of events and approximate distribution of events over time.", + "type": "object", + "properties": { + "range": { + "description": "Minimum and maximum values of event timestamp ($ts) property.", + "$ref": "#/definitions/DateTimeRange", + "readOnly": true + }, + "intervalSize": { + "description": "Interval size for the returned distribution of the events. Returned interval is selected to return a reasonable number of points. All intervals are the same size. On the wire interval is specified in ISO-8601 duration format. One month is always converted to 30 days, and one year is always 365 days. Examples: 1 minute is \"PT1M\", 1 millisecond is \"PT0.001S\". For more information, see https://www.w3.org/TR/xmlschema-2/#duration", + "readOnly": true, + "type": "string", + "format": "duration" + }, + "distribution": { + "additionalProperties": { + "description": "Key value pair where key represents the interval denoted by the date time of the start of the interval and the value is the number of events in that interval.", + "readOnly": true, + "type": "integer", + "format": "int32" + } + } + } + }, + "GetEventSchemaRequest": { + "description": "Request to get the event schema of all events within a given search span.", + "type": "object", + "properties": { + "searchSpan": { + "description": "The range of time on which the query is executed. Cannot be null.", + "$ref": "#/definitions/DateTimeRange" + } + }, + "required": [ + "searchSpan" + ] + }, + "EventSchema": { + "description": "Event schema of all events within a given search span. Event schema is a set of property definitions. Properties are identified by both name and type. Different events can have properties with same name, but different type. Event schema may not be contain all persisted properties when there are too many properties.", + "type": "object", + "properties": { + "properties": { + "description": "A set of property definitions. When environment has no data, the returned array is empty.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/EventProperty" + } + } + } + }, + "QueryRequest": { + "type": "object", + "description": "Request to execute a time series query over events. Exactly one of \"getEvents\", \"getSeries\" or \"aggregateSeries\" must be set.", + "properties": { + "getEvents": { + "description": "Get Events query. Allows to retrieve raw events for a given Time Series ID and search span.", + "$ref": "#/definitions/GetEvents" + }, + "getSeries": { + "description": "Get Series query. Allows to retrieve time series of calculated variable values from events for a given Time Series ID and search span.", + "$ref": "#/definitions/GetSeries" + }, + "aggregateSeries": { + "description": "Aggregate Series query. Allows to calculate an aggregated time series from events for a given Time Series ID and search span.", + "$ref": "#/definitions/AggregateSeries" + } + } + }, + "GetEvents": { + "description": "Get Events query. Allows to retrieve raw events for a given Time Series ID and search span.", + "type": "object", + "properties": { + "timeSeriesId": { + "description": "A single Time Series ID value that uniquely identifies a single time series instance (e.g. a device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be null.", + "$ref": "#/definitions/TimeSeriesId" + }, + "searchSpan": { + "description": "The range of time on which the query is executed. Cannot be null.", + "$ref": "#/definitions/DateTimeRange" + }, + "filter": { + "description": "Optional top-level filter for the query which will be applied to all the variables in the query. Example: \"$event.Status.String='Good'\". Can be null.", + "$ref": "#/definitions/Tsx" + }, + "projectedProperties": { + "description": "Projected properties is an array of properties which you want to project. These properties must appear in the events; otherwise, they are not returned.", + "type": "array", + "items": { + "$ref": "#/definitions/EventProperty" + } + }, + "take": { + "description": "Maximum number of property values in the whole response set, not the maximum number of property values per page. Defaults to 10,000 when not set. Maximum value of take can be 250,000.", + "type": "integer", + "format": "int32" + } + }, + "required": [ + "timeSeriesId", + "searchSpan" + ] + }, + "GetSeries": { + "description": "Get Series query. Allows to retrieve time series of calculated variable values from events for a given Time Series ID and search span.", + "type": "object", + "properties": { + "timeSeriesId": { + "description": "A single Time Series ID value that uniquely identifies a single time series instance (e.g. a device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be null.", + "$ref": "#/definitions/TimeSeriesId" + }, + "searchSpan": { + "description": "The range of time on which the query is executed. Cannot be null.", + "$ref": "#/definitions/DateTimeRange" + }, + "filter": { + "description": "Top-level filter over the events that restricts the number of events being considered for computation. This filter is AND'ed with filter in each variable. Example: \"$event.Status.String='Good'\". Optional.", + "$ref": "#/definitions/Tsx" + }, + "projectedVariables": { + "description": "Selected variables that needs to be projected in the query result. When it is null or not set, all the variables from inlineVariables and time series type in the model are returned. Can be null.", + "type": "array", + "items": { + "type": "string" + } + }, + "inlineVariables": { + "description": "Optional inline variables apart from the ones already defined in the time series type in the model. When the inline variable name is the same name as in the model, the inline variable definition takes precedence. Can be null.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Variable" + } + }, + "take": { + "description": "Maximum number of property values in the whole response set, not the maximum number of property values per page. Defaults to 10,000 when not set. Maximum value of take can be 250,000.", + "type": "integer", + "format": "int32" + } + }, + "required": [ + "timeSeriesId", + "searchSpan" + ] + }, + "AggregateSeries": { + "description": "Aggregate Series query. Allows to calculate an aggregated time series from events for a given Time Series ID and search span.", + "type": "object", + "properties": { + "timeSeriesId": { + "description": "A single Time Series ID value that uniquely identifies a single time series instance (e.g. a device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be null.", + "$ref": "#/definitions/TimeSeriesId" + }, + "searchSpan": { + "description": "The range of time on which the query is executed. Cannot be null.", + "$ref": "#/definitions/DateTimeRange" + }, + "filter": { + "description": "Top-level filter over the events that restricts the number of events being considered for computation. This filter is AND'ed with filter in each variable. Example: \"$event.Status.String='Good'\". Optional.", + "$ref": "#/definitions/Tsx" + }, + "interval": { + "type": "string", + "format": "duration", + "description": "Interval size is specified in ISO-8601 duration format. All intervals are the same size. One month is always converted to 30 days, and one year is always 365 days. Examples: 1 minute is \"PT1M\", 1 millisecond is \"PT0.001S\". For more information, see https://www.w3.org/TR/xmlschema-2/#duration" + }, + "projectedVariables": { + "description": "This allows the user to optionally select the variables that needs to be projected. When it is null or not set, all the variables from inlineVariables and model are returned. Can be null.", + "type": "array", + "items": { + "type": "string" + } + }, + "inlineVariables": { + "description": "This allows the user the optionally define inline-variables apart from the ones already defined in the model. When the inline variable names have the same name as the model, the inline variable definition takes precedence. Can be null.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/Variable" + } + } + }, + "required": [ + "timeSeriesId", + "searchSpan", + "interval" + ] + }, + "TimeSeriesId": { + "description": "A single Time Series ID value that is an array of primitive values that uniquely identifies a time series instance (e.g. a single device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be empty.", + "type": "array", + "items": { + "description": "A single Time Series ID value that is an array of primitive values that uniquely identifies a time series instance (e.g. a single device). Note that a single Time Series ID can be composite if multiple properties are specified as Time Series ID at environment creation time. The position and type of values must match Time Series ID properties specified on the environment and returned by Get Model Setting API. Cannot be empty." + }, + "minItems": 1 + }, + "Tsx": { + "description": "Time series expression (TSX) written as a single string. Examples: \"$event.Status.String='Good'\", \"avg($event.Temperature)\". Refer to the documentation on how to write time series expressions.", + "type": "object", + "properties": { + "tsx": { + "description": "Time series expression (TSX) written as a single string. Examples: \"$event.Status.String='Good'\", \"avg($event.Temperature)\". Refer to the documentation on how to write time series expressions.", + "type": "string" + } + }, + "required": [ + "tsx" + ] + }, + "Interpolation": { + "description": "The interpolation operation to be performed on the raw data points. Currently, only sampling of interpolated time series is allowed. Allowed aggregate function - eg: left($value). Can be null if no interpolation needs to be applied.", + "type": "object", + "properties": { + "kind": { + "description": "The type of interpolation technique : \"Linear\" or \"Step\".", + "type": "string", + "enum": [ + "Linear", + "Step" + ], + "x-ms-enum": { + "name": "InterpolationKind", + "modelAsString": true + } + }, + "boundary": { + "description": "The time range to the left and right of the search span to be used for Interpolation. This is helpful in scenarios where the data points are missing close to the start or end of the input search span. Can be null.", + "type": "object", + "properties": { + "span": { + "type": "string", + "format": "duration" + } + } + } + } + }, + "DateTimeRange": { + "description": "The range of time. Cannot be null or negative.", + "type": "object", + "properties": { + "from": { + "description": "Start timestamp of the time range. Start timestamp is inclusive when used in time series query requests. Events that have this timestamp are included.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "End timestamp of the time range. End timestamp is exclusive when used in time series query requests. Events that match this timestamp are excluded. Note that end timestamp is inclusive when returned by Get Availability (meaning that there is an event with this exact \"to\" timestamp).", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "NumericVariable": { + "description": "Numeric variable represents a single continuous numeric signal that can be reconstructed using interpolation.", + "x-ms-discriminator-value": "numeric", + "allOf": [ + { + "$ref": "#/definitions/Variable" + }, + { + "type": "object", + "properties": { + "value": { + "description": "Value time series expression is used to represent the value of the signal that is going to be aggregated or interpolated. For example, temperature values from the event is represented like this: \"$event.Temperature.Double\".", + "$ref": "#/definitions/Tsx" + }, + "interpolation": { + "$ref": "#/definitions/Interpolation" + }, + "aggregation": { + "description": "Aggregation time series expression when kind is \"numeric\" is used to represent the aggregation that needs to be performed on the $value expression. This requires $value to be specified and can only use $value inside the aggregate functions. For example, aggregation for calculating minimum of the $value is written as: \"min($value)\".", + "$ref": "#/definitions/Tsx" + } + } + } + ], + "required": [ + "kind", + "value", + "aggregation" + ] + }, + "AggregateVariable": { + "description": "Aggregate variable represents any aggregation calculation. Aggregate Variables does not support interpolation.", + "x-ms-discriminator-value": "aggregate", + "allOf": [ + { + "$ref": "#/definitions/Variable" + }, + { + "type": "object", + "properties": { + "aggregation": { + "description": "Aggregation time series expression when kind is \"aggregate\" is used to represent the aggregation that needs to be performed directly using event properties like \"$event.Temperature\". For example, aggregation for calculating range of temperature changes can be written as: \"max($event.Temperature)-min($event.Temperature)\".", + "$ref": "#/definitions/Tsx" + } + } + } + ], + "required": [ + "kind", + "aggregation" + ] + }, + "CategoricalVariable": { + "description": "Categorical variable represents signal that needs to be analyzed based on the count or duration of occurrence of limited set of defined values.", + "x-ms-discriminator-value": "categorical", + "allOf": [ + { + "$ref": "#/definitions/Variable" + }, + { + "type": "object", + "properties": { + "value": { + "description": "Value time series expression is used to represent the value of the signal that is going to be categorized. It can evaluate to only 'String' or 'Long' type for categorical variables.", + "$ref": "#/definitions/Tsx" + }, + "interpolation": { + "description": "Categorical variable supports only 'step' interpolation.", + "$ref": "#/definitions/Interpolation" + }, + "categories": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesAggregateCategory" + } + }, + "defaultCategory": { + "$ref": "#/definitions/TimeSeriesDefaultCategory" + } + } + } + ], + "required": [ + "kind", + "value", + "defaultCategory" + ] + }, + "TimeSeriesAggregateCategory": { + "description": "Category used in categorical variables. A category is defined by 'label' and the 'values' that are assigned this label.", + "type": "object", + "properties": { + "label": { + "description": "The name of the category which will be used in constructing the output variable names.", + "type": "string" + }, + "values": { + "description": "The list of values that a category maps to. Can be either a unique list of string or list of long.", + "type": "array", + "items": { + "type": "object" + } + } + }, + "required": [ + "label", + "values" + ] + }, + "TimeSeriesDefaultCategory": { + "description": "Represents the default category.", + "type": "object", + "properties": { + "label": { + "description": "The name of the default category which will be assigned to the values that does not match any of those that are defined in the 'categories'.", + "type": "string" + } + }, + "required": [ + "label" + ] + }, + "Variable": { + "description": "Variables are named calculations over values from the events. Time Series Insights variable definitions contain formula and computation rules. Variables are stored in the type definition in Time Series Model and can be provided inline via Query APIs to override the stored definition.", + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "description": "Allowed \"kind\" values are - \"numeric\" or \"aggregate\". While \"numeric\" allows you to specify value of the reconstructed signal and the expression to aggregate them, the \"aggregate\" kind lets you directly aggregate on the event properties without specifying value.", + "type": "string" + }, + "filter": { + "description": "Filter over the events that restricts the number of events being considered for computation. Example: \"$event.Status.String='Good'\". Optional.", + "$ref": "#/definitions/Tsx" + } + }, + "required": [ + "kind" + ] + }, + "QueryResultPage": { + "description": "A single page of query results. If query has not finished yet, a page will have continuation token set. In this case, to get the next page of results, send the same request again with continuation token parameter. If query has completed, the continuation token is null. It is also possible to get an empty page with only continuation token set when no query results have been computed yet. If paging has completed (continuation token is null), then timestamps and properties may be empty if there is no data to return.", + "allOf": [ + { + "$ref": "#/definitions/PagedResponse" + }, + { + "type": "object", + "properties": { + "timestamps": { + "description": "The timestamps of the values of the time series. If an aggregation over intervals is used, timestamps represent the start of corresponding intervals. If events are retrieved, timestamps are values of timestamp $ts property of events. Can be null if server was unable to fill the page in this request, or can be empty if there are no more objects when continuation token is null.", + "readOnly": true, + "type": "array", + "items": { + "type": "string", + "format": "date-time" + } + }, + "properties": { + "description": "Collection of time series properties and values for each of the timestamps. Can be null if server was unable to fill the page in this request, or can be empty if there are no more objects when continuation token is null.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PropertyValues" + } + }, + "progress": { + "description": "Approximate progress of the query in percentage. It can be between 0 and 100. When the continuation token in the response is null, the progress is expected to be 100.", + "readOnly": true, + "type": "number", + "format": "double" + } + } + } + ] + }, + "PropertyValues": { + "description": "Values of a single property corresponding to the timestamps. May contain nulls. Type of values matches the type of property.", + "allOf": [ + { + "$ref": "#/definitions/EventProperty" + }, + { + "type": "object", + "properties": { + "values": { + "description": "Values of a single property corresponding to the timestamps. May contain nulls. Type of values matches the type of property.", + "type": "array", + "items": {} + } + } + } + ] + }, + "GetInstancesPage": { + "description": "Partial list of time series instances returned in a single request.", + "allOf": [ + { + "$ref": "#/definitions/PagedResponse" + }, + { + "type": "object", + "properties": { + "instances": { + "description": "Partial list of time series instances returned in a single request. Can be empty if server was unable to fill the page in this request, or there is no more objects when continuation token is null.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesInstance" + } + } + } + } + ] + }, + "TimeSeriesInstance": { + "description": "Time series instances are the time series themselves. In most cases, the deviceId or assetId is the unique identifier of the asset in the environment. Instances have descriptive information associated with them called instance fields. At a minimum, instance fields include hierarchy information. They can also include useful, descriptive data like the manufacturer, operator, or the last service date.", + "type": "object", + "properties": { + "timeSeriesId": { + "description": "Time Series ID that uniquely identifies the instance. It matches Time Series ID properties in an environment. Immutable, never null.", + "$ref": "#/definitions/TimeSeriesId" + }, + "typeId": { + "description": "This represents the type that this instance belongs to. Never null.", + "type": "string" + }, + "name": { + "description": "Optional name of the instance which is unique in an environment. Names acts as a mutable alias or display name of the time series instance. Mutable, may be null.", + "type": "string" + }, + "description": { + "description": "This optional field contains description about the instance.", + "type": "string" + }, + "hierarchyIds": { + "description": "Set of time series hierarchy IDs that the instance belong to. May be null.", + "type": "array", + "items": { + "type": "string" + } + }, + "instanceFields": { + "description": "Set of key-value pairs that contain user-defined instance properties. May be null.", + "type": "object", + "additionalProperties": {} + } + }, + "required": [ + "timeSeriesId", + "typeId" + ] + }, + "InstancesBatchRequest": { + "description": "Request to perform a single operation on a batch of instances. Exactly one of \"get\", \"put\", \"update\" or \"delete\" must be set.", + "type": "object", + "properties": { + "get": { + "description": "Time series IDs or names of time series instances to return.", + "$ref": "#/definitions/InstancesRequestBatchGetOrDelete" + }, + "put": { + "description": "Time series instances to be created or updated.", + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesInstance" + } + }, + "update": { + "description": "Time series instances to be updated onlRequest to perform a single operation on a batch of instances. y. If instance does not exist, an error is returned.", + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesInstance" + } + }, + "delete": { + "description": "Time series IDs or names of time series instances to delete.", + "$ref": "#/definitions/InstancesRequestBatchGetOrDelete" + } + } + }, + "InstancesRequestBatchGetOrDelete": { + "description": "Request to get or delete instances by time series IDs or time series names. Exactly one of \"timeSeriesIds\" or \"names\" must be set.", + "type": "object", + "properties": { + "timeSeriesIds": { + "description": "List of time series IDs of the time series instances to return or delete.", + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesId" + } + }, + "names": { + "description": "List of names of the time series instances to return or delete.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "InstancesBatchResponse": { + "description": "Response of a single operation on a batch of instances. Only one of \"get\", \"put\", \"update\" or \"delete\" will be set based on the request.", + "type": "object", + "properties": { + "get": { + "description": "List of instance or error objects corresponding by position to the \"get\" array in the request. Instance object is set when operation is successful and error object is set when operation is unsuccessful.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstanceOrError" + } + }, + "put": { + "description": "List of error objects corresponding by position to the \"put\" array in the request. Error object is set when operation is unsuccessful.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstanceOrError" + } + }, + "update": { + "description": "List of error objects corresponding by position to the \"update\" array in the request. Instance object is set when operation is successful and error object is set when operation is unsuccessful.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstanceOrError" + } + }, + "delete": { + "description": "List of error objects corresponding by position to the \"delete\" array in the request. Null means the instance has been deleted, or did not exist. Error object is set when operation is unsuccessful (e.g. when there are events associated with this time series instance).", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TsiErrorBody" + } + } + } + }, + "InstanceOrError": { + "description": "Result of a batch operation on a particular time series instance. Instance object is set when operation is successful (except put operation) and error object is set when operation is unsuccessful.", + "type": "object", + "properties": { + "instance": { + "description": "Time series instance object - set when the operation is successful (except put operation).", + "readOnly": true, + "$ref": "#/definitions/TimeSeriesInstance" + }, + "error": { + "description": "Error object - set when the operation is unsuccessful.", + "readOnly": true, + "$ref": "#/definitions/TsiErrorBody" + } + } + }, + "GetTypesPage": { + "description": "Partial list of time series types returned in a single request.", + "allOf": [ + { + "$ref": "#/definitions/PagedResponse" + }, + { + "type": "object", + "properties": { + "types": { + "description": "Partial list of time series types returned in a single request. Can be empty if server was unable to fill the page with more types in this request, or there is no more types when continuation token is null.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesType" + } + } + } + } + ] + }, + "TimeSeriesType": { + "description": "Time series type defines variables or formulas for doing computation on events associated with time series instances. Each time series instance is associated with exactly one type. A type can have one or more variables. For example, a time series instance might be of type Temperature Sensor, which consists of the variables avg temperature, min temperature, and max temperature.", + "type": "object", + "properties": { + "id": { + "description": "Case-sensitive unique type identifier that is immutable. Can be null on create or update requests, and then server generates the ID. Not null on get and delete operations.", + "type": "string" + }, + "name": { + "description": "User-given unique name for the type. Mutable, not null.", + "type": "string" + }, + "description": { + "description": "Description of the type. May be null.", + "type": "string" + }, + "variables": { + "description": "Different variables associated with the type. Not empty, not null.", + "additionalProperties": { + "$ref": "#/definitions/Variable" + } + } + }, + "required": [ + "name", + "variables" + ] + }, + "TypesBatchRequest": { + "description": "Request to perform a single operation on a batch of time series types. Exactly one of \"get\", \"put\" or \"delete\" must be set.", + "type": "object", + "properties": { + "get": { + "description": "Definition of what time series types to return.", + "$ref": "#/definitions/TypesRequestBatchGetOrDelete" + }, + "put": { + "description": "Definition of what time series types to update or create.", + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesType" + } + }, + "delete": { + "description": "Definition of what time series types to delete.", + "$ref": "#/definitions/TypesRequestBatchGetOrDelete" + } + } + }, + "TypesRequestBatchGetOrDelete": { + "description": "Request to get or delete time series types by IDs or type names. Exactly one of \"typeIds\" or \"names\" must be set.", + "type": "object", + "properties": { + "typeIds": { + "description": "List of IDs of time series types to return or delete.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "List of names of time series types to return or delete.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "TypesBatchResponse": { + "description": "Response of a single operation on a batch of time series types. Exactly one of \"get\", \"put\" or \"delete\" will be set.", + "type": "object", + "properties": { + "get": { + "description": "List of types or error objects corresponding by position to the \"get\" array in the request. Type object is set when operation is successful and error object is set when operation is unsuccessful.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesTypeOrError" + } + }, + "put": { + "description": "List of types or error objects corresponding by position to the \"put\" array in the request. Type object is set when operation is successful and error object is set when operation is unsuccessful.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesTypeOrError" + } + }, + "delete": { + "description": "List of error objects corresponding by position to the \"delete\" array in the request - null when the operation is successful.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/TsiErrorBody" + } + } + } + }, + "TimeSeriesTypeOrError": { + "description": "Result of a batch operation on a particular time series type. Type object is set when operation is successful and error object is set when operation is unsuccessful.", + "type": "object", + "properties": { + "timeSeriesType": { + "description": "Time series type object - set when the operation is successful.", + "readOnly": true, + "$ref": "#/definitions/TimeSeriesType" + }, + "error": { + "description": "Error object - set when the operation is unsuccessful.", + "readOnly": true, + "$ref": "#/definitions/TsiErrorBody" + } + } + }, + "GetHierarchiesPage": { + "description": "Partial list of time series hierarchies returned in a single request.", + "allOf": [ + { + "$ref": "#/definitions/PagedResponse" + }, + { + "type": "object", + "properties": { + "hierarchies": { + "description": "Partial list of time series hierarchies returned in a single request. Can be empty if server was unable to fill the page in this request, or there is no more objects when continuation token is null.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesHierarchy" + } + } + } + } + ] + }, + "TimeSeriesHierarchy": { + "description": "Time series hierarchy organizes time series instances into a tree.", + "type": "object", + "properties": { + "id": { + "description": "Case-sensitive unique hierarchy identifier. Can be null while creating hierarchy objects and then server generates the id, not null on get and delete operations.", + "type": "string" + }, + "name": { + "description": "User-given unique name for the type. It is mutable and not null.", + "type": "string" + }, + "source": { + "description": "Definition of how time series hierarchy tree levels are created.", + "type": "object", + "properties": { + "instanceFieldNames": { + "description": "List of instance field names that must be set in all time series instances that belong to this hierarchy. The order of the instance fields defines the levels in the hierarchy.", + "type": "array", + "items": { + "type": "string" + } + } + } + } + }, + "required": [ + "name", + "source" + ] + }, + "HierarchiesBatchRequest": { + "description": "Request to perform a single operation on a batch of hierarchies. Exactly one of \"get\", \"put\" or \"delete\" must be set.", + "type": "object", + "properties": { + "get": { + "description": "\"get\" should be set while fetching specific hierarchies either by IDs or names.", + "$ref": "#/definitions/HierarchiesRequestBatchGetDelete" + }, + "put": { + "description": "\"put\" should be set while creating or updating hierarchies.", + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesHierarchy" + } + }, + "delete": { + "description": "\"delete\" should be set while fetching specific hierarchies either by IDs or names.", + "$ref": "#/definitions/HierarchiesRequestBatchGetDelete" + } + } + }, + "HierarchiesRequestBatchGetDelete": { + "description": "Request to get or delete multiple time series hierarchies. Exactly one of \"hierarchyIds\" or \"names\" must be set.", + "type": "object", + "properties": { + "hierarchyIds": { + "description": "List of hierarchy IDs.", + "type": "array", + "items": { + "type": "string" + } + }, + "names": { + "description": "List of hierarchy names.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "HierarchiesBatchResponse": { + "description": "Response of a single operation on a batch of time series hierarchies. Only one of \"get\", \"put\" or \"delete\" will be set.", + "type": "object", + "properties": { + "get": { + "description": "List of hierarchy or error objects corresponding by position to the \"get\" array in the request. Hierarchy object is set when operation is successful and error object is set when operation is unsuccessful.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesHierarchyOrError" + } + }, + "put": { + "description": "List of hierarchy or error object corresponding by position to the \"put\" array in the request. Hierarchy object is set when operation is successful and error object is set when operation is unsuccessful.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesHierarchyOrError" + } + }, + "delete": { + "description": "List of error objects corresponding by position to the \"delete\" array in the request - null when the operation is successful.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TsiErrorBody" + } + } + } + }, + "TimeSeriesHierarchyOrError": { + "description": "Result of a batch operation on a particular time series hierarchy. Hierarchy is set when operation is successful and error object is set when operation is unsuccessful.", + "type": "object", + "properties": { + "hierarchy": { + "description": "Time series hierarchy object - set when the operation is successful.", + "readOnly": true, + "$ref": "#/definitions/TimeSeriesHierarchy" + }, + "error": { + "description": "Error object - set when the operation is unsuccessful.", + "readOnly": true, + "$ref": "#/definitions/TsiErrorBody" + } + } + }, + "ModelSettingsResponse": { + "description": "Response containing full time series model settings which include model name, Time Series ID properties and default type ID.", + "type": "object", + "properties": { + "modelSettings": { + "description": "Model settings including model name, Time Series ID properties and default type ID.", + "readOnly": true, + "$ref": "#/definitions/TimeSeriesModelSettings" + } + } + }, + "TimeSeriesModelSettings": { + "description": "Time series model settings including model name, Time Series ID properties and default type ID.", + "type": "object", + "properties": { + "name": { + "description": "Time series model display name which is shown in the UX. Examples: \"Temperature Sensors\", \"MyDevices\".", + "readOnly": true, + "type": "string" + }, + "timeSeriesIdProperties": { + "description": "Time series ID properties defined during environment creation.", + "readOnly": true, + "$ref": "#/definitions/TimeSeriesIdProperties" + }, + "defaultTypeId": { + "description": "Default type ID of the model that new time series instances will automatically belong to.", + "readOnly": true, + "type": "string" + } + } + }, + "TimeSeriesIdProperties": { + "description": "Time series ID properties defined during environment creation.", + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "minItems": 1 + }, + "TimeSeriesIdProperty": { + "description": "A definition of a single property that can be used in time series ID properties defined during environment creation.", + "type": "object", + "properties": { + "name": { + "description": "The name of the property.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "The type of the property. Currently, only \"String\" is supported.", + "readOnly": true, + "type": "string", + "enum": [ + "String" + ], + "x-ms-enum": { + "name": "TimeSeriesIdPropertyTypes", + "modelAsString": true + } + } + } + }, + "UpdateModelSettingsRequest": { + "description": "Request to update model settings. One of \"name\" or \"defaultTypeId\" must be set.", + "type": "object", + "properties": { + "name": { + "description": "Model display name which is shown in the UX and mutable by the user. Initial value is \"DefaultModel\".", + "type": "string" + }, + "defaultTypeId": { + "description": "Default type id of the model that new instances will automatically belong to.", + "type": "string" + } + } + }, + "SearchInstancesRequest": { + "description": "Request to execute a search query against time series instances and return matching time series instances.", + "type": "object", + "properties": { + "searchString": { + "description": "Query search string that will be matched to the attributes of time series instances. Example: \"floor 100\". Case-insensitive, must be present, but can be empty string.", + "type": "string" + }, + "path": { + "description": "Filter on hierarchy path of time series instances. Path is represented as array of string path segments. First element should be hierarchy name. Example: [\"Location\", \"California\"]. Optional, case sensitive, never empty and can be null.", + "type": "array", + "items": { + "type": "string" + } + }, + "instances": { + "description": "Parameters of how to return time series instances. Can be null. When both the instances and hierarchies parameters are null, the instances are returned in the results based on the default values of parameters, and hierarchies are not returned.", + "type": "object", + "$ref": "#/definitions/SearchInstancesParameters" + }, + "hierarchies": { + "description": "Parameters of how to return time series instance hierarchies. If null, hierarchies are not returned. If instances parameter is null and hierarchies parameter is not null, only hierarchies with no instances are returned.", + "type": "object", + "$ref": "#/definitions/SearchInstancesHierarchiesParameters" + } + }, + "required": [ + "searchString" + ] + }, + "SearchInstancesParameters": { + "description": "Parameters of how to return time series instances by search instances call.", + "type": "object", + "properties": { + "recursive": { + "description": "Definition of which instances are returned. When recursive is set to 'true', all instances that have the path that starts with path the path parameter are returned. When recursive is set to 'false', only instances that have the path that exactly matches the path parameter are returned. Using recursive search allows to implement search user experience, while using non-recursive search allows to implement navigation experience. Optional, default is 'true'.", + "type": "boolean" + }, + "sort": { + "description": "Definition of how time series instances are sorted before being returned by search instances call - relevance or alphabetical. Optional, default is \"Rank\".", + "type": "object", + "$ref": "#/definitions/InstancesSortParameter" + }, + "highlights": { + "description": "Definition of highlighted search results or not. When it is set to 'true', the highlighted search results are returned. When it is set to 'false', the highlighted search results are not returned. Default is 'true'.", + "type": "boolean" + }, + "pageSize": { + "description": "Maximum number of instances expected in each page of the result. Defaults to 10 when not set. Ranges from 1 to 100. If there are results beyond the page size, the user can use the continuation token to fetch the next page.", + "type": "integer", + "format": "int32" + } + } + }, + "InstancesSortParameter": { + "description": "Definition of how time series instances are sorted before being returned by search instances call.", + "type": "object", + "properties": { + "by": { + "description": "Value to use for sorting of the time series instances before being returned by search instances call. When it is set to 'Rank', the returned instances are sorted based on the relevance. When it is set to 'DisplayName', the returned results are sorted based on the display name. Display name is the name of the instance if it exists, otherwise, display name is the time series ID. Default is 'Rank'.", + "type": "string", + "enum": [ + "Rank", + "DisplayName" + ], + "x-ms-enum": { + "name": "InstancesSortBy", + "modelAsString": true + } + } + } + }, + "SearchInstancesHierarchiesParameters": { + "description": "Parameter of how to return time series instance hierarchies by search instances call.", + "type": "object", + "properties": { + "expand": { + "description": "Definition of whether to expand hierarchy nodes in the same search instances call. Optional, default is 'UntilChildren'.", + "type": "object", + "$ref": "#/definitions/HierarchiesExpandParameter" + }, + "sort": { + "description": "Definition of sorting of hierarchy nodes. Optional, default is 'CumulativeInstanceCount'.", + "type": "object", + "$ref": "#/definitions/HierarchiesSortParameter" + }, + "pageSize": { + "description": "Maximum number of hierarchies in the same level to return in the same page. Optional, default is 10 when not set. Range is from 1 to 100. If there are results beyond the page size, the continuation token can be used to fetch the next page.", + "type": "integer", + "format": "int32" + } + } + }, + "HierarchiesExpandParameter": { + "description": "Definition of whether to expand hierarchy nodes in the same search instances call.", + "type": "object", + "properties": { + "kind": { + "description": "Kind of the expansion of hierarchy nodes. When it is set to 'UntilChildren', the hierarchy nodes are expanded recursively until there is more than one child. When it is set to 'OneLevel', the hierarchies are expanded only at the single level matching path search instances parameter. Optional, default is 'UntilChildren'.", + "type": "string", + "enum": [ + "UntilChildren", + "OneLevel" + ], + "x-ms-enum": { + "name": "HierarchiesExpandKind", + "modelAsString": true + } + } + } + }, + "HierarchiesSortParameter": { + "description": "Definition of sorting of hierarchy nodes.", + "type": "object", + "properties": { + "by": { + "description": "Value to use for hierarchy node sorting. When it is set to 'CumulativeInstanceCount', the returned hierarchies are sorted based on the total instances belonging to the hierarchy node and its child hierarchy nodes. When it is set to 'Name', the returned hierarchies are sorted based on the hierarchy name. Optional, default is 'CumulativeInstanceCount'.", + "type": "string", + "enum": [ + "CumulativeInstanceCount", + "Name" + ], + "x-ms-enum": { + "name": "HierarchiesSortBy", + "modelAsString": true + } + } + } + }, + "SearchInstancesResponsePage": { + "description": "Single page of the search results.", + "type": "object", + "properties": { + "instances": { + "description": "The instances matching the query based on the input. May be empty or null.", + "readOnly": true, + "type": "object", + "$ref": "#/definitions/SearchInstancesResponse" + }, + "hierarchyNodes": { + "description": "The hierarchy nodes which contains the instances matching the query based on the input. May be empty or null.", + "readOnly": true, + "type": "object", + "$ref": "#/definitions/SearchHierarchyNodesResponse" + } + } + }, + "SearchInstancesResponse": { + "description": "The instances matching the query based on the input. May be empty or null.", + "type": "object", + "properties": { + "hits": { + "description": "The list of instances matching the query based on the input. May be empty.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstanceHit" + } + }, + "hitCount": { + "description": "Total number of instances matching the query based on the input.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "continuationToken": { + "description": "If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in \"x-ms-continuation\" HTTP header.", + "readOnly": true, + "type": "string" + } + } + }, + "SearchHierarchyNodesResponse": { + "description": "The hierarchy nodes which contains the instances matching the query based on the input. May be empty or null.", + "type": "object", + "properties": { + "hits": { + "description": "The list of hierarchy nodes which contains the instances matching the query based on the input. May be empty.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/HierarchyHit" + } + }, + "hitCount": { + "description": "Total number of hierarchy nodes which contains the instances matching the query based on the input.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "continuationToken": { + "description": "If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in \"x-ms-continuation\" HTTP header.", + "readOnly": true, + "type": "string" + } + } + }, + "InstanceHit": { + "description": "Time series instance that is returned by instances search call. Returned instance matched the search request and contains highlighted text to be displayed to the user if it is set to 'true'.", + "type": "object", + "properties": { + "timeSeriesId": { + "description": "Time series ID of the time series instance that matched the search request.", + "readOnly": true, + "type": "array", + "$ref": "#/definitions/TimeSeriesId" + }, + "name": { + "description": "Name of the time series instance that matched the search request. May be null.", + "readOnly": true, + "type": "string" + }, + "typeId": { + "description": "Represents the type that time series instance which matched the search request belongs to. Never null.", + "readOnly": true, + "type": "string" + }, + "hierarchyIds": { + "description": "List of time series hierarchy IDs that time series instance which matched the search request belongs to. Cannot be used to lookup hierarchies. May be null.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "highlights": { + "description": "Highlighted text of time series instance to be displayed to the user. Highlighting inserts and tags in the portions of text that matched the search string. Do not use any of the highlighted properties to do further API calls.", + "readOnly": true, + "type": "object", + "properties": { + "timeSeriesId": { + "description": "List of highlighted string values of Time Series ID for displaying. Cannot be used to lookup instance.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "typeName": { + "description": "Highlighted time series type name that this instance belongs to.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Highlighted name of time series instance. May be null.", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "Highlighted description of time series instance. May be null.", + "readOnly": true, + "type": "string" + }, + "hierarchyIds": { + "description": "List of highlighted time series hierarchy IDs that time series instance belongs to. Cannot be used to lookup hierarchies. May be null.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "hierarchyNames": { + "description": "List of highlighted time series hierarchy names that time series instance belongs to. Cannot be used to lookup hierarchies. May be null.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "instanceFieldNames": { + "description": "List of highlighted time series instance field names. May be null.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + }, + "instanceFieldValues": { + "description": "List of highlighted time series instance field values. May be null.", + "readOnly": true, + "type": "array", + "items": { + "type": "string" + } + } + } + } + } + }, + "HierarchyHit": { + "description": "The hierarchy node which contains the instances matching the query based on the input. May be empty or null.", + "type": "object", + "properties": { + "name": { + "description": "Name of the hierarchy node. May be empty, cannot be null.", + "readOnly": true, + "type": "string" + }, + "cumulativeInstanceCount": { + "description": "Total number of instances that belong to this node and it's subtrees matching the query.", + "readOnly": true, + "type": "integer", + "format": "int32" + }, + "hierarchyNodes": { + "description": "Child hierarchy nodes of this node. May be empty or null.", + "readOnly": true, + "type": "object", + "$ref": "#/definitions/SearchHierarchyNodesResponse" + } + } + }, + "InstancesSuggestRequest": { + "description": "Request to get search string suggestions for time series instances search based on prefix text.", + "type": "object", + "properties": { + "searchString": { + "description": "Search string for which suggestions are required. Empty is allowed, but not null.", + "type": "string" + }, + "take": { + "description": "Maximum number of suggestions expected in the result. Defaults to 10 when not set.", + "type": "integer", + "format": "int32" + } + }, + "required": [ + "searchString" + ] + }, + "InstancesSuggestResponse": { + "description": "Response of getting suggestions for search for time series instances.", + "type": "object", + "properties": { + "suggestions": { + "description": "List of instance suggestions for searching time series models.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/InstancesSearchStringSuggestion" + } + } + } + }, + "InstancesSearchStringSuggestion": { + "description": "Suggested search string to be used for further search for time series instances.", + "type": "object", + "properties": { + "searchString": { + "description": "Suggested search string. Can be used for further search for time series instances.", + "readOnly": true, + "type": "string" + }, + "highlightedSearchString": { + "description": "Highlighted suggested search string to be displayed to the user. Highlighting inserts and tags in the portions of text that matched the search string. Do not use highlighted search string to do further search calls.", + "readOnly": true, + "type": "string" + } + } + }, + "PagedResponse": { + "description": "Partial result that has continuation token to fetch the next partial result.", + "type": "object", + "properties": { + "continuationToken": { + "description": "If returned, this means that current results represent a partial result. Continuation token allows to get the next page of results. To get the next page of query results, send the same request with continuation token parameter in \"x-ms-continuation\" HTTP header.", + "readOnly": true, + "type": "string" + } + } + }, + "EventProperty": { + "description": "Property of an event that is either stored or computed. Properties are identified by both name and type. Different events can have properties with same name, but different type.", + "type": "object", + "properties": { + "name": { + "description": "The name of the property.", + "type": "string" + }, + "type": { + "description": "The type of the property.", + "$ref": "#/definitions/PropertyType" + } + } + }, + "PropertyType": { + "description": "The type of the property that is either stored in events or computed by a calculation.", + "type": "string", + "enum": [ + "Bool", + "DateTime", + "Double", + "String", + "TimeSpan", + "Long" + ], + "x-ms-enum": { + "name": "PropertyTypes", + "modelAsString": true + } + }, + "TsiError": { + "description": "Information about an API error.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/TsiErrorBody" + } + }, + "x-ms-external": false + }, + "TsiErrorBody": { + "description": "A particular API error with an error code and a message.", + "type": "object", + "properties": { + "code": { + "description": "Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.", + "readOnly": true, + "type": "string" + }, + "target": { + "description": "Target of the particular error (for example, the name of the property in error). May be null.", + "readOnly": true, + "type": "string" + }, + "innerError": { + "description": "Contains more specific error that narrows down the cause. May be null.", + "readOnly": true, + "$ref": "#/definitions/TsiErrorBody" + }, + "details": { + "description": "Contains additional error information. May be null.", + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TsiErrorDetails" + } + } + }, + "additionalProperties": true, + "x-ms-external": false + }, + "TsiErrorDetails": { + "description": "Additional error information.", + "type": "object", + "properties": { + "code": { + "description": "Language-independent, human-readable string that defines a service-specific error code. This code serves as a more specific indicator for the HTTP error code specified in the response. Can be used to programmatically handle specific error cases.", + "readOnly": true, + "type": "string" + }, + "message": { + "description": "Human-readable, language-independent representation of the error. It is intended as an aid to developers and is not suitable for exposure to end users.", + "readOnly": true, + "type": "string" + } + }, + "additionalProperties": true, + "x-ms-external": false + } + }, + "parameters": { + "ApiVersion": { + "name": "api-version", + "in": "query", + "required": true, + "default": "2020-07-31", + "type": "string", + "description": "Version of the API to be used with the client request. Currently supported version is \"2020-07-31\"." + }, + "StoreType": { + "name": "storeType", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "For the environments with warm store enabled, the query can be executed either on the 'WarmStore' or 'ColdStore'. This parameter in the query defines which store the query should be executed on. If not defined, the query will be executed on the cold store." + }, + "EnvironmentFqdn": { + "name": "environmentFqdn", + "in": "path", + "required": true, + "type": "string", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client", + "description": "Per environment FQDN, for example 10000000-0000-0000-0000-100000000109.env.timeseries.azure.com. You can obtain this domain name from the response of the Get Environments API, Azure portal, or Azure Resource Manager." + }, + "ContinuationToken": { + "name": "x-ms-continuation", + "x-ms-client-name": "continuationToken", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Continuation token from previous page of results to retrieve the next page of the results in calls that support pagination. To get the first page results, specify null continuation token as parameter value. Returned continuation token is null if all results have been returned, and there is no next page of results." + }, + "ClientRequestId": { + "name": "x-ms-client-request-id", + "x-ms-client-name": "clientRequestId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional client request ID. Service records this value. Allows the service to trace operation across services, and allows the customer to contact support regarding a particular request." + }, + "ClientSessionId": { + "name": "x-ms-client-session-id", + "x-ms-client-name": "clientSessionId", + "in": "header", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Optional client session ID. Service records this value. Allows the service to trace a group of related operations across services, and allows the customer to contact support regarding a particular group of requests." + } + } +} diff --git a/specification/timeseriesinsights/data-plane/readme.md b/specification/timeseriesinsights/data-plane/readme.md index ed219508d482..a1b84838b2b2 100644 --- a/specification/timeseriesinsights/data-plane/readme.md +++ b/specification/timeseriesinsights/data-plane/readme.md @@ -28,16 +28,16 @@ These are the global settings for Azure Time Series Insights Data Plane API. openapi-type: data-plane add-credentials: true license-header: MICROSOFT_MIT -tag: package-2018-11-01-preview +tag: package-2020-07-31 ``` -### Tag: package-2018-11-01-preview +### Tag: package-2020-07-31 -These settings apply only when `--tag=package-2018-11-01-preview` is specified on the command line. +These settings apply only when `--tag=package-2020-07-31` is specified on the command line. -``` yaml $(tag) == 'package-2018-11-01-preview' +``` yaml $(tag) == 'package-2020-07-31' input-file: -- Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json +- Microsoft.TimeSeriesInsights/stable/2020-07-31/timeseriesinsights.json ``` ## Suppression @@ -83,6 +83,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.TimeSeriesInsights/stable/2020-07-31/timeseriesinsights.json - $(this-folder)/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json ``` From 43a8b2be30b8fbd6c7a53d1d6ed64a68113fa298 Mon Sep 17 00:00:00 2001 From: giakas Date: Mon, 29 Jun 2020 14:20:06 -0700 Subject: [PATCH 222/318] =?UTF-8?q?[AMS]=20Adding=20New=20LVA=20Edge=20Swa?= =?UTF-8?q?gger=20file=20to=20azure=20media=20services=20data=20p=E2=80=A6?= =?UTF-8?q?=20(#9697)?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit * [AMS] Adding New LVA Edge Swagger file to azure media services data plane * fix prettier issues * fix go SDK folder structure * change open-api type to data-plane * Update LVA swagger files with validation errors. * Fix Prettier and spell checks * Rename folder Microsoft.LVAEdge to LvaEdge * fix a casing in the name * updateing some namespaces. * removing all other language support other than C# * fix some strings * Update c# namespace to Azure.Media.LiveVideoAnalytics.Edge --- custom-words.txt | 7 + .../preview/1.0.0/LiveVideoAnalytics.json | 1317 +++++++++++++++++ .../1.0.0/examples/GraphInstanceDelete.json | 16 + .../1.0.0/examples/GraphInstanceGet.json | 36 + .../1.0.0/examples/GraphInstanceList.json | 35 + .../1.0.0/examples/GraphInstanceSet.json | 62 + .../examples/GraphInstanceStateChange.json | 12 + .../1.0.0/examples/GraphTopologyDelete.json | 16 + .../1.0.0/examples/GraphTopologyGet.json | 70 + .../1.0.0/examples/GraphTopologyList.json | 69 + .../1.0.0/examples/GraphTopologySet.json | 173 +++ .../mediaservices/data-plane/readme.md | 71 + 12 files changed, 1884 insertions(+) create mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/LiveVideoAnalytics.json create mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceDelete.json create mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceGet.json create mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceList.json create mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceSet.json create mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceStateChange.json create mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyDelete.json create mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyGet.json create mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyList.json create mode 100644 specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologySet.json create mode 100644 specification/mediaservices/data-plane/readme.md diff --git a/custom-words.txt b/custom-words.txt index 9ca95409c6fe..9640d6f559f3 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -100,6 +100,8 @@ applynetworkconfigurationupdates appservice appsettings appteststorage +ABGRABGR +ARGBARGB Arjun armtemplates arpa @@ -192,6 +194,9 @@ BCWG beider Bfor bfqt +BGRA +BGRABGRA +BGRBGR bigint Bigram bigrams @@ -1295,6 +1300,8 @@ Retryable Revalidates Revertable REVOKEACE +RGBARGBA +RGBRGB rgname rhel Rolledback diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/LiveVideoAnalytics.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/LiveVideoAnalytics.json new file mode 100644 index 000000000000..67ce9df2dfcb --- /dev/null +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/LiveVideoAnalytics.json @@ -0,0 +1,1317 @@ +{ + "swagger": "2.0", + "info": { + "description": "Direct Methods for Live Video Analytics on IoT Edge.", + "version": "1.0.0", + "title": "Direct Methods for Live Video Analytics on IoT Edge", + "contact": { + "email": "amshelp@microsoft.com" + } + }, + "security": [ + { + "sharedAccessSignature": [] + } + ], + "paths": { + "/api/GraphTopology": { + "get": { + "summary": "Retrieves a list of graph topologies.", + "description": "Retrieves a list of graph topologies that have been added to the Live Video Analytics IoT Edge module.", + "operationId": "GraphTopologyList", + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "Graph Topologies were successfully retrieved from the Live Video Analytics IoT Edge module.", + "schema": { + "$ref": "#/definitions/MediaGraphTopologyCollection" + } + } + }, + "x-ms-examples": { + "List all Graph Topologies": { + "$ref": "examples/GraphTopologyList.json" + } + } + }, + "put": { + "summary": "Creates or updates a graph topology.", + "description": "Creates a new topology or updates an existing one, with the given name. A topology is a blueprint defining what nodes are in a graph, and how they are interconnected.", + "operationId": "GraphTopologySet", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "topology", + "required": true, + "schema": { + "$ref": "#/definitions/MediaGraphTopology" + } + } + ], + "responses": { + "200": { + "description": "Existing graph topology updated.", + "schema": { + "$ref": "#/definitions/MediaGraphTopology" + } + }, + "201": { + "description": "New graph topology created.", + "schema": { + "$ref": "#/definitions/MediaGraphTopology" + } + } + }, + "x-ms-examples": { + "Create or Update a Graph Topology": { + "$ref": "examples/GraphTopologySet.json" + } + } + } + }, + "/api/GraphTopology/{name}": { + "get": { + "summary": "Gets a graph topology by name.", + "description": "Retrieves a graph topology by name. If a topology with that name has been previously set, then the call will return the JSON representation of that topology.", + "operationId": "GraphTopologyGet", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the graph topology to be retrieved.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Graph topology retrieved successfully.", + "schema": { + "$ref": "#/definitions/MediaGraphTopology" + } + }, + "404": { + "description": "Graph topology was not found." + } + }, + "x-ms-examples": { + "Get a Graph Topology": { + "$ref": "examples/GraphTopologyGet.json" + } + } + }, + "delete": { + "summary": "Deletes a graph topology.", + "description": "Deletes a graph topology with the given name. This method should be called after all instances of the topology have been stopped and deleted.", + "operationId": "GraphTopologyDelete", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the graph topology to be deleted.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Graph topology deleted successfully." + }, + "204": { + "description": "Graph topology not found." + } + }, + "x-ms-examples": { + "Delete a Graph Topology": { + "$ref": "examples/GraphTopologyDelete.json" + } + } + } + }, + "/api/GraphInstance": { + "get": { + "summary": "Retrieves a list of graph instances.", + "description": "Retrieves a list of graph instances, if any, that have been created in the Live Video Analytics IoT Edge module.", + "operationId": "GraphInstanceList", + "produces": [ + "application/json" + ], + "parameters": [], + "responses": { + "200": { + "description": "List of graph instances that were successfully retrieved.", + "schema": { + "$ref": "#/definitions/MediaGraphInstanceCollection" + } + } + }, + "x-ms-examples": { + "List all Graph Instances": { + "$ref": "examples/GraphInstanceList.json" + } + } + }, + "put": { + "summary": "Creates or updates a graph instance.", + "description": "Creates or updates a graph instance.", + "operationId": "GraphInstanceSet", + "produces": [ + "application/json" + ], + "parameters": [ + { + "in": "body", + "name": "instance", + "required": true, + "schema": { + "$ref": "#/definitions/MediaGraphInstance" + } + } + ], + "responses": { + "200": { + "description": "Graph instance updated.", + "schema": { + "$ref": "#/definitions/MediaGraphInstance" + } + }, + "201": { + "description": "New graph instance created.", + "schema": { + "$ref": "#/definitions/MediaGraphInstance" + } + } + }, + "x-ms-examples": { + "Create or Update a Graph Instance": { + "$ref": "examples/GraphInstanceSet.json" + } + } + } + }, + "/api/GraphInstance/{name}": { + "get": { + "summary": "Gets a graph instance by name.", + "description": "Retrieves a graph instance by name. If a graph instance with that name has been previously created, then the direct method call will return the JSON representation of that instance.", + "operationId": "GraphInstanceGet", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the graph instance to be retrieved.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Graph instance retrieved successfully.", + "schema": { + "$ref": "#/definitions/MediaGraphInstance" + } + }, + "404": { + "description": "Graph instance not found." + } + }, + "x-ms-examples": { + "Get a Graph Instance": { + "$ref": "examples/GraphInstanceGet.json" + } + } + }, + "delete": { + "summary": "Deletes a graph instance.", + "description": "Deletes a graph instance.", + "operationId": "GraphInstanceDelete", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the graph instance to be deleted.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Graph instance deleted successfully." + }, + "204": { + "description": "Graph instance not found." + } + }, + "x-ms-examples": { + "Delete a Graph Instance": { + "$ref": "examples/GraphInstanceDelete.json" + } + } + } + }, + "/api/GraphInstance/{name}/activate": { + "post": { + "summary": "Activate a given graph instance.", + "description": "Activates a graph instance with the name provided, if it exists.", + "operationId": "GraphInstanceActivate", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the graph instance to be activated.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Graph instance activated successfully." + } + }, + "x-ms-examples": { + "Activate a Graph Instance": { + "$ref": "examples/GraphInstanceStateChange.json" + } + } + } + }, + "/api/GraphInstance/{name}/deactivate": { + "post": { + "summary": "Deactivate a graph instance.", + "description": "Deactivates a graph instance with the name provided, if it is active.", + "operationId": "GraphInstanceDeactivate", + "produces": [ + "application/json" + ], + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Name of the graph instance to be deactivated.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Graph instance deactivated successfully." + } + }, + "x-ms-examples": { + "Deactivate a Graph Instance": { + "$ref": "examples/GraphInstanceStateChange.json" + } + } + } + } + }, + "securityDefinitions": { + "sharedAccessSignature": { + "type": "apiKey", + "name": "Authorization", + "in": "header" + } + }, + "definitions": { + "MediaGraphInstance": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "@apiVersion": { + "type": "string" + }, + "systemData": { + "$ref": "#/definitions/MediaGraphSystemData" + }, + "properties": { + "$ref": "#/definitions/MediaGraphInstanceProperties" + } + }, + "description": "Represents a Media Graph instance." + }, + "MediaGraphInstanceProperties": { + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "An optional description for the instance." + }, + "topologyName": { + "type": "string", + "description": "The name of the graph topology that this instance will run. A topology with this name should already have been set in the Edge module." + }, + "parameters": { + "type": "array", + "description": "List of one or more graph instance parameters.", + "items": { + "$ref": "#/definitions/MediaGraphParameterDefinition" + } + }, + "state": { + "type": "string", + "description": "Allowed states for a graph Instance.", + "enum": [ + "Inactive", + "Activating", + "Active", + "Deactivating" + ], + "x-ms-enum": { + "name": "MediaGraphInstanceState", + "values": [ + { + "value": "Inactive", + "description": "Inactive state." + }, + { + "value": "Activating", + "description": "Activating state." + }, + { + "value": "Active", + "description": "Active state." + }, + { + "value": "Deactivating", + "description": "Deactivating state." + } + ], + "modelAsString": false + } + } + }, + "description": "Properties of a Media Graph instance." + }, + "MediaGraphParameterDefinition": { + "type": "object", + "required": [ + "name", + "value" + ], + "properties": { + "name": { + "type": "string", + "description": "Name of parameter as defined in the graph topology." + }, + "value": { + "type": "string", + "description": "Value of parameter." + } + }, + "description": "A key, value pair. The graph topology can be authored with certain values with parameters. Then, during graph instance creation, the value for that parameters can be specified. This allows the same graph topology to be used as a blueprint for multiple graph instances with different values for the parameters." + }, + "MediaGraphInstanceCollection": { + "properties": { + "value": { + "type": "array", + "description": "Collection of graph instances.", + "items": { + "$ref": "#/definitions/MediaGraphInstance" + } + }, + "@continuationToken": { + "type": "string", + "description": "Continuation token to use in subsequent calls to enumerate through the graph instance collection (when the collection contains too many results to return in one response)." + } + }, + "description": "Collection of graph instances." + }, + "MediaGraphTopologyCollection": { + "properties": { + "value": { + "type": "array", + "description": "Collection of graph topologies.", + "items": { + "$ref": "#/definitions/MediaGraphTopology" + } + }, + "@continuationToken": { + "type": "string", + "description": "Continuation token to use in subsequent calls to enumerate through the graph topologies collection (when the collection contains too many results to return in one response)." + } + }, + "description": "Collection of graph topologies." + }, + "MediaGraphTopology": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "type": "string" + }, + "@apiVersion": { + "type": "string" + }, + "systemData": { + "$ref": "#/definitions/MediaGraphSystemData" + }, + "properties": { + "$ref": "#/definitions/MediaGraphTopologyProperties" + } + }, + "description": "Describes a graph topology." + }, + "MediaGraphTopologyProperties": { + "type": "object", + "properties": { + "description": { + "type": "string" + }, + "parameters": { + "type": "array", + "items": { + "$ref": "#/definitions/MediaGraphParameterDeclaration" + } + }, + "sources": { + "type": "array", + "items": { + "$ref": "#/definitions/MediaGraphSource" + } + }, + "processors": { + "type": "array", + "items": { + "$ref": "#/definitions/MediaGraphProcessor" + } + }, + "sinks": { + "type": "array", + "items": { + "$ref": "#/definitions/MediaGraphSink" + } + } + }, + "description": "Describes the properties of a graph topology." + }, + "MediaGraphSystemData": { + "type": "object", + "properties": { + "createdAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource creation (UTC)." + }, + "lastModifiedAt": { + "type": "string", + "format": "date-time", + "description": "The timestamp of resource last modification (UTC)." + } + }, + "description": "Graph system data." + }, + "MediaGraphParameterDeclaration": { + "type": "object", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "type": "string", + "description": "The name of the parameter.", + "maxLength": 64 + }, + "type": { + "type": "string", + "enum": [ + "String", + "SecretString", + "Int", + "Double", + "Bool" + ], + "x-ms-enum": { + "name": "MediaGraphParameterType", + "values": [ + { + "value": "String", + "description": "A string parameter value." + }, + { + "value": "SecretString", + "description": "A string to hold sensitive information as parameter value." + }, + { + "value": "Int", + "description": "A 32-bit signed integer as parameter value." + }, + { + "value": "Double", + "description": "A 64-bit double-precision floating point type as parameter value." + }, + { + "value": "Bool", + "description": "A boolean value that is either true or false." + } + ], + "modelAsString": false + } + }, + "description": { + "type": "string", + "description": "Description of the parameter." + }, + "default": { + "type": "string", + "description": "The default value for the parameter, to be used if the graph instance does not specify a value." + } + }, + "description": "The declaration of a parameter in the graph topology. A graph topology can be authored with parameters. Then, during graph instance creation, the value for those parameters can be specified. This allows the same graph topology to be used as a blueprint for multiple graph instances with different values for the parameters." + }, + "MediaGraphSource": { + "type": "object", + "required": [ + "@type", + "name" + ], + "discriminator": "@type", + "properties": { + "@type": { + "type": "string", + "description": "The type of the source node. The discriminator for derived types." + }, + "name": { + "type": "string", + "description": "The name to be used for this source node." + } + }, + "description": "Media graph source." + }, + "MediaGraphRtspSource": { + "properties": { + "transport": { + "type": "string", + "description": "Underlying RTSP transport. This is used to enable or disable HTTP tunneling.", + "enum": [ + "Http", + "Tcp" + ], + "x-ms-enum": { + "name": "MediaGraphRtspTransport", + "values": [ + { + "value": "Http", + "description": "HTTP/HTTPS transport. This should be used when HTTP tunneling is desired." + }, + { + "value": "Tcp", + "description": "TCP transport. This should be used when HTTP tunneling is NOT desired." + } + ], + "modelAsString": true + } + }, + "endpoint": { + "description": "RTSP endpoint of the stream that is being connected to.", + "$ref": "#/definitions/MediaGraphEndpoint" + } + }, + "required": [ + "endpoint" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaGraphSource" + }, + {} + ], + "description": "Enables a graph to capture media from a RTSP server.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphRtspSource" + }, + "MediaGraphIoTHubMessageSource": { + "properties": { + "hubInputName": { + "type": "string", + "description": "Name of the input path where messages can be routed to (via routes declared in the IoT Edge deployment manifest)." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaGraphSource" + }, + {} + ], + "description": "Enables a graph to receive messages via routes declared in the IoT Edge deployment manifest.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphIoTHubMessageSource" + }, + "MediaGraphIoTHubMessageSink": { + "properties": { + "hubOutputName": { + "type": "string", + "description": "Name of the output path to which the graph will publish message. These messages can then be delivered to desired destinations by declaring routes referencing the output path in the IoT Edge deployment manifest." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaGraphSink" + }, + {} + ], + "description": "Enables a graph to publish messages that can be delivered via routes declared in the IoT Edge deployment manifest.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphIoTHubMessageSink" + }, + "MediaGraphEndpoint": { + "type": "object", + "required": [ + "@type", + "url" + ], + "discriminator": "@type", + "properties": { + "@type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "credentials": { + "description": "Polymorphic credentials to be presented to the endpoint.", + "$ref": "#/definitions/MediaGraphCredentials" + }, + "url": { + "type": "string", + "description": "Url for the endpoint." + } + }, + "description": "Base class for endpoints." + }, + "MediaGraphCredentials": { + "type": "object", + "required": [ + "@type" + ], + "discriminator": "@type", + "properties": { + "@type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "description": "Credentials to present during authentication." + }, + "MediaGraphUsernamePasswordCredentials": { + "properties": { + "username": { + "type": "string", + "description": "Username for a username/password pair." + }, + "password": { + "type": "string", + "description": "Password for a username/password pair." + } + }, + "required": [ + "username" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaGraphCredentials" + }, + {} + ], + "description": "Username/password credential pair.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials" + }, + "MediaGraphHttpHeaderCredentials": { + "properties": { + "headerName": { + "type": "string", + "description": "HTTP header name." + }, + "headerValue": { + "type": "string", + "description": "HTTP header value." + } + }, + "required": [ + "headerName", + "headerValue" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaGraphCredentials" + }, + {} + ], + "description": "Http header service credentials.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphHttpHeaderCredentials" + }, + "MediaGraphUnsecuredEndpoint": { + "allOf": [ + { + "$ref": "#/definitions/MediaGraphEndpoint" + }, + {} + ], + "description": "An endpoint that the media graph can connect to, with no encryption in transit.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphUnsecuredEndpoint" + }, + "MediaGraphTlsEndpoint": { + "properties": { + "trustedCertificates": { + "description": "Trusted certificates when authenticating a TLS connection. Null designates that Azure Media Service's source of trust should be used.", + "$ref": "#/definitions/MediaGraphCertificateSource" + }, + "validationOptions": { + "description": "Validation options to use when authenticating a TLS connection. By default, strict validation is used.", + "$ref": "#/definitions/MediaGraphTlsValidationOptions" + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaGraphEndpoint" + }, + {} + ], + "description": "An endpoint that the graph can connect to, which must be connected over TLS/SSL.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphTlsEndpoint" + }, + "MediaGraphCertificateSource": { + "type": "object", + "required": [ + "@type" + ], + "discriminator": "@type", + "properties": { + "@type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "description": "Base class for certificate sources." + }, + "MediaGraphTlsValidationOptions": { + "type": "object", + "properties": { + "ignoreHostname": { + "type": "string", + "description": "Boolean value ignoring the host name (common name) during validation." + }, + "ignoreSignature": { + "type": "string", + "description": "Boolean value ignoring the integrity of the certificate chain at the current time." + } + }, + "description": "Options for controlling the authentication of TLS endpoints." + }, + "MediaGraphPemCertificateList": { + "properties": { + "certificates": { + "type": "array", + "description": "PEM formatted public certificates one per entry.", + "items": { + "type": "string" + } + } + }, + "required": [ + "certificates" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaGraphCertificateSource" + }, + {} + ], + "description": "A list of PEM formatted certificates.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphPemCertificateList" + }, + "MediaGraphSink": { + "type": "object", + "required": [ + "@type", + "inputs", + "name" + ], + "discriminator": "@type", + "properties": { + "@type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "name": { + "type": "string", + "description": "Name to be used for the media graph sink." + }, + "inputs": { + "type": "array", + "description": "An array of the names of the other nodes in the media graph, the outputs of which are used as input for this sink node.", + "items": { + "$ref": "#/definitions/MediaGraphNodeInput" + } + } + }, + "description": "Enables a media graph to write media data to a destination outside of the Live Video Analytics IoT Edge module." + }, + "MediaGraphNodeInput": { + "type": "object", + "properties": { + "nodeName": { + "type": "string", + "description": "The name of another node in the media graph, the output of which is used as input to this node." + }, + "outputSelectors": { + "type": "array", + "description": "Allows for the selection of particular streams from another node.", + "items": { + "$ref": "#/definitions/MediaGraphOutputSelector" + } + } + }, + "description": "Represents the input to any node in a media graph." + }, + "MediaGraphOutputSelector": { + "properties": { + "property": { + "type": "string", + "description": "The stream property to compare with.", + "enum": [ + "mediaType" + ], + "x-ms-enum": { + "name": "MediaGraphOutputSelectorProperty", + "values": [ + { + "value": "mediaType", + "description": "The stream's MIME type or subtype." + } + ], + "modelAsString": false + } + }, + "operator": { + "type": "string", + "description": "The operator to compare streams by.", + "enum": [ + "is", + "isNot" + ], + "x-ms-enum": { + "name": "MediaGraphOutputSelectorOperator", + "values": [ + { + "value": "is", + "description": "A media type is the same type or a subtype." + }, + { + "value": "isNot", + "description": "A media type is not the same type or a subtype." + } + ], + "modelAsString": false + } + }, + "value": { + "type": "string", + "description": "Value to compare against." + } + }, + "description": "Allows for the selection of particular streams from another node." + }, + "MediaGraphFileSink": { + "properties": { + "filePathPattern": { + "type": "string", + "description": "Absolute file path pattern for creating new files on the Edge device.", + "minLength": 1 + } + }, + "required": [ + "filePathPattern" + ], + "allOf": [ + { + "$ref": "#/definitions/MediaGraphSink" + }, + {} + ], + "description": "Enables a media graph to write/store media (video and audio) to a file on the Edge device.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphFileSink" + }, + "MediaGraphAssetSink": { + "properties": { + "assetNamePattern": { + "type": "string", + "description": "A name pattern when creating new assets." + }, + "segmentLength": { + "type": "string", + "format": "duration", + "example": "PT30S", + "description": "When writing media to an asset, wait until at least this duration of media has been accumulated on the Edge. Expressed in increments of 30 seconds, with a minimum of 30 seconds and a recommended maximum of 5 minutes." + }, + "localMediaCachePath": { + "type": "string", + "description": "Path to a local file system directory for temporary caching of media, before writing to an Asset. Used when the Edge device is temporarily disconnected from Azure." + }, + "localMediaCacheMaximumSizeMiB": { + "type": "string", + "description": "Maximum amount of disk space that can be used for temporary caching of media." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaGraphSink" + }, + {} + ], + "description": "Enables a graph to record media to an Azure Media Services asset, for subsequent playback.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphAssetSink" + }, + "MediaGraphProcessor": { + "type": "object", + "required": [ + "@type", + "inputs", + "name" + ], + "discriminator": "@type", + "properties": { + "@type": { + "type": "string", + "description": "The discriminator for derived types." + }, + "name": { + "type": "string", + "description": "The name for this processor node." + }, + "inputs": { + "type": "array", + "description": "An array of the names of the other nodes in the media graph, the outputs of which are used as input for this processor node.", + "items": { + "$ref": "#/definitions/MediaGraphNodeInput" + } + } + }, + "description": "A node that represents the desired processing of media in a graph. Takes media and/or events as inputs, and emits media and/or event as output." + }, + "MediaGraphMotionDetectionProcessor": { + "properties": { + "sensitivity": { + "type": "string", + "description": "Enumeration that specifies the sensitivity of the motion detection processor.", + "enum": [ + "Low", + "Medium", + "High" + ], + "x-ms-enum": { + "name": "MediaGraphMotionDetectionSensitivity", + "values": [ + { + "value": "Low", + "description": "Low Sensitivity." + }, + { + "value": "Medium", + "description": "Medium Sensitivity." + }, + { + "value": "High", + "description": "High Sensitivity." + } + ], + "modelAsString": true + } + }, + "outputMotionRegion": { + "type": "boolean", + "description": "Indicates whether the processor should detect and output the regions, within the video frame, where motion was detected. Default is true." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaGraphProcessor" + }, + {} + ], + "description": "A node that accepts raw video as input, and detects if there are moving objects present. If so, then it emits an event, and allows frames where motion was detected to pass through. Other frames are blocked/dropped.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphMotionDetectionProcessor" + }, + "MediaGraphExtensionProcessorBase": { + "properties": { + "endpoint": { + "description": "Endpoint to which this processor should connect.", + "$ref": "#/definitions/MediaGraphEndpoint" + }, + "image": { + "description": "Describes the parameters of the image that is sent as input to the endpoint.", + "$ref": "#/definitions/MediaGraphImage" + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaGraphProcessor" + }, + {} + ], + "description": "Processor that allows for extensions, outside of the Live Video Analytics Edge module, to be integrated into the graph. It is the base class for various different kinds of extension processor types.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphExtensionProcessorBase" + }, + "MediaGraphHttpExtension": { + "allOf": [ + { + "$ref": "#/definitions/MediaGraphExtensionProcessorBase" + }, + {} + ], + "description": "A processor that allows the media graph to send video frames (mostly at low frame rates e.g. <5 fps) to external inference container by leveraging HTTP based RESTful API. It then retrieves the inference results and relays them downstream to the next node.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphHttpExtension" + }, + "MediaGraphImage": { + "type": "object", + "properties": { + "scale": { + "$ref": "#/definitions/MediaGraphImageScale" + }, + "format": { + "$ref": "#/definitions/MediaGraphImageFormat" + } + }, + "description": "Describes the properties of an image frame." + }, + "MediaGraphImageScale": { + "type": "object", + "properties": { + "mode": { + "type": "string", + "description": "Describes the modes for scaling an input video frame into an image, before it is sent to an inference engine.", + "enum": [ + "PreserveAspectRatio", + "Pad", + "Stretch" + ], + "x-ms-enum": { + "name": "MediaGraphImageScaleMode", + "values": [ + { + "value": "PreserveAspectRatio", + "description": "Use the same aspect ratio as the input frame." + }, + { + "value": "Pad", + "description": "Center pad the input frame to match the given dimensions." + }, + { + "value": "Stretch", + "description": "Stretch input frame to match given dimensions." + } + ], + "modelAsString": true + } + }, + "width": { + "type": "string", + "description": "The desired output width of the image." + }, + "height": { + "type": "string", + "description": "The desired output height of the image." + } + }, + "description": "The scaling mode for the image." + }, + "MediaGraphImageFormat": { + "required": [ + "@type" + ], + "type": "object", + "discriminator": "@type", + "properties": { + "@type": { + "type": "string", + "description": "The discriminator for derived types." + } + }, + "description": "Encoding settings for an image.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphImageFormat" + }, + "MediaGraphImageFormatRaw": { + "properties": { + "pixelFormat": { + "type": "string", + "enum": [ + "Yuv420p", + "Rgb565be", + "Rgb565le", + "Rgb555be", + "Rgb555le", + "Rgb24", + "Bgr24", + "Argb", + "Rgba", + "Abgr", + "Bgra" + ], + "x-ms-enum": { + "name": "MediaGraphImageFormatRawPixelFormat", + "values": [ + { + "value": "Yuv420p", + "description": "Planar YUV 4:2:0, 12bpp, (1 Cr and Cb sample per 2x2 Y samples)." + }, + { + "value": "Rgb565be", + "description": "Packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), big-endian." + }, + { + "value": "Rgb565le", + "description": "Packed RGB 5:6:5, 16bpp, (msb) 5R 6G 5B(lsb), little-endian." + }, + { + "value": "Rgb555be", + "description": "Packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), big-endian , X=unused/undefined." + }, + { + "value": "Rgb555le", + "description": "Packed RGB 5:5:5, 16bpp, (msb)1X 5R 5G 5B(lsb), little-endian, X=unused/undefined." + }, + { + "value": "Rgb24", + "description": "Packed RGB 8:8:8, 24bpp, RGBRGB." + }, + { + "value": "Bgr24", + "description": "Packed RGB 8:8:8, 24bpp, BGRBGR." + }, + { + "value": "Argb", + "description": "Packed ARGB 8:8:8:8, 32bpp, ARGBARGB." + }, + { + "value": "Rgba", + "description": "Packed RGBA 8:8:8:8, 32bpp, RGBARGBA." + }, + { + "value": "Abgr", + "description": "Packed ABGR 8:8:8:8, 32bpp, ABGRABGR." + }, + { + "value": "Bgra", + "description": "Packed BGRA 8:8:8:8, 32bpp, BGRABGRA." + } + ], + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaGraphImageFormat" + }, + {} + ], + "description": "Encoding settings for raw images.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphImageFormatRaw" + }, + "MediaGraphImageFormatEncoded": { + "properties": { + "encoding": { + "type": "string", + "description": "The different encoding formats that can be used for the image.", + "default": "Jpeg", + "enum": [ + "Jpeg", + "Bmp", + "Png" + ], + "x-ms-enum": { + "name": "MediaGraphImageEncodingFormat", + "values": [ + { + "value": "Jpeg", + "description": "JPEG image format." + }, + { + "value": "Bmp", + "description": "BMP image format." + }, + { + "value": "Png", + "description": "PNG image format." + } + ], + "modelAsString": true + } + }, + "quality": { + "type": "string", + "description": "The image quality (used for JPEG only). Value must be between 0 to 100 (best quality)." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaGraphImageFormat" + }, + {} + ], + "description": "Allowed formats for the image.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphImageFormatEncoded" + }, + "MediaGraphSignalGateProcessor": { + "properties": { + "activationEvaluationWindow": { + "type": "string", + "example": "PT1.0S", + "description": "The period of time over which the gate gathers input events, before evaluating them." + }, + "activationSignalOffset": { + "type": "string", + "example": "-PT1.0S", + "description": "Signal offset once the gate is activated (can be negative). It is an offset between the time the event is received, and the timestamp of the first media sample (eg. video frame) that is allowed through by the gate." + }, + "minimumActivationTime": { + "type": "string", + "example": "PT1S", + "description": "The minimum period for which the gate remains open, in the absence of subsequent triggers (events)." + }, + "maximumActivationTime": { + "type": "string", + "example": "PT2S", + "description": "The maximum period for which the gate remains open, in the presence of subsequent events." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaGraphProcessor" + }, + {} + ], + "description": "A signal gate determines when to block (gate) incoming media, and when to allow it through. It gathers input events over the activationEvaluationWindow, and determines whether to open or close the gate.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphSignalGateProcessor" + }, + "MediaGraphFrameRateFilterProcessor": { + "properties": { + "maximumFps": { + "type": "string", + "description": "Ensures that the frame rate of the video leaving this processor does not exceed this limit." + } + }, + "allOf": [ + { + "$ref": "#/definitions/MediaGraphProcessor" + }, + {} + ], + "description": "Limits the frame rate on the input video stream based on the maximumFps property.", + "x-ms-discriminator-value": "#Microsoft.Media.MediaGraphFrameRateFilterProcessor" + } + } +} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceDelete.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceDelete.json new file mode 100644 index 000000000000..76af8f4992db --- /dev/null +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "name": "IngestAndRecordGraphInstance", + "@apiVersion": "1.0" + }, + "responses": { + "200": { + "payload": null, + "status": 200 + }, + "204": { + "payload": null, + "status": 204 + } + } +} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceGet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceGet.json new file mode 100644 index 000000000000..a83368fb92d1 --- /dev/null +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceGet.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "name": "IngestAndRecordGraphInstance", + "@apiVersion": "1.0" + }, + "responses": { + "200": { + "body": { + "name": "IngestAndRecordGraphInstance", + "properties": { + "description": "An updated description of the instance of the IngestAndRecordGraphTopology", + "parameters": [ + { + "name": "rtspUsername", + "value": "testusername" + }, + { + "name": "rtspPassword", + "value": "testpassword" + } + ], + "state": "Inactive", + "topologyName": "IngestAndRecordGraphTopology" + }, + "systemData": { + "createdAt": "2020-06-10T19:17:58.812Z", + "lastModifiedAt": "2020-06-10T19:19:07.960Z" + } + } + }, + "404": { + "payload": null, + "status": 404 + } + } +} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceList.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceList.json new file mode 100644 index 000000000000..24829a459c28 --- /dev/null +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "@apiVersion": "1.0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "IngestAndRecordGraphInstance", + "properties": { + "description": "An updated description of the instance of the IngestAndRecordGraphTopology", + "parameters": [ + { + "name": "rtspUsername", + "value": "testusername" + }, + { + "name": "rtspPassword", + "value": "testpassword" + } + ], + "state": "Inactive", + "topologyName": "IngestAndRecordGraphTopology" + }, + "systemData": { + "createdAt": "2020-06-10T19:17:58.812Z", + "lastModifiedAt": "2020-06-10T19:19:07.960Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceSet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceSet.json new file mode 100644 index 000000000000..7798068fd654 --- /dev/null +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceSet.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "instance": { + "@apiVersion": "1.0", + "name": "IngestAndRecordGraphInstance", + "properties": { + "topologyName": "IngestAndRecorGraphTopology", + "description": "An instance of the IngestAndRecordGraphTopology" + } + } + }, + "responses": { + "200": { + "body": { + "name": "IngestAndRecordGraphInstance", + "properties": { + "description": "An updated description of the instance of the IngestAndRecordGraphTopology", + "parameters": [ + { + "name": "rtspUsername", + "value": "testusername" + }, + { + "name": "rtspPassword", + "value": "testpassword" + } + ], + "state": "Inactive", + "topologyName": "IngestAndRecorGraphTopology" + }, + "systemData": { + "createdAt": "2020-06-10T19:17:58.812Z", + "lastModifiedAt": "2020-06-10T19:19:07.960Z" + } + } + }, + "201": { + "body": { + "name": "IngestAndRecordGraphInstance", + "properties": { + "description": "An instance of the IngestAndRecordGraphTopology", + "parameters": [ + { + "name": "rtspUsername", + "value": "testusername" + }, + { + "name": "rtspPassword", + "value": "testpassword" + } + ], + "state": "Inactive", + "topologyName": "IngestAndRecordGraphTopology" + }, + "systemData": { + "createdAt": "2020-06-10T19:17:58.812Z", + "lastModifiedAt": "2020-06-10T19:17:58.812Z" + } + } + } + } +} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceStateChange.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceStateChange.json new file mode 100644 index 000000000000..ac22ba64c121 --- /dev/null +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceStateChange.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "name": "IngestAndRecordGraphInstance", + "@apiVersion": "1.0" + }, + "responses": { + "200": { + "payload": null, + "status": 200 + } + } +} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyDelete.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyDelete.json new file mode 100644 index 000000000000..3efef8901cc8 --- /dev/null +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyDelete.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "name": "IngestAndRecordGraphTopology", + "@apiVersion": "1.0" + }, + "responses": { + "200": { + "payload": null, + "status": 200 + }, + "204": { + "payload": null, + "status": 204 + } + } +} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyGet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyGet.json new file mode 100644 index 000000000000..02bcd4422f27 --- /dev/null +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyGet.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "name": "IngestAndRecordGraphTopology", + "@apiVersion": "1.0" + }, + "responses": { + "200": { + "body": { + "name": "IngestAndRecordGraphTopology", + "properties": { + "description": "Simple ingest and record graph definition.", + "parameters": [ + { + "default": "dummyUsername", + "description": "RTSP source username", + "name": "rtspUsername", + "type": "String" + }, + { + "default": "dummyPassword", + "description": "RTSP source password", + "name": "rtspPassword", + "type": "String" + } + ], + "processors": [], + "sinks": [ + { + "@type": "#Microsoft.Media.MediaGraphAssetSink", + "assetNamePattern": "assetSinkTest", + "inputs": [ + { + "nodeName": "rtspSource", + "outputSelectors": [] + } + ], + "localMediaCacheMaximumSizeMiB": "1024", + "localMediaCachePath": "/tmp/test", + "name": "assetSink", + "segmentLength": "PT30S" + } + ], + "sources": [ + { + "@type": "#Microsoft.Media.MediaGraphRtspSource", + "endpoint": { + "@type": "#Microsoft.Media.MediaGraphUnsecuredEndpoint", + "credentials": { + "@type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials", + "username": "${rtspUsername}" + }, + "url": "rtsp://testurl.com" + }, + "name": "rtspSource", + "transport": "Tcp" + } + ] + }, + "systemData": { + "createdAt": "2020-06-10T18:54:33.421Z", + "lastModifiedAt": "2020-06-10T18:55:43.901Z" + } + } + }, + "404": { + "payload": null, + "status": 404 + } + } +} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyList.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyList.json new file mode 100644 index 000000000000..54f6b1eaa64c --- /dev/null +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyList.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "@apiVersion": "1.0" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "IngestAndRecordGraphTopology", + "properties": { + "description": "Simple ingest and record graph definition.", + "parameters": [ + { + "default": "dummyUsername", + "description": "RTSP source username", + "name": "rtspUsername", + "type": "String" + }, + { + "default": "dummyPassword", + "description": "RTSP source password", + "name": "rtspPassword", + "type": "String" + } + ], + "processors": [], + "sinks": [ + { + "@type": "#Microsoft.Media.MediaGraphAssetSink", + "assetNamePattern": "assetSinkTest", + "inputs": [ + { + "nodeName": "rtspSource", + "outputSelectors": [] + } + ], + "localMediaCacheMaximumSizeMiB": "1024", + "localMediaCachePath": "/tmp/test", + "name": "assetSink", + "segmentLength": "PT30S" + } + ], + "sources": [ + { + "@type": "#Microsoft.Media.MediaGraphRtspSource", + "endpoint": { + "@type": "#Microsoft.Media.MediaGraphUnsecuredEndpoint", + "credentials": { + "@type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials", + "username": "${rtspUsername}" + }, + "url": "rtsp://testurl.com" + }, + "name": "rtspSource", + "transport": "Tcp" + } + ] + }, + "systemData": { + "createdAt": "2020-06-10T18:54:33.421Z", + "lastModifiedAt": "2020-06-10T18:55:43.901Z" + } + } + ] + } + } + } +} diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologySet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologySet.json new file mode 100644 index 000000000000..97792c0e29c8 --- /dev/null +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologySet.json @@ -0,0 +1,173 @@ +{ + "parameters": { + "topology": { + "name": "IngestAndRecordGraphTopology", + "@apiVersion": "1.0", + "properties": { + "description": "Simple ingest and record graph definition.", + "parameters": [ + { + "default": "dummyUsername", + "description": "RTSP source username", + "name": "rtspUsername", + "type": "String" + }, + { + "default": "dummyPassword", + "description": "RTSP source password", + "name": "rtspPassword", + "type": "String" + } + ], + "sources": [ + { + "@type": "#Microsoft.Media.MediaGraphRtspSource", + "name": "rtspSource", + "endpoint": { + "@type": "#Microsoft.Media.MediaGraphUnsecuredEndpoint", + "url": "rtsp://testurl.com", + "credentials": { + "@type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials", + "username": "${rtspUsername}", + "password": "${rtspPassword}" + } + } + } + ], + "sinks": [ + { + "@type": "#Microsoft.Media.MediaGraphAssetSink", + "name": "assetSink", + "assetNamePattern": "assetSinkTest", + "inputs": [ + { + "nodeName": "rtspSource" + } + ], + "localMediaCachePath": "/tmp", + "localMediaCacheMaximumSizeMiB": "1024", + "segmentLength": "PT30S" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "name": "IngestAndRecordGraphTopology", + "properties": { + "description": "Simple ingest and record graph definition.", + "parameters": [ + { + "default": "dummyUsername", + "description": "RTSP source username", + "name": "rtspUsername", + "type": "String" + }, + { + "default": "dummyPassword", + "description": "RTSP source password", + "name": "rtspPassword", + "type": "String" + } + ], + "processors": [], + "sinks": [ + { + "@type": "#Microsoft.Media.MediaGraphAssetSink", + "assetNamePattern": "assetSinkTest", + "inputs": [ + { + "nodeName": "rtspSource", + "outputSelectors": [] + } + ], + "localMediaCacheMaximumSizeMiB": "1024", + "localMediaCachePath": "/tmp", + "name": "assetSink", + "segmentLength": "PT30S" + } + ], + "sources": [ + { + "@type": "#Microsoft.Media.MediaGraphRtspSource", + "endpoint": { + "@type": "#Microsoft.Media.MediaGraphUnsecuredEndpoint", + "credentials": { + "@type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials", + "username": "${rtspUsername}" + }, + "url": "rtsp://testurl.com" + }, + "name": "rtspSource", + "transport": "Tcp" + } + ] + }, + "systemData": { + "createdAt": "2020-06-10T18:54:33.421Z", + "lastModifiedAt": "2020-06-10T18:54:33.421Z" + } + } + }, + "201": { + "body": { + "name": "IngestAndRecordGraphTopology", + "properties": { + "description": "Simple ingest and record graph definition.", + "parameters": [ + { + "default": "dummyUsername", + "description": "RTSP source username", + "name": "rtspUsername", + "type": "String" + }, + { + "default": "dummyPassword", + "description": "RTSP source password", + "name": "rtspPassword", + "type": "String" + } + ], + "processors": [], + "sinks": [ + { + "@type": "#Microsoft.Media.MediaGraphAssetSink", + "assetNamePattern": "assetSinkTest", + "inputs": [ + { + "nodeName": "rtspSource", + "outputSelectors": [] + } + ], + "localMediaCacheMaximumSizeMiB": "1024", + "localMediaCachePath": "/tmp/test", + "name": "assetSink", + "segmentLength": "PT30S" + } + ], + "sources": [ + { + "@type": "#Microsoft.Media.MediaGraphRtspSource", + "endpoint": { + "@type": "#Microsoft.Media.MediaGraphUnsecuredEndpoint", + "credentials": { + "@type": "#Microsoft.Media.MediaGraphUsernamePasswordCredentials", + "username": "${rtspUsername}" + }, + "url": "rtsp://testurl.com" + }, + "name": "rtspSource", + "transport": "Tcp" + } + ] + }, + "systemData": { + "createdAt": "2020-06-10T18:54:33.421Z", + "lastModifiedAt": "2020-06-10T18:55:43.901Z" + } + } + } + } +} diff --git a/specification/mediaservices/data-plane/readme.md b/specification/mediaservices/data-plane/readme.md new file mode 100644 index 000000000000..ddf51a816ad0 --- /dev/null +++ b/specification/mediaservices/data-plane/readme.md @@ -0,0 +1,71 @@ +# MediaServices - Live Video Analytics Edge + +> see https://aka.ms/autorest + +This is the AutoRest configuration file for Live video analytics edge. + +--- + +## Getting Started + +To build the SDK for Live video analytics edge, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: + +> `autorest` + +To see additional help and options, run: + +> `autorest --help` + +--- + +## Configuration + +### Basic Information + +These are the global settings for the Live video analytics API. + +``` yaml +openapi-type: data-plane +tag: package-lva-1-0-0-preview +opt-in-extensible-enums: true +``` + +### Tag: package-2018-07 + +These settings apply only when `--tag=package-lva-1-0-0-preview` is specified on the command line. + +``` yaml $(tag) == 'package-lva-1-0-0-preview' +input-file: + - LiveVideoAnalytics.Edge/preview/1.0.0/LiveVideoAnalytics.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-net + after_scripts: + - bundle install && rake arm:regen_all_profiles['azure_media_lva_edge'] +``` + +## C# + +These settings apply only when `--csharp` is specified on the command line. +Please also specify `--csharp-sdks-folder=`. + +``` yaml $(csharp) +csharp: + azure-arm: false + payload-flattening-threshold: 2 + license-header: MICROSOFT_MIT_NO_VERSION + namespace: Azure.Media.LiveVideoAnalytics.Edge + output-folder: $(csharp-sdks-folder)/mediaservices/Azure.Media.LiveVideoAnalytics.Edge/src/Generated + clear-output-folder: true +``` \ No newline at end of file From c3e935ae8322db8aa0e02cddf49d7f6be314be63 Mon Sep 17 00:00:00 2001 From: Ryan W Date: Mon, 29 Jun 2020 19:10:44 -0700 Subject: [PATCH 223/318] Enabling linked delete behavior for Blueprint Assignment (#9969) * Blueprint Assignment can now delete child resources * Added enum values as string * update version on example * Fixing example references in assignment json * Removing abandoned file Co-authored-by: snarkywolverine --- .../blueprintAssignment.json | 21 ++++++++ ...ntAssignment_Delete_AndDeleteChildren.json | 50 +++++++++++++++++++ ...ntAssignment_Delete_AndDeleteChildren.json | 49 ++++++++++++++++++ 3 files changed, 120 insertions(+) create mode 100644 specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPAssignment/BlueprintAssignment_Delete_AndDeleteChildren.json create mode 100644 specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPAssignment/BlueprintAssignment_Delete_AndDeleteChildren.json diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json index 1d3bca28c7a1..fa492a9e78a1 100644 --- a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/blueprintAssignment.json @@ -128,8 +128,14 @@ "Assignment_Delete at subscription scope": { "$ref": "./examples/subscriptionBPAssignment/BlueprintAssignment_Delete.json" }, + "Assignment_Delete at subscription scope, and delete the resources created by the assignment": { + "$ref": "./examples/subscriptionBPAssignment/BlueprintAssignment_Delete_AndDeleteChildren.json" + }, "Assignment_Delete at management group scope": { "$ref": "./examples/managementGroupBPAssignment/BlueprintAssignment_Delete.json" + }, + "Assignment_Delete at management group scope, and delete the resources created by the assignment": { + "$ref": "./examples/managementGroupBPAssignment/BlueprintAssignment_Delete_AndDeleteChildren.json" } }, "parameters": [ @@ -141,6 +147,21 @@ }, { "$ref": "#/parameters/AssignmentNameParameter" + }, + { + "name": "deleteBehavior", + "in": "query", + "required": false, + "type": "string", + "enum": [ + "none", + "all" + ], + "x-ms-enum": { + "name": "AssignmentDeleteBehavior", + "modelAsString": true + }, + "description": "When deleteBehavior=all, the resources that were created by the blueprint assignment will be deleted." } ], "responses": { diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPAssignment/BlueprintAssignment_Delete_AndDeleteChildren.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPAssignment/BlueprintAssignment_Delete_AndDeleteChildren.json new file mode 100644 index 000000000000..a509fb9f825c --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/managementGroupBPAssignment/BlueprintAssignment_Delete_AndDeleteChildren.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2018-11-01-preview", + "resourceScope": "managementGroups/ContosoOnlineGroup", + "assignmentName": "assignSimpleBlueprint", + "deleteBehavior": "all" + }, + "responses": { + "202": { + "body": { + "identity": { + "type": "SystemAssigned", + "tenantId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "properties": { + "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.", + "provisioningState": "deleting", + "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "storageAccountType": { + "value": "Standard_LRS" + }, + "costCenter": { + "value": "Contoso/Online/Shopping/Production" + }, + "owners": { + "value": [ + "johnDoe@contoso.com", + "johnsteam@contoso.com" + ] + } + }, + "resourceGroups": { + "storageRG": { + "name": "defaultRG", + "location": "eastus" + } + } + }, + "id": "/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint", + "type": "Microsoft.Blueprint/Assignment", + "name": "assignSimpleBlueprint" + } + }, + "204": {} + } +} diff --git a/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPAssignment/BlueprintAssignment_Delete_AndDeleteChildren.json b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPAssignment/BlueprintAssignment_Delete_AndDeleteChildren.json new file mode 100644 index 000000000000..c182f4a9423d --- /dev/null +++ b/specification/blueprint/resource-manager/Microsoft.Blueprint/preview/2018-11-01-preview/examples/subscriptionBPAssignment/BlueprintAssignment_Delete_AndDeleteChildren.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "api-version": "2018-11-01-preview", + "resourceScope": "subscriptions/00000000-0000-0000-0000-000000000000", + "assignmentName": "assignSimpleBlueprint", + "deleteBehavior": "all" + }, + "responses": { + "202": { + "body": { + "identity": { + "type": "SystemAssigned", + "tenantId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "properties": { + "description": "enforce pre-defined simpleBlueprint to this XXXXXXXX subscription.", + "provisioningState": "deleting", + "blueprintId": "/providers/Microsoft.Management/managementGroups/ContosoOnlineGroup/providers/Microsoft.Blueprint/blueprints/simpleBlueprint", + "parameters": { + "storageAccountType": { + "value": "Standard_LRS" + }, + "costCenter": { + "value": "Contoso/Online/Shopping/Production" + }, + "owners": { + "value": [ + "johnDoe@contoso.com", + "johnsteam@contoso.com" + ] + } + }, + "resourceGroups": { + "storageRG": { + "name": "defaultRG", + "location": "eastus" + } + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.Blueprint/blueprintAssignments/assignSimpleBlueprint", + "type": "Microsoft.Blueprint/Assignment", + "name": "assignSimpleBlueprint" + } + }, + "204": {} + } +} From a19b5afd8095a75fb77724ffef25b75735972c61 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Tue, 30 Jun 2020 11:20:26 +0800 Subject: [PATCH 224/318] Add api-version 2020-03-13 of search for go SDK (#9985) --- specification/search/resource-manager/readme.go.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/specification/search/resource-manager/readme.go.md b/specification/search/resource-manager/readme.go.md index 0c4e0350036e..6c95fee02859 100644 --- a/specification/search/resource-manager/readme.go.md +++ b/specification/search/resource-manager/readme.go.md @@ -13,10 +13,20 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-03 - tag: package-2015-08 - tag: package-2015-02 ``` +### Tag: package-2020-03 and go + +These settings apply only when `--tag=package-2020-03 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-03' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-03-13/$(namespace) +``` + ### Tag: package-2015-08 and go These settings apply only when `--tag=package-2015-08 --go` is specified on the command line. From 60285ace05fe0d519e90dddbf75841572acbaa3d Mon Sep 17 00:00:00 2001 From: Esha Parmar Date: Mon, 29 Jun 2020 20:20:50 -0700 Subject: [PATCH 225/318] add new properties to the swagger spec (#9957) --- ...eOrUpdateGuestConfigurationAssignment.json | 104 ++ ...pdateGuestConfigurationHCRPAssignment.json | 104 ++ .../deleteGuestConfigurationAssignment.json | 12 + ...eleteGuestConfigurationHCRPAssignment.json | 12 + .../getGuestConfigurationAssignment.json | 36 + ...uestConfigurationAssignmentReportById.json | 95 ++ .../getGuestConfigurationHCRPAssignment.json | 36 + ...ConfigurationHCRPAssignmentReportById.json | 95 ++ ...llGuestConfigurationAssignmentReports.json | 60 + ...estConfigurationHCRPAssignmentReports.json | 60 + .../listGuestConfigurationAssignments.json | 59 + ...listGuestConfigurationHCRPAssignments.json | 59 + .../2020-06-25/examples/listOperations.json | 54 + .../stable/2020-06-25/guestconfiguration.json | 1285 +++++++++++++++++ .../resource-manager/readme.md | 12 +- 15 files changed, 2082 insertions(+), 1 deletion(-) create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/deleteGuestConfigurationAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/deleteGuestConfigurationHCRPAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationAssignmentReportById.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationHCRPAssignment.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationHCRPAssignmentReportById.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listAllGuestConfigurationAssignmentReports.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listAllGuestConfigurationHCRPAssignmentReports.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listGuestConfigurationAssignments.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listGuestConfigurationHCRPAssignments.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listOperations.json create mode 100644 specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationAssignment.json new file mode 100644 index 000000000000..a76baeaef767 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationAssignment.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "WhitelistedApplication", + "api-version": "2020-06-25", + "parameters": { + "location": "westcentralus", + "name": "WhitelistedApplication", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "WhitelistedApplication", + "version": "1.*", + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/WhitelistedApplication", + "name": "WhitelistedApplication", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "WhitelistedApplication", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/WhitelistedApplication", + "name": "WhitelistedApplication", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": null, + "latestReportId": null, + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "WhitelistedApplication", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..bf76cff48d05 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/createOrUpdateGuestConfigurationHCRPAssignment.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "WhitelistedApplication", + "api-version": "2020-06-25", + "parameters": { + "location": "westcentralus", + "name": "WhitelistedApplication", + "properties": { + "context": "Azure policy", + "guestConfiguration": { + "name": "WhitelistedApplication", + "version": "1.*", + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + } + } + } + }, + "responses": { + "201": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/HybridRP.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/WhitelistedApplication", + "name": "WhitelistedApplication", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": "abcdr453g", + "latestReportId": "a2a64e5d-a1a9-4344-a866-fb9e1541f723", + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "WhitelistedApplication", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + }, + "provisioningState": "Succeeded" + } + } + }, + "200": { + "headers": {}, + "body": { + "location": "westcentralus", + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/HybridRP.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/WhitelistedApplication", + "name": "WhitelistedApplication", + "properties": { + "complianceStatus": "Pending", + "assignmentHash": "abcdr453g", + "latestReportId": "a2a64e5d-a1a9-4344-a866-fb9e1541f723", + "lastComplianceStatusChecked": null, + "context": "Azure policy", + "guestConfiguration": { + "kind": null, + "name": "WhitelistedApplication", + "version": "1.0.0.3", + "contentUri": null, + "contentHash": null, + "configurationParameter": [ + { + "name": "[InstalledApplication]bwhitelistedapp;Name", + "value": "NotePad,sql" + } + ], + "configurationSetting": { + "rebootIfNeeded": "False", + "actionAfterReboot": "ContinueConfiguration", + "configurationModeFrequencyMins": 15, + "configurationMode": "MonitorOnly" + } + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/deleteGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/deleteGuestConfigurationAssignment.json new file mode 100644 index 000000000000..c1b7a57adf30 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/deleteGuestConfigurationAssignment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2020-06-25" + }, + "responses": { + "200": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/deleteGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/deleteGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..28efd05339c9 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/deleteGuestConfigurationHCRPAssignment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2020-06-25" + }, + "responses": { + "200": {} + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationAssignment.json new file mode 100644 index 000000000000..697d834134c5 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationAssignment.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2020-06-25" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationAssignmentReportById.json new file mode 100644 index 000000000000..73ad3b873bb8 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myvm", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2020-06-25" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationHCRPAssignment.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationHCRPAssignment.json new file mode 100644 index 000000000000..39d2e06d8ff4 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationHCRPAssignment.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "SecureProtocol", + "api-version": "2020-06-25" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol", + "name": "AuditSecureProtocol", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "E0D8941DD713F284284561648C00C18FA76C8602943C7CD38AFD73B56AE4C35F.E3B0C44298FC1C149AFBF4C8996FB92427AE41E4649B934CA495991B7852B855", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol/AuditSecureProtocol_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationHCRPAssignmentReportById.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationHCRPAssignmentReportById.json new file mode 100644 index 000000000000..6a3a9bfe81ae --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/getGuestConfigurationHCRPAssignmentReportById.json @@ -0,0 +1,95 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "api-version": "2020-06-25" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol", + "version": "1.0.0.0" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": { + "complianceStatus": "Compliant", + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z", + "jobId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "resources": [ + { + "complianceStatus": "Compliant", + "reasons": [ + { + "phrase": "Operation successful.", + "code": "DSC::RESOURCE::SUCCESS" + } + ], + "properties": { + "ConfigurationName": "IsWebServerSecure", + "DependsOn": null, + "IsSingleInstance": "Yes", + "ModuleName": "SecureProtocolWebServer", + "ModuleVersion": "1.0.0.3", + "Protocols": [ + { + "Ensure": "Absent", + "Protocol": "SSL 2.0" + }, + { + "Ensure": "Absent", + "Protocol": "SSL 3.0" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "PCT 1.0" + }, + { + "Ensure": "Absent", + "Protocol": "Multi-Protocol Unified Hello" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.1" + }, + { + "Ensure": "Absent", + "Protocol": "TLS 1.2" + } + ], + "PsDscRunAsCredential": null, + "Reasons": null, + "ResourceId": "[SecureWebServer]s1", + "SourceInfo": null + } + } + ], + "operationType": "Consistency" + }, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listAllGuestConfigurationAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listAllGuestConfigurationAssignmentReports.json new file mode 100644 index 000000000000..807e7142f0e2 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listAllGuestConfigurationAssignmentReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "api-version": "2020-06-25" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listAllGuestConfigurationHCRPAssignmentReports.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listAllGuestConfigurationHCRPAssignmentReports.json new file mode 100644 index 000000000000..4a372181cfcb --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listAllGuestConfigurationHCRPAssignmentReports.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionid", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "guestConfigurationAssignmentName": "AuditSecureProtocol", + "api-version": "2020-06-25" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "name": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T22:13:53Z", + "endTime": "2018-08-29T22:14:13Z" + } + }, + { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol/reports/41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "name": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "properties": { + "complianceStatus": "Compliant", + "assignment": { + "name": "AuditSecureProtocol", + "configuration": { + "name": "AuditSecureProtocol" + } + }, + "reportId": "41ee2caf-48f9-4999-a793-82ec7c6beb2c", + "vm": { + "id": "/subscriptions/mysubscriptionid/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName", + "uuid": "vmuuid" + }, + "details": null, + "startTime": "2018-08-29T20:13:53Z", + "endTime": "2018-08-29T20:14:13Z" + } + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listGuestConfigurationAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listGuestConfigurationAssignments.json new file mode 100644 index 000000000000..132a9d3e2fe4 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listGuestConfigurationAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "vmName": "myVMName", + "api-version": "2020-06-25" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.Compute/virtualMachines/myvm/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listGuestConfigurationHCRPAssignments.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listGuestConfigurationHCRPAssignments.json new file mode 100644 index 000000000000..233b51c01494 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listGuestConfigurationHCRPAssignments.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "mySubscriptionId", + "resourceGroupName": "myResourceGroupName", + "machineName": "myMachineName", + "api-version": "2020-06-25" + }, + "responses": { + "200": { + "headers": {}, + "body": [ + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2", + "name": "AuditSecureProtocol2", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/AuditSecureProtocol2/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "AuditSecureProtocol2", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/AuditSecureProtocol2/AuditSecureProtocol2_1.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + }, + { + "location": "centraluseuap", + "id": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment", + "name": "myAssignment", + "properties": { + "complianceStatus": "Compliant", + "assignmentHash": "content hash", + "latestReportId": "/subscriptions/subscriptionId/resourceGroups/myResourceGroupName/providers/Microsoft.HybridCompute/machines/myMachineName/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/myAssignment/reports/7367cbb8-ae99-47d0-a33b-a283564d2cb1", + "lastComplianceStatusChecked": "2018-08-29T22:14:13Z", + "context": null, + "guestConfiguration": { + "kind": null, + "name": "myAssignment", + "version": "1.0.0.3", + "contentUri": "https://mystorageaccount.blob.core.windows.net/builtinconfig/myAssignment/myAssignment.0.0.3.zip", + "contentHash": "content hash", + "configurationParameter": [], + "configurationSetting": null + }, + "provisioningState": null + } + } + ] + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listOperations.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listOperations.json new file mode 100644 index 000000000000..eb4268a88642 --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/examples/listOperations.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2020-06-25" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/write", + "description": "Create new guest configuration assignment." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/register/action", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Register", + "operation": "Registers the feature for Microsoft.GuestConfiguration.", + "description": "Registers the subscription for the Microsoft.GuestConfiguration resource provider." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/read", + "description": "Get guest configuration assignment." + }, + "properties": null + }, + { + "name": "Microsoft.GuestConfiguration/guestConfigurationAssignments/reports/read", + "display": { + "provider": "Microsoft Guest Configuration", + "resource": "Microsoft.GuestConfiguration/guestConfigurationAssignments", + "operation": "Microsoft.GuestConfiguration/guestConfigurationAssignments/reports/read", + "description": "Get guest configuration assignment report." + }, + "properties": null + } + ] + } + } + } +} diff --git a/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json new file mode 100644 index 000000000000..6aacbd66655b --- /dev/null +++ b/specification/guestconfiguration/resource-manager/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json @@ -0,0 +1,1285 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-06-25", + "title": "GuestConfiguration" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { + "put": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_CreateOrUpdate", + "description": "Creates an association between a VM and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the VM was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the VM was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_Get", + "description": "Get information about a guest configuration assignment", + "x-ms-examples": { + "Get a guest configuration assignment": { + "$ref": "./examples/getGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationAssignments" + ], + "operationId": "GuestConfigurationAssignments_List", + "description": "List all guest configuration assignments for a virtual machine.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listGuestConfigurationAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReports_List", + "description": "List all reports for the guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listAllGuestConfigurationAssignmentReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Compute/virtualMachines/{vmName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}": { + "get": { + "tags": [ + "GuestConfigurationAssignmentReports" + ], + "operationId": "GuestConfigurationAssignmentReports_Get", + "description": "Get a report for the guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine": { + "$ref": "./examples/getGuestConfigurationAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "name": "reportId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/VmNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but VM is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}": { + "put": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_CreateOrUpdate", + "description": "Creates an association between a ARC machine and guest configuration", + "x-ms-examples": { + "Create or update guest configuration assignment": { + "$ref": "./examples/createOrUpdateGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Parameters supplied to the create or update guest configuration assignment." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created. The guest configuration assignment for the ARC machine was created successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "200": { + "description": "OK. The guest configuration assignment for the ARC machine was updated successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "get": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_Get", + "description": "Get information about a guest configuration assignment", + "x-ms-examples": { + "Get a guest configuration assignment": { + "$ref": "./examples/getGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The guest configuration assignment was returned successfully.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + }, + "delete": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_Delete", + "description": "Delete a guest configuration assignment", + "x-ms-examples": { + "Delete an guest configuration assignment": { + "$ref": "./examples/deleteGuestConfigurationHCRPAssignment.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the guest configuration assignment" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments": { + "get": { + "tags": [ + "GuestConfigurationHCRPAssignments" + ], + "operationId": "GuestConfigurationHCRPAssignments_List", + "description": "List all guest configuration assignments for an ARC machine.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listGuestConfigurationHCRPAssignments.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports": { + "get": { + "tags": [ + "GuestConfigurationAssignmentHCRPReports" + ], + "operationId": "GuestConfigurationHCRPAssignmentReports_List", + "description": "List all reports for the guest configuration assignment, latest report first.", + "x-ms-examples": { + "List all guest configuration assignments for a virtual machine": { + "$ref": "./examples/listAllGuestConfigurationHCRPAssignmentReports.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Reports were returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no reports returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.HybridCompute/machines/{machineName}/providers/Microsoft.GuestConfiguration/guestConfigurationAssignments/{guestConfigurationAssignmentName}/reports/{reportId}": { + "get": { + "tags": [ + "GuestConfigurationAssignmentHCRPReports" + ], + "operationId": "GuestConfigurationHCRPAssignmentReports_Get", + "description": "Get a report for the guest configuration assignment, by reportId.", + "x-ms-examples": { + "Get a guest configuration assignment report by Id for a virtual machine": { + "$ref": "./examples/getGuestConfigurationHCRPAssignmentReportById.json" + } + }, + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "guestConfigurationAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The guest configuration assignment name." + }, + { + "name": "reportId", + "in": "path", + "required": true, + "type": "string", + "description": "The GUID for the guest configuration assignment report." + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/MachineNameParameter" + }, + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. This response is due one of these two reasons: 1. Report was returned successfully 2. Guest configuration assignment was found, but machine is not registered yet, hence no report was returned.", + "schema": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + }, + "/providers/Microsoft.GuestConfiguration/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available GuestConfiguration REST API operations.", + "x-ms-examples": { + "Lists all of the available GuestConfiguration REST API operations": { + "$ref": "./examples/listOperations.json" + } + }, + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "../../common/v1/definitions.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../common/v1/definitions.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "produces": [ + "application/json" + ], + "consumes": [ + "application/json" + ] + } + } + }, + "definitions": { + "GuestConfigurationAssignmentList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuestConfigurationAssignment" + }, + "description": "Result of the list guest configuration assignment operation." + } + }, + "description": "The response of the list guest configuration assignment operation." + }, + "GuestConfigurationAssignment": { + "properties": { + "properties": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/GuestConfigurationAssignmentProperties", + "description": "Properties of the Guest configuration assignment." + } + }, + "allOf": [ + { + "$ref": "../../common/v1/definitions.json#/definitions/ProxyResource" + } + ], + "description": "Guest configuration assignment is an association between a machine and guest configuration." + }, + "GuestConfigurationNavigation": { + "description": "Guest configuration is an artifact that encapsulates DSC configuration and its dependencies. The artifact is a zip file containing DSC configuration (as MOF) and dependent resources and other dependencies like modules.", + "properties": { + "kind": { + "type": "string", + "description": "Kind of the guest configuration. For example:DSC", + "x-ms-enum": { + "name": "kind", + "modelAsString": true + }, + "enum": [ + "DSC" + ] + }, + "name": { + "type": "string", + "description": "Name of the guest configuration." + }, + "version": { + "type": "string", + "description": "Version of the guest configuration." + }, + "contentUri": { + "readOnly": true, + "type": "string", + "description": "Uri of the storage where guest configuration package is uploaded." + }, + "contentHash": { + "readOnly": true, + "type": "string", + "description": "Combined hash of the guest configuration package and configuration parameters." + }, + "configurationParameter": { + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationParameter" + }, + "description": "The configuration parameters for the guest configuration." + }, + "configurationSetting": { + "$ref": "#/definitions/ConfigurationSetting", + "description": "The configuration setting for the guest configuration." + } + } + }, + "ConfigurationParameter": { + "properties": { + "name": { + "type": "string", + "readOnly": false, + "description": "Name of the configuration parameter." + }, + "value": { + "type": "string", + "readOnly": false, + "description": "Value of the configuration parameter." + } + }, + "description": "Represents a configuration parameter." + }, + "ConfigurationSetting": { + "properties": { + "configurationMode": { + "type": "string", + "readOnly": false, + "description": "Specifies how the LCM(Local Configuration Manager) actually applies the configuration to the target nodes. Possible values are ApplyOnly, ApplyAndMonitor, and ApplyAndAutoCorrect.", + "x-ms-enum": { + "name": "configurationMode", + "modelAsString": true + }, + "enum": [ + "ApplyOnly", + "ApplyAndMonitor", + "ApplyAndAutoCorrect" + ] + }, + "allowModuleOverwrite": { + "type": "string", + "description": "If true - new configurations downloaded from the pull service are allowed to overwrite the old ones on the target node. Otherwise, false", + "x-ms-enum": { + "name": "allowModuleOverwrite", + "modelAsString": true + }, + "enum": [ + "True", + "False" + ] + }, + "actionAfterReboot": { + "type": "string", + "readOnly": false, + "description": "Specifies what happens after a reboot during the application of a configuration. The possible values are ContinueConfiguration and StopConfiguration", + "x-ms-enum": { + "name": "actionAfterReboot", + "modelAsString": true + }, + "enum": [ + "ContinueConfiguration", + "StopConfiguration" + ] + }, + "refreshFrequencyMins": { + "type": "number", + "readOnly": false, + "default": 30, + "description": "The time interval, in minutes, at which the LCM checks a pull service to get updated configurations. This value is ignored if the LCM is not configured in pull mode. The default value is 30." + }, + "rebootIfNeeded": { + "type": "string", + "readOnly": false, + "default": "False", + "description": "Set this to true to automatically reboot the node after a configuration that requires reboot is applied. Otherwise, you will have to manually reboot the node for any configuration that requires it. The default value is false. To use this setting when a reboot condition is enacted by something other than DSC (such as Windows Installer), combine this setting with the xPendingReboot module.", + "x-ms-enum": { + "name": "rebootIfNeeded", + "modelAsString": true + }, + "enum": [ + "True", + "False" + ] + }, + "configurationModeFrequencyMins": { + "type": "number", + "readOnly": false, + "default": 15, + "description": "How often, in minutes, the current configuration is checked and applied. This property is ignored if the ConfigurationMode property is set to ApplyOnly. The default value is 15." + } + }, + "description": "Configuration setting of LCM (Local Configuration Manager)." + }, + "AssignmentReport": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "ARM resource id of the report for the guest configuration assignment." + }, + "reportId": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "assignment": { + "$ref": "#/definitions/AssignmentInfo", + "description": "Configuration details of the guest configuration assignment." + }, + "vm": { + "$ref": "#/definitions/VMInfo", + "description": "Information about the VM." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "Type of report, Consistency or Initial", + "x-ms-enum": { + "name": "type", + "modelAsString": true + }, + "enum": [ + "Consistency", + "Initial" + ] + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResource" + }, + "description": "The list of resources for which guest configuration assignment compliance is checked." + } + } + }, + "GuestConfigurationAssignmentProperties": { + "properties": { + "targetResourceId": { + "type": "string", + "readOnly": true, + "description": "VM resource Id.", + "x-nullable": true + }, + "guestConfiguration": { + "$ref": "#/definitions/GuestConfigurationNavigation", + "description": "The guest configuration to assign." + }, + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "lastComplianceStatusChecked": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Date and time when last compliance status was checked.", + "x-nullable": true + }, + "latestReportId": { + "type": "string", + "readOnly": true, + "description": "Id of the latest report for the guest configuration assignment. ", + "x-nullable": true + }, + "latestAssignmentReport": { + "$ref": "#/definitions/AssignmentReport", + "description": "Last reported guest configuration assignment report." + }, + "context": { + "type": "string", + "description": "The source which initiated the guest configuration assignment. Ex: Azure Policy" + }, + "assignmentHash": { + "type": "string", + "readOnly": true, + "description": "Combined hash of the configuration package and parameters.", + "x-nullable": true + }, + "provisioningState": { + "readOnly": true, + "type": "string", + "description": "The provisioning state, which only appears in the response.", + "x-nullable": true, + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true + }, + "enum": [ + "Succeeded", + "Failed", + "Canceled", + "Created" + ] + } + }, + "description": "Guest configuration assignment properties." + }, + "GuestConfigurationAssignmentReportList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/GuestConfigurationAssignmentReport" + }, + "description": "List of reports for the guest configuration. Report contains information such as compliance status, reason and more." + } + }, + "description": "List of guest configuration assignment reports." + }, + "GuestConfigurationAssignmentReport": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "ARM resource id of the report for the guest configuration assignment." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "properties": { + "$ref": "#/definitions/GuestConfigurationAssignmentReportProperties", + "description": "Properties of the guest configuration report." + } + }, + "description": "Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more." + }, + "GuestConfigurationAssignmentReportProperties": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "reportId": { + "type": "string", + "readOnly": true, + "description": "GUID that identifies the guest configuration assignment report under a subscription, resource group." + }, + "assignment": { + "$ref": "#/definitions/AssignmentInfo", + "description": "Configuration details of the guest configuration assignment." + }, + "vm": { + "$ref": "#/definitions/VMInfo", + "description": "Information about the VM." + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "details": { + "$ref": "#/definitions/AssignmentReportDetails", + "description": "Details of the assignment report.", + "x-nullable": true + } + }, + "description": "Report for the guest configuration assignment. Report contains information such as compliance status, reason, and more." + }, + "AssignmentInfo": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the guest configuration assignment." + }, + "configuration": { + "$ref": "#/definitions/ConfigurationInfo", + "description": "Information about the configuration." + } + }, + "description": "Information about the guest configuration assignment." + }, + "VMInfo": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id of the VM." + }, + "uuid": { + "type": "string", + "readOnly": true, + "description": "UUID(Universally Unique Identifier) of the VM." + } + }, + "description": "Information about the VM." + }, + "ConfigurationInfo": { + "properties": { + "name": { + "type": "string", + "readOnly": true, + "description": "Name of the configuration." + }, + "version": { + "type": "string", + "readOnly": true, + "description": "Version of the configuration." + } + }, + "description": "Information about the configuration." + }, + "AssignmentReportDetails": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "startTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "Start date and time of the guest configuration assignment compliance status check." + }, + "endTime": { + "type": "string", + "format": "date-time", + "readOnly": true, + "description": "End date and time of the guest configuration assignment compliance status check." + }, + "jobId": { + "type": "string", + "readOnly": true, + "description": "GUID of the report." + }, + "operationType": { + "type": "string", + "readOnly": true, + "description": "Type of report, Consistency or Initial", + "x-ms-enum": { + "name": "type", + "modelAsString": true + }, + "enum": [ + "Consistency", + "Initial" + ] + }, + "resources": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResource" + }, + "description": "The list of resources for which guest configuration assignment compliance is checked." + } + }, + "description": "Details of the guest configuration assignment report." + }, + "AssignmentReportResource": { + "properties": { + "complianceStatus": { + "type": "string", + "readOnly": true, + "description": "A value indicating compliance status of the machine for the assigned guest configuration.", + "x-ms-enum": { + "name": "complianceStatus", + "modelAsString": true + }, + "enum": [ + "Compliant", + "NonCompliant", + "Pending" + ] + }, + "reasons": { + "type": "array", + "items": { + "$ref": "#/definitions/AssignmentReportResourceComplianceReason" + }, + "description": "Compliance reason and reason code for a resource." + }, + "properties": { + "type": "object", + "readOnly": true, + "description": "Properties of a guest configuration assignment resource." + } + }, + "description": "The guest configuration assignment resource." + }, + "AssignmentReportResourceComplianceReason": { + "properties": { + "phrase": { + "type": "string", + "readOnly": true, + "description": "Reason for the compliance of the guest configuration assignment resource." + }, + "code": { + "type": "string", + "readOnly": true, + "description": "Code for the compliance of the guest configuration assignment resource." + } + }, + "description": "Reason and code for the compliance of the guest configuration assignment resource." + } + }, + "parameters": {} +} diff --git a/specification/guestconfiguration/resource-manager/readme.md b/specification/guestconfiguration/resource-manager/readme.md index 8c7d94f58edd..2a96dbda74b9 100644 --- a/specification/guestconfiguration/resource-manager/readme.md +++ b/specification/guestconfiguration/resource-manager/readme.md @@ -28,7 +28,16 @@ These are the global settings for the Guest Configuration API. title: GuestConfigurationClient description: Guest Configuration Client openapi-type: arm -tag: package-2018-11-20 +tag: package-2020-06-25 +``` + +### Tag: package-2020-06-25 + +These settings apply only when `--tag=package-2020-06-25` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06-25' +input-file: + - Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json ``` ### Tag: package-2018-11-20 @@ -133,6 +142,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.GuestConfiguration/stable/2020-06-25/guestconfiguration.json - $(this-folder)/Microsoft.GuestConfiguration/stable/2018-11-20/guestconfiguration.json - $(this-folder)/Microsoft.GuestConfiguration/preview/2018-06-30-preview/guestconfiguration.json - $(this-folder)/Microsoft.GuestConfiguration/preview/2018-01-20-preview/guestconfiguration.json From 1a487ce6d19f040171d62cdf5d39686bc81b1cbd Mon Sep 17 00:00:00 2001 From: Tanyi Chen Date: Tue, 30 Jun 2020 11:21:40 +0800 Subject: [PATCH 226/318] update cdn java md (#9991) --- .../cdn/resource-manager/readme.java.md | 33 +++++++++++++++---- 1 file changed, 26 insertions(+), 7 deletions(-) diff --git a/specification/cdn/resource-manager/readme.java.md b/specification/cdn/resource-manager/readme.java.md index a007070f0c23..d6d38fa512d1 100644 --- a/specification/cdn/resource-manager/readme.java.md +++ b/specification/cdn/resource-manager/readme.java.md @@ -4,11 +4,30 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) -java: - azure-arm: true - fluent: true - namespace: com.microsoft.azure.management.cdn - license-header: MICROSOFT_MIT_NO_CODEGEN - payload-flattening-threshold: 1 - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-cdn +azure-arm: true +fluent: true +namespace: com.microsoft.azure.management.cdn +license-header: MICROSOFT_MIT_NO_CODEGEN +payload-flattening-threshold: 1 +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-cdn +``` + +### Java multi-api + +``` yaml $(java) && $(multiapi) +batch: + - tag: package-2020-04 ``` + +### Tag: package-2020-04 and java + +These settings apply only when `--tag=package-2020-04 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-04' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.cdn.v2020_04_15 + output-folder: $(azure-libraries-for-java-folder)/sdk/cdn/mgmt-v2020_04_15 +regenerate-manager: true +generate-interface: true +``` \ No newline at end of file From 2e3a8082cbf34602fcf8e544618d57b6d1399d2f Mon Sep 17 00:00:00 2001 From: chetmaddula <57730350+chetmaddula@users.noreply.github.com> Date: Mon, 29 Jun 2020 20:23:33 -0700 Subject: [PATCH 227/318] Fixing few properties for DiskRP Api Version 2020-05-01 (#9937) --- .../Microsoft.Compute/stable/2020-05-01/disk.json | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/disk.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/disk.json index 8871f4d6f77e..7aecfefdf14d 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/disk.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-05-01/disk.json @@ -1849,7 +1849,7 @@ "values": [ { "value": "EncryptionAtRestWithPlatformKey", - "description": "Disk is encrypted at rest with Platform managed key. It is the default encryption type." + "description": "Disk is encrypted at rest with Platform managed key. It is the default encryption type. This is not a valid encryption type for disk encryption sets." }, { "value": "EncryptionAtRestWithCustomerKey", @@ -2002,6 +2002,9 @@ }, "DiskEncryptionSetUpdateProperties": { "properties": { + "encryptionType": { + "$ref": "#/definitions/EncryptionType" + }, "activeKey": { "$ref": "#/definitions/KeyVaultAndKeyReference" } From 7f857993dbe9979af344606a28cc7b1f9a6cfeb6 Mon Sep 17 00:00:00 2001 From: changlong-liu <59815250+changlong-liu@users.noreply.github.com> Date: Tue, 30 Jun 2020 13:14:49 +0800 Subject: [PATCH 228/318] Revert "disable create/delete/update (#9950)" (#9993) This reverts commit bd1854c16aa96980fa7cc520cd49e0e36e2f9ac2. --- .../guestconfiguration/resource-manager/readme.az.md | 4 +--- 1 file changed, 1 insertion(+), 3 deletions(-) diff --git a/specification/guestconfiguration/resource-manager/readme.az.md b/specification/guestconfiguration/resource-manager/readme.az.md index 3041965528d8..319a17cc5022 100644 --- a/specification/guestconfiguration/resource-manager/readme.az.md +++ b/specification/guestconfiguration/resource-manager/readme.az.md @@ -17,7 +17,5 @@ cli: prop: 'properties' flatten: true - - where: - op: 'CreateOrUpdate#Create|Delete|CreateOrUpdate#Update' - hidden: true + ``` From e917ed8c8c5d5b3d1c3f844f17788e6192122cb1 Mon Sep 17 00:00:00 2001 From: xichen Date: Tue, 30 Jun 2020 13:49:10 +0800 Subject: [PATCH 229/318] create individal file for python readme (#9994) Co-authored-by: xichen --- .../iotcentral/resource-manager/readme.md | 29 ------------------- .../resource-manager/readme.python.md | 28 ++++++++++++++++++ 2 files changed, 28 insertions(+), 29 deletions(-) create mode 100644 specification/iotcentral/resource-manager/readme.python.md diff --git a/specification/iotcentral/resource-manager/readme.md b/specification/iotcentral/resource-manager/readme.md index f1677b8b592c..0e236fbb0bbc 100644 --- a/specification/iotcentral/resource-manager/readme.md +++ b/specification/iotcentral/resource-manager/readme.md @@ -131,35 +131,6 @@ regenerate-manager: true generate-interface: true ``` -## Python - -These settings apply only when `--python` is specified on the command line. -Please also specify `--python-sdks-folder=`. -Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. - -``` yaml $(python) -python-mode: create -python: - azure-arm: true - license-header: MICROSOFT_MIT_NO_VERSION - payload-flattening-threshold: 2 - namespace: azure.mgmt.iotcentral - package-name: azure-mgmt-iotcentral - clear-output-folder: true -``` - -``` yaml $(python) && $(python-mode) == 'update' -python: - no-namespace-folders: true - output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iotcentral/azure/mgmt/iotcentral -``` - -``` yaml $(python) && $(python-mode) == 'create' -python: - basic-setup-py: true - output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iotcentral -``` - ## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. diff --git a/specification/iotcentral/resource-manager/readme.python.md b/specification/iotcentral/resource-manager/readme.python.md new file mode 100644 index 000000000000..af2c1668bc45 --- /dev/null +++ b/specification/iotcentral/resource-manager/readme.python.md @@ -0,0 +1,28 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. +Use `--python-mode=update` if you already have a setup.py and just want to update the code itself. + +``` yaml $(python) +python-mode: create +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + payload-flattening-threshold: 2 + namespace: azure.mgmt.iotcentral + package-name: azure-mgmt-iotcentral + clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iotcentral/azure/mgmt/iotcentral +``` + +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/iothub/azure-mgmt-iotcentral +``` From 02d54c8e6e8282091805f4e01b5d58b33178ff87 Mon Sep 17 00:00:00 2001 From: Jorge Baca <58745759+jorgbaca@users.noreply.github.com> Date: Tue, 30 Jun 2020 00:54:10 -0700 Subject: [PATCH 230/318] Add sql managed instance (#9164) * Adding Microsoft.AzureData/dataControllers (mostly a copy of Microsoft.AzureData/hybridDataManagers) * Fixing issue. * Fixed response body * Use camelCase style * Updated DataControllerResource * Removed invalid format * Adding sqlManagedInstances * Added simple comment. * Adding default responses --- .../preview/2019-07-24-preview/azuredata.json | 924 +++++++++++++++++- .../CreateOrUpdateDataController.json | 41 + .../CreateOrUpdateSqlManagedInstance.json | 41 + .../examples/DeleteDataController.json | 12 + .../examples/DeleteSqlManagedInstance.json | 12 + .../examples/GetDataController.json | 22 + .../examples/GetSqlManagedInstance.json | 22 + .../ListByResourceGroupDataController.json | 35 + ...ListByResourceGroupSqlManagedInstance.json | 35 + .../ListSubscriptionDataController.json | 34 + .../ListSubscriptionSqlManagedInstance.json | 34 + .../examples/UpdateDataController.json | 27 + .../examples/UpdateSqlManagedInstance.json | 24 + 13 files changed, 1238 insertions(+), 25 deletions(-) create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlManagedInstance.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateDataController.json create mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlManagedInstance.json diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json index 86241df72903..9d1a0f4d63c8 100644 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json @@ -568,6 +568,294 @@ } } }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_List", + "summary": "List sqlManagedInstance resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a subscription.": { + "$ref": "./examples/ListSubscriptionSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlManagedInstances": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_ListByResourceGroup", + "description": "Gets all sqlManagedInstances in a resource group.", + "summary": "List sqlManagedInstance resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstanceListResult" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all SQL Instance in a resource group.": { + "$ref": "./examples/ListByResourceGroupSqlManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlManagedInstances/{sqlManagedInstanceName}": { + "get": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Get", + "description": "Retrieves a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "Name of SQL Managed Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a SQL Instance tags.": { + "$ref": "./examples/GetSqlManagedInstance.json" + } + } + }, + "put": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Create", + "description": "Creates or replaces a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "The name of SQL Managed Instances", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Managed Instance to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a SQL Managed Instance tags.": { + "$ref": "./examples/CreateOrUpdateSqlManagedInstance.json" + } + } + }, + "delete": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Delete", + "description": "Deletes a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "The name of Sql Managed Instances", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SQL Managed Instance." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "204": { + "description": "The specified SQL Managed Instance does not exist." + } + }, + "x-ms-examples": { + "Delete a SQL Instance.": { + "$ref": "./examples/DeleteSqlManagedInstance.json" + } + } + }, + "patch": { + "tags": [ + "SqlManagedInstances" + ], + "operationId": "SqlManagedInstances_Update", + "description": "Updates a SQL Managed Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "sqlManagedInstanceName", + "description": "Name of sqlManagedInstance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The SQL Managed Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlManagedInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SqlManagedInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a sql Instance tags.": { + "$ref": "./examples/UpdateSqlManagedInstance.json" + } + } + } + }, "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/sqlInstances": { "get": { "tags": [ @@ -1337,8 +1625,283 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "postgresInstanceName", - "description": "Name of Postgres Instance", + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the Postgres Instance." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "204": { + "description": "The specified Postgres Instance does not exist." + } + }, + "x-ms-examples": { + "Deletes a PostgresInstances.": { + "$ref": "./examples/DeletePostgresInstance.json" + } + } + }, + "patch": { + "tags": [ + "PostgresInstances" + ], + "operationId": "PostgresInstances_Update", + "description": "Updates a postgres Instance resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "name": "parameters", + "in": "body", + "description": "The Postgres Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/PostgresInstanceUpdate" + } + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a postgres Instances tags.": { + "$ref": "./examples/UpdatePostgresInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInSubscription", + "summary": "List dataController resources in the subscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a subscription.": { + "$ref": "./examples/ListSubscriptionDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/dataControllers": { + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_ListInGroup", + "summary": "List dataController resources in the resource group", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/PageOfDataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets all dataControllers in a resource group.": { + "$ref": "./examples/ListByResourceGroupDataController.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/dataControllers/{dataControllerName}": { + "put": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Updates a dataControllers tags.": { + "$ref": "./examples/CreateOrUpdateDataController.json" + } + } + }, + "delete": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + { + "$ref": "#/parameters/apiVersion" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the DataController." + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" + } + }, + "204": { + "description": "The specified DataController does not exist." + } + }, + "x-ms-examples": { + "Delete a dataController.": { + "$ref": "./examples/DeleteDataController.json" + } + } + }, + "get": { + "tags": [ + "DataControllers" + ], + "operationId": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource", + "parameters": [ + { + "$ref": "#/parameters/subscriptionId" + }, + { + "$ref": "#/parameters/resourceGroupName" + }, + { + "name": "dataControllerName", "in": "path", "required": true, "type": "string", @@ -1350,30 +1913,30 @@ ], "responses": { "200": { - "description": "Successfully deleted the Postgres Instance." + "description": "OK", + "schema": { + "$ref": "#/definitions/DataControllerResource" + } }, "default": { "description": "*** Error Responses: ***", "schema": { "$ref": "#/definitions/CloudError" } - }, - "204": { - "description": "The specified Postgres Instance does not exist." } }, "x-ms-examples": { - "Deletes a PostgresInstances.": { - "$ref": "./examples/DeletePostgresInstance.json" + "Updates a dataController tags.": { + "$ref": "./examples/GetDataController.json" } } }, "patch": { "tags": [ - "PostgresInstances" + "DataControllers" ], - "operationId": "PostgresInstances_Update", - "description": "Updates a postgres Instance resource", + "operationId": "DataControllers_PatchDataController", + "description": "Updates a dataController resource", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1382,22 +1945,12 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "postgresInstanceName", - "description": "Name of Postgres Instance", + "name": "dataControllerName", "in": "path", "required": true, "type": "string", "x-ms-parameter-location": "method" }, - { - "name": "parameters", - "in": "body", - "description": "The Postgres Instance.", - "required": true, - "schema": { - "$ref": "#/definitions/PostgresInstanceUpdate" - } - }, { "$ref": "#/parameters/apiVersion" } @@ -1406,7 +1959,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/PostgresInstance" + "$ref": "#/definitions/DataControllerResource" } }, "default": { @@ -1417,8 +1970,8 @@ } }, "x-ms-examples": { - "Updates a postgres Instances tags.": { - "$ref": "./examples/UpdatePostgresInstance.json" + "Updates a dataController tags.": { + "$ref": "./examples/UpdateDataController.json" } } } @@ -2151,6 +2704,261 @@ } } }, + "PageOfDataControllerResource": { + "type": "object", + "properties": { + "value": { + "items": { + "$ref": "#/definitions/DataControllerResource" + }, + "type": "array" + }, + "nextLink": { + "type": "string", + "description": "Link to retrieve next page of results." + } + } + }, + "DataControllerResource": { + "description": "Data controller resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DataControllerProperties", + "description": "The data controller's properties", + "x-ms-client-flatten": true + } + } + }, + "AzureResource": { + "type": "object", + "properties": { + "etag": { + "type": "string" + }, + "id": { + "type": "string" + }, + "kind": { + "type": "string" + }, + "location": { + "type": "string" + }, + "name": { + "type": "string" + }, + "sku": { + "$ref": "#/definitions/ResourceSku" + }, + "tags": { + "additionalProperties": { + "type": "string" + }, + "type": "object" + }, + "type": { + "type": "string" + } + } + }, + "ResourceSku": { + "type": "object", + "properties": { + "capacity": { + "type": "integer", + "format": "int32" + }, + "family": { + "type": "string" + }, + "name": { + "type": "string" + }, + "size": { + "type": "string" + }, + "tier": { + "type": "string" + } + } + }, + "DataControllerProperties": { + "type": "object", + "properties": { + "dataController": { + "$ref": "#/definitions/DataController" + }, + "requestType": { + "$ref": "#/definitions/RequestType" + }, + "uploadRequest": { + "$ref": "#/definitions/UsageUploadRequest" + }, + "uploadResponse": { + "$ref": "#/definitions/UsageUploadResponse" + }, + "handshakeRequest": { + "$ref": "#/definitions/HandshakeRequest" + }, + "handshakeResponse": { + "$ref": "#/definitions/HandshakeResponse" + } + } + }, + "DataController": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "name": { + "type": "string" + }, + "azureResourceType": { + "type": "string" + }, + "subscription": { + "type": "string", + "format": "uuid" + }, + "resourceGroup": { + "type": "string" + }, + "location": { + "type": "string" + } + } + }, + "RequestType": { + "type": "string", + "enum": [ + "Unknown", + "Handshake", + "UsageUpload" + ], + "x-ms-enum": { + "name": "RequestType", + "modelAsString": true + } + }, + "UsageUploadRequest": { + "type": "object", + "properties": { + "exportType": { + "type": "string" + }, + "dataTimestamp": { + "type": "string", + "format": "date-time" + }, + "data": { + "items": { + "$ref": "#/definitions/UsageRecord" + }, + "type": "array" + }, + "signature": { + "type": "string" + } + } + }, + "UsageRecord": { + "type": "object", + "properties": { + "id": { + "type": "string", + "format": "uuid" + }, + "eventSeq": { + "type": "integer", + "format": "int64" + }, + "eventId": { + "type": "string", + "format": "uuid" + }, + "namespace": { + "type": "string" + }, + "type": { + "type": "string" + }, + "subscriptionId": { + "type": "string", + "format": "uuid" + }, + "resourceGroup": { + "type": "string" + }, + "name": { + "type": "string" + }, + "location": { + "type": "string" + }, + "startTime": { + "type": "string", + "format": "date-time" + }, + "endTime": { + "type": "string", + "format": "date-time" + }, + "quantity": { + "type": "number", + "format": "double" + }, + "tags": { + "type": "string" + } + } + }, + "UsageUploadResponse": { + "type": "object", + "properties": { + "usageUploadStatus": { + "$ref": "#/definitions/UsageUploadStatus" + }, + "usageWaterMark": { + "type": "integer", + "format": "int64" + } + } + }, + "UsageUploadStatus": { + "type": "string", + "enum": [ + "Unknown", + "Failed", + "PartialSuccess", + "Completed" + ], + "x-ms-enum": { + "name": "UsageUploadStatus", + "modelAsString": true + } + }, + "HandshakeRequest": { + "type": "object" + }, + "HandshakeResponse": { + "type": "object", + "properties": { + "usageUploadUrl": { + "type": "string" + }, + "usageResultUrl": { + "type": "string" + } + } + }, "PostgresInstanceProperties": { "description": "Postgres Instance properties.", "type": "object", @@ -2224,6 +3032,16 @@ } } }, + "SqlManagedInstanceProperties": { + "description": "Properties of sqlManagedInstance.", + "type": "object", + "properties": { + "dataControllerId": { + "type": "string", + "description": "null" + } + } + }, "SqlInstance": { "description": "A SqlInstance.", "type": "object", @@ -2240,6 +3058,22 @@ } } }, + "SqlManagedInstance": { + "description": "A SqlManagedInstance.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SqlManagedInstanceProperties", + "description": "null", + "x-ms-client-flatten": true + } + } + }, "SqlInstanceUpdate": { "description": "An update to a SQL Instance.", "type": "object", @@ -2253,6 +3087,19 @@ } } }, + "SqlManagedInstanceUpdate": { + "description": "An update to a SQL Managed Instance.", + "type": "object", + "properties": { + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, "SqlInstanceListResult": { "description": "A list of SqlInstance.", "type": "object", @@ -2272,6 +3119,25 @@ } } }, + "SqlManagedInstanceListResult": { + "description": "A list of SqlManagedInstance.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlManagedInstance" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, "SqlServerInstanceProperties": { "description": "Properties of SqlServerInstance.", "type": "object", @@ -2563,6 +3429,14 @@ "type": "string", "x-ms-parameter-location": "method" }, + "SqlManagedInstanceNameParameter": { + "in": "path", + "name": "sqlManagedInstanceName", + "description": "The name of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, "SqlServerInstanceNameParameter": { "in": "path", "name": "sqlServerInstanceName", diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateDataController.json new file mode 100644 index 000000000000..8716f33d8c6b --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateDataController.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2017-07-24", + "parameters": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureData/dataControllers" + } + }, + "201": { + "body": { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureData/dataControllers" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlManagedInstance.json new file mode 100644 index 000000000000..0e4e37dabc79 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlManagedInstance.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2017-07-24", + "parameters": { + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "properties": {} + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureData/sqlManagedInstances" + } + }, + "201": { + "body": { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureData/sqlManagedInstances" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteDataController.json new file mode 100644 index 000000000000..386d1034d97c --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteDataController.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2017-07-24" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlManagedInstance.json new file mode 100644 index 000000000000..9bfc6d45587d --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlManagedInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2017-07-24" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetDataController.json new file mode 100644 index 000000000000..f3e6441b8037 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetDataController.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController", + "api-version": "2017-07-24" + }, + "responses": { + "200": { + "body": { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController", + "name": "testdataController", + "type": "Microsoft.AzureData/dataControllers" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlManagedInstance.json new file mode 100644 index 000000000000..10526e7a311b --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlManagedInstance.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2017-07-24" + }, + "responses": { + "200": { + "body": { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureData/sqlManagedInstance" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupDataController.json new file mode 100644 index 000000000000..4f782efa4071 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupDataController.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2017-07-24" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureData/dataControllers" + }, + { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlManagedInstance.json new file mode 100644 index 000000000000..42e1e2ca7145 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlManagedInstance.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "api-version": "2017-07-24" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureData/sqlManagedInstances" + }, + { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionDataController.json new file mode 100644 index 000000000000..e6d852b80e60 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionDataController.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2017-07-24" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureData/dataControllers" + }, + { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController2", + "name": "testdataController2", + "type": "Microsoft.AzureData/dataControllers" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlManagedInstance.json new file mode 100644 index 000000000000..01135eaff880 --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlManagedInstance.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2017-07-24" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlManagedInstances/sqlManagedInstance1", + "name": "sqlManagedInstances1", + "type": "Microsoft.AzureData/sqlManagedInstances" + }, + { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlManagedInstances/sqlManagedInstance2", + "name": "sqlManagedInstances2", + "type": "Microsoft.AzureData/sqlManagedInstances" + } + ] + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateDataController.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateDataController.json new file mode 100644 index 000000000000..6fc5c473618f --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateDataController.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "dataControllerName": "testdataController1", + "api-version": "2019-07-24", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "location": "northeurope", + "tags": { + "mytag": "myval" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/dataControllers/testdataController1", + "name": "testdataController1", + "type": "Microsoft.AzureData/dataControllers" + } + } + } +} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlManagedInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlManagedInstance.json new file mode 100644 index 000000000000..75e316e4504c --- /dev/null +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlManagedInstance.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "sqlManagedInstanceName": "testsqlManagedInstance", + "api-version": "2017-07-24", + "parameters": { + "tags": { + "mytag": "myval" + } + } + }, + "responses": { + "200": { + "body": { + "properties": {}, + "location": "northeurope", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/sqlManagedInstances/testsqlManagedInstance", + "name": "testsqlManagedInstance", + "type": "Microsoft.AzureData/sqlManagedInstances" + } + } + } +} From 84f0cf052e6bb6db63de50e27924cfe508db0af0 Mon Sep 17 00:00:00 2001 From: Rodge Fu Date: Tue, 30 Jun 2020 18:26:45 +0800 Subject: [PATCH 231/318] add cli codegen readme files (#9980) --- .../resource-manager/readme.az.md | 15 +++++++++++ .../resource-manager/readme.cli.md | 5 ++++ .../resource-manager/readme.md | 1 + .../resource-manager/readme.python.md | 25 +++++++++++++++++++ 4 files changed, 46 insertions(+) create mode 100644 specification/managementgroups/resource-manager/readme.az.md create mode 100644 specification/managementgroups/resource-manager/readme.cli.md create mode 100644 specification/managementgroups/resource-manager/readme.python.md diff --git a/specification/managementgroups/resource-manager/readme.az.md b/specification/managementgroups/resource-manager/readme.az.md new file mode 100644 index 000000000000..3b55cd97e24c --- /dev/null +++ b/specification/managementgroups/resource-manager/readme.az.md @@ -0,0 +1,15 @@ +## AZ + +These settings apply only when `--az` is specified on the command line. + +``` yaml $(az) +az: + extensions: managementgroup + namespace: azure.mgmt.managementgroup + package-name: azure-mgmt-managementgroup + client-subscription-bound: false + client-base-url-bound: true +az-output-folder: $(azure-cli-extension-folder)/src/managementgroup +python-sdk-output-folder: "$(az-output-folder)/azext_managementgroup/vendored_sdks/managementgroup" + +``` diff --git a/specification/managementgroups/resource-manager/readme.cli.md b/specification/managementgroups/resource-manager/readme.cli.md new file mode 100644 index 000000000000..c41d5e8d8f67 --- /dev/null +++ b/specification/managementgroups/resource-manager/readme.cli.md @@ -0,0 +1,5 @@ + CLI + +These settings apply only when `--cli` is specified on the command line. + + diff --git a/specification/managementgroups/resource-manager/readme.md b/specification/managementgroups/resource-manager/readme.md index a4124506a58a..41ca9a5ef605 100644 --- a/specification/managementgroups/resource-manager/readme.md +++ b/specification/managementgroups/resource-manager/readme.md @@ -92,6 +92,7 @@ swagger-to-sdk: - repo: azure-sdk-for-go - repo: azure-sdk-for-js - repo: azure-sdk-for-node + - repo: azure-cli-extensions ``` ## C# diff --git a/specification/managementgroups/resource-manager/readme.python.md b/specification/managementgroups/resource-manager/readme.python.md new file mode 100644 index 000000000000..e7723a3f525c --- /dev/null +++ b/specification/managementgroups/resource-manager/readme.python.md @@ -0,0 +1,25 @@ +## Python + +These settings apply only when `--python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +```yaml $(python) +python: + azure-arm: true + license-header: MICROSOFT_MIT_NO_VERSION + namespace: azure.mgmt.managementgroup + package-name: azure-mgmt-managementgroup + package-version: 2019-05-01 + clear-output-folder: true +``` + +``` yaml $(python) && $(python-mode) == 'update' +python: + no-namespace-folders: true + output-folder: $(python-sdks-folder)/managementgroup/azure-mgmt-managementgroup/azure/mgmt/managementgroup +``` +``` yaml $(python) && $(python-mode) == 'create' +python: + basic-setup-py: true + output-folder: $(python-sdks-folder)/managementgroup/azure-mgmt-managementgroup +``` \ No newline at end of file From 5cf2f8a63762eb9c8d11e71deb0d5e3b1808731b Mon Sep 17 00:00:00 2001 From: giakas Date: Tue, 30 Jun 2020 08:32:54 -0700 Subject: [PATCH 232/318] update the lva version and few C# autorest parameters (#9990) --- .../preview/{1.0.0 => 1.0}/LiveVideoAnalytics.json | 2 +- .../preview/{1.0.0 => 1.0}/examples/GraphInstanceDelete.json | 0 .../preview/{1.0.0 => 1.0}/examples/GraphInstanceGet.json | 0 .../preview/{1.0.0 => 1.0}/examples/GraphInstanceList.json | 0 .../preview/{1.0.0 => 1.0}/examples/GraphInstanceSet.json | 0 .../{1.0.0 => 1.0}/examples/GraphInstanceStateChange.json | 0 .../preview/{1.0.0 => 1.0}/examples/GraphTopologyDelete.json | 0 .../preview/{1.0.0 => 1.0}/examples/GraphTopologyGet.json | 0 .../preview/{1.0.0 => 1.0}/examples/GraphTopologyList.json | 0 .../preview/{1.0.0 => 1.0}/examples/GraphTopologySet.json | 0 specification/mediaservices/data-plane/readme.md | 5 ++++- 11 files changed, 5 insertions(+), 2 deletions(-) rename specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/{1.0.0 => 1.0}/LiveVideoAnalytics.json (99%) rename specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/{1.0.0 => 1.0}/examples/GraphInstanceDelete.json (100%) rename specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/{1.0.0 => 1.0}/examples/GraphInstanceGet.json (100%) rename specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/{1.0.0 => 1.0}/examples/GraphInstanceList.json (100%) rename specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/{1.0.0 => 1.0}/examples/GraphInstanceSet.json (100%) rename specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/{1.0.0 => 1.0}/examples/GraphInstanceStateChange.json (100%) rename specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/{1.0.0 => 1.0}/examples/GraphTopologyDelete.json (100%) rename specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/{1.0.0 => 1.0}/examples/GraphTopologyGet.json (100%) rename specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/{1.0.0 => 1.0}/examples/GraphTopologyList.json (100%) rename specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/{1.0.0 => 1.0}/examples/GraphTopologySet.json (100%) diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/LiveVideoAnalytics.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json similarity index 99% rename from specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/LiveVideoAnalytics.json rename to specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json index 67ce9df2dfcb..25871e18d840 100644 --- a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/LiveVideoAnalytics.json +++ b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json @@ -2,7 +2,7 @@ "swagger": "2.0", "info": { "description": "Direct Methods for Live Video Analytics on IoT Edge.", - "version": "1.0.0", + "version": "1.0", "title": "Direct Methods for Live Video Analytics on IoT Edge", "contact": { "email": "amshelp@microsoft.com" diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceDelete.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceDelete.json similarity index 100% rename from specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceDelete.json rename to specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceDelete.json diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceGet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceGet.json similarity index 100% rename from specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceGet.json rename to specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceGet.json diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceList.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceList.json similarity index 100% rename from specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceList.json rename to specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceList.json diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceSet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceSet.json similarity index 100% rename from specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceSet.json rename to specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceSet.json diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceStateChange.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceStateChange.json similarity index 100% rename from specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphInstanceStateChange.json rename to specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphInstanceStateChange.json diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyDelete.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyDelete.json similarity index 100% rename from specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyDelete.json rename to specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyDelete.json diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyGet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyGet.json similarity index 100% rename from specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyGet.json rename to specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyGet.json diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyList.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyList.json similarity index 100% rename from specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologyList.json rename to specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologyList.json diff --git a/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologySet.json b/specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologySet.json similarity index 100% rename from specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0.0/examples/GraphTopologySet.json rename to specification/mediaservices/data-plane/LiveVideoAnalytics.Edge/preview/1.0/examples/GraphTopologySet.json diff --git a/specification/mediaservices/data-plane/readme.md b/specification/mediaservices/data-plane/readme.md index ddf51a816ad0..47663592b1e0 100644 --- a/specification/mediaservices/data-plane/readme.md +++ b/specification/mediaservices/data-plane/readme.md @@ -36,7 +36,7 @@ These settings apply only when `--tag=package-lva-1-0-0-preview` is specified on ``` yaml $(tag) == 'package-lva-1-0-0-preview' input-file: - - LiveVideoAnalytics.Edge/preview/1.0.0/LiveVideoAnalytics.json + - LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json ``` --- @@ -68,4 +68,7 @@ csharp: namespace: Azure.Media.LiveVideoAnalytics.Edge output-folder: $(csharp-sdks-folder)/mediaservices/Azure.Media.LiveVideoAnalytics.Edge/src/Generated clear-output-folder: true + use-internal-constructors: true + override-client-name: LiveVideoAnalyticsEdgeClient + use-datetimeoffset: true ``` \ No newline at end of file From f42e1363f5ef106b7aa033728af0613c5a1229df Mon Sep 17 00:00:00 2001 From: kavskalyan Date: Tue, 30 Jun 2020 08:48:26 -0700 Subject: [PATCH 233/318] CosmosDB - Changes for adding PITR workflow APIs (#9897) * First draft changes for adding PITR workflow APIs * Adding examples * Minor changes to examples * Fixing the example and restore params * Fixing format and readme * Adding the restorable database account API * Adding default responses for new APIs * Fixing error response format * Add Managed Service Identity(MSI) support for ARM Template for Cosmos DB * Fixing format * Adding databases to restore and PR suggestions * Fixing the type at incorrect location * Fix ManagedServiceIdentityType as suggested * Adding the restorable database api without the location input * Managed Service Identity Fix * Renaming restoreParams to restoreParameters * Addressing PR suggestions * Fixing the error response * msi comment fix * fix msi enum type Co-authored-by: xujin-zhang --- .../preview/2020-06-01-preview/cosmos-db.json | 7947 +++++++++++++++++ ...CosmosDBCassandraKeyspaceCreateUpdate.json | 36 + .../CosmosDBCassandraKeyspaceDelete.json | 13 + .../CosmosDBCassandraKeyspaceGet.json | 28 + .../CosmosDBCassandraKeyspaceList.json | 28 + ...osmosDBCassandraKeyspaceThroughputGet.json | 30 + ...osDBCassandraKeyspaceThroughputUpdate.json | 40 + .../CosmosDBCassandraTableCreateUpdate.json | 79 + .../CosmosDBCassandraTableDelete.json | 14 + .../examples/CosmosDBCassandraTableGet.json | 50 + .../examples/CosmosDBCassandraTableList.json | 50 + .../CosmosDBCassandraTableThroughputGet.json | 31 + ...osmosDBCassandraTableThroughputUpdate.json | 39 + ...osmosDBCollectionGetMetricDefinitions.json | 41 + .../CosmosDBCollectionGetMetrics.json | 55 + .../examples/CosmosDBCollectionGetUsages.json | 29 + ...CosmosDBCollectionPartitionGetMetrics.json | 57 + .../CosmosDBCollectionPartitionGetUsages.json | 31 + ...DBCollectionPartitionRegionGetMetrics.json | 58 + ...osmosDBDatabaseAccountCheckNameExists.json | 10 + .../CosmosDBDatabaseAccountCreateMax.json | 169 + .../CosmosDBDatabaseAccountCreateMin.json | 94 + .../CosmosDBDatabaseAccountDelete.json | 12 + ...DatabaseAccountFailoverPriorityChange.json | 24 + .../examples/CosmosDBDatabaseAccountGet.json | 97 + ...DBDatabaseAccountGetMetricDefinitions.json | 39 + .../CosmosDBDatabaseAccountGetMetrics.json | 53 + .../CosmosDBDatabaseAccountGetUsages.json | 27 + .../examples/CosmosDBDatabaseAccountList.json | 97 + ...sDBDatabaseAccountListByResourceGroup.json | 82 + ...BDatabaseAccountListConnectionStrings.json | 13 + ...baseAccountListConnectionStringsMongo.json | 20 + .../CosmosDBDatabaseAccountListKeys.json | 18 + ...smosDBDatabaseAccountListReadOnlyKeys.json | 16 + .../CosmosDBDatabaseAccountOfflineRegion.json | 18 + .../CosmosDBDatabaseAccountOnlineRegion.json | 18 + .../CosmosDBDatabaseAccountPatch.json | 148 + .../CosmosDBDatabaseAccountRegenerateKey.json | 15 + ...smosDBDatabaseAccountRegionGetMetrics.json | 54 + .../CosmosDBDatabaseGetMetricDefinitions.json | 40 + .../examples/CosmosDBDatabaseGetMetrics.json | 54 + .../examples/CosmosDBDatabaseGetUsages.json | 28 + .../CosmosDBGremlinDatabaseCreateUpdate.json | 39 + .../CosmosDBGremlinDatabaseDelete.json | 13 + .../examples/CosmosDBGremlinDatabaseGet.json | 28 + .../examples/CosmosDBGremlinDatabaseList.json | 31 + .../CosmosDBGremlinDatabaseThroughputGet.json | 30 + ...smosDBGremlinDatabaseThroughputUpdate.json | 40 + .../CosmosDBGremlinGraphCreateUpdate.json | 124 + .../examples/CosmosDBGremlinGraphDelete.json | 14 + .../examples/CosmosDBGremlinGraphGet.json | 69 + .../examples/CosmosDBGremlinGraphList.json | 72 + .../CosmosDBGremlinGraphThroughputGet.json | 31 + .../CosmosDBGremlinGraphThroughputUpdate.json | 41 + ...CosmosDBMongoDBCollectionCreateUpdate.json | 71 + .../CosmosDBMongoDBCollectionDelete.json | 14 + .../CosmosDBMongoDBCollectionGet.json | 46 + .../CosmosDBMongoDBCollectionList.json | 46 + ...osmosDBMongoDBCollectionThroughputGet.json | 31 + ...osDBMongoDBCollectionThroughputUpdate.json | 41 + .../CosmosDBMongoDBDatabaseCreateUpdate.json | 36 + .../CosmosDBMongoDBDatabaseDelete.json | 13 + .../examples/CosmosDBMongoDBDatabaseGet.json | 28 + .../examples/CosmosDBMongoDBDatabaseList.json | 28 + .../CosmosDBMongoDBDatabaseThroughputGet.json | 30 + ...smosDBMongoDBDatabaseThroughputUpdate.json | 40 + .../CosmosDBNotebookWorkspaceCreate.json | 23 + .../CosmosDBNotebookWorkspaceDelete.json | 13 + .../CosmosDBNotebookWorkspaceGet.json | 22 + .../CosmosDBNotebookWorkspaceList.json | 25 + ...DBNotebookWorkspaceListConnectionInfo.json | 17 + ...BNotebookWorkspaceRegenerateAuthToken.json | 13 + .../CosmosDBNotebookWorkspaceStart.json | 13 + .../examples/CosmosDBOperationsList.json | 22 + .../CosmosDBPKeyRangeIdGetMetrics.json | 58 + .../CosmosDBPKeyRangeIdRegionGetMetrics.json | 59 + .../CosmosDBPercentileGetMetrics.json | 61 + ...mosDBPercentileSourceTargetGetMetrics.json | 41 + .../CosmosDBPercentileTargetGetMetrics.json | 62 + .../CosmosDBRegionCollectionGetMetrics.json | 56 + .../CosmosDBRestorableDatabaseAccountGet.json | 23 + ...CosmosDBRestorableDatabaseAccountList.json | 36 + ...storableDatabaseAccountNoLocationList.json | 35 + ...sDBRestoreDatabaseAccountCreateUpdate.json | 124 + .../CosmosDBSqlContainerCreateUpdate.json | 124 + .../examples/CosmosDBSqlContainerDelete.json | 14 + .../examples/CosmosDBSqlContainerGet.json | 74 + .../examples/CosmosDBSqlContainerList.json | 74 + .../CosmosDBSqlContainerThroughputGet.json | 31 + .../CosmosDBSqlContainerThroughputUpdate.json | 41 + .../CosmosDBSqlDatabaseCreateUpdate.json | 39 + .../examples/CosmosDBSqlDatabaseDelete.json | 13 + .../examples/CosmosDBSqlDatabaseGet.json | 30 + .../examples/CosmosDBSqlDatabaseList.json | 33 + .../CosmosDBSqlDatabaseThroughputGet.json | 30 + .../CosmosDBSqlDatabaseThroughputUpdate.json | 40 + ...osmosDBSqlStoredProcedureCreateUpdate.json | 39 + .../CosmosDBSqlStoredProcedureDelete.json | 15 + .../CosmosDBSqlStoredProcedureGet.json | 29 + .../CosmosDBSqlStoredProcedureList.json | 32 + .../CosmosDBSqlTriggerCreateUpdate.json | 43 + .../examples/CosmosDBSqlTriggerDelete.json | 15 + .../examples/CosmosDBSqlTriggerGet.json | 31 + .../examples/CosmosDBSqlTriggerList.json | 34 + ...sDBSqlUserDefinedFunctionCreateUpdate.json | 39 + .../CosmosDBSqlUserDefinedFunctionDelete.json | 15 + .../CosmosDBSqlUserDefinedFunctionGet.json | 29 + .../CosmosDBSqlUserDefinedFunctionList.json | 32 + .../examples/CosmosDBTableCreateUpdate.json | 35 + .../examples/CosmosDBTableDelete.json | 13 + .../examples/CosmosDBTableGet.json | 28 + .../examples/CosmosDBTableList.json | 28 + .../examples/CosmosDBTableThroughputGet.json | 30 + .../CosmosDBTableThroughputUpdate.json | 40 + .../preview/2020-06-01-preview/notebook.json | 461 + .../cosmos-db/resource-manager/readme.go.md | 9 + .../cosmos-db/resource-manager/readme.java.md | 13 + .../cosmos-db/resource-manager/readme.md | 14 + 118 files changed, 13028 insertions(+) create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetMetricDefinitions.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetUsages.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionGetUsages.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionRegionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCheckNameExists.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCreateMax.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCreateMin.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetUsages.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListByResourceGroup.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListConnectionStrings.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListKeys.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountOfflineRegion.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountOnlineRegion.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountPatch.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountRegenerateKey.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountRegionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetMetricDefinitions.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetUsages.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceCreate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceStart.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBOperationsList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPKeyRangeIdGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileSourceTargetGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileTargetGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRegionCollectionGetMetrics.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableCreateUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableDelete.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableList.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableThroughputGet.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableThroughputUpdate.json create mode 100644 specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json new file mode 100644 index 000000000000..a73db2e85162 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json @@ -0,0 +1,7947 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2020-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}": { + "get": { + "operationId": "DatabaseAccounts_Get", + "x-ms-examples": { + "CosmosDBDatabaseAccountGet": { + "$ref": "./examples/CosmosDBDatabaseAccountGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The database account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountGetResults" + } + } + } + }, + "patch": { + "operationId": "DatabaseAccounts_Update", + "x-ms-examples": { + "CosmosDBDatabaseAccountPatch": { + "$ref": "./examples/CosmosDBDatabaseAccountPatch.json" + } + }, + "description": "Updates the properties of an existing Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseAccountUpdateParameters" + }, + "description": "The parameters to provide for the current database account." + } + ], + "responses": { + "200": { + "description": "The database account update operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DatabaseAccountGetResults" + } + } + } + }, + "put": { + "operationId": "DatabaseAccounts_CreateOrUpdate", + "x-ms-examples": { + "CosmosDBDatabaseAccountCreateMin": { + "$ref": "./examples/CosmosDBDatabaseAccountCreateMin.json" + }, + "CosmosDBDatabaseAccountCreateMax": { + "$ref": "./examples/CosmosDBDatabaseAccountCreateMax.json" + }, + "CosmosDBRestoreDatabaseAccountCreateUpdate.json": { + "$ref": "./examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json" + } + }, + "description": "Creates or updates an Azure Cosmos DB database account. The \"Update\" method is preferred when performing updates on an account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseAccountCreateUpdateParameters" + }, + "description": "The parameters to provide for the current database account." + } + ], + "responses": { + "200": { + "description": "The database account create or update operation will complete asynchronously.", + "schema": { + "$ref": "#/definitions/DatabaseAccountGetResults" + } + } + } + }, + "delete": { + "operationId": "DatabaseAccounts_Delete", + "x-ms-examples": { + "CosmosDBDatabaseAccountDelete": { + "$ref": "./examples/CosmosDBDatabaseAccountDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The database account delete operation will complete asynchronously." + }, + "204": { + "description": "The specified account does not exist in the subscription." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/failoverPriorityChange": { + "post": { + "operationId": "DatabaseAccounts_FailoverPriorityChange", + "x-ms-examples": { + "CosmosDBDatabaseAccountFailoverPriorityChange": { + "$ref": "./examples/CosmosDBDatabaseAccountFailoverPriorityChange.json" + } + }, + "description": "Changes the failover priority for the Azure Cosmos DB database account. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "failoverParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FailoverPolicies" + }, + "description": "The new failover policies for the database account." + } + ], + "responses": { + "202": { + "description": "Accepted. The failover policy change operation will complete asynchronously." + }, + "204": { + "description": "No Content" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/databaseAccounts": { + "get": { + "operationId": "DatabaseAccounts_List", + "x-ms-examples": { + "CosmosDBDatabaseAccountList": { + "$ref": "./examples/CosmosDBDatabaseAccountList.json" + } + }, + "description": "Lists all the Azure Cosmos DB database accounts available under the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts": { + "get": { + "operationId": "DatabaseAccounts_ListByResourceGroup", + "x-ms-examples": { + "CosmosDBDatabaseAccountListByResourceGroup": { + "$ref": "./examples/CosmosDBDatabaseAccountListByResourceGroup.json" + } + }, + "description": "Lists all the Azure Cosmos DB database accounts available under the given resource group.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listKeys": { + "post": { + "operationId": "DatabaseAccounts_ListKeys", + "x-ms-examples": { + "CosmosDBDatabaseAccountListKeys": { + "$ref": "./examples/CosmosDBDatabaseAccountListKeys.json" + } + }, + "description": "Lists the access keys for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/listConnectionStrings": { + "post": { + "operationId": "DatabaseAccounts_ListConnectionStrings", + "x-ms-examples": { + "CosmosDBDatabaseAccountListConnectionStrings": { + "$ref": "./examples/CosmosDBDatabaseAccountListConnectionStrings.json" + }, + "CosmosDBDatabaseAccountListConnectionStringsMongo": { + "$ref": "./examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json" + } + }, + "description": "Lists the connection strings for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListConnectionStringsResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/offlineRegion": { + "post": { + "operationId": "DatabaseAccounts_OfflineRegion", + "x-ms-examples": { + "CosmosDBDatabaseAccountOfflineRegion": { + "$ref": "./examples/CosmosDBDatabaseAccountOfflineRegion.json" + } + }, + "description": "Offline the specified region for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "regionParameterForOffline", + "in": "body", + "required": true, + "description": "Cosmos DB region to offline for the database account.", + "schema": { + "$ref": "#/definitions/RegionForOnlineOffline" + } + } + ], + "responses": { + "200": { + "description": "The offline region operation is completed successfully." + }, + "202": { + "description": "Accepted. The offline region operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/onlineRegion": { + "post": { + "operationId": "DatabaseAccounts_OnlineRegion", + "x-ms-examples": { + "CosmosDBDatabaseAccountOnlineRegion": { + "$ref": "./examples/CosmosDBDatabaseAccountOnlineRegion.json" + } + }, + "description": "Online the specified region for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "regionParameterForOnline", + "in": "body", + "required": true, + "description": "Cosmos DB region to online for the database account.", + "schema": { + "$ref": "#/definitions/RegionForOnlineOffline" + } + } + ], + "responses": { + "200": { + "description": "The online region operation is completed successfully." + }, + "202": { + "description": "Accepted. The online region operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/readonlykeys": { + "get": { + "operationId": "DatabaseAccounts_GetReadOnlyKeys", + "x-ms-examples": { + "CosmosDBDatabaseAccountListReadOnlyKeys": { + "$ref": "./examples/CosmosDBDatabaseAccountListReadOnlyKeys.json" + } + }, + "description": "Lists the read-only access keys for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListReadOnlyKeysResult" + } + } + } + }, + "post": { + "operationId": "DatabaseAccounts_ListReadOnlyKeys", + "x-ms-examples": { + "CosmosDBDatabaseAccountListReadOnlyKeys": { + "$ref": "./examples/CosmosDBDatabaseAccountListReadOnlyKeys.json" + } + }, + "description": "Lists the read-only access keys for the specified Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/DatabaseAccountListReadOnlyKeysResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/regenerateKey": { + "post": { + "operationId": "DatabaseAccounts_RegenerateKey", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegenerateKey": { + "$ref": "./examples/CosmosDBDatabaseAccountRegenerateKey.json" + } + }, + "description": "Regenerates an access key for the specified Azure Cosmos DB database account.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "keyToRegenerate", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabaseAccountRegenerateKeyParameters" + }, + "description": "The name of the key to regenerate." + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The regenerate key operation will complete asynchronously." + } + } + } + }, + "/providers/Microsoft.DocumentDB/databaseAccountNames/{accountName}": { + "head": { + "operationId": "DatabaseAccounts_CheckNameExists", + "x-ms-examples": { + "CosmosDBDatabaseAccountCheckNameExists": { + "$ref": "./examples/CosmosDBDatabaseAccountCheckNameExists.json" + } + }, + "description": "Checks that the Azure Cosmos DB account name already exists. A valid account name may contain only lowercase letters, numbers, and the '-' character, and must be between 3 and 50 characters.", + "parameters": [ + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The account name is valid but is already in use." + }, + "404": { + "description": "Not Found. The account name is available and valid." + } + } + } + }, + "/providers/Microsoft.DocumentDB/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available Cosmos DB Resource Provider operations.", + "operationId": "Operations_List", + "x-ms-examples": { + "CosmosDBOperationsList": { + "$ref": "./examples/CosmosDBOperationsList.json" + } + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metrics": { + "get": { + "operationId": "DatabaseAccounts_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountGetMetrics": { + "$ref": "./examples/CosmosDBDatabaseAccountGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metrics": { + "get": { + "operationId": "Database_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseGetMetrics": { + "$ref": "./examples/CosmosDBDatabaseGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account and database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metrics": { + "get": { + "operationId": "Collection_ListMetrics", + "x-ms-examples": { + "CosmosDBCollectionGetMetrics": { + "$ref": "./examples/CosmosDBCollectionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account and collection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/metrics": { + "get": { + "operationId": "CollectionRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBRegionCollectionGetMetrics": { + "$ref": "./examples/CosmosDBRegionCollectionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account, collection and region.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/metrics": { + "get": { + "operationId": "DatabaseAccountRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBDatabaseAccountRegionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account and region.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The metrics for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sourceRegion/{sourceRegion}/targetRegion/{targetRegion}/percentile/metrics": { + "get": { + "operationId": "PercentileSourceTarget_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPercentileSourceTargetGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given account, source and target region. This url is only for PBS and Replication Latency data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/sourceRegionParameter" + }, + { + "$ref": "#/parameters/targetRegionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The percentile metrics for the account, source and target regions were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PercentileMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/targetRegion/{targetRegion}/percentile/metrics": { + "get": { + "operationId": "PercentileTarget_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPercentileTargetGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given account target region. This url is only for PBS and Replication Latency data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/targetRegionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The percentile metrics for the account and target regions were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PercentileMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/percentile/metrics": { + "get": { + "operationId": "Percentile_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPercentileGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given database account. This url is only for PBS and Replication Latency data", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The percentile metrics for the account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PercentileMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics": { + "get": { + "operationId": "CollectionPartitionRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBCollectionPartitionRegionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given collection and region, split by partition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the collection and region were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/metrics": { + "get": { + "operationId": "CollectionPartition_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBCollectionPartitionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given collection, split by partition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the collection were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics": { + "get": { + "operationId": "PartitionKeyRangeId_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPKeyRangeIdGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given partition key range id.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "#/parameters/partitionKeyRangeIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the partition key range id were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/region/{region}/databases/{databaseRid}/collections/{collectionRid}/partitionKeyRangeId/{partitionKeyRangeId}/metrics": { + "get": { + "operationId": "PartitionKeyRangeIdRegion_ListMetrics", + "x-ms-examples": { + "CosmosDBDatabaseAccountRegionGetMetrics": { + "$ref": "./examples/CosmosDBPKeyRangeIdRegionGetMetrics.json" + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "description": "Retrieves the metrics determined by the given filter for the given partition key range id and region.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "#/parameters/partitionKeyRangeIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/filterParameter" + } + ], + "responses": { + "200": { + "description": "The partition-level metrics for the partition key range id and region were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionMetricListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/usages": { + "get": { + "operationId": "DatabaseAccounts_ListUsages", + "x-ms-examples": { + "CosmosDBDatabaseAccountGetUsages": { + "$ref": "./examples/CosmosDBDatabaseAccountGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent data) for the given database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/usages": { + "get": { + "operationId": "Database_ListUsages", + "x-ms-examples": { + "CosmosDBDatabaseGetUsages": { + "$ref": "./examples/CosmosDBDatabaseGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent data) for the given database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the database were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/usages": { + "get": { + "operationId": "Collection_ListUsages", + "x-ms-examples": { + "CosmosDBCollectionGetUsages": { + "$ref": "./examples/CosmosDBCollectionGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent storage data) for the given collection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the collection were retrieved successfully.", + "schema": { + "$ref": "#/definitions/UsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/partitions/usages": { + "get": { + "operationId": "CollectionPartition_ListUsages", + "x-ms-examples": { + "CosmosDBCollectionGetUsages": { + "$ref": "./examples/CosmosDBCollectionPartitionGetUsages.json" + } + }, + "description": "Retrieves the usages (most recent storage data) for the given collection, split by partition.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/usageFilterParameter" + } + ], + "responses": { + "200": { + "description": "The usages for the collection, per partition were retrieved successfully.", + "schema": { + "$ref": "#/definitions/PartitionUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/metricDefinitions": { + "get": { + "operationId": "Database_ListMetricDefinitions", + "x-ms-examples": { + "CosmosDBDatabaseGetMetricDefinitions": { + "$ref": "./examples/CosmosDBDatabaseGetMetricDefinitions.json" + } + }, + "description": "Retrieves metric definitions for the given database.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric definitions for the database were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricDefinitionsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/databases/{databaseRid}/collections/{collectionRid}/metricDefinitions": { + "get": { + "operationId": "Collection_ListMetricDefinitions", + "x-ms-examples": { + "CosmosDBCollectionGetMetricDefinitions": { + "$ref": "./examples/CosmosDBCollectionGetMetricDefinitions.json" + } + }, + "description": "Retrieves metric definitions for the given collection.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseRidParameter" + }, + { + "$ref": "#/parameters/collectionRidParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric definitions for the collection were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricDefinitionsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/metricDefinitions": { + "get": { + "operationId": "DatabaseAccounts_ListMetricDefinitions", + "x-ms-examples": { + "CosmosDBDatabaseAccountGetMetricDefinitions": { + "$ref": "./examples/CosmosDBDatabaseAccountGetMetricDefinitions.json" + } + }, + "description": "Retrieves metric definitions for the given database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The metric definitions for the database account were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MetricDefinitionsListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases": { + "get": { + "operationId": "SqlResources_ListSqlDatabases", + "x-ms-examples": { + "CosmosDBSqlDatabaseList": { + "$ref": "./examples/CosmosDBSqlDatabaseList.json" + } + }, + "description": "Lists the SQL databases under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL database properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}": { + "get": { + "operationId": "SqlResources_GetSqlDatabase", + "x-ms-examples": { + "CosmosDBSqlDatabaseGet": { + "$ref": "./examples/CosmosDBSqlDatabaseGet.json" + } + }, + "description": "Gets the SQL database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL database property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlDatabase", + "x-ms-examples": { + "CosmosDBSqlDatabaseCreateUpdate": { + "$ref": "./examples/CosmosDBSqlDatabaseCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlDatabaseParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlDatabaseCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL database." + } + ], + "responses": { + "202": { + "description": "The SQL database create or update operation will complete asynchronously." + }, + "200": { + "description": "The SQL database create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlDatabaseGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlDatabase", + "x-ms-examples": { + "CosmosDBSqlDatabaseDelete": { + "$ref": "./examples/CosmosDBSqlDatabaseDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL database.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL database delete operation will complete asynchronously." + }, + "204": { + "description": "The SQL database delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/throughputSettings/default": { + "get": { + "operationId": "SqlResources_GetSqlDatabaseThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseThroughputGet": { + "$ref": "./examples/CosmosDBSqlDatabaseThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the SQL database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the SQL database was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_UpdateSqlDatabaseThroughput", + "x-ms-examples": { + "CosmosDBSqlDatabaseThroughputUpdate": { + "$ref": "./examples/CosmosDBSqlDatabaseThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB SQL database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The parameters to provide for the RUs per second of the current SQL database." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the SQL database update operation will complete asynchronously." + }, + "200": { + "description": "The RUs per second of the SQL database update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers": { + "get": { + "operationId": "SqlResources_ListSqlContainers", + "x-ms-examples": { + "CosmosDBSqlContainerList": { + "$ref": "./examples/CosmosDBSqlContainerList.json" + } + }, + "description": "Lists the SQL container under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL container properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlContainerListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}": { + "get": { + "operationId": "SqlResources_GetSqlContainer", + "x-ms-examples": { + "CosmosDBSqlContainerGet": { + "$ref": "./examples/CosmosDBSqlContainerGet.json" + } + }, + "description": "Gets the SQL container under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL container property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlContainerGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlContainer", + "x-ms-examples": { + "CosmosDBSqlContainerCreateUpdate": { + "$ref": "./examples/CosmosDBSqlContainerCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL container", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlContainerParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlContainerCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL container." + } + ], + "responses": { + "202": { + "description": "The SQL container create or update operation will complete asynchronously." + }, + "200": { + "description": "The SQL container create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlContainerGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlContainer", + "x-ms-examples": { + "CosmosDBSqlContainerDelete": { + "$ref": "./examples/CosmosDBSqlContainerDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL container.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL container delete operation will complete asynchronously." + }, + "204": { + "description": "The SQL container delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/throughputSettings/default": { + "get": { + "operationId": "SqlResources_GetSqlContainerThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerThroughputGet": { + "$ref": "./examples/CosmosDBSqlContainerThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the SQL container under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the SQL container was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_UpdateSqlContainerThroughput", + "x-ms-examples": { + "CosmosDBSqlContainerThroughputUpdate": { + "$ref": "./examples/CosmosDBSqlContainerThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB SQL container", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The parameters to provide for the RUs per second of the current SQL container." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the SQL container update operation will complete asynchronously." + }, + "200": { + "description": "The RUs per second of the SQL container update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures": { + "get": { + "operationId": "SqlResources_ListSqlStoredProcedures", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureList": { + "$ref": "./examples/CosmosDBSqlStoredProcedureList.json" + } + }, + "description": "Lists the SQL storedProcedure under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL stored procedure properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlStoredProcedureListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/storedProcedures/{storedProcedureName}": { + "get": { + "operationId": "SqlResources_GetSqlStoredProcedure", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureGet": { + "$ref": "./examples/CosmosDBSqlStoredProcedureGet.json" + } + }, + "description": "Gets the SQL storedProcedure under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/storedProcedureNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL storedProcedure property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlStoredProcedureGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlStoredProcedure", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureCreateUpdate": { + "$ref": "./examples/CosmosDBSqlStoredProcedureCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL storedProcedure", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/storedProcedureNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlStoredProcedureParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlStoredProcedureCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL storedProcedure." + } + ], + "responses": { + "202": { + "description": "The SQL storedProcedure create or update operation will complete asynchronously." + }, + "200": { + "description": "The SQL storedProcedure create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlStoredProcedureGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlStoredProcedure", + "x-ms-examples": { + "CosmosDBSqlStoredProcedureDelete": { + "$ref": "./examples/CosmosDBSqlStoredProcedureDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL storedProcedure.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/storedProcedureNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL storedProcedure delete operation will complete asynchronously." + }, + "204": { + "description": "The SQL storedProcedure delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions": { + "get": { + "operationId": "SqlResources_ListSqlUserDefinedFunctions", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionList": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionList.json" + } + }, + "description": "Lists the SQL userDefinedFunction under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL userDefinedFunction properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/userDefinedFunctions/{userDefinedFunctionName}": { + "get": { + "operationId": "SqlResources_GetSqlUserDefinedFunction", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionGet": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionGet.json" + } + }, + "description": "Gets the SQL userDefinedFunction under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/userDefinedFunctionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL userDefinedFunction property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlUserDefinedFunction", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionCreateUpdate": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL userDefinedFunction", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/userDefinedFunctionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlUserDefinedFunctionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL userDefinedFunction." + } + ], + "responses": { + "202": { + "description": "The SQL userDefinedFunction create or update operation will complete asynchronously." + }, + "200": { + "description": "The SQL userDefinedFunction create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlUserDefinedFunctionGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlUserDefinedFunction", + "x-ms-examples": { + "CosmosDBSqlUserDefinedFunctionDelete": { + "$ref": "./examples/CosmosDBSqlUserDefinedFunctionDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL userDefinedFunction.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/userDefinedFunctionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL userDefinedFunction delete operation will complete asynchronously." + }, + "204": { + "description": "The SQL userDefinedFunction delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers": { + "get": { + "operationId": "SqlResources_ListSqlTriggers", + "x-ms-examples": { + "CosmosDBSqlTriggerList": { + "$ref": "./examples/CosmosDBSqlTriggerList.json" + } + }, + "description": "Lists the SQL trigger under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL trigger properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlTriggerListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/sqlDatabases/{databaseName}/containers/{containerName}/triggers/{triggerName}": { + "get": { + "operationId": "SqlResources_GetSqlTrigger", + "x-ms-examples": { + "CosmosDBSqlTriggerGet": { + "$ref": "./examples/CosmosDBSqlTriggerGet.json" + } + }, + "description": "Gets the SQL trigger under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/triggerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The SQL trigger property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/SqlTriggerGetResults" + } + } + } + }, + "put": { + "operationId": "SqlResources_CreateUpdateSqlTrigger", + "x-ms-examples": { + "CosmosDBSqlTriggerCreateUpdate": { + "$ref": "./examples/CosmosDBSqlTriggerCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB SQL trigger", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/triggerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateSqlTriggerParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/SqlTriggerCreateUpdateParameters" + }, + "description": "The parameters to provide for the current SQL trigger." + } + ], + "responses": { + "202": { + "description": "The SQL trigger create or update operation will complete asynchronously." + }, + "200": { + "description": "The SQL trigger create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/SqlTriggerGetResults" + } + } + } + }, + "delete": { + "operationId": "SqlResources_DeleteSqlTrigger", + "x-ms-examples": { + "CosmosDBSqlTriggerDelete": { + "$ref": "./examples/CosmosDBSqlTriggerDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB SQL trigger.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/containerNameParameter" + }, + { + "$ref": "#/parameters/triggerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The SQL trigger delete operation will complete asynchronously." + }, + "204": { + "description": "The SQL trigger delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases": { + "get": { + "operationId": "MongoDBResources_ListMongoDBDatabases", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseList": { + "$ref": "./examples/CosmosDBMongoDBDatabaseList.json" + } + }, + "description": "Lists the MongoDB databases under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB database properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBDatabaseListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}": { + "get": { + "operationId": "MongoDBResources_GetMongoDBDatabase", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseGet": { + "$ref": "./examples/CosmosDBMongoDBDatabaseGet.json" + } + }, + "description": "Gets the MongoDB databases under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB database property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBDatabaseGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_CreateUpdateMongoDBDatabase", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseCreateUpdate": { + "$ref": "./examples/CosmosDBMongoDBDatabaseCreateUpdate.json" + } + }, + "description": "Create or updates Azure Cosmos DB MongoDB database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateMongoDBDatabaseParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MongoDBDatabaseCreateUpdateParameters" + }, + "description": "The parameters to provide for the current MongoDB database." + } + ], + "responses": { + "202": { + "description": "The MongoDB database create or update operation will complete asynchronously." + }, + "200": { + "description": "The MongoDB database create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/MongoDBDatabaseGetResults" + } + } + } + }, + "delete": { + "operationId": "MongoDBResources_DeleteMongoDBDatabase", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseDelete": { + "$ref": "./examples/CosmosDBMongoDBDatabaseDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB MongoDB database.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB database delete operation will complete asynchronously." + }, + "204": { + "description": "The MongoDB database delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/throughputSettings/default": { + "get": { + "operationId": "MongoDBResources_GetMongoDBDatabaseThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseThroughputGet": { + "$ref": "./examples/CosmosDBMongoDBDatabaseThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the MongoDB database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the MongoDB database was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_UpdateMongoDBDatabaseThroughput", + "x-ms-examples": { + "CosmosDBMongoDBDatabaseThroughputUpdate": { + "$ref": "./examples/CosmosDBMongoDBDatabaseThroughputUpdate.json" + } + }, + "description": "Update RUs per second of the an Azure Cosmos DB MongoDB database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current MongoDB database." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the MongoDB database update operation will complete asynchronously." + }, + "200": { + "description": "The RUs per second of the MongoDB database update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections": { + "get": { + "operationId": "MongoDBResources_ListMongoDBCollections", + "x-ms-examples": { + "CosmosDBMongoDBCollectionList": { + "$ref": "./examples/CosmosDBMongoDBCollectionList.json" + } + }, + "description": "Lists the MongoDB collection under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB collection properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBCollectionListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}": { + "get": { + "operationId": "MongoDBResources_GetMongoDBCollection", + "x-ms-examples": { + "CosmosDBMongoDBCollectionGet": { + "$ref": "./examples/CosmosDBMongoDBCollectionGet.json" + } + }, + "description": "Gets the MongoDB collection under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The MongoDB collection property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/MongoDBCollectionGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_CreateUpdateMongoDBCollection", + "x-ms-examples": { + "CosmosDBMongoDBCollectionCreateUpdate": { + "$ref": "./examples/CosmosDBMongoDBCollectionCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB MongoDB Collection", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateMongoDBCollectionParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/MongoDBCollectionCreateUpdateParameters" + }, + "description": "The parameters to provide for the current MongoDB Collection." + } + ], + "responses": { + "202": { + "description": "The MongoDB Collection create or update operation will complete asynchronously." + }, + "200": { + "description": "The MongoDB Collection create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/MongoDBCollectionGetResults" + } + } + } + }, + "delete": { + "operationId": "MongoDBResources_DeleteMongoDBCollection", + "x-ms-examples": { + "CosmosDBMongoDBCollectionDelete": { + "$ref": "./examples/CosmosDBMongoDBCollectionDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB MongoDB Collection.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The MongoDB collection delete operation will complete asynchronously." + }, + "204": { + "description": "The MongoDB collection delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/mongodbDatabases/{databaseName}/collections/{collectionName}/throughputSettings/default": { + "get": { + "operationId": "MongoDBResources_GetMongoDBCollectionThroughput", + "x-ms-examples": { + "CosmosDBMongoDBCollectionThroughputGet": { + "$ref": "./examples/CosmosDBMongoDBCollectionThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the MongoDB collection under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the MongoDB collection was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "MongoDBResources_UpdateMongoDBCollectionThroughput", + "x-ms-examples": { + "CosmosDBMongoDBCollectionThroughputUpdate": { + "$ref": "./examples/CosmosDBMongoDBCollectionThroughputUpdate.json" + } + }, + "description": "Update the RUs per second of an Azure Cosmos DB MongoDB collection", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/collectionNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current MongoDB collection." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the MongoDB collection update operation will complete asynchronously." + }, + "200": { + "description": "The RUs per second of the MongoDB collection update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables": { + "get": { + "operationId": "TableResources_ListTables", + "x-ms-examples": { + "CosmosDBTableList": { + "$ref": "./examples/CosmosDBTableList.json" + } + }, + "description": "Lists the Tables under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Table properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/TableListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}": { + "get": { + "operationId": "TableResources_GetTable", + "x-ms-examples": { + "CosmosDBTableGet": { + "$ref": "./examples/CosmosDBTableGet.json" + } + }, + "description": "Gets the Tables under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Table property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/TableGetResults" + } + } + } + }, + "put": { + "operationId": "TableResources_CreateUpdateTable", + "x-ms-examples": { + "CosmosDBTableReplace": { + "$ref": "./examples/CosmosDBTableCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateTableParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/TableCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Table." + } + ], + "responses": { + "202": { + "description": "The Table create or update operation will complete asynchronously." + }, + "200": { + "description": "The Table create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/TableGetResults" + } + } + } + }, + "delete": { + "operationId": "TableResources_DeleteTable", + "x-ms-examples": { + "CosmosDBTableDelete": { + "$ref": "./examples/CosmosDBTableDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Table.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Table delete operation will complete asynchronously." + }, + "204": { + "description": "The Table delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/tables/{tableName}/throughputSettings/default": { + "get": { + "operationId": "TableResources_GetTableThroughput", + "x-ms-examples": { + "CosmosDBTableThroughputGet": { + "$ref": "./examples/CosmosDBTableThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Table under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Table was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "TableResources_UpdateTableThroughput", + "x-ms-examples": { + "CosmosDBTableThroughputUpdate": { + "$ref": "./examples/CosmosDBTableThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The parameters to provide for the RUs per second of the current Table." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Table update operation will complete asynchronously." + }, + "200": { + "description": "The RUs per second of the Table update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces": { + "get": { + "operationId": "CassandraResources_ListCassandraKeyspaces", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceList": { + "$ref": "./examples/CosmosDBCassandraKeyspaceList.json" + } + }, + "description": "Lists the Cassandra keyspaces under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra keyspace properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraKeyspaceListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}": { + "get": { + "operationId": "CassandraResources_GetCassandraKeyspace", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceGet": { + "$ref": "./examples/CosmosDBCassandraKeyspaceGet.json" + } + }, + "description": "Gets the Cassandra keyspaces under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra keyspace property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraKeyspaceGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_CreateUpdateCassandraKeyspace", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceCreateUpdate": { + "$ref": "./examples/CosmosDBCassandraKeyspaceCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Cassandra keyspace", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateCassandraKeyspaceParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CassandraKeyspaceCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Cassandra keyspace." + } + ], + "responses": { + "202": { + "description": "The Cassandra keyspace create or update operation will complete asynchronously." + }, + "200": { + "description": "The Cassandra keyspace create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/CassandraKeyspaceGetResults" + } + } + } + }, + "delete": { + "operationId": "CassandraResources_DeleteCassandraKeyspace", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceDelete": { + "$ref": "./examples/CosmosDBCassandraKeyspaceDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Cassandra keyspace.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra keyspace delete operation will complete asynchronously." + }, + "204": { + "description": "The Cassandra keyspace delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/throughputSettings/default": { + "get": { + "operationId": "CassandraResources_GetCassandraKeyspaceThroughput", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceThroughputGet": { + "$ref": "./examples/CosmosDBCassandraKeyspaceThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Cassandra Keyspace under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Cassandra Keyspace was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_UpdateCassandraKeyspaceThroughput", + "x-ms-examples": { + "CosmosDBCassandraKeyspaceThroughputUpdate": { + "$ref": "./examples/CosmosDBCassandraKeyspaceThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Cassandra Keyspace", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Cassandra Keyspace." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Cassandra Keyspace update operation will complete asynchronously." + }, + "200": { + "description": "The RUs per second of the Cassandra Keyspace update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables": { + "get": { + "operationId": "CassandraResources_ListCassandraTables", + "x-ms-examples": { + "CosmosDBCassandraTableList": { + "$ref": "./examples/CosmosDBCassandraTableList.json" + } + }, + "description": "Lists the Cassandra table under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra table properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraTableListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}": { + "get": { + "operationId": "CassandraResources_GetCassandraTable", + "x-ms-examples": { + "CosmosDBCassandraTableGet": { + "$ref": "./examples/CosmosDBCassandraTableGet.json" + } + }, + "description": "Gets the Cassandra table under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Cassandra table property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/CassandraTableGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_CreateUpdateCassandraTable", + "x-ms-examples": { + "CosmosDBCassandraTableCreateUpdate": { + "$ref": "./examples/CosmosDBCassandraTableCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Cassandra Table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateCassandraTableParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CassandraTableCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Cassandra Table." + } + ], + "responses": { + "202": { + "description": "The Cassandra Table create or update operation will complete asynchronously." + }, + "200": { + "description": "The Cassandra Table create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/CassandraTableGetResults" + } + } + } + }, + "delete": { + "operationId": "CassandraResources_DeleteCassandraTable", + "x-ms-examples": { + "CosmosDBCassandraTableDelete": { + "$ref": "./examples/CosmosDBCassandraTableDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Cassandra table.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Cassandra table delete operation will complete asynchronously." + }, + "204": { + "description": "The Cassandra table delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/cassandraKeyspaces/{keyspaceName}/tables/{tableName}/throughputSettings/default": { + "get": { + "operationId": "CassandraResources_GetCassandraTableThroughput", + "x-ms-examples": { + "CosmosDBCassandraTableThroughputGet": { + "$ref": "./examples/CosmosDBCassandraTableThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Cassandra table under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Cassandra table was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "CassandraResources_UpdateCassandraTableThroughput", + "x-ms-examples": { + "CosmosDBCassandraTableThroughputUpdate": { + "$ref": "./examples/CosmosDBCassandraTableThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Cassandra table", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/keyspaceNameParameter" + }, + { + "$ref": "#/parameters/tableNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Cassandra table." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Cassandra table update operation will complete asynchronously." + }, + "200": { + "description": "The RUs per second of the Cassandra table update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases": { + "get": { + "operationId": "GremlinResources_ListGremlinDatabases", + "x-ms-examples": { + "CosmosDBGremlinDatabaseList": { + "$ref": "./examples/CosmosDBGremlinDatabaseList.json" + } + }, + "description": "Lists the Gremlin databases under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin database properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinDatabaseListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}": { + "get": { + "operationId": "GremlinResources_GetGremlinDatabase", + "x-ms-examples": { + "CosmosDBGremlinDatabaseGet": { + "$ref": "./examples/CosmosDBGremlinDatabaseGet.json" + } + }, + "description": "Gets the Gremlin databases under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin database property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinDatabaseGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_CreateUpdateGremlinDatabase", + "x-ms-examples": { + "CosmosDBGremlinDatabaseCreateUpdate": { + "$ref": "./examples/CosmosDBGremlinDatabaseCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Gremlin database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateGremlinDatabaseParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GremlinDatabaseCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Gremlin database." + } + ], + "responses": { + "202": { + "description": "The Gremlin database create or update operation will complete asynchronously." + }, + "200": { + "description": "The Gremlin database create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/GremlinDatabaseGetResults" + } + } + } + }, + "delete": { + "operationId": "GremlinResources_DeleteGremlinDatabase", + "x-ms-examples": { + "CosmosDBGremlinDatabaseDelete": { + "$ref": "./examples/CosmosDBGremlinDatabaseDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Gremlin database.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin database delete operation will complete asynchronously." + }, + "204": { + "description": "The Gremlin database delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/throughputSettings/default": { + "get": { + "operationId": "GremlinResources_GetGremlinDatabaseThroughput", + "x-ms-examples": { + "CosmosDBGremlinDatabaseThroughputGet": { + "$ref": "./examples/CosmosDBGremlinDatabaseThroughputGet.json" + } + }, + "description": "Gets the RUs per second of the Gremlin database under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Gremlin database was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_UpdateGremlinDatabaseThroughput", + "x-ms-examples": { + "CosmosDBGremlinDatabaseThroughputUpdate": { + "$ref": "./examples/CosmosDBGremlinDatabaseThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Gremlin database", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Gremlin database." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Gremlin database update operation will complete asynchronously." + }, + "200": { + "description": "The RUs per second of the Gremlin database update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs": { + "get": { + "operationId": "GremlinResources_ListGremlinGraphs", + "x-ms-examples": { + "CosmosDBGremlinGraphList": { + "$ref": "./examples/CosmosDBGremlinGraphList.json" + } + }, + "description": "Lists the Gremlin graph under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin graph properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinGraphListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}": { + "get": { + "operationId": "GremlinResources_GetGremlinGraph", + "x-ms-examples": { + "CosmosDBGremlinGraphGet": { + "$ref": "./examples/CosmosDBGremlinGraphGet.json" + } + }, + "description": "Gets the Gremlin graph under an existing Azure Cosmos DB database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Gremlin graph property was retrieved successfully.", + "schema": { + "$ref": "#/definitions/GremlinGraphGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_CreateUpdateGremlinGraph", + "x-ms-examples": { + "CosmosDBGremlinGraphCreateUpdate": { + "$ref": "./examples/CosmosDBGremlinGraphCreateUpdate.json" + } + }, + "description": "Create or update an Azure Cosmos DB Gremlin graph", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "createUpdateGremlinGraphParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/GremlinGraphCreateUpdateParameters" + }, + "description": "The parameters to provide for the current Gremlin graph." + } + ], + "responses": { + "202": { + "description": "The Gremlin graph create or update operation will complete asynchronously." + }, + "200": { + "description": "The Gremlin graph create or update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/GremlinGraphGetResults" + } + } + } + }, + "delete": { + "operationId": "GremlinResources_DeleteGremlinGraph", + "x-ms-examples": { + "CosmosDBGremlinGraphDelete": { + "$ref": "./examples/CosmosDBGremlinGraphDelete.json" + } + }, + "description": "Deletes an existing Azure Cosmos DB Gremlin graph.", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "202": { + "description": "The Gremlin graph delete operation will complete asynchronously." + }, + "204": { + "description": "The Gremlin graph delete operation was completed successfully." + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/gremlinDatabases/{databaseName}/graphs/{graphName}/throughputSettings/default": { + "get": { + "operationId": "GremlinResources_GetGremlinGraphThroughput", + "x-ms-examples": { + "CosmosDBGremlinGraphThroughputGet": { + "$ref": "./examples/CosmosDBGremlinGraphThroughputGet.json" + } + }, + "description": "Gets the Gremlin graph throughput under an existing Azure Cosmos DB database account with the provided name.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The RUs per second of the Gremlin graph was retrieved successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + }, + "put": { + "operationId": "GremlinResources_UpdateGremlinGraphThroughput", + "x-ms-examples": { + "CosmosDBGremlinGraphThroughputUpdate": { + "$ref": "./examples/CosmosDBGremlinGraphThroughputUpdate.json" + } + }, + "description": "Update RUs per second of an Azure Cosmos DB Gremlin graph", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/databaseNameParameter" + }, + { + "$ref": "#/parameters/graphNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "name": "updateThroughputParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ThroughputSettingsUpdateParameters" + }, + "description": "The RUs per second of the parameters to provide for the current Gremlin graph." + } + ], + "responses": { + "202": { + "description": "The RUs per second of the Gremlin graph update operation will complete asynchronously." + }, + "200": { + "description": "The RUs per second of the Gremlin graph update operation was completed successfully.", + "schema": { + "$ref": "#/definitions/ThroughputSettingsGetResults" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts": { + "get": { + "operationId": "RestorableDatabaseAccounts_ListByLocation", + "x-ms-examples": { + "CosmosDBDatabaseAccountList": { + "$ref": "./examples/CosmosDBRestorableDatabaseAccountList.json" + } + }, + "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription and in a region.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableDatabaseAccountsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseUpdatedFormat" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/restorableDatabaseAccounts": { + "get": { + "operationId": "RestorableDatabaseAccounts_List", + "x-ms-examples": { + "CosmosDBDatabaseAccountList": { + "$ref": "./examples/CosmosDBRestorableDatabaseAccountNoLocationList.json" + } + }, + "description": "Lists all the restorable Azure Cosmos DB database accounts available under the subscription.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/RestorableDatabaseAccountsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseUpdatedFormat" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DocumentDB/locations/{location}/restorableDatabaseAccounts/{instanceId}": { + "get": { + "operationId": "RestorableDatabaseAccounts_GetByLocation", + "x-ms-examples": { + "CosmosDBDatabaseAccountGet": { + "$ref": "./examples/CosmosDBRestorableDatabaseAccountGet.json" + } + }, + "description": "Retrieves the properties of an existing Azure Cosmos DB restorable database account.", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/locationParameter" + }, + { + "$ref": "#/parameters/instanceIdParameter" + } + ], + "responses": { + "200": { + "description": "The restorable database account properties were retrieved successfully.", + "schema": { + "$ref": "#/definitions/RestorableDatabaseAccountGetResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponseUpdatedFormat" + } + } + } + } + } + }, + "definitions": { + "DatabaseAccountsListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/DatabaseAccountGetResults" + }, + "description": "List of database account and their properties." + } + }, + "description": "The List operation response, that contains the database accounts and their properties." + }, + "SqlDatabaseListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlDatabaseGetResults" + }, + "description": "List of SQL databases and their properties." + } + }, + "description": "The List operation response, that contains the SQL databases and their properties." + }, + "SqlContainerListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlContainerGetResults" + }, + "description": "List of containers and their properties." + } + }, + "description": "The List operation response, that contains the containers and their properties." + }, + "SqlStoredProcedureListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlStoredProcedureGetResults" + }, + "description": "List of storedProcedures and their properties." + } + }, + "description": "The List operation response, that contains the storedProcedures and their properties." + }, + "SqlUserDefinedFunctionListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlUserDefinedFunctionGetResults" + }, + "description": "List of userDefinedFunctions and their properties." + } + }, + "description": "The List operation response, that contains the userDefinedFunctions and their properties." + }, + "SqlTriggerListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/SqlTriggerGetResults" + }, + "description": "List of triggers and their properties." + } + }, + "description": "The List operation response, that contains the triggers and their properties." + }, + "MongoDBDatabaseListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MongoDBDatabaseGetResults" + }, + "description": "List of MongoDB databases and their properties." + } + }, + "description": "The List operation response, that contains the MongoDB databases and their properties." + }, + "MongoDBCollectionListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MongoDBCollectionGetResults" + }, + "description": "List of MongoDB collections and their properties." + } + }, + "description": "The List operation response, that contains the MongoDB collections and their properties." + }, + "TableListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/TableGetResults" + }, + "description": "List of Table and their properties." + } + }, + "description": "The List operation response, that contains the Table and their properties." + }, + "CassandraKeyspaceListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CassandraKeyspaceGetResults" + }, + "description": "List of Cassandra keyspaces and their properties." + } + }, + "description": "The List operation response, that contains the Cassandra keyspaces and their properties." + }, + "CassandraTableListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/CassandraTableGetResults" + }, + "description": "List of Cassandra tables and their properties." + } + }, + "description": "The List operation response, that contains the Cassandra tables and their properties." + }, + "GremlinDatabaseListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/GremlinDatabaseGetResults" + }, + "description": "List of Gremlin databases and their properties." + } + }, + "description": "The List operation response, that contains the Gremlin databases and their properties." + }, + "GremlinGraphListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/GremlinGraphGetResults" + }, + "description": "List of graphs and their properties." + } + }, + "description": "The List operation response, that contains the graphs and their properties." + }, + "ErrorResponse": { + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + }, + "description": "Error Response." + }, + "ErrorResponseUpdatedFormat": { + "description": "An error response from the service.", + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "FailoverPolicies": { + "properties": { + "failoverPolicies": { + "type": "array", + "description": "List of failover policies.", + "items": { + "$ref": "#/definitions/FailoverPolicy" + } + } + }, + "required": [ + "failoverPolicies" + ], + "description": "The list of new failover policies for the failover priority change." + }, + "FailoverPolicy": { + "type": "object", + "description": "The failover policy for a given region of a database account.", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The unique identifier of the region in which the database account replicates to. Example: <accountName>-<locationName>." + }, + "locationName": { + "type": "string", + "description": "The name of the region in which the database account exists." + }, + "failoverPriority": { + "type": "integer", + "minimum": 0, + "format": "int32", + "description": "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists." + } + } + }, + "RegionForOnlineOffline": { + "properties": { + "region": { + "type": "string", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + } + }, + "required": [ + "region" + ], + "description": "Cosmos DB region to online or offline." + }, + "Location": { + "description": "A region in which the Azure Cosmos DB database account is deployed.", + "type": "object", + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The unique identifier of the region within the database account. Example: <accountName>-<locationName>." + }, + "locationName": { + "type": "string", + "description": "The name of the region." + }, + "documentEndpoint": { + "type": "string", + "readOnly": true, + "description": "The connection endpoint for the specific region. Example: https://<accountName>-<locationName>.documents.azure.com:443/" + }, + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "failoverPriority": { + "description": "The failover priority of the region. A failover priority of 0 indicates a write region. The maximum value for a failover priority = (total number of regions - 1). Failover priority values must be unique for each of the regions in which the database account exists.", + "format": "int32", + "type": "integer", + "minimum": 0 + }, + "isZoneRedundant": { + "type": "boolean", + "description": "Flag to indicate whether or not this region is an AvailabilityZone region" + } + } + }, + "ARMResourceProperties": { + "type": "object", + "description": "The core properties of ARM resources.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the ARM resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the ARM resource." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "tags": { + "$ref": "#/definitions/Tags" + }, + "identity": { + "$ref": "#/definitions/ManagedServiceIdentity" + } + }, + "x-ms-azure-resource": true + }, + "ARMProxyResource": { + "type": "object", + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The unique resource identifier of the database account." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "The name of the database account." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "The type of Azure resource." + } + }, + "x-ms-azure-resource": true + }, + "DatabaseAccountGetResults": { + "description": "An Azure Cosmos DB database account.", + "type": "object", + "properties": { + "kind": { + "description": "Indicates the type of database account. This can only be set at database account creation.", + "type": "string", + "default": "GlobalDocumentDB", + "enum": [ + "GlobalDocumentDB", + "MongoDB", + "Parse" + ], + "x-ms-enum": { + "name": "DatabaseAccountKind", + "modelAsString": true + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseAccountGetProperties" + }, + "systemData": { + "readOnly": true, + "description": "The system meta data relating to this resource.", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "ExtendedResourceProperties": { + "description": "The system generated resource properties associated with SQL databases, SQL containers, Gremlin databases and Gremlin graphs.", + "type": "object", + "properties": { + "_rid": { + "type": "string", + "description": "A system generated property. A unique identifier.", + "readOnly": true + }, + "_ts": { + "description": "A system generated property that denotes the last updated timestamp of the resource.", + "readOnly": true + }, + "_etag": { + "type": "string", + "description": "A system generated property representing the resource etag required for optimistic concurrency control.", + "readOnly": true + } + } + }, + "ThroughputSettingsGetResults": { + "description": "An Azure Cosmos DB resource throughput.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB resource throughput", + "$ref": "#/definitions/ThroughputSettingsGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "ThroughputSettingsGetProperties": { + "description": "The properties of an Azure Cosmos DB resource throughput", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/ThroughputSettingsResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "SqlDatabaseGetResults": { + "description": "An Azure Cosmos DB SQL database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB SQL database", + "$ref": "#/definitions/SqlDatabaseGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlDatabaseGetProperties": { + "description": "The properties of an Azure Cosmos DB SQL database", + "type": "object", + "properties": { + "resource": { + "properties": { + "_colls": { + "type": "string", + "description": "A system generated property that specified the addressable path of the collections resource." + }, + "_users": { + "type": "string", + "description": "A system generated property that specifies the addressable path of the users resource." + } + }, + "allOf": [ + { + "$ref": "#/definitions/SqlDatabaseResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "SqlContainerGetResults": { + "description": "An Azure Cosmos DB container.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB container", + "$ref": "#/definitions/SqlContainerGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlContainerGetProperties": { + "description": "The properties of an Azure Cosmos DB container", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlContainerResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "SqlStoredProcedureGetResults": { + "description": "An Azure Cosmos DB storedProcedure.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB storedProcedure", + "$ref": "#/definitions/SqlStoredProcedureGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlStoredProcedureGetProperties": { + "description": "The properties of an Azure Cosmos DB StoredProcedure", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlStoredProcedureResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "SqlUserDefinedFunctionGetResults": { + "description": "An Azure Cosmos DB userDefinedFunction.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB userDefinedFunction", + "$ref": "#/definitions/SqlUserDefinedFunctionGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlUserDefinedFunctionGetProperties": { + "description": "The properties of an Azure Cosmos DB userDefinedFunction", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlUserDefinedFunctionResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "SqlTriggerGetResults": { + "description": "An Azure Cosmos DB trigger.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB trigger", + "$ref": "#/definitions/SqlTriggerGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "SqlTriggerGetProperties": { + "description": "The properties of an Azure Cosmos DB trigger", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/SqlTriggerResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + } + } + }, + "MongoDBDatabaseGetResults": { + "description": "An Azure Cosmos DB MongoDB database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB MongoDB database", + "$ref": "#/definitions/MongoDBDatabaseGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "MongoDBDatabaseGetProperties": { + "description": "The properties of an Azure Cosmos DB MongoDB database", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/MongoDBDatabaseResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "MongoDBCollectionGetResults": { + "description": "An Azure Cosmos DB MongoDB collection.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB MongoDB collection", + "$ref": "#/definitions/MongoDBCollectionGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "MongoDBCollectionGetProperties": { + "description": "The properties of an Azure Cosmos DB MongoDB collection", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/MongoDBCollectionResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "TableGetResults": { + "description": "An Azure Cosmos DB Table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Table", + "$ref": "#/definitions/TableGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "TableGetProperties": { + "description": "The properties of an Azure Cosmos Table", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/TableResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "CassandraKeyspaceGetResults": { + "description": "An Azure Cosmos DB Cassandra keyspace.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Cassandra keyspace", + "$ref": "#/definitions/CassandraKeyspaceGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "CassandraKeyspaceGetProperties": { + "description": "The properties of an Azure Cosmos DB Cassandra keyspace", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/CassandraKeyspaceResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "CassandraTableGetResults": { + "description": "An Azure Cosmos DB Cassandra table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Cassandra table", + "$ref": "#/definitions/CassandraTableGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "CassandraTableGetProperties": { + "description": "The properties of an Azure Cosmos DB Cassandra table", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/CassandraTableResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "GremlinDatabaseGetResults": { + "description": "An Azure Cosmos DB Gremlin database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB SQL database", + "$ref": "#/definitions/GremlinDatabaseGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "GremlinDatabaseGetProperties": { + "description": "The properties of an Azure Cosmos DB SQL database", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/GremlinDatabaseResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "GremlinGraphGetResults": { + "description": "An Azure Cosmos DB Gremlin graph.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of an Azure Cosmos DB Gremlin graph", + "$ref": "#/definitions/GremlinGraphGetProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "GremlinGraphGetProperties": { + "description": "The properties of an Azure Cosmos DB Gremlin graph", + "type": "object", + "properties": { + "resource": { + "allOf": [ + { + "$ref": "#/definitions/GremlinGraphResource" + }, + { + "$ref": "#/definitions/ExtendedResourceProperties" + } + ] + }, + "options": { + "allOf": [ + { + "$ref": "#/definitions/OptionsResource" + } + ] + } + } + }, + "ConsistencyPolicy": { + "type": "object", + "description": "The consistency policy for the Cosmos DB database account.", + "properties": { + "defaultConsistencyLevel": { + "description": "The default consistency level and configuration settings of the Cosmos DB account.", + "type": "string", + "enum": [ + "Eventual", + "Session", + "BoundedStaleness", + "Strong", + "ConsistentPrefix" + ], + "x-ms-enum": { + "name": "DefaultConsistencyLevel", + "modelAsString": false + } + }, + "maxStalenessPrefix": { + "description": "When used with the Bounded Staleness consistency level, this value represents the number of stale requests tolerated. Accepted range for this value is 1 – 2,147,483,647. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.", + "type": "integer", + "minimum": 1, + "maximum": 2147483647, + "format": "int64" + }, + "maxIntervalInSeconds": { + "description": "When used with the Bounded Staleness consistency level, this value represents the time amount of staleness (in seconds) tolerated. Accepted range for this value is 5 - 86400. Required when defaultConsistencyPolicy is set to 'BoundedStaleness'.", + "type": "integer", + "minimum": 5, + "maximum": 86400, + "format": "int32" + } + }, + "required": [ + "defaultConsistencyLevel" + ] + }, + "DatabaseAccountGetProperties": { + "description": "Properties for the database account.", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState" + }, + "documentEndpoint": { + "description": "The connection endpoint for the Cosmos DB database account.", + "type": "string", + "readOnly": true + }, + "databaseAccountOfferType": { + "description": "The offer type for the Cosmos DB database account. Default value: Standard.", + "readOnly": true, + "$ref": "#/definitions/DatabaseAccountOfferType" + }, + "ipRules": { + "description": "List of IpRules.", + "$ref": "#/definitions/IPRules" + }, + "isVirtualNetworkFilterEnabled": { + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.", + "type": "boolean" + }, + "enableAutomaticFailover": { + "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.", + "type": "boolean" + }, + "consistencyPolicy": { + "description": "The consistency policy for the Cosmos DB database account.", + "$ref": "#/definitions/ConsistencyPolicy" + }, + "capabilities": { + "type": "array", + "description": "List of Cosmos DB capabilities for the account", + "items": { + "$ref": "#/definitions/Capability" + } + }, + "writeLocations": { + "type": "array", + "readOnly": true, + "description": "An array that contains the write location for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "readLocations": { + "type": "array", + "readOnly": true, + "description": "An array that contains of the read locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "locations": { + "type": "array", + "readOnly": true, + "description": "An array that contains all of the locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "failoverPolicies": { + "type": "array", + "readOnly": true, + "description": "An array that contains the regions ordered by their failover priorities.", + "items": { + "$ref": "#/definitions/FailoverPolicy" + } + }, + "virtualNetworkRules": { + "type": "array", + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "privateEndpointConnections": { + "type": "array", + "readOnly": true, + "description": "List of Private Endpoint Connections configured for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "enableMultipleWriteLocations": { + "description": "Enables the account to write in multiple locations", + "type": "boolean" + }, + "enableCassandraConnector": { + "description": "Enables the cassandra connector on the Cosmos DB C* account", + "type": "boolean" + }, + "connectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB database C* account.", + "$ref": "#/definitions/ConnectorOffer" + }, + "disableKeyBasedMetadataWriteAccess": { + "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys", + "type": "boolean" + }, + "keyVaultKeyUri": { + "description": "The URI of the key vault", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "enableFreeTier": { + "description": "Flag to indicate whether Free Tier is enabled.", + "type": "boolean" + }, + "apiProperties": { + "description": "API specific properties.", + "type": "object", + "$ref": "#/definitions/ApiProperties" + }, + "enableAnalyticalStorage": { + "description": "Flag to indicate whether to enable storage analytics.", + "type": "boolean" + }, + "instanceId": { + "description": "A unique identifier assigned to the database account", + "type": "string", + "readOnly": true + }, + "createMode": { + "description": "Enum to indicate the mode of account creation.", + "type": "string", + "default": "Default", + "$ref": "#/definitions/CreateMode" + }, + "restoreParameters": { + "description": "Parameters to indicate the information about the restore.", + "type": "object", + "$ref": "#/definitions/RestoreParameters" + }, + "backupPolicy": { + "description": "The object representing the policy for taking backups on an account.", + "type": "object", + "$ref": "#/definitions/BackupPolicy" + } + } + }, + "DatabaseAccountCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB database accounts.", + "type": "object", + "discriminator": "createMode", + "properties": { + "consistencyPolicy": { + "description": "The consistency policy for the Cosmos DB account.", + "$ref": "#/definitions/ConsistencyPolicy" + }, + "locations": { + "type": "array", + "description": "An array that contains the georeplication locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "databaseAccountOfferType": { + "description": "The offer type for the database", + "$ref": "#/definitions/DatabaseAccountOfferType" + }, + "ipRules": { + "description": "List of IpRules.", + "$ref": "#/definitions/IPRules" + }, + "isVirtualNetworkFilterEnabled": { + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.", + "type": "boolean" + }, + "enableAutomaticFailover": { + "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.", + "type": "boolean" + }, + "capabilities": { + "type": "array", + "description": "List of Cosmos DB capabilities for the account", + "items": { + "$ref": "#/definitions/Capability" + } + }, + "virtualNetworkRules": { + "type": "array", + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "enableMultipleWriteLocations": { + "description": "Enables the account to write in multiple locations", + "type": "boolean" + }, + "enableCassandraConnector": { + "description": "Enables the cassandra connector on the Cosmos DB C* account", + "type": "boolean" + }, + "connectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB database C* account.", + "$ref": "#/definitions/ConnectorOffer" + }, + "disableKeyBasedMetadataWriteAccess": { + "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys", + "type": "boolean" + }, + "keyVaultKeyUri": { + "description": "The URI of the key vault", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "enableFreeTier": { + "description": "Flag to indicate whether Free Tier is enabled.", + "type": "boolean" + }, + "apiProperties": { + "description": "API specific properties. Currently, supported only for MongoDB API.", + "type": "object", + "$ref": "#/definitions/ApiProperties" + }, + "enableAnalyticalStorage": { + "description": "Flag to indicate whether to enable storage analytics.", + "type": "boolean" + }, + "createMode": { + "description": "Enum to indicate the mode of account creation.", + "type": "string", + "default": "Default", + "$ref": "#/definitions/CreateMode" + }, + "backupPolicy": { + "description": "The object representing the policy for taking backups on an account.", + "type": "object", + "$ref": "#/definitions/BackupPolicy" + } + }, + "required": [ + "locations", + "databaseAccountOfferType", + "createMode" + ] + }, + "DefaultRequestDatabaseAccountCreateUpdateProperties": { + "description": "Properties for non-restore Azure Cosmos DB database account requests.", + "allOf": [ + { + "$ref": "#/definitions/DatabaseAccountCreateUpdateProperties" + } + ], + "x-ms-discriminator-value": "Default" + }, + "RestoreReqeustDatabaseAccountCreateUpdateProperties": { + "description": "Properties to restore Azure Cosmos DB database account.", + "allOf": [ + { + "$ref": "#/definitions/DatabaseAccountCreateUpdateProperties" + } + ], + "properties": { + "restoreParameters": { + "description": "Parameters to indicate the information about the restore.", + "type": "object", + "$ref": "#/definitions/RestoreParameters" + } + }, + "x-ms-discriminator-value": "Restore" + }, + "DatabaseAccountCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB database accounts.", + "type": "object", + "properties": { + "kind": { + "description": "Indicates the type of database account. This can only be set at database account creation.", + "type": "string", + "default": "GlobalDocumentDB", + "enum": [ + "GlobalDocumentDB", + "MongoDB", + "Parse" + ], + "x-ms-enum": { + "name": "DatabaseAccountKind", + "modelAsString": true + } + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseAccountCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "DatabaseAccountUpdateProperties": { + "description": "Properties to update Azure Cosmos DB database accounts.", + "type": "object", + "properties": { + "consistencyPolicy": { + "description": "The consistency policy for the Cosmos DB account.", + "$ref": "#/definitions/ConsistencyPolicy" + }, + "locations": { + "type": "array", + "description": "An array that contains the georeplication locations enabled for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/Location" + } + }, + "ipRules": { + "description": "List of IpRules.", + "$ref": "#/definitions/IPRules" + }, + "isVirtualNetworkFilterEnabled": { + "description": "Flag to indicate whether to enable/disable Virtual Network ACL rules.", + "type": "boolean" + }, + "enableAutomaticFailover": { + "description": "Enables automatic failover of the write region in the rare event that the region is unavailable due to an outage. Automatic failover will result in a new write region for the account and is chosen based on the failover priorities configured for the account.", + "type": "boolean" + }, + "capabilities": { + "type": "array", + "description": "List of Cosmos DB capabilities for the account", + "items": { + "$ref": "#/definitions/Capability" + } + }, + "virtualNetworkRules": { + "type": "array", + "description": "List of Virtual Network ACL rules configured for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/VirtualNetworkRule" + } + }, + "enableMultipleWriteLocations": { + "description": "Enables the account to write in multiple locations", + "type": "boolean" + }, + "enableCassandraConnector": { + "description": "Enables the cassandra connector on the Cosmos DB C* account", + "type": "boolean" + }, + "connectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB database C* account.", + "$ref": "#/definitions/ConnectorOffer" + }, + "disableKeyBasedMetadataWriteAccess": { + "description": "Disable write operations on metadata resources (databases, containers, throughput) via account keys", + "type": "boolean" + }, + "keyVaultKeyUri": { + "description": "The URI of the key vault", + "type": "string" + }, + "publicNetworkAccess": { + "description": "Whether requests from Public Network are allowed", + "$ref": "#/definitions/PublicNetworkAccess" + }, + "enableFreeTier": { + "description": "Flag to indicate whether Free Tier is enabled.", + "type": "boolean" + }, + "apiProperties": { + "description": "API specific properties. Currently, supported only for MongoDB API.", + "type": "object", + "$ref": "#/definitions/ApiProperties" + }, + "enableAnalyticalStorage": { + "description": "Flag to indicate whether to enable storage analytics.", + "type": "boolean" + }, + "backupPolicy": { + "description": "The object representing the policy for taking backups on an account.", + "type": "object", + "$ref": "#/definitions/BackupPolicy" + } + } + }, + "DatabaseAccountUpdateParameters": { + "description": "Parameters for patching Azure Cosmos DB database account properties.", + "type": "object", + "properties": { + "tags": { + "$ref": "#/definitions/Tags" + }, + "location": { + "type": "string", + "description": "The location of the resource group to which the resource belongs." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabaseAccountUpdateProperties" + } + } + }, + "DatabaseAccountListReadOnlyKeysResult": { + "description": "The read-only access keys for the given database account.", + "properties": { + "primaryReadonlyMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the primary read-only key." + }, + "secondaryReadonlyMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the secondary read-only key." + } + } + }, + "DatabaseAccountListKeysResult": { + "description": "The access keys for the given database account.", + "properties": { + "primaryMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the primary read-write key." + }, + "secondaryMasterKey": { + "readOnly": true, + "type": "string", + "description": "Base 64 encoded value of the secondary read-write key." + } + }, + "allOf": [ + { + "$ref": "#/definitions/DatabaseAccountListReadOnlyKeysResult" + } + ] + }, + "DatabaseAccountConnectionString": { + "description": "Connection string for the Cosmos DB account", + "properties": { + "connectionString": { + "readOnly": true, + "type": "string", + "description": "Value of the connection string" + }, + "description": { + "readOnly": true, + "type": "string", + "description": "Description of the connection string" + } + } + }, + "DatabaseAccountListConnectionStringsResult": { + "description": "The connection strings for the given database account.", + "properties": { + "connectionStrings": { + "type": "array", + "description": "An array that contains the connection strings for the Cosmos DB account.", + "items": { + "$ref": "#/definitions/DatabaseAccountConnectionString" + } + } + } + }, + "DatabaseAccountRegenerateKeyParameters": { + "type": "object", + "description": "Parameters to regenerate the keys within the database account.", + "properties": { + "keyKind": { + "type": "string", + "description": "The access key to regenerate.", + "enum": [ + "primary", + "secondary", + "primaryReadonly", + "secondaryReadonly" + ], + "x-ms-enum": { + "name": "KeyKind", + "modelAsString": true + } + } + }, + "required": [ + "keyKind" + ] + }, + "DatabaseAccountOfferType": { + "description": "The offer type for the Cosmos DB database account.", + "type": "string", + "enum": [ + "Standard" + ], + "x-ms-enum": { + "name": "DatabaseAccountOfferType", + "modelAsString": false + } + }, + "ThroughputSettingsUpdateParameters": { + "description": "Parameters to update Cosmos DB resource throughput.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to update Azure Cosmos DB resource throughput.", + "$ref": "#/definitions/ThroughputSettingsUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "ThroughputSettingsUpdateProperties": { + "description": "Properties to update Azure Cosmos DB resource throughput.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a resource throughput", + "$ref": "#/definitions/ThroughputSettingsResource" + } + }, + "required": [ + "resource" + ] + }, + "SqlDatabaseCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB SQL database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB SQL database.", + "$ref": "#/definitions/SqlDatabaseCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlDatabaseCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB SQL database.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a SQL database", + "$ref": "#/definitions/SqlDatabaseResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "SqlContainerCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB container.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB container.", + "$ref": "#/definitions/SqlContainerCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlContainerCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB container.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a container", + "$ref": "#/definitions/SqlContainerResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "SqlStoredProcedureCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB storedProcedure.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB storedProcedure.", + "$ref": "#/definitions/SqlStoredProcedureCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlStoredProcedureCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB storedProcedure.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a storedProcedure", + "$ref": "#/definitions/SqlStoredProcedureResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "SqlUserDefinedFunctionCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB userDefinedFunction.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB userDefinedFunction.", + "$ref": "#/definitions/SqlUserDefinedFunctionCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlUserDefinedFunctionCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB userDefinedFunction.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a userDefinedFunction", + "$ref": "#/definitions/SqlUserDefinedFunctionResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "SqlTriggerCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB trigger.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB trigger.", + "$ref": "#/definitions/SqlTriggerCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "SqlTriggerCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB trigger.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a trigger", + "$ref": "#/definitions/SqlTriggerResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "MongoDBDatabaseCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB MongoDB database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB MongoDB database.", + "$ref": "#/definitions/MongoDBDatabaseCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "MongoDBDatabaseCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB MongoDB database.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a MongoDB database", + "$ref": "#/definitions/MongoDBDatabaseResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "MongoDBCollectionCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB MongoDB collection.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB MongoDB collection.", + "$ref": "#/definitions/MongoDBCollectionCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "MongoDBCollectionCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB MongoDB collection.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a MongoDB collection", + "$ref": "#/definitions/MongoDBCollectionResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "TableCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Table.", + "$ref": "#/definitions/TableCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "TableCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Table.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Table", + "$ref": "#/definitions/TableResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "CassandraKeyspaceCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Cassandra keyspace.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace.", + "$ref": "#/definitions/CassandraKeyspaceCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "CassandraKeyspaceCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Cassandra keyspace.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Cassandra keyspace", + "$ref": "#/definitions/CassandraKeyspaceResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "CassandraTableCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Cassandra table.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Cassandra table.", + "$ref": "#/definitions/CassandraTableCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "CassandraTableCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Cassandra table.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Cassandra table", + "$ref": "#/definitions/CassandraTableResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "GremlinDatabaseCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Gremlin database.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Gremlin database.", + "$ref": "#/definitions/GremlinDatabaseCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "GremlinDatabaseCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Gremlin database.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Gremlin database", + "$ref": "#/definitions/GremlinDatabaseResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "GremlinGraphCreateUpdateParameters": { + "description": "Parameters to create and update Cosmos DB Gremlin graph.", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "Properties to create and update Azure Cosmos DB Gremlin graph.", + "$ref": "#/definitions/GremlinGraphCreateUpdateProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ], + "required": [ + "properties" + ] + }, + "GremlinGraphCreateUpdateProperties": { + "description": "Properties to create and update Azure Cosmos DB Gremlin graph.", + "type": "object", + "properties": { + "resource": { + "description": "The standard JSON format of a Gremlin graph", + "$ref": "#/definitions/GremlinGraphResource" + }, + "options": { + "description": "A key-value pair of options to be applied for the request. This corresponds to the headers sent with the request.", + "$ref": "#/definitions/CreateUpdateOptions" + } + }, + "required": [ + "resource", + "options" + ] + }, + "ThroughputSettingsResource": { + "type": "object", + "description": "Cosmos DB resource throughput object. Either throughput is required or autoscaleSettings is required, but not both.", + "properties": { + "throughput": { + "type": "integer", + "description": "Value of the Cosmos DB resource throughput. Either throughput is required or autoscaleSettings is required, but not both." + }, + "autoscaleSettings": { + "description": "Cosmos DB resource for autoscale settings. Either throughput is required or autoscaleSettings is required, but not both.", + "$ref": "#/definitions/AutoscaleSettingsResource" + }, + "minimumThroughput": { + "type": "string", + "description": "The minimum throughput of the resource", + "readOnly": true + }, + "offerReplacePending": { + "type": "string", + "description": "The throughput replace is pending", + "readOnly": true + } + } + }, + "AutoscaleSettingsResource": { + "type": "object", + "description": "Cosmos DB provisioned throughput settings object", + "properties": { + "maxThroughput": { + "type": "integer", + "description": "Represents maximum throughput container can scale up to." + }, + "autoUpgradePolicy": { + "description": "Cosmos DB resource auto-upgrade policy", + "$ref": "#/definitions/AutoUpgradePolicyResource" + }, + "targetMaxThroughput": { + "type": "integer", + "description": "Represents target maximum throughput container can scale up to once offer is no longer in pending state.", + "readOnly": true + } + }, + "required": [ + "maxThroughput" + ] + }, + "AutoUpgradePolicyResource": { + "type": "object", + "description": "Cosmos DB resource auto-upgrade policy", + "properties": { + "throughputPolicy": { + "description": "Represents throughput policy which service must adhere to for auto-upgrade", + "$ref": "#/definitions/ThroughputPolicyResource" + } + } + }, + "ThroughputPolicyResource": { + "type": "object", + "description": "Cosmos DB resource throughput policy", + "properties": { + "isEnabled": { + "type": "boolean", + "description": "Determines whether the ThroughputPolicy is active or not" + }, + "incrementPercent": { + "type": "integer", + "description": "Represents the percentage by which throughput can increase every time throughput policy kicks in." + } + } + }, + "OptionsResource": { + "type": "object", + "description": "Cosmos DB options resource object", + "readOnly": true, + "properties": { + "throughput": { + "type": "integer", + "description": "Value of the Cosmos DB resource throughput or autoscaleSettings. Use the ThroughputSetting resource when retrieving offer details." + }, + "autoscaleSettings": { + "type": "object", + "$ref": "#/definitions/AutoscaleSettings", + "description": "Specifies the Autoscale settings." + } + } + }, + "SqlDatabaseResource": { + "type": "object", + "description": "Cosmos DB SQL database resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL database" + } + }, + "required": [ + "id" + ] + }, + "SqlContainerResource": { + "type": "object", + "description": "Cosmos DB SQL container resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL container" + }, + "indexingPolicy": { + "$ref": "#/definitions/IndexingPolicy", + "description": "The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the container" + }, + "partitionKey": { + "$ref": "#/definitions/ContainerPartitionKey", + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "defaultTtl": { + "type": "integer", + "description": "Default time to live" + }, + "uniqueKeyPolicy": { + "$ref": "#/definitions/UniqueKeyPolicy", + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "conflictResolutionPolicy": { + "$ref": "#/definitions/ConflictResolutionPolicy", + "description": "The conflict resolution policy for the container." + } + }, + "required": [ + "id" + ] + }, + "IndexingPolicy": { + "type": "object", + "description": "Cosmos DB indexing policy", + "properties": { + "automatic": { + "type": "boolean", + "description": "Indicates if the indexing policy is automatic" + }, + "indexingMode": { + "description": "Indicates the indexing mode.", + "type": "string", + "default": "Consistent", + "enum": [ + "Consistent", + "Lazy", + "None" + ], + "x-ms-enum": { + "name": "IndexingMode", + "modelAsString": true + } + }, + "includedPaths": { + "description": "List of paths to include in the indexing", + "type": "array", + "items": { + "$ref": "#/definitions/IncludedPath" + } + }, + "excludedPaths": { + "description": "List of paths to exclude from indexing", + "type": "array", + "items": { + "$ref": "#/definitions/ExcludedPath" + } + }, + "compositeIndexes": { + "description": "List of composite path list", + "type": "array", + "items": { + "$ref": "#/definitions/CompositePathList" + } + }, + "spatialIndexes": { + "description": "List of spatial specifics", + "type": "array", + "items": { + "$ref": "#/definitions/SpatialSpec" + } + } + } + }, + "ExcludedPath": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + } + } + }, + "IncludedPath": { + "type": "object", + "description": "The paths that are included in indexing", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "indexes": { + "description": "List of indexes for this path", + "type": "array", + "items": { + "$ref": "#/definitions/Indexes" + } + } + } + }, + "Indexes": { + "type": "object", + "description": "The indexes for the path.", + "properties": { + "dataType": { + "description": "The datatype for which the indexing behavior is applied to.", + "type": "string", + "default": "String", + "enum": [ + "String", + "Number", + "Point", + "Polygon", + "LineString", + "MultiPolygon" + ], + "x-ms-enum": { + "name": "DataType", + "modelAsString": true + } + }, + "precision": { + "description": "The precision of the index. -1 is maximum precision.", + "type": "integer" + }, + "kind": { + "description": "Indicates the type of index.", + "type": "string", + "default": "Hash", + "enum": [ + "Hash", + "Range", + "Spatial" + ], + "x-ms-enum": { + "name": "IndexKind", + "modelAsString": true + } + } + } + }, + "CompositePathList": { + "description": "List of composite path", + "type": "array", + "items": { + "$ref": "#/definitions/CompositePath" + } + }, + "CompositePath": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "order": { + "description": "Sort order for composite paths.", + "type": "string", + "enum": [ + "Ascending", + "Descending" + ], + "x-ms-enum": { + "name": "CompositePathSortOrder", + "modelAsString": true + } + } + } + }, + "SpatialSpec": { + "type": "object", + "properties": { + "path": { + "type": "string", + "description": "The path for which the indexing behavior applies to. Index paths typically start with root and end with wildcard (/path/*)" + }, + "types": { + "description": "List of path's spatial type", + "type": "array", + "items": { + "$ref": "#/definitions/SpatialType" + } + } + } + }, + "SpatialType": { + "description": "Indicates the spatial type of index.", + "type": "string", + "enum": [ + "Point", + "LineString", + "Polygon", + "MultiPolygon" + ], + "x-ms-enum": { + "name": "SpatialType", + "modelAsString": true + } + }, + "ContainerPartitionKey": { + "type": "object", + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions", + "properties": { + "paths": { + "description": "List of paths using which data within the container can be partitioned", + "type": "array", + "items": { + "$ref": "#/definitions/Path" + } + }, + "kind": { + "description": "Indicates the kind of algorithm used for partitioning", + "type": "string", + "default": "Hash", + "enum": [ + "Hash", + "Range" + ], + "x-ms-enum": { + "name": "PartitionKind", + "modelAsString": true + } + }, + "version": { + "description": "Indicates the version of the partition key definition", + "type": "integer", + "minimum": 1, + "maximum": 2, + "format": "int32" + } + } + }, + "Path": { + "type": "string", + "description": "A path. These typically start with root (/path)" + }, + "UniqueKeyPolicy": { + "type": "object", + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service.", + "properties": { + "uniqueKeys": { + "description": "List of unique keys on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.", + "type": "array", + "items": { + "$ref": "#/definitions/UniqueKey" + } + } + } + }, + "UniqueKey": { + "type": "object", + "description": "The unique key on that enforces uniqueness constraint on documents in the collection in the Azure Cosmos DB service.", + "properties": { + "paths": { + "description": "List of paths must be unique for each document in the Azure Cosmos DB service", + "type": "array", + "items": { + "$ref": "#/definitions/Path" + } + } + } + }, + "ConflictResolutionPolicy": { + "type": "object", + "description": "The conflict resolution policy for the container.", + "properties": { + "mode": { + "description": "Indicates the conflict resolution mode.", + "type": "string", + "default": "LastWriterWins", + "enum": [ + "LastWriterWins", + "Custom" + ], + "x-ms-enum": { + "name": "ConflictResolutionMode", + "modelAsString": true + } + }, + "conflictResolutionPath": { + "type": "string", + "description": "The conflict resolution path in the case of LastWriterWins mode." + }, + "conflictResolutionProcedure": { + "type": "string", + "description": "The procedure to resolve conflicts in the case of custom mode." + } + } + }, + "SqlStoredProcedureResource": { + "type": "object", + "description": "Cosmos DB SQL storedProcedure resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL storedProcedure" + }, + "body": { + "type": "string", + "description": "Body of the Stored Procedure" + } + }, + "required": [ + "id" + ] + }, + "SqlUserDefinedFunctionResource": { + "type": "object", + "description": "Cosmos DB SQL userDefinedFunction resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL userDefinedFunction" + }, + "body": { + "type": "string", + "description": "Body of the User Defined Function" + } + }, + "required": [ + "id" + ] + }, + "SqlTriggerResource": { + "type": "object", + "description": "Cosmos DB SQL trigger resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB SQL trigger" + }, + "body": { + "type": "string", + "description": "Body of the Trigger" + }, + "triggerType": { + "type": "string", + "enum": [ + "Pre", + "Post" + ], + "description": "Type of the Trigger", + "x-ms-enum": { + "name": "triggerType", + "modelAsString": true + } + }, + "triggerOperation": { + "type": "string", + "enum": [ + "All", + "Create", + "Update", + "Delete", + "Replace" + ], + "description": "The operation the trigger is associated with", + "x-ms-enum": { + "name": "triggerOperation", + "modelAsString": true + } + } + }, + "required": [ + "id" + ] + }, + "MongoDBDatabaseResource": { + "type": "object", + "description": "Cosmos DB MongoDB database resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB MongoDB database" + } + }, + "required": [ + "id" + ] + }, + "MongoDBCollectionResource": { + "type": "object", + "description": "Cosmos DB MongoDB collection resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB MongoDB collection" + }, + "shardKey": { + "description": "A key-value pair of shard keys to be applied for the request.", + "$ref": "#/definitions/ShardKeys" + }, + "indexes": { + "description": "List of index keys", + "type": "array", + "items": { + "$ref": "#/definitions/MongoIndex" + } + }, + "analyticalStorageTtl": { + "type": "integer", + "description": "Analytical TTL." + } + }, + "required": [ + "id" + ] + }, + "ShardKeys": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "The shard key and partition kind pair, only support \"Hash\" partition kind" + }, + "MongoIndex": { + "type": "object", + "description": "Cosmos DB MongoDB collection index key", + "properties": { + "key": { + "description": "Cosmos DB MongoDB collection index keys", + "$ref": "#/definitions/MongoIndexKeys" + }, + "options": { + "description": "Cosmos DB MongoDB collection index key options", + "$ref": "#/definitions/MongoIndexOptions" + } + } + }, + "MongoIndexKeys": { + "type": "object", + "description": "Cosmos DB MongoDB collection resource object", + "properties": { + "keys": { + "description": "List of keys for each MongoDB collection in the Azure Cosmos DB service", + "type": "array", + "items": { + "$ref": "#/definitions/Key" + } + } + } + }, + "Key": { + "type": "string", + "description": "A Key." + }, + "MongoIndexOptions": { + "type": "object", + "description": "Cosmos DB MongoDB collection index options", + "properties": { + "expireAfterSeconds": { + "description": "Expire after seconds", + "type": "integer" + }, + "unique": { + "description": "Is unique or not", + "type": "boolean" + } + } + }, + "TableResource": { + "type": "object", + "description": "Cosmos DB table resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB table" + } + }, + "required": [ + "id" + ] + }, + "CassandraKeyspaceResource": { + "type": "object", + "description": "Cosmos DB Cassandra keyspace resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra keyspace" + } + }, + "required": [ + "id" + ] + }, + "CassandraTableResource": { + "type": "object", + "description": "Cosmos DB Cassandra table resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table" + }, + "defaultTtl": { + "type": "integer", + "description": "Time to live of the Cosmos DB Cassandra table" + }, + "schema": { + "description": "Schema of the Cosmos DB Cassandra table", + "$ref": "#/definitions/CassandraSchema" + }, + "analyticalStorageTtl": { + "type": "integer", + "description": "Analytical TTL." + } + }, + "required": [ + "id" + ] + }, + "CassandraSchema": { + "type": "object", + "description": "Cosmos DB Cassandra table schema", + "properties": { + "columns": { + "type": "array", + "items": { + "$ref": "#/definitions/Column" + }, + "description": "List of Cassandra table columns." + }, + "partitionKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/CassandraPartitionKey" + }, + "description": "List of partition key." + }, + "clusterKeys": { + "type": "array", + "items": { + "$ref": "#/definitions/ClusterKey" + }, + "description": "List of cluster key." + } + } + }, + "Column": { + "type": "object", + "description": "Cosmos DB Cassandra table column", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table column" + }, + "type": { + "type": "string", + "description": "Type of the Cosmos DB Cassandra table column" + } + } + }, + "CassandraPartitionKey": { + "type": "object", + "description": "Cosmos DB Cassandra table partition key", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table partition key" + } + } + }, + "ClusterKey": { + "type": "object", + "description": "Cosmos DB Cassandra table cluster key", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB Cassandra table cluster key" + }, + "orderBy": { + "type": "string", + "description": "Order of the Cosmos DB Cassandra table cluster key, only support \"Asc\" and \"Desc\"" + } + } + }, + "GremlinDatabaseResource": { + "type": "object", + "description": "Cosmos DB Gremlin database resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Gremlin database" + } + }, + "required": [ + "id" + ] + }, + "GremlinGraphResource": { + "type": "object", + "description": "Cosmos DB Gremlin graph resource object", + "properties": { + "id": { + "type": "string", + "description": "Name of the Cosmos DB Gremlin graph" + }, + "indexingPolicy": { + "$ref": "#/definitions/IndexingPolicy", + "description": "The configuration of the indexing policy. By default, the indexing is automatic for all document paths within the graph" + }, + "partitionKey": { + "$ref": "#/definitions/ContainerPartitionKey", + "description": "The configuration of the partition key to be used for partitioning data into multiple partitions" + }, + "defaultTtl": { + "type": "integer", + "description": "Default time to live" + }, + "uniqueKeyPolicy": { + "$ref": "#/definitions/UniqueKeyPolicy", + "description": "The unique key policy configuration for specifying uniqueness constraints on documents in the collection in the Azure Cosmos DB service." + }, + "conflictResolutionPolicy": { + "$ref": "#/definitions/ConflictResolutionPolicy", + "description": "The conflict resolution policy for the graph." + } + }, + "required": [ + "id" + ] + }, + "CreateUpdateOptions": { + "type": "object", + "properties": { + "throughput": { + "type": "integer", + "description": "Request Units per second. For example, \"throughput\": 10000." + }, + "autoscaleSettings": { + "$ref": "#/definitions/AutoscaleSettings", + "description": "Specifies the Autoscale settings." + } + }, + "description": "CreateUpdateOptions are a list of key-value pairs that describe the resource. Supported keys are \"If-Match\", \"If-None-Match\", \"Session-Token\" and \"Throughput\"" + }, + "AutoscaleSettings": { + "type": "object", + "properties": { + "maxThroughput": { + "type": "integer", + "description": "Represents maximum throughput, the resource can scale up to." + } + } + }, + "Capability": { + "type": "object", + "description": "Cosmos DB capability object", + "properties": { + "name": { + "type": "string", + "description": "Name of the Cosmos DB capability. For example, \"name\": \"EnableCassandra\". Current values also include \"EnableTable\" and \"EnableGremlin\"." + } + } + }, + "Tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Tags are a list of key-value pairs that describe the resource. These tags can be used in viewing and grouping this resource (across resource groups). A maximum of 15 tags can be provided for a resource. Each tag must have a key no greater than 128 characters and value no greater than 256 characters. For example, the default experience for a template type is set with \"defaultExperience\": \"Cassandra\". Current \"defaultExperience\" values also include \"Table\", \"Graph\", \"DocumentDB\", and \"MongoDB\"." + }, + "ManagedServiceIdentity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant id of the system assigned identity. This property will only be provided for a system assigned identity." + }, + "type": { + "type": "string", + "description": "The type of identity used for the resource. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user assigned identities. The type 'None' will remove any identities from the service.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + } + }, + "description": "Identity for the resource." + }, + "ProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The status of the Cosmos DB account at the time the operation was called. The status can be one of following. 'Creating' – the Cosmos DB account is being created. When an account is in Creating state, only properties that are specified as input for the Create Cosmos DB account operation are returned. 'Succeeded' – the Cosmos DB account is active for use. 'Updating' – the Cosmos DB account is being updated. 'Deleting' – the Cosmos DB account is being deleted. 'Failed' – the Cosmos DB account failed creation. 'DeletionFailed' – the Cosmos DB account deletion failed." + }, + "IPRules": { + "type": "array", + "description": "Array of IpAddressOrRange objects.", + "items": { + "$ref": "#/definitions/IpAddressOrRange" + } + }, + "IpAddressOrRange": { + "type": "object", + "description": "IpAddressOrRange object", + "properties": { + "ipAddressOrRange": { + "type": "string", + "description": "A single IPv4 address or a single IPv4 address range in CIDR format. Provided IPs must be well-formatted and cannot be contained in one of the following ranges: 10.0.0.0/8, 100.64.0.0/10, 172.16.0.0/12, 192.168.0.0/16, since these are not enforceable by the IP address filter. Example of valid inputs: “23.40.210.245” or “23.40.210.0/8”." + } + } + }, + "VirtualNetworkRule": { + "type": "object", + "description": "Virtual Network ACL Rule object", + "properties": { + "id": { + "type": "string", + "description": "Resource ID of a subnet, for example: /subscriptions/{subscriptionId}/resourceGroups/{groupName}/providers/Microsoft.Network/virtualNetworks/{virtualNetworkName}/subnets/{subnetName}." + }, + "ignoreMissingVNetServiceEndpoint": { + "type": "boolean", + "description": "Create firewall rule before the virtual network has vnet service endpoint enabled." + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ] + }, + "PrivateEndpointConnectionProperties": { + "description": "Properties of a private endpoint connection.", + "type": "object", + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpointProperty", + "description": "Private endpoint which the connection belongs to." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStateProperty", + "description": "Connection State of the Private Endpoint Connection." + } + } + }, + "PrivateEndpointProperty": { + "type": "object", + "description": "Private endpoint which the connection belongs to.", + "properties": { + "id": { + "type": "string", + "description": "Resource id of the private endpoint." + } + } + }, + "PrivateLinkServiceConnectionStateProperty": { + "type": "object", + "description": "Connection State of the Private Endpoint Connection.", + "properties": { + "status": { + "type": "string", + "description": "The private link service connection status." + }, + "actionsRequired": { + "type": "string", + "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)", + "readOnly": true + } + } + }, + "Operation": { + "description": "REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "Provider": { + "description": "Service provider: Microsoft.ResourceProvider", + "type": "string" + }, + "Resource": { + "description": "Resource on which the operation is performed: Profile, endpoint, etc.", + "type": "string" + }, + "Operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string" + }, + "Description": { + "description": "Description of operation", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "Result of the request to list Resource Provider operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of operations supported by the Resource Provider." + }, + "nextLink": { + "type": "string", + "description": "URL to get the next set of operation list results if there are any." + } + } + }, + "UsagesResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of usages for the database. A usage is a point in time metric" + } + }, + "description": "The response to a list usage request." + }, + "Usage": { + "properties": { + "unit": { + "description": "The unit of the metric.", + "$ref": "#/definitions/UnitType" + }, + "name": { + "$ref": "#/definitions/MetricName", + "readOnly": true, + "description": "The name information for the metric." + }, + "quotaPeriod": { + "type": "string", + "readOnly": true, + "description": "The quota period used to summarize the usage values." + }, + "limit": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Maximum value for this metric" + }, + "currentValue": { + "type": "integer", + "format": "int64", + "readOnly": true, + "description": "Current value for this metric" + } + }, + "description": "The usage data for a usage request." + }, + "PartitionUsagesResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PartitionUsage" + }, + "description": "The list of partition-level usages for the database. A usage is a point in time metric" + } + }, + "description": "The response to a list partition level usage request." + }, + "PartitionUsage": { + "allOf": [ + { + "$ref": "#/definitions/Usage" + } + ], + "properties": { + "partitionId": { + "readOnly": true, + "type": "string", + "description": "The partition id (GUID identifier) of the usages." + }, + "partitionKeyRangeId": { + "readOnly": true, + "type": "string", + "description": "The partition key range id (integer identifier) of the usages." + } + }, + "description": "The partition level usage data for a usage request." + }, + "MetricDefinitionsListResult": { + "properties": { + "value": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MetricDefinition" + }, + "description": "The list of metric definitions for the account." + } + }, + "description": "The response to a list metric definitions request." + }, + "MetricDefinition": { + "properties": { + "metricAvailabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/MetricAvailability" + }, + "description": "The list of metric availabilities for the account." + }, + "primaryAggregationType": { + "readOnly": true, + "type": "string", + "description": "The primary aggregation type of the metric.", + "enum": [ + "None", + "Average", + "Total", + "Minimum", + "Maximum", + "Last" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PrimaryAggregationType" + } + }, + "unit": { + "description": "The unit of the metric.", + "$ref": "#/definitions/UnitType" + }, + "resourceUri": { + "readOnly": true, + "type": "string", + "description": "The resource uri of the database." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + } + }, + "description": "The definition of a metric." + }, + "MetricAvailability": { + "properties": { + "timeGrain": { + "readOnly": true, + "type": "string", + "description": "The time grain to be used to summarize the metric values." + }, + "retention": { + "readOnly": true, + "type": "string", + "description": "The retention for the metric values." + } + }, + "description": "The availability of the metric." + }, + "MetricListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Metric" + }, + "description": "The list of metrics for the account." + } + }, + "description": "The response to a list metrics request." + }, + "Metric": { + "properties": { + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The start time for the metric (ISO-8601 format)." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The end time for the metric (ISO-8601 format)." + }, + "timeGrain": { + "readOnly": true, + "type": "string", + "description": "The time grain to be used to summarize the metric values." + }, + "unit": { + "$ref": "#/definitions/UnitType", + "description": "The unit of the metric." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + }, + "metricValues": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/MetricValue" + }, + "description": "The metric values for the specified time window and timestep." + } + }, + "description": "Metric data" + }, + "MetricName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the metric." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The friendly name of the metric." + } + }, + "description": "A metric name." + }, + "MetricValue": { + "properties": { + "_count": { + "readOnly": true, + "type": "number", + "format": "int32", + "description": "The number of values for the metric." + }, + "average": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The average value of the metric." + }, + "maximum": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The max value of the metric." + }, + "minimum": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The min value of the metric." + }, + "timestamp": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The metric timestamp (ISO-8601 format)." + }, + "total": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The total value of the metric." + } + }, + "description": "Represents metrics values." + }, + "PercentileMetricListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PercentileMetric" + }, + "description": "The list of percentile metrics for the account." + } + }, + "description": "The response to a list percentile metrics request." + }, + "PercentileMetric": { + "properties": { + "startTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The start time for the metric (ISO-8601 format)." + }, + "endTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The end time for the metric (ISO-8601 format)." + }, + "timeGrain": { + "readOnly": true, + "type": "string", + "description": "The time grain to be used to summarize the metric values." + }, + "unit": { + "$ref": "#/definitions/UnitType", + "description": "The unit of the metric." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/MetricName", + "description": "The name information for the metric." + }, + "metricValues": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PercentileMetricValue" + }, + "description": "The percentile metric values for the specified time window and timestep." + } + }, + "description": "Percentile Metric data" + }, + "PercentileMetricValue": { + "allOf": [ + { + "$ref": "#/definitions/MetricValue" + } + ], + "properties": { + "P10": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 10th percentile value for the metric." + }, + "P25": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 25th percentile value for the metric." + }, + "P50": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 50th percentile value for the metric." + }, + "P75": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 75th percentile value for the metric." + }, + "P90": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 90th percentile value for the metric." + }, + "P95": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 95th percentile value for the metric." + }, + "P99": { + "readOnly": true, + "type": "number", + "format": "double", + "description": "The 99th percentile value for the metric." + } + }, + "description": "Represents percentile metrics values." + }, + "PartitionMetricListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PartitionMetric" + }, + "description": "The list of partition-level metrics for the account." + } + }, + "description": "The response to a list partition metrics request." + }, + "PartitionMetric": { + "allOf": [ + { + "$ref": "#/definitions/Metric" + } + ], + "properties": { + "partitionId": { + "readOnly": true, + "type": "string", + "description": "The partition id (GUID identifier) of the metric values." + }, + "partitionKeyRangeId": { + "readOnly": true, + "type": "string", + "description": "The partition key range id (integer identifier) of the metric values." + } + }, + "description": "The metric values for a single partition." + }, + "UnitType": { + "type": "string", + "readOnly": true, + "description": "The unit of the metric.", + "enum": [ + "Count", + "Bytes", + "Seconds", + "Percent", + "CountPerSecond", + "BytesPerSecond", + "Milliseconds" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "UnitType" + } + }, + "ConnectorOffer": { + "description": "The cassandra connector offer type for the Cosmos DB C* database account.", + "type": "string", + "enum": [ + "Small" + ], + "x-ms-enum": { + "name": "ConnectorOffer", + "modelAsString": true + } + }, + "PublicNetworkAccess": { + "type": "string", + "readOnly": true, + "description": "Whether requests from Public Network are allowed", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "modelAsString": true, + "name": "PublicNetworkAccess" + } + }, + "ApiProperties": { + "type": "object", + "properties": { + "serverVersion": { + "type": "string", + "enum": [ + "3.2", + "3.6" + ], + "description": "Describes the ServerVersion of an a MongoDB account.", + "x-ms-enum": { + "modelAsString": true, + "name": "ServerVersion" + } + } + } + }, + "CreateMode": { + "description": "Enum to indicate the mode of account creation.", + "type": "string", + "default": "Default", + "enum": [ + "Default", + "Restore" + ], + "x-ms-enum": { + "name": "CreateMode", + "modelAsString": true + } + }, + "RestoreParameters": { + "type": "object", + "description": "Parameters to indicate the information about the restore.", + "x-ms-mutability": [ + "read", + "create" + ], + "properties": { + "restoreMode": { + "type": "string", + "enum": [ + "PointInTime" + ], + "description": "Describes the mode of the restore.", + "x-ms-enum": { + "modelAsString": true, + "name": "RestoreMode" + } + }, + "restoreSource": { + "type": "string", + "description": "Path of the source account from which the restore has to be initiated" + }, + "restoreTimestampInUtc": { + "type": "string", + "format": "date-time", + "description": "Time to which the account has to be restored (ISO-8601 format)." + }, + "databasesToRestore": { + "type": "array", + "description": "List of specific databases to restore.", + "items": { + "$ref": "#/definitions/DatabaseRestoreResource" + } + } + } + }, + "DatabaseRestoreResource": { + "type": "object", + "description": "Specific Databases to restore.", + "properties": { + "databaseName": { + "type": "string", + "description": "The name of the database to restore." + }, + "collectionNames": { + "type": "array", + "description": "The names of the collections to restore.", + "items": { + "$ref": "#/definitions/CollectionName" + } + } + } + }, + "CollectionName": { + "type": "string", + "description": "The name of the collection." + }, + "BackupPolicy": { + "type": "object", + "description": "The object representing the policy for taking backups on an account.", + "discriminator": "type", + "properties": { + "type": { + "type": "string", + "enum": [ + "Periodic", + "Continuous" + ], + "description": "Describes the mode of backups.", + "x-ms-enum": { + "modelAsString": true, + "name": "BackupType" + } + } + }, + "required": [ + "type" + ] + }, + "PeriodicModeBackupPolicy": { + "description": "The object representing periodic mode backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupPolicy" + } + ], + "properties": { + "periodicModeProperties": { + "type": "object", + "description": "Configuration values for periodic mode backup", + "$ref": "#/definitions/PeriodicModeProperties" + } + }, + "x-ms-discriminator-value": "Periodic" + }, + "ContinuousModeBackupPolicy": { + "description": "The object representing continuous mode backup policy.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/BackupPolicy" + } + ], + "x-ms-discriminator-value": "Continuous" + }, + "PeriodicModeProperties": { + "type": "object", + "description": "Configuration values for periodic mode backup", + "properties": { + "backupIntervalInMinutes": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "An integer representing the interval in minutes between two backups" + }, + "backupRetentionIntervalInHours": { + "type": "integer", + "format": "int32", + "minimum": 0, + "description": "An integer representing the time (in hours) that each backup is retained" + } + } + }, + "RestorableDatabaseAccountsListResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/RestorableDatabaseAccountGetResult" + }, + "description": "List of restorable database accounts and their properties." + } + }, + "description": "The List operation response, that contains the restorable database accounts and their properties." + }, + "RestorableDatabaseAccountGetResult": { + "description": "A Azure Cosmos DB restorable database account.", + "type": "object", + "properties": { + "properties": { + "type": "object", + "x-ms-client-flatten": true, + "description": "The properties of a restorable database account.", + "$ref": "#/definitions/RestorableDatabaseAccountProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/ARMResourceProperties" + } + ] + }, + "RestorableDatabaseAccountProperties": { + "type": "object", + "description": "The properties of a restorable database account.", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the global database account" + }, + "creationTime": { + "type": "string", + "format": "date-time", + "description": "The creation time of the restorable database account (ISO-8601 format)." + }, + "deletionTime": { + "type": "string", + "format": "date-time", + "description": "The time at which the restorable database account has been deleted (ISO-8601 format)." + } + } + } + }, + "parameters": { + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "x-ms-parameter-location": "method", + "description": "Name of an Azure resource group." + }, + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "filterParameter": { + "name": "$filter", + "in": "query", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "An OData filter expression that describes a subset of metrics to return. The parameters that can be filtered are name.value (name of the metric, can have an or of multiple names), startTime, endTime, and timeGrain. The supported operator is eq." + }, + "usageFilterParameter": { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "An OData filter expression that describes a subset of usages to return. The supported parameter is name.value (name of the metric, can have an or of multiple names)." + }, + "databaseRidParameter": { + "name": "databaseRid", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database rid." + }, + "collectionRidParameter": { + "name": "collectionRid", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB collection rid." + }, + "databaseNameParameter": { + "name": "databaseName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database name." + }, + "containerNameParameter": { + "name": "containerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB container name." + }, + "storedProcedureNameParameter": { + "name": "storedProcedureName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB storedProcedure name." + }, + "userDefinedFunctionNameParameter": { + "name": "userDefinedFunctionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB userDefinedFunction name." + }, + "triggerNameParameter": { + "name": "triggerName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB trigger name." + }, + "tableNameParameter": { + "name": "tableName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB table name." + }, + "collectionNameParameter": { + "name": "collectionName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB collection name." + }, + "keyspaceNameParameter": { + "name": "keyspaceName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB keyspace name." + }, + "graphNameParameter": { + "name": "graphName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB graph name." + }, + "regionParameter": { + "name": "region", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + }, + "sourceRegionParameter": { + "name": "sourceRegion", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Source region from which data is written. Cosmos DB region, with spaces between words and each word capitalized." + }, + "targetRegionParameter": { + "name": "targetRegion", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Target region to which data is written. Cosmos DB region, with spaces between words and each word capitalized." + }, + "partitionKeyRangeIdParameter": { + "name": "partitionKeyRangeId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Partition Key Range Id for which to get data." + }, + "locationParameter": { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB region, with spaces between words and each word capitalized." + }, + "instanceIdParameter": { + "name": "instanceId", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "The instanceId GUID of a restorable database account." + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceCreateUpdate.json new file mode 100644 index 000000000000..704a58b5370a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceCreateUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "createUpdateCassandraKeyspaceParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName", + "name": "keyspaceName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceDelete.json new file mode 100644 index 000000000000..a00447bc3970 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceGet.json new file mode 100644 index 000000000000..bd7d25ca3402 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName", + "name": "keyspaceName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceList.json new file mode 100644 index 000000000000..43d5d1ba9756 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName", + "name": "keyspaceName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "keyspaceName" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceThroughputGet.json new file mode 100644 index 000000000000..58d8462cf64c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceThroughputGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json new file mode 100644 index 000000000000..eea27bf7db93 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraKeyspaceThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableCreateUpdate.json new file mode 100644 index 000000000000..14c411773aee --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableCreateUpdate.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName", + "createUpdateCassandraTableParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "analyticalStorageTtl": 500, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "analyticalStorageTtl": 500, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableDelete.json new file mode 100644 index 000000000000..7ef5350d9689 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableGet.json new file mode 100644 index 000000000000..965e0010d877 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableGet.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "analyticalStorageTtl": 500, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableList.json new file mode 100644 index 000000000000..1fa9aa4eecd6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableList.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "keyspaceName": "keyspaceName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "defaultTtl": 100, + "analyticalStorageTtl": 500, + "schema": { + "columns": [ + { + "name": "columnA", + "type": "Ascii" + } + ], + "partitionKeys": [ + { + "name": "columnA" + } + ], + "clusterKeys": [ + { + "name": "columnA", + "orderBy": "Asc" + } + ] + } + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableThroughputGet.json new file mode 100644 index 000000000000..9a6890c7f1b2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableThroughputGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableThroughputUpdate.json new file mode 100644 index 000000000000..6dee1f99e66f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCassandraTableThroughputUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyspaceName": "keyspaceName", + "tableName": "tableName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/cassandraKeyspaces/keyspaceName/cassandraTables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/cassandraKeyspaces/cassandraTables/throughputSettings", + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetMetricDefinitions.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetMetricDefinitions.json new file mode 100644 index 000000000000..6a503803cca4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetMetricDefinitions.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "api-version": "2020-06-01-preview", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "timeGrain": "PT5M", + "retention": "P2D" + }, + { + "timeGrain": "PT1H", + "retention": "P14D" + }, + { + "timeGrain": "P1D", + "retention": "P60D" + } + ], + "primaryAggregationType": "Total", + "unit": "Count", + "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetMetrics.json new file mode 100644 index 000000000000..fda0156ddfe7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetMetrics.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetUsages.json new file mode 100644 index 000000000000..163634723a7e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionGetUsages.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionGetMetrics.json new file mode 100644 index 000000000000..f24c2b3bcbad --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionGetMetrics.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionGetUsages.json new file mode 100644 index 000000000000..9e2d9c9f85be --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionGetUsages.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Partition Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionRegionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionRegionGetMetrics.json new file mode 100644 index 000000000000..2a2eb4964a0e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBCollectionPartitionRegionGetMetrics.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "region": "North Europe", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCheckNameExists.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCheckNameExists.json new file mode 100644 index 000000000000..88a5ba3070e6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCheckNameExists.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "accountName": "ddb1", + "api-version": "2020-06-01-preview" + }, + "responses": { + "200": {}, + "404": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCreateMax.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCreateMax.json new file mode 100644 index 000000000000..2197eae8a3fa --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCreateMax.json @@ -0,0 +1,169 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "createUpdateParameters": { + "location": "westus", + "tags": {}, + "kind": "MongoDB", + "properties": { + "databaseAccountOfferType": "Standard", + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "isVirtualNetworkFilterEnabled": true, + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false + } + ], + "locations": [ + { + "failoverPriority": 0, + "locationName": "southcentralus", + "isZoneRedundant": false + }, + { + "failoverPriority": 1, + "locationName": "eastus", + "isZoneRedundant": false + } + ], + "createMode": "Default", + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "keyVaultKeyUri": "https://myKeyVault.vault.azure.net", + "enableFreeTier": false, + "apiProperties": { + "serverVersion": "3.2" + }, + "enableAnalyticalStorage": true, + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "MongoDB", + "tags": {}, + "properties": { + "provisioningState": "Initializing", + "isVirtualNetworkFilterEnabled": true, + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "writeLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "readLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + }, + { + "id": "ddb1-eastus", + "locationName": "East US", + "provisioningState": "Initializing", + "failoverPriority": 1, + "isZoneRedundant": false + } + ], + "locations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + }, + { + "id": "ddb1-eastus", + "locationName": "East US", + "provisioningState": "Initializing", + "failoverPriority": 1, + "isZoneRedundant": false + } + ], + "failoverPolicies": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "failoverPriority": 0 + }, + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 1 + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1" + } + ], + "keyVaultKeyUri": "https://myKeyVault.vault.azure.net", + "enableFreeTier": false, + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "apiProperties": { + "serverVersion": "3.2" + }, + "enableAnalyticalStorage": true, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720 + } + } + }, + "systemData": { + "createdAt": "2020-06-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCreateMin.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCreateMin.json new file mode 100644 index 000000000000..3b69dcc403f0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountCreateMin.json @@ -0,0 +1,94 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "createUpdateParameters": { + "location": "westus", + "properties": { + "databaseAccountOfferType": "Standard", + "locations": [ + { + "failoverPriority": 0, + "locationName": "southcentralus", + "isZoneRedundant": false + } + ], + "createMode": "Default" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Initializing", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "readLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "locations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "failoverPolicies": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "failoverPriority": 0 + } + ], + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": false, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720 + } + } + }, + "systemData": { + "createdAt": "2020-06-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountDelete.json new file mode 100644 index 000000000000..9ff324b8aaed --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json new file mode 100644 index 000000000000..d8af0ff02935 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountFailoverPriorityChange.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "accountName": "ddb1-failover", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "failoverParameters": { + "failoverPolicies": [ + { + "locationName": "eastus", + "failoverPriority": 0 + }, + { + "locationName": "westus", + "failoverPriority": 1 + } + ] + } + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGet.json new file mode 100644 index 000000000000..92ae63e5ada1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGet.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "ipRules": [], + "isVirtualNetworkFilterEnabled": false, + "virtualNetworkRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "privateEndpointConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": true, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720 + } + } + }, + "systemData": { + "createdAt": "2020-06-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json new file mode 100644 index 000000000000..63517ceb5d9a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetMetricDefinitions.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "api-version": "2020-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "timeGrain": "PT5M", + "retention": "P2D" + }, + { + "timeGrain": "PT1H", + "retention": "P14D" + }, + { + "timeGrain": "P1D", + "retention": "P60D" + } + ], + "primaryAggregationType": "Total", + "unit": "Count", + "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetMetrics.json new file mode 100644 index 000000000000..a0f443baa506 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetMetrics.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetUsages.json new file mode 100644 index 000000000000..1bb8ecba1ac4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountGetUsages.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountList.json new file mode 100644 index 000000000000..f4c4cc0b1429 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountList.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "privateEndpointConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": true, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720 + } + } + }, + "systemData": { + "createdAt": "2020-06-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListByResourceGroup.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListByResourceGroup.json new file mode 100644 index 000000000000..65415c73b724 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListByResourceGroup.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "resourceGroupName": "rg1", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "enableFreeTier": false, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720 + } + } + }, + "systemData": { + "createdAt": "2020-06-12T22:05:09Z" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListConnectionStrings.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListConnectionStrings.json new file mode 100644 index 000000000000..37ca1bbce43e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListConnectionStrings.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": {} + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json new file mode 100644 index 000000000000..c662a11aaac4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListConnectionStringsMongo.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "accountName": "mongo-ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "connectionStrings": [ + { + "connectionString": "connection-string", + "description": "Name of the connection string" + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListKeys.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListKeys.json new file mode 100644 index 000000000000..fc86bad626ce --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryMasterKey": "primaryMasterKey", + "secondaryMasterKey": "secondaryMasterKey", + "primaryReadonlyMasterKey": "primaryReadonlyMasterKey", + "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json new file mode 100644 index 000000000000..86cfea49057e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountListReadOnlyKeys.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "primaryReadonlyMasterKey": "primaryReadonlyMasterKey", + "secondaryReadonlyMasterKey": "secondaryReadonlyMasterKey" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountOfflineRegion.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountOfflineRegion.json new file mode 100644 index 000000000000..682fcdb01757 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountOfflineRegion.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "region": "North Europe", + "regionParameterForOffline": [ + { + "region": "North Europe" + } + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountOnlineRegion.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountOnlineRegion.json new file mode 100644 index 000000000000..625bb398abf4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountOnlineRegion.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "region": "North Europe", + "regionParameterForOnline": [ + { + "region": "North Europe" + } + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountPatch.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountPatch.json new file mode 100644 index 000000000000..9976e4e73f08 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountPatch.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "updateParameters": { + "location": "westus", + "tags": { + "dept": "finance" + }, + "properties": { + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "isVirtualNetworkFilterEnabled": true, + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false + } + ], + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "enableFreeTier": false, + "enableAnalyticalStorage": true, + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720 + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": { + "dept": "finance" + }, + "properties": { + "provisioningState": "Succeeded", + "documentEndpoint": "https://ddb1.documents.azure.com:443/", + "databaseAccountOfferType": "Standard", + "ipRules": [ + { + "ipAddressOrRange": "23.43.230.120" + }, + { + "ipAddressOrRange": "110.12.240.0/12" + } + ], + "isVirtualNetworkFilterEnabled": true, + "disableKeyBasedMetadataWriteAccess": false, + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "writeLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "readLocations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "locations": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "documentEndpoint": "https://ddb1-eastus.documents.azure.com:443/", + "provisioningState": "Succeeded", + "failoverPriority": 0 + } + ], + "failoverPolicies": [ + { + "id": "ddb1-eastus", + "locationName": "East US", + "failoverPriority": 0 + } + ], + "virtualNetworkRules": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/virtualNetworks/vnet1/subnets/subnet1", + "ignoreMissingVNetServiceEndpoint": false + } + ], + "privateEndpointConnections": [ + { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.DocumentDB/databaseAccounts/account1/privateEndpointConnections/pe1", + "properties": { + "privateEndpoint": { + "id": "/subscriptions/subId/resourceGroups/rg/providers/Microsoft.Network/privateEndpoints/pe1" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "actionsRequired": "None" + } + } + } + ], + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": true, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Default", + "backupPolicy": { + "type": "Periodic", + "periodicModeProperties": { + "backupIntervalInMinutes": 240, + "backupRetentionIntervalInHours": 720 + } + } + }, + "systemData": { + "createdAt": "2020-06-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountRegenerateKey.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountRegenerateKey.json new file mode 100644 index 000000000000..f85beb45eafe --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountRegenerateKey.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "keyToRegenerate": { + "keyKind": "primary" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountRegionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountRegionGetMetrics.json new file mode 100644 index 000000000000..57d348a599d6 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseAccountRegionGetMetrics.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "region": "North Europe", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetMetricDefinitions.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetMetricDefinitions.json new file mode 100644 index 000000000000..44125deca8fa --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetMetricDefinitions.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "subscriptionId": "subid", + "api-version": "2020-06-01-preview", + "databaseRid": "databaseRid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "metricAvailabilities": [ + { + "timeGrain": "PT5M", + "retention": "P2D" + }, + { + "timeGrain": "PT1H", + "retention": "P14D" + }, + { + "timeGrain": "P1D", + "retention": "P60D" + } + ], + "primaryAggregationType": "Total", + "unit": "Count", + "resourceUri": "/subscriptions/subId/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetMetrics.json new file mode 100644 index 000000000000..50ecbb2b5814 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetMetrics.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseRid": "rid", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetUsages.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetUsages.json new file mode 100644 index 000000000000..bf3fd23ba35c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBDatabaseGetUsages.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "databaseRid": "databaseRid", + "subscriptionId": "subid", + "$filter": "$filter=name.value eq 'Storage'" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "unit": "Bytes", + "quotaPeriod": "P1D", + "limit": 10737418240, + "currentValue": 0, + "name": { + "value": "Storage", + "localizedValue": "Storage" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseCreateUpdate.json new file mode 100644 index 000000000000..99e4f7832302 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateGremlinDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseDelete.json new file mode 100644 index 000000000000..511d9bcd4972 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseGet.json new file mode 100644 index 000000000000..6058e6595bbe --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseList.json new file mode 100644 index 000000000000..d11ac57d5e09 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseList.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseThroughputGet.json new file mode 100644 index 000000000000..d7cbd90483f2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseThroughputGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseThroughputUpdate.json new file mode 100644 index 000000000000..5d2d0a8c309e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinDatabaseThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphCreateUpdate.json new file mode 100644 index 000000000000..9c19ff332f3a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphCreateUpdate.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName", + "createUpdateGremlinGraphParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "graphName", + "indexingPolicy": { + "indexingMode": "Consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/gremlinGraphs/graphName", + "name": "graphName", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/gremlinGraphs", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "graphName", + "indexingPolicy": { + "indexingMode": "Consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphDelete.json new file mode 100644 index 000000000000..73028e433711 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphGet.json new file mode 100644 index 000000000000..e3dbd74c9b17 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphGet.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "id": "graphName", + "name": "graphName", + "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs", + "properties": { + "resource": { + "id": "graphName", + "indexingPolicy": { + "indexingMode": "Consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphList.json new file mode 100644 index 000000000000..c5063750656c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphList.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "testgrf", + "name": "testgrf", + "type": "Microsoft.DocumentDB/databaseAccounts/apis/databases/graphs", + "properties": { + "resource": { + "id": "testgrf", + "indexingPolicy": { + "indexingMode": "Consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphThroughputGet.json new file mode 100644 index 000000000000..6a8cb74481b7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphThroughputGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/gremlinGraphs/graphName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphThroughputUpdate.json new file mode 100644 index 000000000000..9651decd38e9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBGremlinGraphThroughputUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "graphName": "graphName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/gremlinDatabases/databaseName/gremlinGraphs/graphName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/gremlinDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionCreateUpdate.json new file mode 100644 index 000000000000..0770c6e729b0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionCreateUpdate.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName", + "createUpdateMongoDBCollectionParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "collectionName", + "indexes": [ + { + "key": { + "keys": [ + "testKey" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + } + ], + "shardKey": { + "testKey": "Hash" + }, + "analyticalStorageTtl": 500 + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName", + "name": "collectionName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "collectionName", + "indexes": [ + { + "key": { + "keys": [ + "testKey" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + } + ], + "shardKey": { + "testKey": "Hash" + }, + "analyticalStorageTtl": 500 + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionDelete.json new file mode 100644 index 000000000000..a50c0a68ac0c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionGet.json new file mode 100644 index 000000000000..e85d07849b7f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionGet.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName", + "name": "collectionName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testcoll", + "indexes": [ + { + "key": { + "keys": [ + "testKey" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + } + ], + "shardKey": { + "testKey": "Hash" + }, + "analyticalStorageTtl": 500, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionList.json new file mode 100644 index 000000000000..15ec98ed27b5 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName", + "name": "collectionName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testcoll", + "indexes": [ + { + "key": { + "keys": [ + "testKey" + ] + }, + "options": { + "expireAfterSeconds": 100, + "unique": true + } + } + ], + "shardKey": { + "testKey": "Hash" + }, + "analyticalStorageTtl": 500 + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionThroughputGet.json new file mode 100644 index 000000000000..5e76ac6ef716 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionThroughputGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionThroughputUpdate.json new file mode 100644 index 000000000000..9bd78681310b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBCollectionThroughputUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "collectionName": "collectionName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/mongodbCollections/collectionName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/mongodbCollections/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseCreateUpdate.json new file mode 100644 index 000000000000..7e889dabe227 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseCreateUpdate.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateMongoDBDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "updatedDatabaseName" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseDelete.json new file mode 100644 index 000000000000..511d9bcd4972 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseGet.json new file mode 100644 index 000000000000..346712c979e5 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseList.json new file mode 100644 index 000000000000..26fc4d475d9a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseThroughputGet.json new file mode 100644 index 000000000000..dce707ff3240 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseThroughputGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json new file mode 100644 index 000000000000..3f034474e39f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBMongoDBDatabaseThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/mongodbDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/mongodbDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceCreate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceCreate.json new file mode 100644 index 000000000000..afaae8fd0162 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceCreate.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default", + "notebookCreateUpdateParameters": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces", + "properties": { + "notebookServerEndpoint": "endpoint", + "status": "Online" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceDelete.json new file mode 100644 index 000000000000..ae29c887cf63 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "notebookWorkspaceName": "default" + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceGet.json new file mode 100644 index 000000000000..ca935a796b3f --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceGet.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces", + "properties": { + "notebookServerEndpoint": "endpoint", + "status": "Online" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceList.json new file mode 100644 index 000000000000..673787cf0a17 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceList.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/notebookWorkspaces/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/notebookWorkspaces", + "properties": { + "notebookServerEndpoint": "endpoint", + "status": "Online" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json new file mode 100644 index 000000000000..aa7442088867 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceListConnectionInfo.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": { + "body": { + "authToken": "auth-token", + "notebookServerEndpoint": "notebook endpoint" + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json new file mode 100644 index 000000000000..1ba266df714c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceStart.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceStart.json new file mode 100644 index 000000000000..1ba266df714c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBNotebookWorkspaceStart.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "accountName": "ddb1", + "notebookWorkspaceName": "default" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBOperationsList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBOperationsList.json new file mode 100644 index 000000000000..607a63bc1261 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBOperationsList.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "operationName", + "display": { + "Provider": "providerName", + "Resource": "resourceName", + "Operation": "operationName", + "Description": "description" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPKeyRangeIdGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPKeyRangeIdGetMetrics.json new file mode 100644 index 000000000000..1b5d6d517ab7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPKeyRangeIdGetMetrics.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "partitionKeyRangeId": "0", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json new file mode 100644 index 000000000000..0138199a1df3 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPKeyRangeIdRegionGetMetrics.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "partitionKeyRangeId": "0", + "region": "West US", + "$filter": "$filter=(name.value eq 'Max RUs Per Second') and timeGrain eq duration'PT1M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T23:58:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT1M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T23:58:55.2780000Z", + "unit": "Count", + "partitionId": "00000000-0000-0000-0000-000000000000", + "partitionKeyRangeId": "0", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:54:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:55:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:56:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:57:55.2780000Z", + "maximum": 5 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "maximum": 5 + } + ], + "name": { + "value": "Max RUs Per Second", + "localizedValue": "Max RUs Per Second" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileGetMetrics.json new file mode 100644 index 000000000000..c0231b6d7ae9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileGetMetrics.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "$filter": "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-East US" + } + }, + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-West US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-West US" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileSourceTargetGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileSourceTargetGetMetrics.json new file mode 100644 index 000000000000..60ecb004ae1d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileSourceTargetGetMetrics.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "sourceRegion": "West Central US", + "targetRegion": "East US", + "$filter": "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-East US" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileTargetGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileTargetGetMetrics.json new file mode 100644 index 000000000000..1b1ed44bc304 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBPercentileTargetGetMetrics.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "targetRegion": "East US", + "$filter": "$filter=(name.value eq 'Probabilistic Bounded Staleness') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West Central US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-East US" + } + }, + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Milliseconds", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "P10": 1.11, + "P25": 2.5, + "P50": 4.34, + "P75": 5.2, + "P90": 6.77, + "P95": 7.1, + "P99": 8.3 + } + ], + "name": { + "value": "Probabilistic Bounded Staleness-S-West US-T-East US", + "localizedValue": "Probabilistic Bounded Staleness-S-West Central US-T-West US" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRegionCollectionGetMetrics.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRegionCollectionGetMetrics.json new file mode 100644 index 000000000000..3d4f9ea56040 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRegionCollectionGetMetrics.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseRid": "databaseRid", + "collectionRid": "collectionRid", + "region": "North Europe", + "$filter": "$filter=(name.value eq 'Total Requests') and timeGrain eq duration'PT5M' and startTime eq '2017-11-19T23:53:55.2780000Z' and endTime eq '2017-11-20T00:13:55.2780000Z" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "timeGrain": "PT5M", + "startTime": "2017-11-19T23:53:55.2780000Z", + "endTime": "2017-11-20T00:13:55.2780000Z", + "unit": "Count", + "metricValues": [ + { + "timestamp": "2017-11-19T23:53:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-19T23:58:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:03:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + }, + { + "timestamp": "2017-11-20T00:08:55.2780000Z", + "total": 0, + "_count": 0, + "average": 0 + } + ], + "name": { + "value": "Total Requests", + "localizedValue": "Total Requests" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountGet.json new file mode 100644 index 000000000000..d5edee780392 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountGet.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "location": "West US", + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d", + "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb1", + "creationTime": "2020-04-11T21:56:15Z", + "deletionTime": "2020-06-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountList.json new file mode 100644 index 000000000000..aae7cbb69c37 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountList.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "location": "West US" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d", + "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb1", + "creationTime": "2020-04-11T21:56:15Z", + "deletionTime": "2020-06-12T22:05:09Z" + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "name": "4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb2", + "creationTime": "2020-05-01T08:05:18Z" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json new file mode 100644 index 000000000000..5b983987c671 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestorableDatabaseAccountNoLocationList.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/d9b26648-2f53-4541-b3d8-3044f4f9810d", + "name": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "location": "West US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb1", + "creationTime": "2020-04-11T21:56:15Z", + "deletionTime": "2020-06-12T22:05:09Z" + } + }, + { + "id": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/West US/restorableDatabaseAccounts/4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "name": "4f9e6ace-ac7a-446c-98bc-194c502a06b4", + "location": "East US", + "type": "Microsoft.DocumentDB/locations/restorableDatabaseAccounts", + "properties": { + "accountName": "ddb2", + "creationTime": "2020-05-01T08:05:18Z" + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json new file mode 100644 index 000000000000..911e7ddb3017 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBRestoreDatabaseAccountCreateUpdate.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "createUpdateParameters": { + "location": "westus", + "tags": {}, + "kind": "GlobalDocumentDB", + "properties": { + "databaseAccountOfferType": "Standard", + "locations": [ + { + "failoverPriority": 0, + "locationName": "southcentralus", + "isZoneRedundant": false + } + ], + "createMode": "Restore", + "restoreParameters": { + "restoreMode": "PointInTime", + "restoreSource": "/subscriptions/subid/providers/Microsoft.DocumentDB/locations/westus/restorableDatabaseAccounts/1a97b4bb-f6a0-430e-ade1-638d781830cc", + "restoreTimestampInUtc": "2020-06-11T22:05:09Z", + "databasesToRestore": [ + { + "databaseName": "db1", + "collectionNames": [ + "collection1", + "collection2" + ] + }, + { + "databaseName": "db2", + "collectionNames": [ + "collection3", + "collection4" + ] + } + ] + }, + "backupPolicy": { + "type": "Continuous" + }, + "consistencyPolicy": { + "defaultConsistencyLevel": "BoundedStaleness", + "maxIntervalInSeconds": 10, + "maxStalenessPrefix": 200 + }, + "keyVaultKeyUri": "https://myKeyVault.vault.azure.net", + "enableFreeTier": false, + "apiProperties": { + "serverVersion": "3.2" + }, + "enableAnalyticalStorage": true + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1", + "name": "ddb1", + "location": "West US", + "type": "Microsoft.DocumentDB/databaseAccounts", + "kind": "GlobalDocumentDB", + "tags": {}, + "properties": { + "provisioningState": "Initializing", + "ipRules": [], + "databaseAccountOfferType": "Standard", + "disableKeyBasedMetadataWriteAccess": false, + "instanceId": "d9b26648-2f53-4541-b3d8-3044f4f9810d", + "createMode": "Restore", + "consistencyPolicy": { + "defaultConsistencyLevel": "Session", + "maxIntervalInSeconds": 5, + "maxStalenessPrefix": 100 + }, + "writeLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "readLocations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "locations": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "provisioningState": "Initializing", + "failoverPriority": 0, + "isZoneRedundant": false + } + ], + "failoverPolicies": [ + { + "id": "ddb1-southcentralus", + "locationName": "South Central US", + "failoverPriority": 0 + } + ], + "enableFreeTier": false, + "apiProperties": {}, + "enableAnalyticalStorage": false + }, + "systemData": { + "createdAt": "2020-06-12T22:05:09Z" + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerCreateUpdate.json new file mode 100644 index 000000000000..d1501e29aa40 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerCreateUpdate.json @@ -0,0 +1,124 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "createUpdateSqlContainerParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "indexingPolicy": { + "indexingMode": "Consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + } + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName", + "name": "containerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "indexingPolicy": { + "indexingMode": "Consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerDelete.json new file mode 100644 index 000000000000..fc2853b90ebe --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerGet.json new file mode 100644 index 000000000000..179c0f5a81a9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerGet.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName", + "name": "containerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "containerName", + "indexingPolicy": { + "indexingMode": "Consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + }, + "options": { + "throughput": 400 + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerList.json new file mode 100644 index 000000000000..d5b52fbc7be7 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerList.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName", + "name": "containerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "testctn", + "indexingPolicy": { + "indexingMode": "Consistent", + "automatic": true, + "includedPaths": [ + { + "path": "/*", + "indexes": [ + { + "kind": "Range", + "dataType": "String", + "precision": -1 + }, + { + "kind": "Range", + "dataType": "Number", + "precision": -1 + } + ] + } + ], + "excludedPaths": [] + }, + "partitionKey": { + "paths": [ + "/AccountNumber" + ], + "kind": "Hash" + }, + "defaultTtl": 100, + "uniqueKeyPolicy": { + "uniqueKeys": [ + { + "paths": [ + "/testPath" + ] + } + ] + }, + "conflictResolutionPolicy": { + "mode": "LastWriterWins", + "conflictResolutionPath": "/path" + }, + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerThroughputGet.json new file mode 100644 index 000000000000..7114ec352ee9 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerThroughputGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerThroughputUpdate.json new file mode 100644 index 000000000000..06677777dea0 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlContainerThroughputUpdate.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseCreateUpdate.json new file mode 100644 index 000000000000..a7ef59f044b2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "createUpdateSqlDatabaseParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseDelete.json new file mode 100644 index 000000000000..511d9bcd4972 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseGet.json new file mode 100644 index 000000000000..e7923f36c977 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"", + "_colls": "colls/", + "_users": "users/" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseList.json new file mode 100644 index 000000000000..517ddda21f2d --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseList.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName", + "name": "databaseName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "databaseName", + "_rid": "CqNBAA==", + "_ts": 1449602962, + "_etag": "\"00000a00-0000-0000-0000-56672f920000\"", + "_colls": "colls/", + "_users": "users/" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseThroughputGet.json new file mode 100644 index 000000000000..1e2f1e3adc78 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseThroughputGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseThroughputUpdate.json new file mode 100644 index 000000000000..1f5b228deb22 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlDatabaseThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureCreateUpdate.json new file mode 100644 index 000000000000..c807256b0caa --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "storedProcedureName": "storedProcedureName", + "createUpdateSqlStoredProcedureParameters": { + "properties": { + "resource": { + "id": "storedProcedureName", + "body": "body" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName", + "name": "storedProcedureName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures", + "properties": { + "resource": { + "id": "storedProcedureName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureDelete.json new file mode 100644 index 000000000000..01802d9d09a1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "storedProcedureName": "storedProcedureName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureGet.json new file mode 100644 index 000000000000..9bb9c50b6c9e --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "storedProcedureName": "storedProcedureName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName", + "name": "storedProcedureName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures", + "properties": { + "resource": { + "id": "storedProcedureName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureList.json new file mode 100644 index 000000000000..be06ae058c7b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlStoredProcedureList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlStoredProcedures/storedProcedureName", + "name": "testctn", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlStoredProcedures", + "properties": { + "resource": { + "id": "testctn", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerCreateUpdate.json new file mode 100644 index 000000000000..d6eaba1a0572 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerCreateUpdate.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "triggerName": "triggerName", + "createUpdateSqlTriggerParameters": { + "properties": { + "resource": { + "id": "triggerName", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlTriggers/triggerName", + "name": "triggerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlTriggers", + "properties": { + "resource": { + "id": "triggerName", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerDelete.json new file mode 100644 index 000000000000..37cdf314a540 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "triggerName": "triggerName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerGet.json new file mode 100644 index 000000000000..2745bc74ce3c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "triggerName": "triggerName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlTriggers/triggerName", + "name": "triggerName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlTriggers", + "properties": { + "resource": { + "id": "triggerName", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerList.json new file mode 100644 index 000000000000..9a376a3ce9f4 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlTriggerList.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlTriggers/triggerName", + "name": "testctn", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlTriggers", + "properties": { + "resource": { + "id": "testctn", + "body": "body", + "triggerType": "triggerType", + "triggerOperation": "triggerOperation", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json new file mode 100644 index 000000000000..05b20aff47cf --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionCreateUpdate.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "userDefinedFunctionName": "userDefinedFunctionName", + "createUpdateSqlUserDefinedFunctionParameters": { + "properties": { + "resource": { + "id": "userDefinedFunctionName", + "body": "body" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlUserDefinedFunctions/userDefinedFunctionName", + "name": "userDefinedFunctionName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlUserDefinedFunctions", + "properties": { + "resource": { + "id": "userDefinedFunctionName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionDelete.json new file mode 100644 index 000000000000..c7ab1db02f6c --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "databaseName": "databaseName", + "containerName": "containerName", + "userDefinedFunctionName": "userDefinedFunctionName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionGet.json new file mode 100644 index 000000000000..60e2f938c7a2 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName", + "userDefinedFunctionName": "userDefinedFunctionName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlUserDefinedFunctions/userDefinedFunctionName", + "name": "userDefinedFunctionName", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlUserDefinedFunctions", + "properties": { + "resource": { + "id": "userDefinedFunctionName", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionList.json new file mode 100644 index 000000000000..5a3bdfee2cde --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBSqlUserDefinedFunctionList.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1", + "databaseName": "databaseName", + "containerName": "containerName" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/sqlDatabases/databaseName/sqlContainers/containerName/sqlUserDefinedFunctions/userDefinedFunctionName", + "name": "testctn", + "type": "Microsoft.DocumentDB/databaseAccounts/sqlDatabases/sqlContainers/sqlUserDefinedFunctions", + "properties": { + "resource": { + "id": "testctn", + "body": "body", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableCreateUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableCreateUpdate.json new file mode 100644 index 000000000000..a71b934c2e8a --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableCreateUpdate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "tableName": "tableName", + "createUpdateTableParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName" + }, + "options": {} + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/tables", + "location": "West US", + "properties": { + "resource": { + "id": "tableName" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableDelete.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableDelete.json new file mode 100644 index 000000000000..d60d1b42d61b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "204": {}, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableGet.json new file mode 100644 index 000000000000..54c731e2fe3b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/tables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableList.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableList.json new file mode 100644 index 000000000000..bfa823fc0d8b --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableList.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "resourceGroupName": "rgName", + "accountName": "ddb1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName", + "name": "tableName", + "type": "Microsoft.DocumentDB/databaseAccounts/tables", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "id": "tableName" + } + } + } + ] + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableThroughputGet.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableThroughputGet.json new file mode 100644 index 000000000000..3c3e67319312 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableThroughputGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "tableName": "tableName" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableThroughputUpdate.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableThroughputUpdate.json new file mode 100644 index 000000000000..a87c053f5b92 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/examples/CosmosDBTableThroughputUpdate.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "accountName": "ddb1", + "resourceGroupName": "rg1", + "api-version": "2020-06-01-preview", + "subscriptionId": "subid", + "tableName": "tableName", + "updateThroughputParameters": { + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.DocumentDB/databaseAccounts/ddb1/tables/tableName/throughputSettings/default", + "name": "default", + "type": "Microsoft.DocumentDB/databaseAccounts/tables/throughputSettings", + "location": "West US", + "tags": {}, + "properties": { + "resource": { + "throughput": 400, + "minimumThroughput": "400", + "offerReplacePending": "true", + "_rid": "PD5DALigDgw=", + "_ts": 1459200611, + "_etag": "\"00005900-0000-0000-0000-56f9a2630000\"" + } + } + } + }, + "202": {} + } +} diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json new file mode 100644 index 000000000000..caf426f3c4e1 --- /dev/null +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json @@ -0,0 +1,461 @@ +{ + "swagger": "2.0", + "info": { + "title": "Cosmos DB", + "description": "Azure Cosmos DB Database Service Resource Provider REST API", + "version": "2020-06-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "Impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces": { + "get": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Gets the notebook workspace resources of an existing Cosmos DB account.", + "operationId": "NotebookWorkspaces_ListByDatabaseAccount", + "x-ms-pageable": { + "nextLinkName": null + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved notebook workspace resources.", + "schema": { + "$ref": "#/definitions/NotebookWorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceList": { + "$ref": "./examples/CosmosDBNotebookWorkspaceList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}": { + "get": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Gets the notebook workspace for a Cosmos DB account.", + "operationId": "NotebookWorkspaces_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved a specified notebook workspace resource.", + "schema": { + "$ref": "#/definitions/NotebookWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceGet": { + "$ref": "./examples/CosmosDBNotebookWorkspaceGet.json" + } + } + }, + "put": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Creates the notebook workspace for a Cosmos DB account.", + "operationId": "NotebookWorkspaces_CreateOrUpdate", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + }, + { + "name": "notebookCreateUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/NotebookWorkspaceCreateUpdateParameters" + }, + "description": "The notebook workspace to create for the current database account." + } + ], + "responses": { + "200": { + "description": "Creation of notebook workspace will complete asynchronously.", + "schema": { + "$ref": "#/definitions/NotebookWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceCreate": { + "$ref": "./examples/CosmosDBNotebookWorkspaceCreate.json" + } + } + }, + "delete": { + "tags": [ + "NotebookWorkspacesResource" + ], + "description": "Deletes the notebook workspace for a Cosmos DB account.", + "operationId": "NotebookWorkspaces_Delete", + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "202": { + "description": "The notebook workspace delete operation will complete asynchronously." + }, + "204": { + "description": "The specified notebook workspace does not exist in the database account." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceDelete": { + "$ref": "./examples/CosmosDBNotebookWorkspaceDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/listConnectionInfo": { + "post": { + "tags": [ + "NotebookWorkspacesResource" + ], + "operationId": "NotebookWorkspaces_ListConnectionInfo", + "x-ms-examples": { + "CosmosDBNotebookWorkspaceListConnectionInfo": { + "$ref": "./examples/CosmosDBNotebookWorkspaceListConnectionInfo.json" + } + }, + "description": "Retrieves the connection info for the notebook workspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The operation completed successfully.", + "schema": { + "$ref": "#/definitions/NotebookWorkspaceConnectionInfoResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/regenerateAuthToken": { + "post": { + "tags": [ + "NotebookWorkspacesResource" + ], + "operationId": "NotebookWorkspaces_RegenerateAuthToken", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceRegenerateAuthToken": { + "$ref": "./examples/CosmosDBNotebookWorkspaceRegenerateAuthToken.json" + } + }, + "description": "Regenerates the auth token for the notebook workspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The regenerate auth token operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DocumentDB/databaseAccounts/{accountName}/notebookWorkspaces/{notebookWorkspaceName}/start": { + "post": { + "tags": [ + "NotebookWorkspacesResource" + ], + "operationId": "NotebookWorkspaces_Start", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CosmosDBNotebookWorkspaceStart": { + "$ref": "./examples/CosmosDBNotebookWorkspaceStart.json" + } + }, + "description": "Starts the notebook workspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/accountNameParameter" + }, + { + "$ref": "#/parameters/NotebookWorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "OK" + }, + "202": { + "description": "Accepted. The start operation will complete asynchronously." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "NotebookWorkspaceCreateUpdateParameters": { + "description": "Parameters to create a notebook workspace resource", + "type": "object", + "allOf": [ + { + "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ARMProxyResource" + } + ] + }, + "NotebookWorkspaceListResult": { + "description": "A list of notebook workspace resources", + "type": "object", + "properties": { + "value": { + "type": "array", + "description": "Array of notebook workspace resources", + "items": { + "$ref": "#/definitions/NotebookWorkspace" + } + } + } + }, + "NotebookWorkspace": { + "description": "A notebook workspace resource", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/NotebookWorkspaceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "../../preview/2020-06-01-preview/cosmos-db.json#/definitions/ARMProxyResource" + } + ] + }, + "NotebookWorkspaceProperties": { + "description": "Properties of a notebook workspace resource.", + "type": "object", + "properties": { + "notebookServerEndpoint": { + "description": "Specifies the endpoint of Notebook server.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "Status of the notebook workspace. Possible values are: Creating, Online, Deleting, Failed, Updating.", + "type": "string", + "readOnly": true + } + } + }, + "NotebookWorkspaceConnectionInfoResult": { + "description": "The connection info for the given notebook workspace", + "properties": { + "authToken": { + "type": "string", + "description": "Specifies auth token used for connecting to Notebook server (uses token-based auth).", + "readOnly": true + }, + "notebookServerEndpoint": { + "type": "string", + "description": "Specifies the endpoint of Notebook server.", + "readOnly": true + } + } + } + }, + "parameters": { + "accountNameParameter": { + "name": "accountName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Cosmos DB database account name.", + "minLength": 3, + "maxLength": 50, + "pattern": "^[a-z0-9]+(-[a-z0-9]+)*" + }, + "NotebookWorkspaceNameParameter": { + "name": "notebookWorkspaceName", + "in": "path", + "description": "The name of the notebook workspace resource.", + "required": true, + "x-ms-parameter-location": "method", + "type": "string", + "enum": [ + "default" + ], + "x-ms-enum": { + "name": "NotebookWorkspaceName", + "modelAsString": true + } + } + } +} diff --git a/specification/cosmos-db/resource-manager/readme.go.md b/specification/cosmos-db/resource-manager/readme.go.md index 09594aa19120..c87fb1089fde 100644 --- a/specification/cosmos-db/resource-manager/readme.go.md +++ b/specification/cosmos-db/resource-manager/readme.go.md @@ -13,6 +13,7 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-06-preview - tag: package-2020-04 - tag: package-2020-03 - tag: package-2019-12 @@ -20,6 +21,14 @@ batch: - tag: package-2019-08-preview - tag: package-2015-04 ``` +### Tag: package-2020-06-preview and go + +These settings apply only when `--tag=package-2020-06-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-06-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/cosmos-db/mgmt/2020-06-01-preview/$(namespace) +``` ### Tag: package-2020-04 and go diff --git a/specification/cosmos-db/resource-manager/readme.java.md b/specification/cosmos-db/resource-manager/readme.java.md index f54ed71714a6..4419599d765a 100644 --- a/specification/cosmos-db/resource-manager/readme.java.md +++ b/specification/cosmos-db/resource-manager/readme.java.md @@ -17,6 +17,7 @@ service-name: CosmosDB ``` yaml $(java) && $(multiapi) batch: + - tag: package-2020-06-preview - tag: package-2020-04 - tag: package-2020-03 - tag: package-2019-12 @@ -24,6 +25,18 @@ batch: - tag: package-2019-08-preview - tag: package-2015-04 ``` +### Tag: package-2020-06-preview and java + +These settings apply only when `--tag=package-2020-06-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-06-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.cosmosdb.v2020_06_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/cosmos/mgmt-v2020_06_01_preview +regenerate-manager: true +generate-interface: true +``` ### Tag: package-2020-04 and java diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index 7d71859a71b3..49a88ce16881 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -30,6 +30,18 @@ openapi-type: arm tag: package-2020-04 ``` +### Tag: package-2020-06-preview + +These settings apply only when `--tag=package-2020-06-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06-preview' +input-file: +- Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json +- Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json +- Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json +- Microsoft.DocumentDB/preview/2019-08-01-preview/privateEndpointConnection.json +``` + ### Tag: package-2020-04 These settings apply only when `--tag=package-2020-04` is specified on the command line. @@ -266,6 +278,8 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json + - $(this-folder)/Microsoft.DocumentDB/preview/2020-06-01-preview/notebook.json - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/cosmos-db.json - $(this-folder)/Microsoft.DocumentDB/stable/2020-04-01/notebook.json - $(this-folder)/Microsoft.DocumentDB/preview/2019-08-01-preview/privateLinkResources.json From 8be2c17e611ff898572f0bdecda531283e262dce Mon Sep 17 00:00:00 2001 From: HanLiMS <31705044+HanLiMS@users.noreply.github.com> Date: Tue, 30 Jun 2020 09:06:33 -0700 Subject: [PATCH 234/318] update error code to use PascalCase to be syned with the library (#8329) --- .../preview/v3.0-preview.1/TextAnalytics.json | 18 +++++++++--------- 1 file changed, 9 insertions(+), 9 deletions(-) diff --git a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json index 3ecddf3e6b15..ce0e51fa4b86 100644 --- a/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json +++ b/specification/cognitiveservices/data-plane/TextAnalytics/preview/v3.0-preview.1/TextAnalytics.json @@ -492,15 +492,15 @@ "code": { "type": "string", "enum": [ - "invalidParameterValue", - "invalidRequestBodyFormat", - "emptyRequest", - "missingInputRecords", - "invalidDocument", - "modelVersionIncorrect", - "invalidDocumentBatch", - "unsupportedLanguageCode", - "invalidCountryHint" + "InvalidParameterValue", + "InvalidRequestBodyFormat", + "EmptyRequest", + "MissingInputRecords", + "InvalidDocument", + "ModelVersionIncorrect", + "InvalidDocumentBatch", + "UnsupportedLanguageCode", + "InvalidCountryHint" ], "x-ms-enum": { "name": "InnerErrorCodeValue", From 847615bc828a92b1aaab22eb1903a509c39f8eb3 Mon Sep 17 00:00:00 2001 From: alshulma <59140398+alshulma@users.noreply.github.com> Date: Tue, 30 Jun 2020 22:12:53 +0300 Subject: [PATCH 235/318] Feature/alshulma/update stable version (#8884) * Update stable version * Some updates * Another change * Remove objects * Removed IncidentConfiguration * Fix issues * revert preview * Add objects * Add Entity * Add more * EntityCommonProperties * Changes * prettier * Remove * Make pretty * Remove unneeded definitions * Update incidents definition and examples * Update CreateOfficeDataConnetor.json delete read only from data connector examples * Update CreateOfficeDataConnetor.json Delete read only from data connector create * Update CreateFusionAlertRule.json Change "true" to true * Update CreateBookmark.json remove type, name, id since are read only * Update CreateActionOfAlertRule.json remove name, id and type from example since are read only * Update CreateBookmark.json delete read only email and names * Update CreateBookmark.json remove , * Update operationId of GET on a single incident comment Co-authored-by: Mark Cowlishaw * Update SecurityInsights.json Add "description": "OK, Operation successfully completed", * Update SecurityInsights.json Remove redundant , * Fixed Analytics issues + CloudError from common * More fixes to the Analytics sections * fixed AlertRuleKind after referencing to it - changed to string * fix incorrect hierarchy in MicrosoftSecurityIncidentCreationAlertRuleTemplate * extracted MicrosoftSecurityIncidentCreationAlertRuleTemplateCommonProperties to a separate object definition * extracted MicrosoftSecurityProductName to enum * Update SecurityInsights.json "discriminator": "kind", in AlertRuleKind and DataConnectorKind * Update SecurityInsights.json Kind discriminator required * remove discriminator and required from enum - it is set on the using definitions * Revert "remove discriminator and required from enum - it is set on the using definitions" This reverts commit c24e7d0a85c9cbc5025c2b4f8cc80800df66c44c. Revert "extracted MicrosoftSecurityProductName to enum" This reverts commit 2389fc968e477d5ef300f5b71cc61a8d23bcb5f1. Revert "extracted MicrosoftSecurityIncidentCreationAlertRuleTemplateCommonProperties to a separate object definition" This reverts commit 72280091f402ba9e7cb2be3f62cd16cb58b99188. Revert "fix incorrect hierarchy in MicrosoftSecurityIncidentCreationAlertRuleTemplate" This reverts commit dbf12a9189c3718f49229fe8a6a5ffa99150615c. revert 03ace77f5 revert 1cc27d544 Revert "Fixed Analytics issues + CloudError from common" This reverts commit 39bffde1aaebe654d2c0b09dc9c9e84b1f9fe911. Revert Analytics Changes * revert the discriminator kind change * Revert "revert the discriminator kind change" This reverts commit abee5fb24694045780861ac978ac87fe4ca88eeb. * Revert "Revert "remove discriminator and required from enum - it is set on the using definitions"" This reverts commit 81054a97bdf1417b533f2c989563b8a826520361. * Update SecurityInsights.json add "format": "int32" to integer types * DataConnectorKind to enum Change DataConnectorKind to enum and fix DataConnector to use it in the property * SettingsKind to enum Change SettingsKind to enum and use in the Settings properties. * Remove double allOff in connectors * Fix connectors inner properties * fix scheduled alert rule template properties * fixed nested all of issue in analytic rules templates * Fix inner allof in connectors properties Co-authored-by: Itai Yankelevsky Co-authored-by: ofshomro <51954696+ofshomro@users.noreply.github.com> Co-authored-by: ityankel <47292630+ityankel@users.noreply.github.com> Co-authored-by: Mark Cowlishaw Co-authored-by: Laith Hisham Co-authored-by: Ofir Shomron --- .../stable/2020-01-01/SecurityInsights.json | 2492 +++++++++++++---- .../actions/CreateActionOfAlertRule.json | 3 - .../GetAlertRuleTemplateById.json | 45 + .../GetAlertRuleTemplates.json | 82 + .../alertRules/CreateFusionAlertRule.json | 2 +- .../examples/bookmarks/CreateBookmark.json | 93 + .../examples/bookmarks/DeleteBookmark.json | 14 + .../examples/bookmarks/GetBookmarkById.json | 48 + .../examples/bookmarks/GetBookmarks.json | 51 + .../CreateOfficeDataConnetor.json | 3 - .../examples/incidents/CreateIncident.json | 104 + .../examples/incidents/DeleteIncident.json | 13 + .../examples/incidents/GetIncidentById.json | 54 + .../examples/incidents/GetIncidents.json | 59 + .../comments/CreateIncidentComment.json | 34 + .../comments/GetAllIncidentComments.json | 32 + .../comments/GetIncidentCommentById.json | 29 + 17 files changed, 2567 insertions(+), 591 deletions(-) create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRuleTemplates/GetAlertRuleTemplateById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRuleTemplates/GetAlertRuleTemplates.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/CreateBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/DeleteBookmark.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/GetBookmarkById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/GetBookmarks.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/CreateIncident.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/DeleteIncident.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/GetIncidentById.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/GetIncidents.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/CreateIncidentComment.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/GetAllIncidentComments.json create mode 100644 specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/GetIncidentCommentById.json diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json index 0dae763435cf..c6cc554ad423 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json @@ -93,7 +93,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/AlertRulesList" } @@ -147,7 +147,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/AlertRule" } @@ -199,7 +199,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/AlertRule" } @@ -248,7 +248,7 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK, Operation successfully completed" }, "204": { "description": "No Content" @@ -293,7 +293,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/ActionsList" } @@ -344,7 +344,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/ActionResponse" } @@ -393,7 +393,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/ActionResponse" } @@ -445,7 +445,282 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK, Operation successfully completed" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates": { + "get": { + "x-ms-examples": { + "Get all alert rule templates.": { + "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplates.json" + } + }, + "tags": [ + "Alert Rule Templates" + ], + "description": "Gets all alert rule templates.", + "operationId": "AlertRuleTemplates_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/AlertRuleTemplatesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/alertRuleTemplates/{alertRuleTemplateId}": { + "get": { + "x-ms-examples": { + "Get alert rule template by Id.": { + "$ref": "./examples/alertRuleTemplates/GetAlertRuleTemplateById.json" + } + }, + "tags": [ + "Alert Rule Templates" + ], + "description": "Gets the alert rule template.", + "operationId": "AlertRuleTemplates_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/AlertRuleTemplateId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/AlertRuleTemplate" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks": { + "get": { + "x-ms-examples": { + "Get all bookmarks.": { + "$ref": "./examples/bookmarks/GetBookmarks.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Gets all bookmarks.", + "operationId": "Bookmarks_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/BookmarkList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/bookmarks/{bookmarkId}": { + "get": { + "x-ms-examples": { + "Get a bookmark.": { + "$ref": "./examples/bookmarks/GetBookmarkById.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Gets a bookmark.", + "operationId": "Bookmarks_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates a bookmark.": { + "$ref": "./examples/bookmarks/CreateBookmark.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Creates or updates the bookmark.", + "operationId": "Bookmarks_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + }, + { + "$ref": "#/parameters/Bookmark" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Bookmark" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete a bookmark.": { + "$ref": "./examples/bookmarks/DeleteBookmark.json" + } + }, + "tags": [ + "Bookmarks" + ], + "description": "Delete the bookmark.", + "operationId": "Bookmarks_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/BookmarkId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" }, "204": { "description": "No Content" @@ -487,7 +762,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/DataConnectorList" } @@ -556,7 +831,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/DataConnector" } @@ -602,7 +877,7 @@ ], "responses": { "200": { - "description": "OK", + "description": "OK, Operation successfully completed", "schema": { "$ref": "#/definitions/DataConnector" } @@ -651,7 +926,7 @@ ], "responses": { "200": { - "description": "OK" + "description": "OK, Operation successfully completed" }, "204": { "description": "No Content" @@ -664,190 +939,1068 @@ } } } - } - }, - "definitions": { - "AADDataConnector": { - "allOf": [ - { - "$ref": "#/definitions/DataConnector" - } - ], - "description": "Represents AAD (Azure Active Directory) data connector.", - "properties": { - "properties": { - "$ref": "#/definitions/AADDataConnectorProperties", - "description": "AAD (Azure Active Directory) data connector properties.", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "AzureActiveDirectory" }, - "AADDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents": { + "get": { + "x-ms-examples": { + "Get all incidents.": { + "$ref": "./examples/incidents/GetIncidents.json" + } }, - { - "$ref": "#/definitions/DataConnectorWithAlertsProperties" - } - ], - "description": "AAD (Azure Active Directory) data connector properties.", - "type": "object" - }, + "tags": [ + "Incidents" + ], + "description": "Gets all incidents.", + "operationId": "Incidents_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataOrderBy" + }, + { + "$ref": "#/parameters/ODataTop" + }, + { + "$ref": "#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/IncidentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}": { + "get": { + "x-ms-examples": { + "Get an incident.": { + "$ref": "./examples/incidents/GetIncidentById.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Gets an incident.", + "operationId": "Incidents_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates or updates an incident.": { + "$ref": "./examples/incidents/CreateIncident.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Creates or updates the incident.", + "operationId": "Incidents_CreateOrUpdate", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/Incident" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/Incident" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "x-ms-examples": { + "Delete an incident.": { + "$ref": "./examples/incidents/DeleteIncident.json" + } + }, + "tags": [ + "Incidents" + ], + "description": "Delete the incident.", + "operationId": "Incidents_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed" + }, + "204": { + "description": "No Content" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments": { + "get": { + "x-ms-examples": { + "Get all incident comments.": { + "$ref": "./examples/incidents/comments/GetAllIncidentComments.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Gets all incident comments.", + "operationId": "IncidentComments_ListByIncident", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/ODataFilter" + }, + { + "$ref": "#/parameters/ODataOrderBy" + }, + { + "$ref": "#/parameters/ODataTop" + }, + { + "$ref": "#/parameters/ODataSkipToken" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/IncidentCommentList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-odata": "#/definitions/IncidentComment", + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.OperationalInsights/workspaces/{workspaceName}/providers/Microsoft.SecurityInsights/incidents/{incidentId}/comments/{incidentCommentId}": { + "get": { + "x-ms-examples": { + "Get an incident comment.": { + "$ref": "./examples/incidents/comments/GetIncidentCommentById.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Gets an incident comment.", + "operationId": "IncidentComments_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + } + ], + "responses": { + "200": { + "description": "OK, Operation successfully completed", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "x-ms-examples": { + "Creates an incident comment.": { + "$ref": "./examples/incidents/comments/CreateIncidentComment.json" + } + }, + "tags": [ + "IncidentComments" + ], + "description": "Creates the incident comment.", + "operationId": "IncidentComments_CreateComment", + "parameters": [ + { + "$ref": "#/parameters/ApiVersion" + }, + { + "$ref": "#/parameters/SubscriptionId" + }, + { + "$ref": "#/parameters/ResourceGroupName" + }, + { + "$ref": "#/parameters/WorkspaceName" + }, + { + "$ref": "#/parameters/IncidentId" + }, + { + "$ref": "#/parameters/IncidentCommentId" + }, + { + "$ref": "#/parameters/IncidentComment" + } + ], + "responses": { + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/IncidentComment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "AADDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents AAD (Azure Active Directory) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AADDataConnectorProperties", + "description": "AAD (Azure Active Directory) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureActiveDirectory" + }, + "AADDataConnectorProperties": { + "description": "AAD (Azure Active Directory) data connector properties.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, "AATPDataConnector": { "allOf": [ { "$ref": "#/definitions/DataConnector" } ], - "description": "Represents AATP (Azure Advanced Threat Protection) data connector.", + "description": "Represents AATP (Azure Advanced Threat Protection) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/AATPDataConnectorProperties", + "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureAdvancedThreatProtection" + }, + "AATPDataConnectorProperties": { + "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "ASCDataConnector": { + "allOf": [ + { + "$ref": "#/definitions/DataConnector" + } + ], + "description": "Represents ASC (Azure Security Center) data connector.", + "properties": { + "properties": { + "$ref": "#/definitions/ASCDataConnectorProperties", + "description": "ASC (Azure Security Center) data connector properties.", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "AzureSecurityCenter" + }, + "ASCDataConnectorProperties": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorWithAlertsProperties" + } + ], + "description": "ASC (Azure Security Center) data connector properties.", + "properties": { + "subscriptionId": { + "description": "The subscription id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "ActionRequest": { + "allOf": [ + { + "$ref": "#/definitions/ResourceWithEtag" + } + ], + "description": "Action for alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/ActionRequestProperties", + "description": "Action properties for put request", + "x-ms-client-flatten": true + } + }, + "type": "object" + }, + "ActionPropertiesBase": { + "description": "Action property bag base.", + "properties": { + "logicAppResourceId": { + "description": "Logic App Resource Id, /subscriptions/{my-subscription}/resourceGroups/{my-resource-group}/providers/Microsoft.Logic/workflows/{my-workflow-id}.", + "type": "string" + } + }, + "required": [ + "logicAppResourceId" + ], + "type": "object" + }, + "ActionRequestProperties": { + "allOf": [ + { + "$ref": "#/definitions/ActionPropertiesBase" + } + ], + "description": "Action property bag.", + "properties": { + "triggerUri": { + "description": "Logic App Callback URL for this specific workflow.", + "type": "string" + } + }, + "type": "object" + }, + "ActionResponse": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Action for alert rule.", "properties": { + "etag": { + "description": "Etag of the action.", + "type": "string" + }, "properties": { - "$ref": "#/definitions/AATPDataConnectorProperties", - "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "$ref": "#/definitions/ActionResponseProperties", + "description": "Action properties for get request", "x-ms-client-flatten": true } }, - "type": "object", - "x-ms-discriminator-value": "AzureAdvancedThreatProtection" + "type": "object" }, - "AATPDataConnectorProperties": { + "ActionResponseProperties": { "allOf": [ { - "$ref": "#/definitions/DataConnectorTenantId" + "$ref": "#/definitions/ActionPropertiesBase" + } + ], + "description": "Action property bag.", + "properties": { + "workflowId": { + "description": "The name of the logic app's workflow.", + "type": "string" + } + }, + "type": "object" + }, + "ActionsList": { + "description": "List all the actions.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of actions.", + "readOnly": true, + "type": "string" }, + "value": { + "description": "Array of actions.", + "items": { + "$ref": "#/definitions/ActionResponse" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "AlertRule": { + "allOf": [ { - "$ref": "#/definitions/DataConnectorWithAlertsProperties" + "$ref": "#/definitions/ResourceWithEtag" } ], - "description": "AATP (Azure Advanced Threat Protection) data connector properties.", + "description": "Alert rule.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AlertRuleKind", + "description": "The alert rule kind" + } + }, "type": "object" }, - "ASCDataConnector": { + "AlertRuleKind": { + "description": "The kind of the alert rule", + "enum": [ + "Scheduled", + "MicrosoftSecurityIncidentCreation", + "Fusion" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertRuleKind", + "values": [ + { + "value": "Scheduled" + }, + { + "value": "MicrosoftSecurityIncidentCreation" + }, + { + "value": "Fusion" + } + ] + } + }, + "AlertRuleTemplateStatus": { + "description": "The alert rule template status.", + "enum": [ + "Installed", + "Available", + "NotAvailable" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "TemplateStatus", + "values": [ + { + "description": "Alert rule template installed. and can not use more then once", + "value": "Installed" + }, + { + "description": "Alert rule template is available.", + "value": "Available" + }, + { + "description": "Alert rule template is not available", + "value": "NotAvailable" + } + ] + } + }, + "AlertRuleTemplate": { + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "Alert rule template.", + "discriminator": "kind", + "required": [ + "kind" + ], + "properties": { + "kind": { + "$ref": "#/definitions/AlertRuleKind", + "description": "The alert rule kind", + "type": "string" + } + }, + "type": "object" + }, + "AlertRuleTemplateDataSource": { + "description": "alert rule template data sources", + "properties": { + "connectorId": { + "description": "The connector id that provides the following data types", + "type": "string" + }, + "dataTypes": { + "description": "The data types used by the alert rule template", + "items": { + "type": "string" + }, + "type": "array" + } + }, + "type": "object" + }, + "AlertRuleTemplatesList": { + "description": "List all the alert rule templates.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alert rule templates.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of alert rule templates.", + "items": { + "$ref": "#/definitions/AlertRuleTemplate" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "AlertRuleTriggerOperator": { + "description": "The operation against the threshold that triggers alert rule.", + "enum": [ + "GreaterThan", + "LessThan", + "Equal", + "NotEqual" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": false, + "name": "TriggerOperator" + } + }, + "AlertRulesList": { + "description": "List all the alert rules.", + "properties": { + "nextLink": { + "description": "URL to fetch the next set of alert rules.", + "readOnly": true, + "type": "string" + }, + "value": { + "description": "Array of alert rules.", + "items": { + "$ref": "#/definitions/AlertRule" + }, + "type": "array" + } + }, + "required": [ + "value" + ] + }, + "AlertSeverity": { + "description": "The severity of the alert", + "enum": [ + "High", + "Medium", + "Low", + "Informational" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AlertSeverity", + "values": [ + { + "description": "High severity", + "value": "High" + }, + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "MicrosoftSecurityProductName": { + "description": "The alerts' productName on which the cases will be generated", + "enum": [ + "Microsoft Cloud App Security", + "Azure Security Center", + "Azure Advanced Threat Protection", + "Azure Active Directory Identity Protection", + "Azure Security Center for IoT" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "MicrosoftSecurityProductName" + } + }, + "AlertsDataTypeOfDataConnector": { + "description": "Alerts data type for data connectors.", + "properties": { + "alerts": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Alerts data type connection.", + "type": "object" + } + }, + "type": "object" + }, + "AttackTactic": { + "description": "The severity for alerts created by this alert rule.", + "enum": [ + "InitialAccess", + "Execution", + "Persistence", + "PrivilegeEscalation", + "DefenseEvasion", + "CredentialAccess", + "Discovery", + "LateralMovement", + "Collection", + "Exfiltration", + "CommandAndControl", + "Impact" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "AttackTactic" + } + }, + "AwsCloudTrailDataConnector": { "allOf": [ { "$ref": "#/definitions/DataConnector" } ], - "description": "Represents ASC (Azure Security Center) data connector.", + "description": "Represents Amazon Web Services CloudTrail data connector.", "properties": { "properties": { - "$ref": "#/definitions/ASCDataConnectorProperties", - "description": "ASC (Azure Security Center) data connector properties.", + "$ref": "#/definitions/AwsCloudTrailDataConnectorProperties", + "description": "Amazon Web Services CloudTrail data connector properties.", "x-ms-client-flatten": true } }, "type": "object", - "x-ms-discriminator-value": "AzureSecurityCenter" + "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" }, - "ASCDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorWithAlertsProperties" + "AwsCloudTrailDataConnectorDataTypes": { + "description": "The available data types for Amazon Web Services CloudTrail data connector.", + "properties": { + "logs": { + "allOf": [ + { + "$ref": "#/definitions/DataConnectorDataTypeCommon" + } + ], + "description": "Logs data type.", + "type": "object" } - ], - "description": "ASC (Azure Security Center) data connector properties.", + }, + "type": "object" + }, + "AwsCloudTrailDataConnectorProperties": { + "description": "Amazon Web Services CloudTrail data connector properties.", "properties": { - "subscriptionId": { - "description": "The subscription id to connect to, and get the data from.", + "awsRoleArn": { + "description": "The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account.", "type": "string" + }, + "dataTypes": { + "$ref": "#/definitions/AwsCloudTrailDataConnectorDataTypes", + "description": "The available data types for the connector." } }, "type": "object" }, - "ActionRequest": { + "Bookmark": { "allOf": [ { "$ref": "#/definitions/ResourceWithEtag" } ], - "description": "Action for alert rule.", + "description": "Represents a bookmark in Azure Security Insights.", "properties": { "properties": { - "$ref": "#/definitions/ActionRequestProperties", - "description": "Action properties for put request", + "$ref": "#/definitions/BookmarkProperties", + "description": "Bookmark properties", "x-ms-client-flatten": true } }, "type": "object" }, - "ActionPropertiesBase": { - "description": "Action property bag base.", + "BookmarkList": { + "description": "List all the bookmarks.", "properties": { - "logicAppResourceId": { - "description": "Logic App Resource Id, providers/Microsoft.Logic/workflows/{WorkflowID}.", + "nextLink": { + "description": "URL to fetch the next set of cases.", + "readOnly": true, "type": "string" + }, + "value": { + "description": "Array of bookmarks.", + "items": { + "$ref": "#/definitions/Bookmark" + }, + "type": "array" } }, "required": [ - "logicAppResourceId" - ], - "type": "object" + "value" + ] }, - "ActionRequestProperties": { - "allOf": [ - { - "$ref": "#/definitions/ActionPropertiesBase" - } - ], - "description": "Action property bag.", + "BookmarkProperties": { + "description": "Describes bookmark properties", "properties": { - "triggerUri": { - "description": "Logic App Callback URL for this specific workflow.", + "created": { + "description": "The time the bookmark was created", + "format": "date-time", + "type": "string" + }, + "createdBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that created the bookmark", + "type": "object" + }, + "displayName": { + "description": "The display name of the bookmark", + "type": "string" + }, + "labels": { + "description": "List of labels relevant to this bookmark", + "items": { + "$ref": "#/definitions/Label" + }, + "type": "array" + }, + "notes": { + "description": "The notes of the bookmark", + "type": "string" + }, + "query": { + "description": "The query of the bookmark.", + "type": "string" + }, + "queryResult": { + "description": "The query result of the bookmark.", + "type": "string" + }, + "updated": { + "description": "The last time the bookmark was updated", + "format": "date-time", "type": "string" + }, + "updatedBy": { + "$ref": "#/definitions/UserInfo", + "description": "Describes a user that updated the bookmark", + "type": "object" + }, + "incidentInfo": { + "$ref": "#/definitions/IncidentInfo", + "description": "Describes an incident that relates to bookmark", + "type": "object" } }, + "required": [ + "displayName", + "query" + ], "type": "object" }, - "ActionResponse": { - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ], - "description": "Action for alert rule.", + "ClientInfo": { + "description": "Information on the client (user or application) that made some action", "properties": { - "etag": { - "description": "Etag of the action.", + "email": { + "description": "The email of the client.", "type": "string" }, - "properties": { - "$ref": "#/definitions/ActionResponseProperties", - "description": "Action properties for get request", - "x-ms-client-flatten": true + "name": { + "description": "The name of the client.", + "type": "string" + }, + "objectId": { + "description": "The object id of the client.", + "format": "uuid", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name of the client.", + "type": "string" } }, "type": "object" }, - "ActionResponseProperties": { + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "The error object of the CloudError response" + } + }, + "description": "An error response for a resource management request." + }, + "DataConnector": { "allOf": [ { - "$ref": "#/definitions/ActionPropertiesBase" + "$ref": "#/definitions/ResourceWithEtag" } ], - "description": "Action property bag.", + "description": "Data connector.", + "discriminator": "kind", + "required": [ + "kind" + ], "properties": { - "workflowId": { - "description": "The name of the logic app's workflow.", - "type": "string" + "kind": { + "$ref": "#/definitions/DataConnectorKind", + "description": "The data connector kind" } }, "type": "object" }, - "ActionsList": { - "description": "List all the actions.", + "DataConnectorDataTypeCommon": { + "description": "Common field for data type in data connectors.", + "properties": { + "state": { + "description": "Describe whether this data type connection is enabled or not.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataTypeState" + } + } + }, + "type": "object" + }, + "DataConnectorKind": { + "description": "The kind of the data connector", + "enum": [ + "AzureActiveDirectory", + "AzureSecurityCenter", + "MicrosoftCloudAppSecurity", + "ThreatIntelligence", + "Office365", + "AmazonWebServicesCloudTrail", + "AzureAdvancedThreatProtection", + "MicrosoftDefenderAdvancedThreatProtection" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "DataConnectorKind", + "values": [ + { + "value": "AzureActiveDirectory" + }, + { + "value": "AzureSecurityCenter" + }, + { + "value": "MicrosoftCloudAppSecurity" + }, + { + "value": "ThreatIntelligence" + }, + { + "value": "Office365" + }, + { + "value": "AmazonWebServicesCloudTrail" + }, + { + "value": "AzureAdvancedThreatProtection" + }, + { + "value": "MicrosoftDefenderAdvancedThreatProtection" + } + ] + } + }, + "DataConnectorList": { + "description": "List all the data connectors.", "properties": { "nextLink": { - "description": "URL to fetch the next set of actions.", + "description": "URL to fetch the next set of data connectors.", "readOnly": true, "type": "string" }, "value": { - "description": "Array of actions.", + "description": "Array of data connectors.", "items": { - "$ref": "#/definitions/ActionResponse" + "$ref": "#/definitions/DataConnector" }, "type": "array" } @@ -856,93 +2009,120 @@ "value" ] }, - "AlertRule": { + "DataConnectorTenantId": { + "description": "Properties data connector on tenant level.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + } + }, + "type": "object" + }, + "DataConnectorWithAlertsProperties": { + "description": "Data connector properties.", + "properties": { + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." + } + }, + "type": "object" + }, + "FusionAlertRule": { "allOf": [ { - "$ref": "#/definitions/ResourceWithEtag" - }, - { - "$ref": "#/definitions/AlertRuleKind" + "$ref": "#/definitions/AlertRule" } ], - "description": "Alert rule.", - "discriminator": "kind", - "required": [ - "kind" - ], - "type": "object" + "description": "Represents Fusion alert rule.", + "properties": { + "properties": { + "$ref": "#/definitions/FusionAlertRuleProperties", + "description": "Fusion alert rule properties", + "x-ms-client-flatten": true + } + }, + "type": "object", + "x-ms-discriminator-value": "Fusion" }, - "AlertRuleKind": { - "description": "Describes an Azure resource with kind.", + "FusionAlertRuleProperties": { + "description": "Fusion alert rule base property bag.", "properties": { - "kind": { - "description": "The kind of the alert rule", - "enum": [ - "Scheduled", - "MicrosoftSecurityIncidentCreation", - "Fusion" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AlertRuleKind", - "values": [ - { - "value": "Scheduled" - }, - { - "value": "MicrosoftSecurityIncidentCreation" - }, - { - "value": "Fusion" - } - ] - } + "alertRuleTemplateName": { + "description": "The Name of the alert rule template used to create this rule.", + "type": "string" + }, + "description": { + "description": "The description of the alert rule.", + "readOnly": true, + "type": "string" + }, + "displayName": { + "description": "The display name for alerts created by this alert rule.", + "readOnly": true, + "type": "string" + }, + "enabled": { + "description": "Determines whether this alert rule is enabled or disabled.", + "type": "boolean" + }, + "lastModifiedUtc": { + "description": "The last time that this alert has been modified.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule.", + "readOnly": true + }, + "tactics": { + "description": "The tactics of the alert rule", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "readOnly": true, + "type": "array" } }, "required": [ - "kind" + "alertRuleTemplateName", + "enabled" ], "type": "object" }, - "AlertRuleTemplate": { + "FusionAlertRuleTemplate": { "allOf": [ { - "$ref": "#/definitions/Resource" - }, - { - "$ref": "#/definitions/AlertRuleKind" + "$ref": "#/definitions/AlertRuleTemplate" } ], - "description": "Alert rule template.", - "discriminator": "kind", - "required": [ - "kind" - ], - "type": "object" - }, - "AlertRuleTemplateDataSource": { - "description": "alert rule template data sources", + "description": "Represents Fusion alert rule template.", "properties": { - "connectorId": { - "description": "The connector id that provides the following data types", - "type": "string" - }, - "dataTypes": { - "description": "The data types used by the alert rule template", - "items": { - "type": "string" - }, - "type": "array" + "properties": { + "$ref": "#/definitions/FusionAlertRuleTemplateProperties", + "description": "Fusion alert rule template properties", + "required": [ + "displayName", + "description", + "status", + "severity", + "alertRulesCreatedByTemplateCount" + ], + "x-ms-client-flatten": true } }, - "type": "object" + "type": "object", + "x-ms-discriminator-value": "Fusion" }, - "AlertRuleTemplatePropertiesBase": { - "description": "Base alert rule template property bag.", + "FusionAlertRuleTemplateProperties": { + "description": "Represents Fusion alert rule template properties", "properties": { "alertRulesCreatedByTemplateCount": { "description": "the number of alert rules that were created by this template", + "format": "int32", "type": "integer" }, "createdDateUTC": { @@ -967,309 +2147,190 @@ "type": "array" }, "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", "description": "The alert rule template status.", - "enum": [ - "Installed", - "Available", - "NotAvailable" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "TemplateStatus", - "values": [ - { - "description": "Alert rule template installed. and can not use more then once", - "value": "Installed" - }, - { - "description": "Alert rule template is available.", - "value": "Available" - }, - { - "description": "Alert rule template is not available", - "value": "NotAvailable" - } - ] - } + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" } }, "type": "object" }, - "AlertRuleTriggerOperator": { - "description": "The operation against the threshold that triggers alert rule.", - "enum": [ - "GreaterThan", - "LessThan", - "Equal", - "NotEqual" + "Incident": { + "allOf": [ + { + "$ref": "#/definitions/ResourceWithEtag" + } ], - "type": "string", - "x-ms-enum": { - "modelAsString": false, - "name": "TriggerOperator" - } + "description": "Represents an incident in Azure Security Insights.", + "properties": { + "properties": { + "$ref": "#/definitions/IncidentProperties", + "description": "Incident properties", + "x-ms-client-flatten": true + } + }, + "type": "object" }, - "AlertRulesList": { - "description": "List all the alert rules.", + "IncidentAdditionalData": { + "description": "Incident additional data property bag.", "properties": { - "nextLink": { - "description": "URL to fetch the next set of alert rules.", + "alertsCount": { + "description": "The number of alerts in the incident", + "format": "int32", "readOnly": true, - "type": "string" + "type": "integer" }, - "value": { - "description": "Array of alert rules.", + "bookmarksCount": { + "description": "The number of bookmarks in the incident", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "commentsCount": { + "description": "The number of comments in the incident", + "format": "int32", + "readOnly": true, + "type": "integer" + }, + "alertProductNames": { + "description": "List of product names of alerts in the incident", "items": { - "$ref": "#/definitions/AlertRule" + "description": "Alert product name", + "type": "string" }, + "readOnly": true, "type": "array" - } - }, - "required": [ - "value" - ] - }, - "AlertSeverity": { - "description": "The severity of the alert", - "enum": [ - "High", - "Medium", - "Low", - "Informational" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AlertSeverity", - "values": [ - { - "description": "High severity", - "value": "High" - }, - { - "description": "Medium severity", - "value": "Medium" - }, - { - "description": "Low severity", - "value": "Low" + }, + "tactics": { + "description": "The tactics associated with incident", + "items": { + "$ref": "#/definitions/AttackTactic" }, - { - "description": "Informational severity", - "value": "Informational" - } - ] - } - }, - "AlertsDataTypeOfDataConnector": { - "description": "Alerts data type for data connectors.", - "properties": { - "alerts": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Alerts data type connection.", - "type": "object" + "readOnly": true, + "type": "array" } }, "type": "object" }, - "AttackTactic": { - "description": "The severity for alerts created by this alert rule.", - "enum": [ - "InitialAccess", - "Execution", - "Persistence", - "PrivilegeEscalation", - "DefenseEvasion", - "CredentialAccess", - "Discovery", - "LateralMovement", - "Collection", - "Exfiltration", - "CommandAndControl", - "Impact" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "AttackTactic" - } - }, - "AwsCloudTrailDataConnector": { + "IncidentComment": { "allOf": [ { - "$ref": "#/definitions/DataConnector" + "$ref": "#/definitions/Resource" } ], - "description": "Represents Amazon Web Services CloudTrail data connector.", + "description": "Represents an incident comment", "properties": { "properties": { - "$ref": "#/definitions/AwsCloudTrailDataConnectorProperties", - "description": "Amazon Web Services CloudTrail data connector properties.", + "$ref": "#/definitions/IncidentCommentProperties", + "description": "Incident comment properties", "x-ms-client-flatten": true } }, - "type": "object", - "x-ms-discriminator-value": "AmazonWebServicesCloudTrail" - }, - "AwsCloudTrailDataConnectorDataTypes": { - "description": "The available data types for Amazon Web Services CloudTrail data connector.", - "properties": { - "logs": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Logs data type.", - "type": "object" - } - }, "type": "object" }, - "AwsCloudTrailDataConnectorProperties": { - "description": "Amazon Web Services CloudTrail data connector properties.", + "IncidentCommentList": { + "description": "List of incident comments.", "properties": { - "awsRoleArn": { - "description": "The Aws Role Arn (with CloudTrailReadOnly policy) that is used to access the Aws account.", + "nextLink": { + "description": "URL to fetch the next set of comments.", + "readOnly": true, "type": "string" }, - "dataTypes": { - "$ref": "#/definitions/AwsCloudTrailDataConnectorDataTypes", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, - "CloudError": { - "description": "Error response structure.", - "properties": { - "error": { - "$ref": "#/definitions/CloudErrorBody", - "description": "Error data", - "x-ms-client-flatten": true + "value": { + "description": "Array of comments.", + "items": { + "$ref": "#/definitions/IncidentComment" + }, + "type": "array" } }, - "type": "object", - "x-ms-external": true + "required": [ + "value" + ] }, - "CloudErrorBody": { - "description": "Error details.", + "IncidentCommentProperties": { + "description": "Incident comment property bag.", "properties": { - "code": { - "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", + "createdTimeUtc": { + "description": "The time the comment was created", + "format": "date-time", "readOnly": true, "type": "string" }, "message": { - "description": "A message describing the error, intended to be suitable for display in a user interface.", - "readOnly": true, + "description": "The comment message", "type": "string" - } - }, - "type": "object", - "x-ms-external": true - }, - "DataConnector": { - "allOf": [ - { - "$ref": "#/definitions/ResourceWithEtag" }, - { - "$ref": "#/definitions/DataConnectorKind" + "author": { + "$ref": "#/definitions/ClientInfo", + "description": "Describes the client that created the comment", + "readOnly": true, + "type": "object" } - ], - "description": "Data connector.", - "discriminator": "kind", + }, "required": [ - "kind" + "message" ], "type": "object" }, - "DataConnectorDataTypeCommon": { - "description": "Common field for data type in data connectors.", - "properties": { - "state": { - "description": "Describe whether this data type connection is enabled or not.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "DataTypeState" - } - } - }, - "type": "object" - }, - "DataConnectorKind": { - "description": "Describes an Azure resource with kind.", + "IncidentLabel": { + "description": "Represents an incident label", "properties": { - "kind": { - "description": "The kind of the data connector", + "labelName": { + "description": "The name of the label", + "type": "string" + }, + "labelType": { + "description": "The type of the label", "enum": [ - "AzureActiveDirectory", - "AzureSecurityCenter", - "MicrosoftCloudAppSecurity", - "ThreatIntelligence", - "Office365", - "AmazonWebServicesCloudTrail", - "AzureAdvancedThreatProtection", - "MicrosoftDefenderAdvancedThreatProtection" + "User", + "System" ], "type": "string", + "readOnly": true, "x-ms-enum": { "modelAsString": true, - "name": "DataConnectorKind", + "name": "IncidentLabelType", "values": [ { - "value": "AzureActiveDirectory" - }, - { - "value": "AzureSecurityCenter" - }, - { - "value": "MicrosoftCloudAppSecurity" - }, - { - "value": "ThreatIntelligence" - }, - { - "value": "Office365" - }, - { - "value": "AmazonWebServicesCloudTrail" - }, - { - "value": "AzureAdvancedThreatProtection" + "description": "Label manually created by a user", + "value": "User" }, { - "value": "MicrosoftDefenderAdvancedThreatProtection" + "description": "Label automatically created by the system", + "value": "System" } ] } } }, + "required": [ + "labelName" + ], "type": "object" }, - "DataConnectorList": { - "description": "List all the data connectors.", + "IncidentList": { + "description": "List all the incidents.", "properties": { "nextLink": { - "description": "URL to fetch the next set of data connectors.", + "description": "URL to fetch the next set of incidents.", "readOnly": true, "type": "string" }, "value": { - "description": "Array of data connectors.", + "description": "Array of incidents.", "items": { - "$ref": "#/definitions/DataConnector" + "$ref": "#/definitions/Incident" }, "type": "array" } @@ -1278,130 +2339,234 @@ "value" ] }, - "DataConnectorTenantId": { - "description": "Properties data connector on tenant level.", + "IncidentOwnerInfo": { + "description": "Information on the user an incident is assigned to", "properties": { - "tenantId": { - "description": "The tenant id to connect to, and get the data from.", + "email": { + "description": "The email of the user the incident is assigned to.", + "type": "string" + }, + "assignedTo": { + "description": "The name of the user the incident is assigned to.", + "type": "string" + }, + "objectId": { + "description": "The object id of the user the incident is assigned to.", + "format": "uuid", + "type": "string" + }, + "userPrincipalName": { + "description": "The user principal name of the user the incident is assigned to.", "type": "string" } }, "type": "object" }, - "DataConnectorWithAlertsProperties": { - "description": "Data connector properties.", - "properties": { - "dataTypes": { - "$ref": "#/definitions/AlertsDataTypeOfDataConnector", - "description": "The available data types for the connector." - } - }, - "type": "object" - }, - "FusionAlertRule": { - "allOf": [ - { - "$ref": "#/definitions/AlertRule" - } - ], - "description": "Represents Fusion alert rule.", - "properties": { - "properties": { - "$ref": "#/definitions/FusionAlertRuleProperties", - "description": "Fusion alert rule properties", - "x-ms-client-flatten": true - } - }, - "type": "object", - "x-ms-discriminator-value": "Fusion" - }, - "FusionAlertRuleProperties": { - "description": "Fusion alert rule base property bag.", + "IncidentProperties": { + "description": "Describes incident properties", "properties": { - "alertRuleTemplateName": { - "description": "The Name of the alert rule template used to create this rule.", + "additionalData": { + "$ref": "#/definitions/IncidentAdditionalData", + "description": "Additional data on the incident", + "readOnly": true, + "type": "object" + }, + "classification": { + "description": "The reason the incident was closed", + "enum": [ + "Undetermined", + "TruePositive", + "BenignPositive", + "FalsePositive" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentClassification", + "values": [ + { + "description": "Incident classification was undetermined", + "value": "Undetermined" + }, + { + "description": "Incident was true positive", + "value": "TruePositive" + }, + { + "description": "Incident was benign positive", + "value": "BenignPositive" + }, + { + "description": "Incident was false positive", + "value": "FalsePositive" + } + ] + } + }, + "classificationComment": { + "description": "Describes the reason the incident was closed", "type": "string" }, - "description": { - "description": "The description of the alert rule.", + "classificationReason": { + "description": "The classification reason the incident was closed with", + "enum": [ + "SuspiciousActivity", + "SuspiciousButExpected", + "IncorrectAlertLogic", + "InaccurateData" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentClassificationReason", + "values": [ + { + "description": "Classification reason was suspicious activity", + "value": "SuspiciousActivity" + }, + { + "description": "Classification reason was suspicious but expected", + "value": "SuspiciousButExpected" + }, + { + "description": "Classification reason was incorrect alert logic", + "value": "IncorrectAlertLogic" + }, + { + "description": "Classification reason was inaccurate data", + "value": "InaccurateData" + } + ] + } + }, + "createdTimeUtc": { + "description": "The time the incident was created", + "format": "date-time", "readOnly": true, "type": "string" }, - "displayName": { - "description": "The display name for alerts created by this alert rule.", + "description": { + "description": "The description of the incident", + "type": "string" + }, + "firstActivityTimeUtc": { + "description": "The time of the first activity in the incident", + "format": "date-time", + "type": "string" + }, + "incidentUrl": { + "description": "The deep-link url to the incident in Azure portal", "readOnly": true, "type": "string" }, - "enabled": { - "description": "Determines whether this alert rule is enabled or disabled.", - "type": "boolean" + "incidentNumber": { + "description": "A sequential number", + "format": "int32", + "readOnly": true, + "type": "integer" }, - "lastModifiedUtc": { - "description": "The last time that this alert has been modified.", + "labels": { + "description": "List of labels relevant to this incident", + "items": { + "$ref": "#/definitions/IncidentLabel" + }, + "type": "array" + }, + "lastActivityTimeUtc": { + "description": "The time of the last activity in the incident", + "format": "date-time", + "type": "string" + }, + "lastModifiedTimeUtc": { + "description": "The last time the incident was updated", "format": "date-time", "readOnly": true, "type": "string" }, - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule.", - "readOnly": true + "owner": { + "$ref": "#/definitions/IncidentOwnerInfo", + "description": "Describes a user that the incident is assigned to", + "type": "object" }, - "tactics": { - "description": "The tactics of the alert rule", + "relatedAnalyticRuleIds": { + "description": "List of resource ids of Analytic rules related to the incident", "items": { - "$ref": "#/definitions/AttackTactic" + "description": "Related Analytic rule resource id", + "type": "string" }, "readOnly": true, "type": "array" - } - }, - "required": [ - "alertRuleTemplateName", - "enabled" - ], - "type": "object" - }, - "FusionAlertRuleTemplate": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplate" - } - ], - "description": "Represents Fusion alert rule template.", - "properties": { - "properties": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" - } + }, + "severity": { + "description": "The severity of the incident", + "enum": [ + "High", + "Medium", + "Low", + "Informational" ], - "description": "Fusion alert rule template properties", - "properties": { - "severity": { - "$ref": "#/definitions/AlertSeverity", - "description": "The severity for alerts created by this alert rule." - }, - "tactics": { - "description": "The tactics of the alert rule template", - "items": { - "$ref": "#/definitions/AttackTactic" + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentSeverity", + "values": [ + { + "description": "High severity", + "value": "High" }, - "type": "array" - } - }, - "required": [ - "displayName", - "description", - "status", - "severity", - "alertRulesCreatedByTemplateCount" + { + "description": "Medium severity", + "value": "Medium" + }, + { + "description": "Low severity", + "value": "Low" + }, + { + "description": "Informational severity", + "value": "Informational" + } + ] + } + }, + "status": { + "description": "The status of the incident", + "enum": [ + "New", + "Active", + "Closed" ], - "x-ms-client-flatten": true + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "IncidentStatus", + "values": [ + { + "description": "An active incident which isn't being handled currently", + "value": "New" + }, + { + "description": "An active incident which is being handled", + "value": "Active" + }, + { + "description": "A non-active incident", + "value": "Closed" + } + ] + } + }, + "title": { + "description": "The title of the incident", + "type": "string" } }, - "type": "object", - "x-ms-discriminator-value": "Fusion" + "required": [ + "title", + "severity", + "status" + ], + "type": "object" }, "Label": { "description": "Label that will be used to tag and filter on.", @@ -1432,26 +2597,24 @@ ], "description": "The available data types for MCAS (Microsoft Cloud App Security) data connector.", "properties": { + "alerts": { + "$ref": "#/definitions/DataConnectorDataTypeCommon", + "description": "Alerts data type connection." + }, "discoveryLogs": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], - "description": "Discovery log data type connection.", - "type": "object" + "$ref": "#/definitions/DataConnectorDataTypeCommon", + "description": "Discovery log data type connection." } }, "type": "object" }, "MCASDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], "description": "MCAS (Microsoft Cloud App Security) data connector properties.", "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, "dataTypes": { "$ref": "#/definitions/MCASDataConnectorDataTypes", "description": "The available data types for the connector." @@ -1477,15 +2640,17 @@ "x-ms-discriminator-value": "MicrosoftDefenderAdvancedThreatProtection" }, "MDATPDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" + "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" }, - { - "$ref": "#/definitions/DataConnectorWithAlertsProperties" + "dataTypes": { + "$ref": "#/definitions/AlertsDataTypeOfDataConnector", + "description": "The available data types for the connector." } - ], - "description": "MDATP (Microsoft Defender Advanced Threat Protection) data connector properties.", + }, "type": "object" }, "MicrosoftSecurityIncidentCreationAlertRule": { @@ -1515,20 +2680,16 @@ }, "type": "array" }, + "displayNamesExcludeFilter": { + "description": "the alerts' displayNames on which the cases will not be generated", + "items": { + "type": "string" + }, + "type": "array" + }, "productFilter": { - "description": "The alerts' productName on which the cases will be generated", - "enum": [ - "Microsoft Cloud App Security", - "Azure Security Center", - "Azure Advanced Threat Protection", - "Azure Active Directory Identity Protection", - "Azure Security Center for IoT" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "MicrosoftSecurityProductName" - } + "$ref": "#/definitions/MicrosoftSecurityProductName", + "description": "The alerts' productName on which the cases will be generated" }, "severitiesFilter": { "description": "the alerts' severities on which the cases will be generated", @@ -1581,6 +2742,71 @@ ], "type": "object" }, + "MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties": { + "description": "MicrosoftSecurityIncidentCreation rule template properties", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "format": "int32", + "type": "integer" + }, + "createdDateUTC": { + "description": "The time that this alert rule template has been added.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the alert rule template.", + "type": "string" + }, + "displayName": { + "description": "The display name for alert rule template.", + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data connectors for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "type": "array" + }, + "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status.", + "type": "string" + }, + "displayNamesFilter": { + "description": "the alerts' displayNames on which the cases will be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "displayNamesExcludeFilter": { + "description": "the alerts' displayNames on which the cases will not be generated", + "items": { + "type": "string" + }, + "type": "array" + }, + "productFilter": { + "$ref": "#/definitions/MicrosoftSecurityProductName", + "description": "The alerts' productName on which the cases will be generated" + }, + "severitiesFilter": { + "description": "the alerts' severities on which the cases will be generated", + "items": { + "$ref": "#/definitions/AlertSeverity" + }, + "type": "array" + } + }, + "required": [ + "productFilter" + ], + "type": "object" + }, "MicrosoftSecurityIncidentCreationAlertRuleTemplate": { "allOf": [ { @@ -1590,14 +2816,7 @@ "description": "Represents MicrosoftSecurityIncidentCreation rule template.", "properties": { "properties": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" - }, - { - "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleCommonProperties" - } - ], + "$ref": "#/definitions/MicrosoftSecurityIncidentCreationAlertRuleTemplateProperties", "description": "MicrosoftSecurityIncidentCreation rule template properties", "required": [ "displayName", @@ -1706,13 +2925,12 @@ "type": "object" }, "OfficeDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], "description": "Office data connector properties.", "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, "dataTypes": { "$ref": "#/definitions/OfficeDataConnectorDataTypes", "description": "The available data types for the connector." @@ -1860,6 +3078,7 @@ }, "triggerThreshold": { "description": "The threshold triggers this alert rule.", + "format": "int32", "type": "integer" } }, @@ -1926,6 +3145,77 @@ ], "type": "object" }, + "ScheduledAlertRuleTemplateProperties": { + "description": "Scheduled alert rule template properties", + "properties": { + "alertRulesCreatedByTemplateCount": { + "description": "the number of alert rules that were created by this template", + "format": "int32", + "type": "integer" + }, + "createdDateUTC": { + "description": "The time that this alert rule template has been added.", + "format": "date-time", + "readOnly": true, + "type": "string" + }, + "description": { + "description": "The description of the alert rule template.", + "type": "string" + }, + "displayName": { + "description": "The display name for alert rule template.", + "type": "string" + }, + "requiredDataConnectors": { + "description": "The required data connectors for this template", + "items": { + "$ref": "#/definitions/AlertRuleTemplateDataSource" + }, + "type": "array" + }, + "status": { + "$ref": "#/definitions/AlertRuleTemplateStatus", + "description": "The alert rule template status.", + "type": "string" + }, + "query": { + "description": "The query that creates alerts for this rule.", + "type": "string" + }, + "queryFrequency": { + "description": "The frequency (in ISO 8601 duration format) for this alert rule to run.", + "format": "duration", + "type": "string" + }, + "queryPeriod": { + "description": "The period (in ISO 8601 duration format) that this alert rule looks at.", + "format": "duration", + "type": "string" + }, + "severity": { + "$ref": "#/definitions/AlertSeverity", + "description": "The severity for alerts created by this alert rule." + }, + "triggerOperator": { + "$ref": "#/definitions/AlertRuleTriggerOperator", + "description": "The operation against the threshold that triggers alert rule." + }, + "triggerThreshold": { + "description": "The threshold triggers this alert rule.", + "format": "int32", + "type": "integer" + }, + "tactics": { + "description": "The tactics of the alert rule template", + "items": { + "$ref": "#/definitions/AttackTactic" + }, + "type": "array" + } + }, + "type": "object" + }, "ScheduledAlertRuleTemplate": { "allOf": [ { @@ -1935,24 +3225,8 @@ "description": "Represents scheduled alert rule template.", "properties": { "properties": { - "allOf": [ - { - "$ref": "#/definitions/AlertRuleTemplatePropertiesBase" - }, - { - "$ref": "#/definitions/ScheduledAlertRuleCommonProperties" - } - ], + "$ref": "#/definitions/ScheduledAlertRuleTemplateProperties", "description": "Scheduled alert rule template properties", - "properties": { - "tactics": { - "description": "The tactics of the alert rule template", - "items": { - "$ref": "#/definitions/AttackTactic" - }, - "type": "array" - } - }, "required": [ "displayName", "description", @@ -1975,36 +3249,33 @@ "allOf": [ { "$ref": "#/definitions/ResourceWithEtag" - }, - { - "$ref": "#/definitions/SettingsKind" } ], - "description": "The Setting.", + "description": "The Settings.", "discriminator": "kind", "required": [ "kind" ], - "type": "object" - }, - "SettingsKind": { - "description": "Describes an Azure resource with kind.", "properties": { "kind": { - "description": "The kind of the setting", - "enum": [ - "UebaSettings", - "ToggleSettings" - ], - "type": "string", - "x-ms-enum": { - "modelAsString": true, - "name": "SettingKind" - } + "$ref": "#/definitions/SettingsKind", + "description": "The data connector kind" } }, "type": "object" }, + "SettingsKind": { + "description": "The kind of the setting", + "enum": [ + "UebaSettings", + "ToggleSettings" + ], + "type": "string", + "x-ms-enum": { + "modelAsString": true, + "name": "SettingKind" + } + }, "TIDataConnector": { "allOf": [ { @@ -2038,13 +3309,12 @@ "type": "object" }, "TIDataConnectorProperties": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorTenantId" - } - ], "description": "TI (Threat Intelligence) data connector properties.", "properties": { + "tenantId": { + "description": "The tenant id to connect to, and get the data from.", + "type": "string" + }, "dataTypes": { "$ref": "#/definitions/TIDataConnectorDataTypes", "description": "The available data types for the connector." @@ -2213,7 +3483,7 @@ "type": "string", "x-ms-enum": { "modelAsString": true, - "name": "IncidentSeverity", + "name": "CaseSeverity", "values": [ { "description": "Critical severity", @@ -2311,6 +3581,24 @@ "required": true, "type": "string" }, + "Bookmark": { + "description": "The bookmark", + "in": "body", + "name": "bookmark", + "required": true, + "schema": { + "$ref": "#/definitions/Bookmark" + }, + "x-ms-parameter-location": "method" + }, + "BookmarkId": { + "description": "Bookmark ID", + "in": "path", + "name": "bookmarkId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, "ConsentId": { "description": "consent ID", "in": "path", @@ -2353,6 +3641,42 @@ "type": "string", "x-ms-parameter-location": "method" }, + "Incident": { + "description": "The incident", + "in": "body", + "name": "incident", + "required": true, + "schema": { + "$ref": "#/definitions/Incident" + }, + "x-ms-parameter-location": "method" + }, + "IncidentComment": { + "description": "The incident comment", + "in": "body", + "name": "incidentComment", + "required": true, + "schema": { + "$ref": "#/definitions/IncidentComment" + }, + "x-ms-parameter-location": "method" + }, + "IncidentCommentId": { + "description": "Incident comment ID", + "in": "path", + "name": "incidentCommentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "IncidentId": { + "description": "Incident ID", + "in": "path", + "name": "incidentId", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, "ODataFilter": { "description": "Filters the results, based on a Boolean condition. Optional.", "in": "query", diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/actions/CreateActionOfAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/actions/CreateActionOfAlertRule.json index 00c3cda73a97..e600106c6361 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/actions/CreateActionOfAlertRule.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/actions/CreateActionOfAlertRule.json @@ -8,9 +8,6 @@ "ruleId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", "actionId": "912bec42-cb66-4c03-ac63-1761b6898c3e", "action": { - "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/73e01a99-5cd7-4139-a149-9f2736ff2ab5/actions/912bec42-cb66-4c03-ac63-1761b6898c3e", - "name": "912bec42-cb66-4c03-ac63-1761b6898c3e", - "type": "Microsoft.SecurityInsights/alertRules/actions", "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", "properties": { "triggerUri": "https://prod-31.northcentralus.logic.azure.com:443/workflows/cd3765391efd48549fd7681ded1d48d7/triggers/manual/paths/invoke?api-version=2016-10-01&sp=%2Ftriggers%2Fmanual%2Frun&sv=1.0&sig=signature", diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRuleTemplates/GetAlertRuleTemplateById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRuleTemplates/GetAlertRuleTemplateById.json new file mode 100644 index 000000000000..d37e8c470833 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRuleTemplates/GetAlertRuleTemplateById.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "alertRuleTemplateId": "65360bb0-8986-4ade-a89d-af3cf44d28aa" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRuleTemplates/65360bb0-8986-4ade-a89d-af3cf44d28aa", + "name": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "Scheduled", + "properties": { + "severity": "Low", + "query": "let timeframe = 1d;\nAWSCloudTrail\n| where TimeGenerated >= ago(timeframe)\n| where EventName == \"CreateNetworkAclEntry\"\n or EventName == \"CreateRoute\"\n| project TimeGenerated, EventName, EventTypeName, UserIdentityAccountId, UserIdentityPrincipalid, UserAgent, UserIdentityUserName, SessionMfaAuthenticated, SourceIpAddress, AWSRegion, EventSource, AdditionalEventData, ResponseElements\n| extend AccountCustomEntity = UserIdentityUserName, IPCustomEntity = SourceIpAddress", + "queryFrequency": "P1D", + "queryPeriod": "P1D", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "displayName": "Changes to Amazon VPC settings", + "description": "This alert monitors changes to Amazon VPC (Virtual Private Cloud) settings such as new ACL entries and routes in route tables.\nMore information: https://medium.com/@GorillaStack/the-most-important-aws-cloudtrail-security-events-to-track-a5b9873f8255 \nand https://aws.amazon.com/vpc/", + "tactics": [ + "PrivilegeEscalation", + "LateralMovement" + ], + "createdDateUTC": "2019-02-27T00:00:00Z", + "status": "Available", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "alertRulesCreatedByTemplateCount": 0 + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRuleTemplates/GetAlertRuleTemplates.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRuleTemplates/GetAlertRuleTemplates.json new file mode 100644 index 000000000000..d10304254569 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRuleTemplates/GetAlertRuleTemplates.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/AlertRuleTemplates/65360bb0-8986-4ade-a89d-af3cf44d28aa", + "name": "65360bb0-8986-4ade-a89d-af3cf44d28aa", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "Scheduled", + "properties": { + "severity": "Low", + "query": "let timeframe = 1d;\nAWSCloudTrail\n| where TimeGenerated >= ago(timeframe)\n| where EventName == \"CreateNetworkAclEntry\"\n or EventName == \"CreateRoute\"\n| project TimeGenerated, EventName, EventTypeName, UserIdentityAccountId, UserIdentityPrincipalid, UserAgent, UserIdentityUserName, SessionMfaAuthenticated, SourceIpAddress, AWSRegion, EventSource, AdditionalEventData, ResponseElements\n| extend AccountCustomEntity = UserIdentityUserName, IPCustomEntity = SourceIpAddress", + "queryFrequency": "P1D", + "queryPeriod": "P1D", + "triggerOperator": "GreaterThan", + "triggerThreshold": 0, + "displayName": "Changes to Amazon VPC settings", + "description": "This alert monitors changes to Amazon VPC (Virtual Private Cloud) settings such as new ACL entries and routes in route tables.\nMore information: https://medium.com/@GorillaStack/the-most-important-aws-cloudtrail-security-events-to-track-a5b9873f8255 \nand https://aws.amazon.com/vpc/", + "tactics": [ + "PrivilegeEscalation", + "LateralMovement" + ], + "createdDateUTC": "2019-02-27T00:00:00Z", + "status": "Available", + "requiredDataConnectors": [ + { + "connectorId": "AWS", + "dataTypes": [ + "AWSCloudTrail" + ] + } + ], + "alertRulesCreatedByTemplateCount": 0 + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/AlertRuleTemplates/f71aba3d-28fb-450b-b192-4e76a83015c8", + "name": "f71aba3d-28fb-450b-b192-4e76a83015c8", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "Fusion", + "properties": { + "displayName": "Advanced Multi-Stage Attack Detection", + "description": "Place holder: Fusion uses graph powered machine learning algorithms to correlate between millions of lower fidelity anomalous activities from different products such as Azure AD Identity Protection, and Microsoft Cloud App Security, to combine them into a manageable number of interesting security cases.\n", + "tactics": [ + "Persistence", + "LateralMovement", + "Exfiltration", + "CommandAndControl" + ], + "createdDateUTC": "2019-07-25T00:00:00Z", + "status": "Available", + "severity": "High", + "alertRulesCreatedByTemplateCount": 0 + } + }, + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/AlertRuleTemplates/b3cfc7c0-092c-481c-a55b-34a3979758cb", + "name": "b3cfc7c0-092c-481c-a55b-34a3979758cb", + "type": "Microsoft.SecurityInsights/AlertRuleTemplates", + "kind": "MicrosoftSecurityIncidentCreation", + "properties": { + "productFilter": "Microsoft Cloud App Security", + "displayName": "Create incidents based on Microsoft Cloud App Security alerts", + "description": "Create incidents based on all alerts generated in Microsoft Cloud App Security", + "createdDateUTC": "2019-07-16T00:00:00Z", + "status": "Available", + "alertRulesCreatedByTemplateCount": 0 + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRules/CreateFusionAlertRule.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRules/CreateFusionAlertRule.json index ef362004531b..ea49be0c55ab 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRules/CreateFusionAlertRule.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/alertRules/CreateFusionAlertRule.json @@ -10,7 +10,7 @@ "kind": "Fusion", "etag": "3d00c3ca-0000-0100-0000-5d42d5010000", "properties": { - "enabled": "true", + "enabled": true, "alertRuleTemplateName": "f71aba3d-28fb-450b-b192-4e76a83015c8" } } diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/CreateBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/CreateBookmark.json new file mode 100644 index 000000000000..302388cb061a --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/CreateBookmark.json @@ -0,0 +1,93 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", + "bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "bookmark": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My bookmark", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70" + }, + "updated": "2019-01-01T13:15:30Z", + "created": "2019-01-01T13:15:30Z", + "notes": "Found a suspicious activity", + "labels": [ + "Tag1", + "Tag2" + ], + "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)", + "queryResult": "Security Event query result" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/bookmarks", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My bookmark", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updated": "2019-01-01T13:15:30Z", + "created": "2019-01-01T13:15:30Z", + "notes": "Found a suspicious activity", + "labels": [ + "Tag1", + "Tag2" + ], + "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)", + "queryResult": "Security Event query result" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/bookmarks", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My bookmark", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updated": "2019-01-01T13:15:30Z", + "created": "2019-01-01T13:15:30Z", + "notes": "Found a suspicious activity", + "labels": [ + "Tag1", + "Tag2" + ], + "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)", + "queryResult": "Security Event query result" + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/DeleteBookmark.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/DeleteBookmark.json new file mode 100644 index 000000000000..ed370512b64f --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/DeleteBookmark.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/GetBookmarkById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/GetBookmarkById.json new file mode 100644 index 000000000000..1fc0d3f2facd --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/GetBookmarkById.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights", + "bookmarkId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/bookmarks", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My bookmark", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updated": "2019-01-01T13:15:30Z", + "created": "2019-01-01T13:15:30Z", + "notes": "Found a suspicious activity", + "labels": [ + "Tag1", + "Tag2" + ], + "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)", + "queryResult": "Security Event query result", + "incidentInfo": { + "incidentId": "DDA55F97-170B-40B9-B8ED-CBFD05481E7D", + "severity": "Low", + "title": "New case 1", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0018" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/GetBookmarks.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/GetBookmarks.json new file mode 100644 index 000000000000..5e2412060910 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/bookmarks/GetBookmarks.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "operationalInsightsResourceProvider": "Microsoft.OperationalIinsights" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/bookmarks/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/bookmarks", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "displayName": "My bookmark", + "createdBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updatedBy": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john@contoso.com", + "name": "john doe" + }, + "updated": "2019-01-01T13:15:30Z", + "created": "2019-01-01T13:15:30Z", + "notes": "Found a suspicious activity", + "labels": [ + "Tag1", + "Tag2" + ], + "query": "SecurityEvent | where TimeGenerated > ago(1d) and TimeGenerated < ago(2d)", + "queryResult": "Security Event query result", + "incidentInfo": { + "incidentId": "DDA55F97-170B-40B9-B8ED-CBFD05481E7D", + "severity": "Low", + "title": "New case 1", + "relationName": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0018" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/dataConnectors/CreateOfficeDataConnetor.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/dataConnectors/CreateOfficeDataConnetor.json index 8b13b4b1723b..ef13fed0c62c 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/dataConnectors/CreateOfficeDataConnetor.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/dataConnectors/CreateOfficeDataConnetor.json @@ -7,9 +7,6 @@ "operationalInsightsResourceProvider": "Microsoft.OperationalInsights", "dataConnectorId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", "dataConnector": { - "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/dataConnectors/73e01a99-5cd7-4139-a149-9f2736ff2ab5", - "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", - "type": "Microsoft.SecurityInsights/dataConnectors", "kind": "Office365", "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", "properties": { diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/CreateIncident.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/CreateIncident.json new file mode 100644 index 000000000000..b0ec076e645c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/CreateIncident.json @@ -0,0 +1,104 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incident": { + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0001\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "relatedAnalyticRuleIds": [], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [] + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0001\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "relatedAnalyticRuleIds": [], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/DeleteIncident.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/DeleteIncident.json new file mode 100644 index 000000000000..48c85f20499e --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/DeleteIncident.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/GetIncidentById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/GetIncidentById.json new file mode 100644 index 000000000000..02700be4d343 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/GetIncidentById.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "InaccurateData", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7" + ], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "InitialAccess", + "Persistence" + ] + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/GetIncidents.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/GetIncidents.json new file mode 100644 index 000000000000..a7c9c0c95747 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/GetIncidents.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "$orderby": "properties/createdTimeUtc desc", + "$top": 1 + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "name": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "type": "Microsoft.SecurityInsights/incidents", + "etag": "\"0300bf09-0000-0000-0000-5c37296e0000\"", + "properties": { + "lastModifiedTimeUtc": "2019-01-01T13:15:30Z", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "lastActivityTimeUtc": "2019-01-01T13:05:30Z", + "firstActivityTimeUtc": "2019-01-01T13:00:30Z", + "description": "This is a demo incident", + "title": "My incident", + "owner": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "assignedTo": "john doe" + }, + "severity": "High", + "classification": "FalsePositive", + "classificationComment": "Not a malicious activity", + "classificationReason": "IncorrectAlertLogic", + "status": "Closed", + "incidentUrl": "https://portal.azure.com/#asset/Microsoft_Azure_Security_Insights/Incident/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentNumber": 3177, + "labels": [], + "relatedAnalyticRuleIds": [ + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/fab3d2d4-747f-46a7-8ef0-9c0be8112bf7", + "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/alertRules/8deb8303-e94d-46ff-96e0-5fd94b33df1a" + ], + "additionalData": { + "alertsCount": 0, + "bookmarksCount": 0, + "commentsCount": 3, + "alertProductNames": [], + "tactics": [ + "Persistence" + ] + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/CreateIncidentComment.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/CreateIncidentComment.json new file mode 100644 index 000000000000..c14515e36f4c --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/CreateIncidentComment.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "incidentComment": { + "properties": { + "message": "Some message" + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/GetAllIncidentComments.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/GetAllIncidentComments.json new file mode 100644 index 000000000000..63d4de097b65 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/GetAllIncidentComments.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + ] + } + } + } +} diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/GetIncidentCommentById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/GetIncidentCommentById.json new file mode 100644 index 000000000000..5874711a65b4 --- /dev/null +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/examples/incidents/comments/GetIncidentCommentById.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0", + "resourceGroupName": "myRg", + "workspaceName": "myWorkspace", + "incidentId": "73e01a99-5cd7-4139-a149-9f2736ff2ab5", + "incidentCommentId": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.OperationalIinsights/workspaces/myWorkspace/providers/Microsoft.SecurityInsights/incidents/73e01a99-5cd7-4139-a149-9f2736ff2ab5/comments/4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "name": "4bb36b7b-26ff-4d1c-9cbe-0d8ab3da0014", + "type": "Microsoft.SecurityInsights/incidents/comments", + "properties": { + "message": "Some message", + "createdTimeUtc": "2019-01-01T13:15:30Z", + "author": { + "objectId": "2046feea-040d-4a46-9e2b-91c2941bfa70", + "email": "john.doe@contoso.com", + "userPrincipalName": "john@contoso.com", + "name": "john doe" + } + } + } + } + } +} From 244d9a0f0a26f097d8aeeb05df1ef1c45f736d6d Mon Sep 17 00:00:00 2001 From: datr93 <43795914+datr93@users.noreply.github.com> Date: Tue, 30 Jun 2020 17:36:08 -0700 Subject: [PATCH 236/318] PersonalDesktopAssignmentType optional (#9988) --- .../preview/2019-01-23-preview/desktopvirtualization.json | 1 - .../preview/2019-09-24-preview/desktopvirtualization.json | 1 - .../preview/2019-12-10-preview/desktopvirtualization.json | 1 - 3 files changed, 3 deletions(-) diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json index 9057fd8119ba..ee6cfedd9ccb 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-01-23-preview/desktopvirtualization.json @@ -2083,7 +2083,6 @@ "type": "object", "required": [ "hostPoolType", - "personalDesktopAssignmentType", "loadBalancerType", "preferredAppGroupType" ], diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json index 57941b12e443..bfa107e11949 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-09-24-preview/desktopvirtualization.json @@ -2083,7 +2083,6 @@ "type": "object", "required": [ "hostPoolType", - "personalDesktopAssignmentType", "loadBalancerType", "preferredAppGroupType" ], diff --git a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json index 8b7462444aea..8bee1f0e764a 100644 --- a/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json +++ b/specification/desktopvirtualization/resource-manager/Microsoft.DesktopVirtualization/preview/2019-12-10-preview/desktopvirtualization.json @@ -2091,7 +2091,6 @@ "type": "object", "required": [ "hostPoolType", - "personalDesktopAssignmentType", "loadBalancerType", "preferredAppGroupType" ], From 4646a57883f08ae445dbdb8afc67cd03f427f8b7 Mon Sep 17 00:00:00 2001 From: iscai-msft <43154838+iscai-msft@users.noreply.github.com> Date: Tue, 30 Jun 2020 21:38:26 -0400 Subject: [PATCH 237/318] separated different error responses (#8881) --- .../2018-05-05-preview/AlertsManagement.json | 20 ++++++------ .../AlertsManagement.json | 32 +++++++++---------- .../2019-03-01-preview/AlertsManagement.json | 20 ++++++------ .../2019-05-05-preview/AlertsManagement.json | 32 +++++++++---------- .../stable/2018-05-05/AlertsManagement.json | 20 ++++++------ .../stable/2019-03-01/AlertsManagement.json | 20 ++++++------ .../SmartDetectorAlertRulesApi.json | 12 +++---- .../SmartDetectorAlertRulesApi.json | 14 ++++---- 8 files changed, 85 insertions(+), 85 deletions(-) diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json index 0236d4f36094..b478a1c46f6a 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-05-05-preview/AlertsManagement.json @@ -116,7 +116,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -159,7 +159,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -198,7 +198,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -234,7 +234,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -273,7 +273,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -344,7 +344,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -390,7 +390,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -435,7 +435,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -471,7 +471,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -808,7 +808,7 @@ "value" ] }, - "errorResponse": { + "AlertsManagementErrorResponse": { "description": "An error response from the service.", "x-ms-external": true, "properties": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/AlertsManagement.json index 908b0abd0480..f876c45039e7 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2018-11-02-privatepreview/AlertsManagement.json @@ -116,7 +116,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -159,7 +159,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -198,7 +198,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -234,7 +234,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -273,7 +273,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -344,7 +344,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -390,7 +390,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -435,7 +435,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -471,7 +471,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -523,7 +523,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } } @@ -573,7 +573,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } } @@ -615,7 +615,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } } @@ -664,7 +664,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } } @@ -701,7 +701,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } } @@ -747,7 +747,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } } @@ -1086,7 +1086,7 @@ "value" ] }, - "errorResponse": { + "AlertsManagementErrorResponse": { "description": "An error response from the service.", "x-ms-external": true, "properties": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-03-01-preview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-03-01-preview/AlertsManagement.json index b2037d78bcf4..ed96b1ddb65b 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-03-01-preview/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-03-01-preview/AlertsManagement.json @@ -128,7 +128,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -171,7 +171,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -210,7 +210,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -246,7 +246,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -315,7 +315,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -386,7 +386,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -432,7 +432,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -477,7 +477,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -513,7 +513,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -919,7 +919,7 @@ "value" ] }, - "errorResponse": { + "AlertsManagementErrorResponse": { "description": "An error response from the service.", "x-ms-external": true, "properties": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json index 750d45a37d73..608116ab02a9 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/preview/2019-05-05-preview/AlertsManagement.json @@ -158,7 +158,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -201,7 +201,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -240,7 +240,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -276,7 +276,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -345,7 +345,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -416,7 +416,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -465,7 +465,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -510,7 +510,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -546,7 +546,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -616,7 +616,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -692,7 +692,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -745,7 +745,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -802,7 +802,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -850,7 +850,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -907,7 +907,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -1368,7 +1368,7 @@ "value" ] }, - "errorResponse": { + "AlertsManagementErrorResponse": { "description": "An error response from the service.", "properties": { "error": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json index 93380511ec43..4ac3fbdee568 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2018-05-05/AlertsManagement.json @@ -128,7 +128,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -171,7 +171,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -210,7 +210,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -246,7 +246,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -315,7 +315,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -386,7 +386,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -435,7 +435,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -480,7 +480,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -516,7 +516,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -913,7 +913,7 @@ "value" ] }, - "errorResponse": { + "AlertsManagementErrorResponse": { "description": "An error response from the service.", "properties": { "error": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json index 6060265ff492..dc6ce3d65350 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/AlertsManagement.json @@ -128,7 +128,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -171,7 +171,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -210,7 +210,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -246,7 +246,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -315,7 +315,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -386,7 +386,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -432,7 +432,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -477,7 +477,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -513,7 +513,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/errorResponse" + "$ref": "#/definitions/AlertsManagementErrorResponse" } } }, @@ -920,7 +920,7 @@ "value" ] }, - "errorResponse": { + "AlertsManagementErrorResponse": { "description": "An error response from the service.", "x-ms-external": true, "properties": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/SmartDetectorAlertRulesApi.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/SmartDetectorAlertRulesApi.json index 30b9b05d7e9f..bedb658c0631 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/SmartDetectorAlertRulesApi.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-03-01/SmartDetectorAlertRulesApi.json @@ -53,7 +53,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -95,7 +95,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -143,7 +143,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -192,7 +192,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -238,7 +238,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -257,7 +257,7 @@ } }, "definitions": { - "ErrorResponse": { + "SmartDetectorErrorResponse": { "description": "Describe the format of an Error response.", "type": "object", "properties": { diff --git a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-06-01/SmartDetectorAlertRulesApi.json b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-06-01/SmartDetectorAlertRulesApi.json index 45d3bcaa439b..77242cc6bfbf 100644 --- a/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-06-01/SmartDetectorAlertRulesApi.json +++ b/specification/alertsmanagement/resource-manager/Microsoft.AlertsManagement/stable/2019-06-01/SmartDetectorAlertRulesApi.json @@ -56,7 +56,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -101,7 +101,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -149,7 +149,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -198,7 +198,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -253,7 +253,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -293,7 +293,7 @@ "default": { "description": "Error response describing why the operation failed.", "schema": { - "$ref": "#/definitions/ErrorResponse" + "$ref": "#/definitions/SmartDetectorErrorResponse" } }, "200": { @@ -312,7 +312,7 @@ } }, "definitions": { - "ErrorResponse": { + "SmartDetectorErrorResponse": { "description": "Describe the format of an Error response.", "type": "object", "properties": { From 5d7c9b734d462cc3b111757957c7d2cc027dff80 Mon Sep 17 00:00:00 2001 From: Jimmy Campbell Date: Tue, 30 Jun 2020 18:52:48 -0700 Subject: [PATCH 238/318] Added 2020-06-01 API version for Microsoft.AppConfiguration. (#9976) * Added 2020-06-01 API version for Microsoft.AppConfiguration. * Fixed file path in readme. * Update go readme since it was using 2019-11-01-preview API version. --- .../stable/2020-06-01/appconfiguration.json | 1649 +++++++++++++++++ .../examples/CheckNameAvailable.json | 19 + .../examples/CheckNameNotAvailable.json | 19 + .../examples/ConfigurationStoresCreate.json | 73 + ...StoresCreatePrivateEndpointConnection.json | 55 + ...ConfigurationStoresCreateWithIdentity.json | 101 + .../examples/ConfigurationStoresDelete.json | 13 + ...StoresDeletePrivateEndpointConnection.json | 14 + .../examples/ConfigurationStoresGet.json | 40 + ...ionStoresGetPrivateEndpointConnection.json | 29 + .../examples/ConfigurationStoresList.json | 70 + ...onfigurationStoresListByResourceGroup.json | 61 + .../ConfigurationStoresListKeyValue.json | 29 + .../examples/ConfigurationStoresListKeys.json | 48 + ...nStoresListPrivateEndpointConnections.json | 32 + .../ConfigurationStoresRegenerateKey.json | 23 + .../examples/ConfigurationStoresUpdate.json | 72 + ...ConfigurationStoresUpdateWithIdentity.json | 100 + .../examples/PrivateLinkResourceGet.json | 27 + ...LinkResourcesListByConfigurationStore.json | 30 + .../resource-manager/readme.go.md | 10 + .../resource-manager/readme.md | 12 +- 22 files changed, 2525 insertions(+), 1 deletion(-) create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/appconfiguration.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/CheckNameAvailable.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/CheckNameNotAvailable.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreate.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreatePrivateEndpointConnection.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreateWithIdentity.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresDelete.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresDeletePrivateEndpointConnection.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresGet.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresGetPrivateEndpointConnection.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresList.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListByResourceGroup.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListKeyValue.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListKeys.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListPrivateEndpointConnections.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresRegenerateKey.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresUpdate.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresUpdateWithIdentity.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/PrivateLinkResourceGet.json create mode 100644 specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/PrivateLinkResourcesListByConfigurationStore.json diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/appconfiguration.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/appconfiguration.json new file mode 100644 index 000000000000..aae591980eaa --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/appconfiguration.json @@ -0,0 +1,1649 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-06-01", + "title": "AppConfigurationManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/configurationStores": { + "get": { + "tags": [ + "ConfigurationStores" + ], + "description": "Lists the configuration stores for a given subscription.", + "operationId": "ConfigurationStores_List", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStoreListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_List": { + "$ref": "./examples/ConfigurationStoresList.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores": { + "get": { + "tags": [ + "ConfigurationStores" + ], + "description": "Lists the configuration stores for a given resource group.", + "operationId": "ConfigurationStores_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStoreListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_ListByResourceGroup": { + "$ref": "./examples/ConfigurationStoresListByResourceGroup.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}": { + "get": { + "tags": [ + "ConfigurationStores" + ], + "description": "Gets the properties of the specified configuration store.", + "operationId": "ConfigurationStores_Get", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Get": { + "$ref": "./examples/ConfigurationStoresGet.json" + } + } + }, + "put": { + "tags": [ + "ConfigurationStores" + ], + "description": "Creates a configuration store with the specified parameters.", + "operationId": "ConfigurationStores_Create", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "configStoreCreationParameters", + "in": "body", + "description": "The parameters for creating a configuration store.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Create": { + "$ref": "./examples/ConfigurationStoresCreate.json" + }, + "ConfigurationStores_Create_WithIdentity": { + "$ref": "./examples/ConfigurationStoresCreateWithIdentity.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "ConfigurationStores" + ], + "description": "Deletes a configuration store.", + "operationId": "ConfigurationStores_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Delete": { + "$ref": "./examples/ConfigurationStoresDelete.json" + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "ConfigurationStores" + ], + "description": "Updates a configuration store with the specified parameters.", + "operationId": "ConfigurationStores_Update", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "configStoreUpdateParameters", + "in": "body", + "description": "The parameters for updating a configuration store.", + "required": true, + "schema": { + "$ref": "#/definitions/ConfigurationStoreUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_Update": { + "$ref": "./examples/ConfigurationStoresUpdate.json" + }, + "ConfigurationStores_Update_WithIdentity": { + "$ref": "./examples/ConfigurationStoresUpdateWithIdentity.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AppConfiguration/checkNameAvailability": { + "post": { + "tags": [ + "Operations" + ], + "description": "Checks whether the configuration store name is available for use.", + "operationId": "Operations_CheckNameAvailability", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "checkNameAvailabilityParameters", + "in": "body", + "description": "The object containing information for the availability request.", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameAvailabilityParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/NameAvailabilityStatus" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_CheckNameAvailable": { + "$ref": "./examples/CheckNameAvailable.json" + }, + "ConfigurationStores_CheckNameNotAvailable": { + "$ref": "./examples/CheckNameNotAvailable.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/ListKeys": { + "post": { + "tags": [ + "ConfigurationStores" + ], + "description": "Lists the access key for the specified configuration store.", + "operationId": "ConfigurationStores_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ApiKeyListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_ListKeys": { + "$ref": "./examples/ConfigurationStoresListKeys.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/RegenerateKey": { + "post": { + "tags": [ + "ConfigurationStores" + ], + "description": "Regenerates an access key for the specified configuration store.", + "operationId": "ConfigurationStores_RegenerateKey", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "regenerateKeyParameters", + "in": "body", + "description": "The parameters for regenerating an access key.", + "required": true, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ApiKey" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_RegenerateKey": { + "$ref": "./examples/ConfigurationStoresRegenerateKey.json" + } + } + } + }, + "/providers/Microsoft.AppConfiguration/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists the operations available from this provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "$skipToken", + "in": "query", + "description": "A skip token is used to continue retrieving items after an operation returns a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skipToken parameter that specifies a starting point to use for subsequent calls.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OperationDefinitionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": {}, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/listKeyValue": { + "post": { + "tags": [ + "ConfigurationStores" + ], + "description": "Lists a configuration store key-value.", + "operationId": "ConfigurationStores_ListKeyValue", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "listKeyValueParameters", + "in": "body", + "description": "The parameters for retrieving a key-value.", + "required": true, + "schema": { + "$ref": "#/definitions/ListKeyValueParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/KeyValue" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "ConfigurationStores_ListKeyValue": { + "$ref": "./examples/ConfigurationStoresListKeyValue.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_ListByConfigurationStore", + "description": "Lists all private endpoint connections for a configuration store.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_List": { + "$ref": "./examples/ConfigurationStoresListPrivateEndpointConnections.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the configuration store.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_GetConnection": { + "$ref": "./examples/ConfigurationStoresGetPrivateEndpointConnection.json" + } + } + }, + "put": { + "tags": [ + "PrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_CreateOrUpdate", + "description": "Update the state of the specified private endpoint connection associated with the configuration store.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection name", + "required": true, + "type": "string" + }, + { + "name": "privateEndpointConnection", + "in": "body", + "description": "The private endpoint connection properties.", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "201": { + "description": "The request was successfully accepted; the operation will complete asynchronously. The provisioning state of the resource should indicate the current state of the resource.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnection_CreateOrUpdate": { + "$ref": "./examples/ConfigurationStoresCreatePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "PrivateEndpointConnections" + ], + "description": "Deletes a private endpoint connection.", + "operationId": "PrivateEndpointConnections_Delete", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "Private endpoint connection name", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the operation will complete asynchronously." + }, + "204": { + "description": "No Content - the specified resource was not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "PrivateEndpointConnections_Delete": { + "$ref": "./examples/ConfigurationStoresDeletePrivateEndpointConnection.json" + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByConfigurationStore", + "description": "Gets the private link resources that need to be created for a configuration store.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_ListGroupIds": { + "$ref": "./examples/PrivateLinkResourcesListByConfigurationStore.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AppConfiguration/configurationStores/{configStoreName}/privateLinkResources/{groupName}": { + "get": { + "tags": [ + "PrivateLinkResources" + ], + "operationId": "PrivateLinkResources_Get", + "description": "Gets a private link resource that need to be created for a configuration store.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ConfigStoreNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "groupName", + "in": "path", + "description": "The name of the private link resource group.", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/Error" + } + } + }, + "x-ms-examples": { + "PrivateLinkResources_Get": { + "$ref": "./examples/PrivateLinkResourceGet.json" + } + } + } + } + }, + "definitions": { + "ConfigurationStoreListResult": { + "description": "The result of a request to list configuration stores.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/ConfigurationStore" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "ConfigurationStore": { + "description": "The configuration store along with all resource properties. The Configuration Store will have all information to begin utilizing it.", + "required": [ + "location", + "sku" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "The managed identity information, if configured." + }, + "properties": { + "$ref": "#/definitions/ConfigurationStoreProperties", + "description": "The properties of a configuration store.", + "x-ms-client-flatten": true + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the configuration store." + } + } + }, + "ConfigurationStoreProperties": { + "description": "The properties of a configuration store.", + "type": "object", + "properties": { + "provisioningState": { + "description": "The provisioning state of the configuration store.", + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "creationDate": { + "format": "date-time", + "description": "The creation date of configuration store.", + "type": "string", + "readOnly": true + }, + "endpoint": { + "description": "The DNS endpoint where the configuration store API will be available.", + "type": "string", + "readOnly": true + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperties", + "description": "The encryption settings of the configuration store." + }, + "privateEndpointConnections": { + "description": "The list of private endpoint connections that are set up for this resource.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PrivateEndpointConnectionReference" + } + }, + "publicNetworkAccess": { + "description": "Control permission for data plane traffic coming from public networks while private endpoint is enabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "PublicNetworkAccess", + "modelAsString": true + } + } + } + }, + "EncryptionProperties": { + "type": "object", + "description": "The encryption settings for a configuration store.", + "properties": { + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Key vault properties." + } + } + }, + "PrivateEndpointConnectionReference": { + "type": "object", + "description": "A reference to a related private endpoint connection.", + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint connection.", + "x-ms-client-flatten": true + } + } + }, + "KeyVaultProperties": { + "type": "object", + "description": "Settings concerning key vault encryption for a configuration store.", + "properties": { + "keyIdentifier": { + "description": "The URI of the key vault key used to encrypt data.", + "type": "string" + }, + "identityClientId": { + "description": "The client id of the identity which will be used to access key vault.", + "type": "string" + } + } + }, + "ConfigurationStoreUpdateParameters": { + "description": "The parameters for updating a configuration store.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ConfigurationStorePropertiesUpdateParameters", + "description": "The properties for updating a configuration store.", + "x-ms-client-flatten": true + }, + "identity": { + "$ref": "#/definitions/ResourceIdentity", + "description": "The managed identity information for the configuration store." + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU of the configuration store." + }, + "tags": { + "description": "The ARM resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ConfigurationStorePropertiesUpdateParameters": { + "description": "The properties for updating a configuration store.", + "type": "object", + "properties": { + "encryption": { + "$ref": "#/definitions/EncryptionProperties", + "description": "The encryption settings of the configuration store." + } + } + }, + "CheckNameAvailabilityParameters": { + "description": "Parameters used for checking whether a resource name is available.", + "required": [ + "name", + "type" + ], + "type": "object", + "properties": { + "name": { + "description": "The name to check for availability.", + "type": "string" + }, + "type": { + "description": "The resource type to check for name availability.", + "enum": [ + "Microsoft.AppConfiguration/configurationStores" + ], + "type": "string", + "x-ms-enum": { + "name": "ConfigurationResourceType", + "modelAsString": true + } + } + } + }, + "NameAvailabilityStatus": { + "description": "The result of a request to check the availability of a resource name.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "The value indicating whether the resource name is available.", + "type": "boolean", + "readOnly": true + }, + "message": { + "description": "If any, the error message that provides more detail for the reason that the name is not available.", + "type": "string", + "readOnly": true + }, + "reason": { + "description": "If any, the reason that the name is not available.", + "type": "string", + "readOnly": true + } + } + }, + "ApiKeyListResult": { + "description": "The result of a request to list API keys.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/ApiKey" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "ApiKey": { + "description": "An API key used for authenticating with a configuration store endpoint.", + "type": "object", + "properties": { + "id": { + "description": "The key ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "A name for the key describing its usage.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The value of the key that is used for authentication purposes.", + "type": "string", + "readOnly": true + }, + "connectionString": { + "description": "A connection string that can be used by supporting clients for authentication.", + "type": "string", + "readOnly": true + }, + "lastModified": { + "format": "date-time", + "description": "The last time any of the key's properties were modified.", + "type": "string", + "readOnly": true + }, + "readOnly": { + "description": "Whether this key can only be used for read operations.", + "type": "boolean", + "readOnly": true + } + } + }, + "RegenerateKeyParameters": { + "description": "The parameters used to regenerate an API key.", + "type": "object", + "properties": { + "id": { + "description": "The id of the key to regenerate.", + "type": "string" + } + } + }, + "ListKeyValueParameters": { + "description": "The parameters used to list a configuration store key-value", + "required": [ + "key" + ], + "type": "object", + "properties": { + "key": { + "description": "The key to retrieve.", + "type": "string" + }, + "label": { + "description": "The label of the key.", + "type": "string" + } + } + }, + "KeyValue": { + "description": "The result of a request to retrieve a key-value from the specified configuration store.", + "type": "object", + "properties": { + "key": { + "description": "The primary identifier of a key-value.\r\nThe key is used in unison with the label to uniquely identify a key-value.", + "type": "string", + "readOnly": true + }, + "label": { + "description": "A value used to group key-values.\r\nThe label is used in unison with the key to uniquely identify a key-value.", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The value of the key-value.", + "type": "string", + "readOnly": true + }, + "contentType": { + "description": "The content type of the key-value's value.\r\nProviding a proper content-type can enable transformations of values when they are retrieved by applications.", + "type": "string", + "readOnly": true + }, + "eTag": { + "description": "An ETag indicating the state of a key-value within a configuration store.", + "type": "string", + "readOnly": true + }, + "lastModified": { + "format": "date-time", + "description": "The last time a modifying operation was performed on the given key-value.", + "type": "string", + "readOnly": true + }, + "locked": { + "description": "A value indicating whether the key-value is locked.\r\nA locked key-value may not be modified until it is unlocked.", + "type": "boolean", + "readOnly": true + }, + "tags": { + "description": "A dictionary of tags that can help identify what a key-value may be applicable for.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "OperationDefinitionListResult": { + "description": "The result of a request to list configuration store operations.", + "type": "object", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/OperationDefinition" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "OperationDefinition": { + "description": "The definition of a configuration store operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDefinitionDisplay", + "description": "The display information for the configuration store operation." + } + } + }, + "OperationDefinitionDisplay": { + "description": "The display information for a configuration store operation.", + "type": "object", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft App Configuration.\"", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } + }, + "ResourceIdentity": { + "type": "object", + "description": "An identity that can be associated with a resource.", + "properties": { + "type": { + "description": "The type of managed identity used. The type 'SystemAssigned, UserAssigned' includes both an implicitly created identity and a set of user-assigned identities. The type 'None' will remove any identities.", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": true + } + }, + "userAssignedIdentities": { + "description": "The list of user-assigned identities associated with the resource. The user-assigned identity dictionary keys will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserIdentity" + } + }, + "principalId": { + "description": "The principal id of the identity. This property will only be provided for a system-assigned identity.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "The tenant id associated with the resource's identity. This property will only be provided for a system-assigned identity.", + "type": "string", + "readOnly": true + } + } + }, + "UserIdentity": { + "type": "object", + "description": "A resource identity that is managed by the user of the service.", + "properties": { + "principalId": { + "description": "The principal ID of the user-assigned identity.", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "The client ID of the user-assigned identity.", + "type": "string", + "readOnly": true + } + } + }, + "Sku": { + "type": "object", + "required": [ + "name" + ], + "properties": { + "name": { + "description": "The SKU name of the configuration store.", + "type": "string" + } + }, + "description": "Describes a configuration store SKU." + }, + "Error": { + "description": "AppConfiguration error object.", + "properties": { + "code": { + "description": "Error code.", + "type": "string" + }, + "message": { + "description": "Error message.", + "type": "string" + } + } + }, + "Resource": { + "description": "An Azure resource.", + "required": [ + "location" + ], + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The location of the resource. This cannot be changed after the resource is created.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The tags of the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionListResult": { + "type": "object", + "description": "A list of private endpoint connections", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection", + "type": "object", + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "The properties of a private endpoint.", + "x-ms-client-flatten": true + } + }, + "x-ms-azure-resource": true + }, + "PrivateEndpointConnectionProperties": { + "type": "object", + "description": "Properties of a private endpoint connection.", + "properties": { + "provisioningState": { + "enum": [ + "Creating", + "Updating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "type": "string", + "readOnly": true, + "description": "The provisioning status of the private endpoint connection.", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private endpoint." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ] + }, + "PrivateEndpoint": { + "type": "object", + "description": "Private endpoint which a connection belongs to.", + "properties": { + "id": { + "description": "The resource Id for private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "The state of a private link service connection.", + "type": "object", + "properties": { + "status": { + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "description": "The private link service connection status.", + "x-ms-enum": { + "name": "ConnectionStatus", + "modelAsString": true + } + }, + "description": { + "type": "string", + "description": "The private link service connection description." + }, + "actionsRequired": { + "enum": [ + "None", + "Recreate" + ], + "type": "string", + "readOnly": true, + "description": "Any action that is required beyond basic workflow (approve/ reject/ disconnect)", + "x-ms-enum": { + "name": "ActionsRequired", + "modelAsString": true + } + } + } + }, + "PrivateLinkResourceListResult": { + "type": "object", + "description": "A list of private link resources.", + "properties": { + "value": { + "description": "The collection value.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next set of paged results.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "type": "object", + "description": "A resource that supports private link capabilities.", + "properties": { + "id": { + "description": "The resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Private link resource properties.", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkResourceProperties": { + "type": "object", + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of required DNS zone names of the private link resource." + } + }, + "description": "Properties of a private link resource." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The Microsoft Azure subscription ID.", + "required": true, + "type": "string" + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group to which the container registry belongs.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ConfigStoreNameParameter": { + "name": "configStoreName", + "in": "path", + "description": "The name of the configuration store.", + "required": true, + "type": "string", + "maxLength": 50, + "minLength": 5, + "pattern": "^[a-zA-Z0-9_-]*$", + "x-ms-parameter-location": "method" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The client API version.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/CheckNameAvailable.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/CheckNameAvailable.json new file mode 100644 index 000000000000..fcab22cbda15 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/CheckNameAvailable.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "api-version": "2020-06-01", + "checkNameAvailabilityParameters": { + "name": "contoso", + "type": "Microsoft.AppConfiguration/configurationStores" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": true, + "message": "The specified name is available.", + "reason": null + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/CheckNameNotAvailable.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/CheckNameNotAvailable.json new file mode 100644 index 000000000000..6df008d2160d --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/CheckNameNotAvailable.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "api-version": "2020-06-01", + "checkNameAvailabilityParameters": { + "name": "contoso", + "type": "Microsoft.AppConfiguration/configurationStores" + } + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The specified name is already in use." + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreate.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreate.json new file mode 100644 index 000000000000..c769ec3ecbbe --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreate.json @@ -0,0 +1,73 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01", + "configStoreCreationParameters": { + "location": "westus", + "sku": { + "name": "Standard" + }, + "tags": { + "myTag": "myTagValue" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": { + "myTag": "myTagValue" + } + } + }, + "201": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Creating", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": { + "myTag": "myTagValue" + } + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreatePrivateEndpointConnection.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreatePrivateEndpointConnection.json new file mode 100644 index 000000000000..f05b50598694 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreatePrivateEndpointConnection.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "privateEndpointConnectionName": "myConnection", + "api-version": "2020-06-01", + "privateEndpointConnection": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.AppConfiguration/configurationStores/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.AppConfiguration/configurationStores/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreateWithIdentity.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreateWithIdentity.json new file mode 100644 index 000000000000..3f4edb802032 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresCreateWithIdentity.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01", + "configStoreCreationParameters": { + "location": "westus", + "sku": { + "name": "Standard" + }, + "tags": { + "myTag": "myTagValue" + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "identity": { + "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", + "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC", + "principalId": "DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD" + } + } + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": { + "myTag": "myTagValue" + } + } + }, + "201": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Creating", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "identity": { + "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", + "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC", + "principalId": "DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD" + } + } + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": { + "myTag": "myTagValue" + } + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresDelete.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresDelete.json new file mode 100644 index 000000000000..097cb7e486b3 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresDeletePrivateEndpointConnection.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..1188e53caf8a --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresDeletePrivateEndpointConnection.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "privateEndpointConnectionName": "myConnection", + "api-version": "2020-06-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresGet.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresGet.json new file mode 100644 index 000000000000..479921b1c07f --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresGet.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "identity": { + "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", + "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", + "type": "SystemAssigned" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": {} + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresGetPrivateEndpointConnection.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..dc9dfa0fa501 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresGetPrivateEndpointConnection.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "privateEndpointConnectionName": "myConnection", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.AppConfiguration/configurationStores/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresList.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresList.json new file mode 100644 index 000000000000..01a057deb0fc --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresList.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "identity": { + "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", + "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", + "type": "SystemAssigned" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": {} + }, + { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T23:06:59+00:00", + "endpoint": "https://contoso2.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "identity": { + "principalId": "CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC", + "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", + "type": "SystemAssigned" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso2", + "name": "contoso2", + "location": "westus", + "tags": {} + } + ] + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListByResourceGroup.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListByResourceGroup.json new file mode 100644 index 000000000000..91c9136c1f94 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListByResourceGroup.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": {} + }, + { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T23:06:59+00:00", + "endpoint": "https://contoso2.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso2", + "name": "contoso2", + "location": "westus", + "tags": {} + } + ] + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListKeyValue.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListKeyValue.json new file mode 100644 index 000000000000..a780f8074510 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListKeyValue.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "fayeh", + "api-version": "2020-06-01", + "listKeyValueParameters": { + "key": "MaxRequests", + "label": "dev" + } + }, + "responses": { + "200": { + "body": { + "key": "MaxRequests", + "label": "dev", + "value": "100", + "contentType": "", + "eTag": "4f6dd610dd5e4deebc7fbaef685fb903", + "lastModified": "2017-12-05T02:41:26+00:00", + "locked": false, + "tags": { + "t1": "value1", + "t2": "value2" + } + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListKeys.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListKeys.json new file mode 100644 index 000000000000..24f870ab5624 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListKeys.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "439AD01B4BE67DB1", + "name": "Primary", + "value": "000000000000000000000000000000000000000000000000000000", + "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "lastModified": "2018-04-24T16:30:54+00:00", + "readOnly": false + }, + { + "id": "CB45E100456857B9", + "name": "Secondary", + "value": "000000000000000000000000000000000000000000000000000000", + "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "lastModified": "2018-04-24T16:30:54+00:00", + "readOnly": false + }, + { + "id": "B3AC55B7E71431A9", + "name": "Primary Read Only", + "value": "000000000000000000000000000000000000000000000000000000", + "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "lastModified": "2018-04-24T16:30:54+00:00", + "readOnly": true + }, + { + "id": "E2AF6A9A89DCC177", + "name": "Secondary Read Only", + "value": "000000000000000000000000000000000000000000000000000000", + "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "lastModified": "2018-04-24T16:30:54+00:00", + "readOnly": true + } + ] + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListPrivateEndpointConnections.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListPrivateEndpointConnections.json new file mode 100644 index 000000000000..d16b2493026c --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresListPrivateEndpointConnections.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateEndpointConnections/myConnection", + "name": "myConnection", + "type": "Microsoft.AppConfiguration/configurationStores/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/peexample01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ] + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresRegenerateKey.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresRegenerateKey.json new file mode 100644 index 000000000000..5cab41e0b835 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresRegenerateKey.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01", + "regenerateKeyParameters": { + "id": "439AD01B4BE67DB1" + } + }, + "responses": { + "200": { + "body": { + "id": "439AD01B4BE67DB1", + "name": "Primary", + "value": "000000000000000000000000000000000000000000000000000000", + "connectionString": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx", + "lastModified": "2018-04-26T22:59:24.2370906+00:00", + "readOnly": false + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresUpdate.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresUpdate.json new file mode 100644 index 000000000000..67248bc6daa3 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresUpdate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01", + "configStoreUpdateParameters": { + "tags": { + "Category": "Marketing" + }, + "sku": { + "name": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": { + "Category": "Marketing" + } + } + }, + "201": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Updating", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": { + "Category": "Marketing" + } + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresUpdateWithIdentity.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresUpdateWithIdentity.json new file mode 100644 index 000000000000..f7444dbab67d --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/ConfigurationStoresUpdateWithIdentity.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01", + "configStoreUpdateParameters": { + "tags": { + "Category": "Marketing" + }, + "sku": { + "name": "Standard" + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Succeeded", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "identity": { + "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", + "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC", + "principalId": "DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD" + } + } + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": { + "Category": "Marketing" + } + } + }, + "201": { + "body": { + "type": "Microsoft.AppConfiguration/configurationStores", + "properties": { + "provisioningState": "Updating", + "creationDate": "2018-04-24T16:30:55+00:00", + "endpoint": "https://contoso.azconfig.io", + "encryption": { + "keyVaultProperties": { + "keyIdentifier": null, + "identityClientId": null + } + }, + "privateEndpointConnections": [], + "publicNetworkAccess": "Disabled" + }, + "sku": { + "name": "Standard" + }, + "identity": { + "principalId": "AAAAAAAA-AAAA-AAAA-AAAA-AAAAAAAAAAAA", + "tenantId": "BBBBBBBB-BBBB-BBBB-BBBB-BBBBBBBBBBBB", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "CCCCCCCC-CCCC-CCCC-CCCC-CCCCCCCCCCCC", + "principalId": "DDDDDDDD-DDDD-DDDD-DDDD-DDDDDDDDDDDD" + } + } + }, + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso", + "name": "contoso", + "location": "westus", + "tags": { + "Category": "Marketing" + } + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/PrivateLinkResourceGet.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/PrivateLinkResourceGet.json new file mode 100644 index 000000000000..ccbd2784bf6e --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/PrivateLinkResourceGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01", + "groupName": "configurationStores" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateLinkResources/configurationStores", + "name": "configurationStores", + "type": "Microsoft.AppConfiguraiton/configurationStores/privateLinkResources", + "properties": { + "groupId": "configurationStores", + "requiredMembers": [ + "configurationStores" + ], + "requiredZoneNames": [ + "privatelink.azconfig.io" + ] + } + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/PrivateLinkResourcesListByConfigurationStore.json b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/PrivateLinkResourcesListByConfigurationStore.json new file mode 100644 index 000000000000..fd340f657b36 --- /dev/null +++ b/specification/appconfiguration/resource-manager/Microsoft.AppConfiguration/stable/2020-06-01/examples/PrivateLinkResourcesListByConfigurationStore.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "c80fb759-c965-4c6a-9110-9b2b2d038882", + "resourceGroupName": "myResourceGroup", + "configStoreName": "contoso", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/c80fb759-c965-4c6a-9110-9b2b2d038882/resourceGroups/myResourceGroup/providers/Microsoft.AppConfiguration/configurationStores/contoso/privateLinkResources/configurationStores", + "name": "configurationStores", + "type": "Microsoft.AppConfiguraiton/configurationStores/privateLinkResources", + "properties": { + "groupId": "configurationStores", + "requiredMembers": [ + "configurationStores" + ], + "requiredZoneNames": [ + "privatelink.azconfig.io" + ] + } + } + ] + } + } + } +} diff --git a/specification/appconfiguration/resource-manager/readme.go.md b/specification/appconfiguration/resource-manager/readme.go.md index 2571d89226d2..169e554cc7cc 100644 --- a/specification/appconfiguration/resource-manager/readme.go.md +++ b/specification/appconfiguration/resource-manager/readme.go.md @@ -13,11 +13,21 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-06-01 - tag: package-2019-11-01-preview - tag: package-2019-10-01 - tag: package-2019-02-01-preview ``` +### Tag: package-2020-06-01 and go + +These settings apply only when `--tag=package-2020-06-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-06-01' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-06-01/$(namespace) +``` + ### Tag: package-2019-11-01-preview and go These settings apply only when `--tag=package-2019-11-01-preview --go` is specified on the command line. diff --git a/specification/appconfiguration/resource-manager/readme.md b/specification/appconfiguration/resource-manager/readme.md index feac2e4b88ce..fcc2df72d21d 100644 --- a/specification/appconfiguration/resource-manager/readme.md +++ b/specification/appconfiguration/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the AppConfiguration API. ``` yaml openapi-type: arm -tag: package-2019-11-01-preview +tag: package-2020-06-01 +``` + +### Tag: package-2020-06-01 + +These settings apply only when `--tag=package-2020-06-01` is specified on the command line. + +``` yaml $(tag) == 'package-2020-06-01' +input-file: +- Microsoft.AppConfiguration/stable/2020-06-01/appconfiguration.json ``` ### Tag: package-2019-11-01-preview @@ -135,6 +144,7 @@ input-file: - $(this-folder)/Microsoft.AppConfiguration/preview/2019-11-01-preview/appconfiguration.json - $(this-folder)/Microsoft.AppConfiguration/preview/2019-02-01-preview/appconfiguration.json - $(this-folder)/Microsoft.AppConfiguration/stable/2019-10-01/appconfiguration.json + - $(this-folder)/Microsoft.AppConfiguration/stable/2020-06-01/appconfiguration.json ``` From 4e88e56afc0e3d4c52886d72926248a67c2dc5d4 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Wed, 1 Jul 2020 10:12:56 +0800 Subject: [PATCH 239/318] Add api-version 2020-06-01 of compute for go SDK (#9983) * Add api-version for go SDK * Update readme.go.md --- specification/compute/resource-manager/readme.go.md | 11 +++++++++++ 1 file changed, 11 insertions(+) diff --git a/specification/compute/resource-manager/readme.go.md b/specification/compute/resource-manager/readme.go.md index 6429e087e0ca..561571b385b6 100644 --- a/specification/compute/resource-manager/readme.go.md +++ b/specification/compute/resource-manager/readme.go.md @@ -31,6 +31,7 @@ directive: ```yaml $(go) && $(multiapi) batch: + - tag: package-2020-06-01 - tag: package-2019-12-01 - tag: package-2019-07 - tag: package-2019-03-01 @@ -49,6 +50,16 @@ batch: - tag: package-container-service-2015-11-preview ``` +### Tag: package-2020-06-01 and go + +These settings apply only when `--tag=package-2020-06-01 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +```yaml $(tag)=='package-2020-06-01' && $(go) +namespace: compute +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-01/$(namespace) +``` + ### Tag: package-2019-12-01 and go These settings apply only when `--tag=package-2019-12-01 --go` is specified on the command line. From 1f2ea1d034aa240b6a1c9019b7d91b04ad0bc480 Mon Sep 17 00:00:00 2001 From: Arcturus Date: Wed, 1 Jul 2020 10:16:07 +0800 Subject: [PATCH 240/318] Rename vmware to avs in go SDK (#9903) --- specification/vmware/resource-manager/readme.go.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/vmware/resource-manager/readme.go.md b/specification/vmware/resource-manager/readme.go.md index d172ca3a98a7..1e87a5f5d07b 100644 --- a/specification/vmware/resource-manager/readme.go.md +++ b/specification/vmware/resource-manager/readme.go.md @@ -5,7 +5,7 @@ These settings apply only when `--go` is specified on the command line. ``` yaml $(go) go: license-header: MICROSOFT_APACHE_NO_VERSION - namespace: vmware + namespace: avs clear-output-folder: true ``` From 584d9390133eda22c7b236d1112fa9354950062b Mon Sep 17 00:00:00 2001 From: keerthi kamal adusumilli Date: Tue, 30 Jun 2020 19:56:18 -0700 Subject: [PATCH 241/318] Add preview APIs for deploying Azure machine learning services (#9592) * add new preview version * add GET services and example * update description * update description * update tag * add put on services * remove produces and consumes * update examples/description * update examples, use detailed service response * add path for get by service id * add example for getservicebyid * add example for createService * add example for delete service * use full resource uri * add 2020-05-01 to readme * fix modelvalidation checks * add words to cspell ignore list * fix prettier issues * fix model validation * fix lint errors * include newly added templates and exmaples from 2020-04-01-preview * remove UNREFERENCED_JSON_FILE * fix lint and avaocado errors * update description in examples * sync changes from previous preview version https://github.com/Azure/azure-rest-api-specs/pull/9649 * fix Potential new SDK errors * mark properties on paginated list response as readonly * sync changes from preview/2020-04-01 https://github.com/Azure/azure-rest-api-specs/pull/9703 * rename operationId * remove createdby * remove createdtime and modifiedtime. Will populate system metadata instead once RP starts populating it. * use 201 instead of 202 on put /services * Revert "remove createdtime and modifiedtime. Will populate system metadata" This reverts commit 8daee90fcdf6d0c96f7802180c8a7d7860c46296. * use servicename parameter instead of id * add apiversionparameter * move PUT from /services to /services/{serivceName} * wrap machine learning service object inside arm resource envelope * fix prettierchecks * set modelAsString to true * dont have to populate operationId * update description of the location * add required fields * use directref instead of allof for containerresourcerequirements * add long running operation on PUT /services/{name} * delete on service is not a long running operation, remove 202 * remove createdtime and modifiedtime. Will populate system metadata instead once RP starts populating it. mark some properties as readonly * update description for ssl cert and ssl key * add description for conda dependencies * add example for service update * set x-ms-secret on authtoken, username and password * fix prettier errors * remove unused file * set readonly for id, name, type. #9948 sync changes from https://github.com/Azure/azure-rest-api-specs/pull/9948 * on response dont populate username, password and authtoken * set x-ms-azure-resource, sync changes from https://github.com/Azure/azure-rest-api-specs/pull/9948 * fix lint errors Co-authored-by: Keerthi Adusumilli --- custom-words.txt | 5 + .../2020-05-01-preview/examples/ListSkus.json | 79 + .../examples/ListUsages.json | 400 ++ .../examples/ListVMSizesResult.json | 455 ++ .../examples/ListWorkspaceFeatures.json | 26 + .../ListWorkspaceQuotasByVMFamily.json | 415 ++ .../examples/amlComputeListNodes.json | 34 + .../examples/createBasicAKSCompute.json | 44 + .../examples/createBasicAmlCompute.json | 54 + .../createBasicDataFactoryCompute.json | 44 + .../examples/createLinkedWorkspace.json | 29 + .../examples/createOrUpdateService.json | 217 + .../examples/createWorkspace.json | 140 + .../examples/deleteCompute.json | 19 + .../examples/deleteLinkedWorkspace.json | 13 + .../examples/deleteService.json | 13 + .../examples/deleteWorkspace.json | 12 + .../examples/getAKSCompute.json | 25 + .../examples/getAmlCompute.json | 49 + .../examples/getComputes.json | 41 + .../examples/getLinkedWorkspace.json | 22 + .../examples/getService.json | 149 + .../examples/getServices.json | 274 + .../examples/getWorkspace.json | 74 + .../getWorkspacesByResourceGroup.json | 56 + .../examples/getWorkspacesBySubscription.json | 55 + .../examples/listKeysAKSCompute.json | 19 + .../examples/listLinkedWorkspaces.json | 32 + .../examples/listWorkspaceKeys.json | 31 + .../examples/patchAmlCompute.json | 36 + .../examples/resyncWorkspaceKeys.json | 11 + .../examples/updateAKSCompute.json | 53 + .../examples/updateAmlCompute.json | 54 + .../examples/updateQuota.json | 45 + .../examples/updateWorkspace.json | 42 + ...kspaceDeletePrivateEndpointConnection.json | 14 + ...workspaceGetPrivateEndpointConnection.json | 30 + .../workspaceListPrivateLinkResources.json | 28 + ...workspacePutPrivateEndpointConnection.json | 38 + .../machineLearningServices.json | 5403 +++++++++++++++++ .../resource-manager/readme.md | 24 + 41 files changed, 8604 insertions(+) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListSkus.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListUsages.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListVMSizesResult.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListWorkspaceFeatures.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListWorkspaceQuotasByVMFamily.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/amlComputeListNodes.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicDataFactoryCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createLinkedWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateService.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteLinkedWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteService.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getComputes.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getLinkedWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getService.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getServices.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspacesByResourceGroup.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspacesBySubscription.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listKeysAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listLinkedWorkspaces.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listWorkspaceKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/patchAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/resyncWorkspaceKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateQuota.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceDeletePrivateEndpointConnection.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceGetPrivateEndpointConnection.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceListPrivateLinkResources.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspacePutPrivateEndpointConnection.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json diff --git a/custom-words.txt b/custom-words.txt index 9640d6f559f3..127b44f4e57b 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -213,6 +213,7 @@ bingspellcheck bingvideosearch bingvisualsearch bingwebsearch +Bioconductor Bitbucket Bitlocker bitness @@ -344,6 +345,7 @@ costmanagement Couchbase cpim CPIM +Cran creatable createconsumergroup createorupdate @@ -933,6 +935,7 @@ monitoringconfiguration monitoringconfigurations Monospace MPNS +MRAN MSAZR MSAZRDE MSCONCAT @@ -1322,6 +1325,7 @@ rscc rscd rsce rscl +rscript rsct Rslp RSNULL @@ -1483,6 +1487,7 @@ streamingendpoint streamingjobs streamingservice subcomponent +subdir subdomain subexpressions subfolder diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListSkus.json new file mode 100644 index 000000000000..3eebca3aaebe --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListSkus.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "workspaces", + "name": "Basic", + "tier": "Basic", + "locations": [ + "westus" + ], + "locationInfo": [ + { + "location": "westus", + "zones": [ + "westus-AZ02", + "westus-AZ01" + ] + } + ], + "capabilities": [ + { + "name": "automatedml_readhyperdrivesdk", + "value": "{\n \"id\": \"automatedml_ readhyperdrivesdk\",\n \"name\": \"Read hyperdrive SDK\",\n \"description\": \"Read only access to Hyperdrive in the SDK\"\n}" + }, + { + "name": "workspace_upgradeworkspacesdk", + "value": "{\n \"id\": \"workspace_upgradeworkspacesdk\",\n \"name\": \"Upgrade workspace SDK\",\n \"description\": \"Upgrade workspace from Basic to enterprise from the SDK\"\n}" + } + ], + "restrictions": [] + }, + { + "resourceType": "workspaces", + "name": "Enterprise", + "tier": "Enterprise", + "locations": [ + "westus" + ], + "locationInfo": [ + { + "location": "westus", + "zones": [ + "westus-AZ01" + ], + "zoneDetails": [ + { + "name": [ + "westus-AZ01" + ], + "capabilities": [ + { + "name": "automatedml_createeditexperimentssdk", + "value": "{\n \"id\": \"automatedml_createeditexperimentssdk\",\n \"name\": \"Create edit experiments SDK\",\n \"description\": \"Create, edit or delete AutoML experiments in the SDK\"\n}" + } + ] + } + ] + } + ], + "capabilities": [ + { + "name": "automatedml_createeditexperimentssdk", + "value": "{\n \"id\": \"automatedml_createeditexperimentssdk\",\n \"name\": \"Create edit experiments SDK\",\n \"description\": \"Create, edit or delete AutoML experiments in the SDK\"\n}" + } + ], + "restrictions": [] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListUsages.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListUsages.json new file mode 100644 index 000000000000..3a90ee1d65e0 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListUsages.json @@ -0,0 +1,400 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/totalCores/usages", + "currentValue": 7, + "limit": 100, + "name": { + "localizedValue": "Clusters", + "value": "Clusters" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/dedicatedCores/usages", + "currentValue": 14, + "limit": 24, + "name": { + "localizedValue": "Total Cluster Dedicated Regional vCPUs", + "value": "Total Cluster Dedicated Regional vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster2_dsv2/usages/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 12, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluser1_nc/usages/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/computes/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages", + "type": "Microsoft.MachineLearningServices/lowPriorityCores/usages", + "currentValue": 18, + "limit": 50, + "name": { + "localizedValue": "Total Cluster LowPriority Regional vCPUs", + "value": "Total Cluster LowPriority Regional vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_D_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "value": "Standard D Family Cluster LowPriority vCPUs", + "localizedValue": "Standard D Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_DSv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard DSv2 Family Cluster LowPriority vCPUs", + "value": "Standard DSv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_Dv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard Dv2 Family Cluster LowPriority vCPUs", + "value": "Standard Dv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_FSv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard FSv2 Family Cluster LowPriority vCPUs", + "value": "Standard FSv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 18, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/usages", + "currentValue": 12, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster2_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster3_lowPriority_nc/usages/Standard_NC_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/workspace/computes/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "Standard NC Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv2 Family Cluster LowPriority vCPUs", + "value": "Standard NCv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NCv3_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv3 Family Cluster LowPriority vCPUs", + "value": "Standard NCv3 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_ND_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard ND Family Cluster LowPriority vCPUs", + "value": "Standard ND Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NDv2_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NDv2 Family Cluster LowPriority vCPUs", + "value": "Standard NDv2 Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/Standard_NV_Family_Cluster_LowPriority_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NV Family Cluster LowPriority vCPUs", + "value": "Standard NV Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListVMSizesResult.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListVMSizesResult.json new file mode 100644 index 000000000000..5e069e3ccd12 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListVMSizesResult.json @@ -0,0 +1,455 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2020-05-01-preview", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "amlCompute": [ + { + "name": "Standard_F2s_v2", + "family": "standardFSv2Family", + "vCPUs": 2, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 16384, + "memoryGB": 4.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F4s_v2", + "family": "standardFSv2Family", + "vCPUs": 4, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 32768, + "memoryGB": 8.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F8s_v2", + "family": "standardFSv2Family", + "vCPUs": 8, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 65536, + "memoryGB": 16.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F16s_v2", + "family": "standardFSv2Family", + "vCPUs": 16, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 131072, + "memoryGB": 32.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F32s_v2", + "family": "standardFSv2Family", + "vCPUs": 32, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 262144, + "memoryGB": 64.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F64s_v2", + "family": "standardFSv2Family", + "vCPUs": 64, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 524288, + "memoryGB": 128.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F72s_v2", + "family": "standardFSv2Family", + "vCPUs": 72, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 589824, + "memoryGB": 144.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_D1_v2", + "family": "standardDv2Family", + "vCPUs": 1, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 51200, + "memoryGB": 3.5, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D2_v2", + "family": "standardDv2Family", + "vCPUs": 2, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 102400, + "memoryGB": 7.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D3_v2", + "family": "standardDv2Family", + "vCPUs": 4, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 204800, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D4_v2", + "family": "standardDv2Family", + "vCPUs": 8, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 409600, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D11_v2", + "family": "standardDv2Family", + "vCPUs": 2, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 102400, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D12_v2", + "family": "standardDv2Family", + "vCPUs": 4, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 204800, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D13_v2", + "family": "standardDv2Family", + "vCPUs": 8, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 409600, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D14_v2", + "family": "standardDv2Family", + "vCPUs": 16, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 819200, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_DS1_v2", + "family": "standardDSv2Family", + "vCPUs": 1, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 7168, + "memoryGB": 3.5, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS2_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 14336, + "memoryGB": 7.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS3_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS4_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS5_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS11_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS12_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS13_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS14_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 229376, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS15_v2", + "family": "standardDSv2Family", + "vCPUs": 20, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 286720, + "memoryGB": 140.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC6s_v2", + "family": "standardNCSv2Family", + "vCPUs": 6, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 344064, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC12s_v2", + "family": "standardNCSv2Family", + "vCPUs": 12, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 688128, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC24rs_v2", + "family": "standardNCSv2Family", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC24s_v2", + "family": "standardNCSv2Family", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC6s_v3", + "family": "standardNCSv3Family", + "vCPUs": 6, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 344064, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC12s_v3", + "family": "standardNCSv3Family", + "vCPUs": 12, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 688128, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC24rs_v3", + "family": "standardNCSv3Family", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC24s_v3", + "family": "standardNCSv3Family", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC6", + "family": "standardNCFamily", + "vCPUs": 6, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 389120, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NC12", + "family": "standardNCFamily", + "vCPUs": 12, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 696320, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NC24", + "family": "standardNCFamily", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1474560, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NC24r", + "family": "standardNCFamily", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1474560, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NV6", + "family": "standardNVFamily", + "vCPUs": 6, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 389120, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NV12", + "family": "standardNVFamily", + "vCPUs": 12, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 696320, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NV24", + "family": "standardNVFamily", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1474560, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_ND6s", + "family": "standardNDSFamily", + "vCPUs": 6, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 344064, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_ND12s", + "family": "standardNDSFamily", + "vCPUs": 12, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 688128, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_ND24rs", + "family": "standardNDSFamily", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_ND24s", + "family": "standardNDSFamily", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListWorkspaceFeatures.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListWorkspaceFeatures.json new file mode 100644 index 000000000000..2872cf5d42cd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListWorkspaceFeatures.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "testworkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "automatedml_createeditexperimentsui", + "displayName": "Create edit experiments UI", + "description": "Create, edit or delete AutoML experiments in the SDK" + }, + { + "id": "workspace_upgradeworkspaceui", + "displayName": "Upgrade workspace UI", + "description": "Upgrade workspace from Basic to enterprise from the UI" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListWorkspaceQuotasByVMFamily.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListWorkspaceQuotasByVMFamily.json new file mode 100644 index 000000000000..2c501c9452cb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/ListWorkspaceQuotasByVMFamily.json @@ -0,0 +1,415 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_D_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard D Family Cluster Dedicated vCPUs", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quota", + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard DSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_Dv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard Dv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_FSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 12, + "name": { + "value": "Standard FSv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NC_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NC Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NCv3_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NCv3 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_ND_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard ND Family Cluster Dedicated vCPUs", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NDv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 0, + "name": { + "value": "Standard NDv2 Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/vmFamily/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/Standard_NV_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 24, + "name": { + "value": "Standard NV Family Cluster Dedicated vCPUs", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/amlComputeListNodes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/amlComputeListNodes.json new file mode 100644 index 000000000000..c3127aed0a48 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/amlComputeListNodes.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "computeType": "AmlCompute", + "nodes": [ + { + "nodeId": "tvm-3601533753_1-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50000, + "nodeState": "running", + "runId": "2f378a44-38f2-443a-9f0d-9909d0b47890" + }, + { + "nodeId": "tvm-3601533753_2-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50001, + "nodeState": "idle" + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicAKSCompute.json new file mode 100644 index 000000000000..389946b0359f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicAKSCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AKS" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicAmlCompute.json new file mode 100644 index 000000000000..3bf21602f613 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicAmlCompute.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "NotSpecified" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicDataFactoryCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicDataFactoryCompute.json new file mode 100644 index 000000000000..6241f15b0a30 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createBasicDataFactoryCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "DataFactory" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createLinkedWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createLinkedWorkspace.json new file mode 100644 index 000000000000..f7e2d3d06c9d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createLinkedWorkspace.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "linkName": "link-1", + "api-version": "2020-04-01-preview", + "parameters": { + "name": "link-1", + "properties": { + "linkedWorkspaceResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.Synapse/workspaces/linkedWorkspace-1", + "userAssignedIdentityResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/link-1", + "name": "link-1", + "type": "linkedWorkspaces", + "properties": { + "linkedWorkspaceResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.Synapse/workspaces/linkedWorkspace-1", + "userAssignedIdentityResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai1" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateService.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateService.json new file mode 100644 index 000000000000..2c5e946027e2 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createOrUpdateService.json @@ -0,0 +1,217 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-05-01-preview", + "serviceName": "service456", + "properties": { + "computeType": "ACI", + "environmentImageRequest": { + "driverProgram": "score.py", + "assets": [ + { + "id": null, + "mimeType": "application/x-python", + "url": "aml://storage/azureml/score.py", + "unpack": false + } + ], + "models": [ + { + "name": "sklearn_regression_model.pkl", + "url": "aml://storage/azureml/sklearn_regression_model.pkl", + "mimeType": "application/x-python" + } + ], + "environment": { + "name": "AzureML-Scikit-learn-0.20.3", + "version": "3", + "python": { + "interpreterPath": "python", + "userManagedDependencies": false, + "condaDependencies": { + "channels": [ + "conda-forge" + ], + "dependencies": [ + "python=3.6.2", + { + "pip": [ + "azureml-core==1.0.69", + "azureml-defaults==1.0.69", + "azureml-telemetry==1.0.69", + "azureml-train-restclients-hyperdrive==1.0.69", + "azureml-train-core==1.0.69", + "scikit-learn==0.20.3", + "scipy==1.2.1", + "numpy==1.16.2", + "joblib==0.13.2" + ] + } + ], + "name": "azureml_ae1acbe6e1e6aabbad900b53c491a17c" + }, + "baseCondaEnvironment": null + }, + "environmentVariables": { + "EXAMPLE_ENV_VAR": "EXAMPLE_VALUE" + }, + "docker": { + "baseImage": "mcr.microsoft.com/azureml/base:openmpi3.1.2-ubuntu16.04", + "baseDockerfile": null, + "baseImageRegistry": { + "address": null, + "username": null, + "password": null + } + }, + "spark": { + "repositories": [], + "packages": [], + "precachePackages": true + }, + "inferencingStackVersion": null + } + }, + "containerResourceRequirements": { + "cpu": 1, + "memoryInGB": 1 + }, + "location": "eastus2", + "authEnabled": true, + "appInsightsEnabled": true + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/services/service456", + "type": "Microsoft.MachineLearningServices/workspaces/services", + "name": "service456", + "properties": { + "computeType": "ACI", + "containerResourceRequirements": { + "cpu": 0.1, + "memoryInGB": 0.5, + "gpu": null, + "fpga": null + }, + "scoringUri": "http://ddde8e29-3e3a-42d2-980d-8fb7e005ab81.eastus2.azurecontainer.io/score", + "location": "eastus2", + "authEnabled": true, + "sslEnabled": false, + "appInsightsEnabled": true, + "dataCollection": { + "eventHubEnabled": false, + "storageEnabled": false + }, + "sslCertificate": "", + "sslKey": "", + "cname": null, + "publicIp": "52.177.232.98", + "publicFqdn": "ddde8e29-3e3a-42d2-980d-8fb7e005ab81.eastus2.azurecontainer.io", + "modelConfigMap": { + "accountContext": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "accountName": "workspaces123", + "workspaceId": "57b243e8-3d24-4427-90e0-8dc47f41c387" + }, + "models": { + "sklearn_regression_model1.pkl": { + "version": 2, + "id": "sklearn_regression_model1.pkl:2", + "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc" + } + }, + "modelsInfo": { + "sklearn_regression_model1.pkl": { + "2": { + "version": 2, + "id": "sklearn_regression_model1.pkl:2", + "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc", + "dataCollectorStoragePath": "/modeldata/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/testrg123/workspaces123/service123/sklearn_regression_model1.pkl/2/" + } + } + } + }, + "environmentImageRequest": { + "driverProgram": "score.py", + "assets": [ + { + "id": null, + "mimeType": "application/x-python", + "url": "aml://artifact/LocalUpload/200518T200218a1a8c0af/score.py", + "unpack": false + } + ], + "modelIds": [ + "sklearn_regression_model1.pkl:2" + ], + "environment": { + "name": "AzureML-Scikit-learn-0.20.3", + "version": "3", + "python": { + "interpreterPath": "python", + "userManagedDependencies": false, + "condaDependencies": { + "channels": [ + "conda-forge" + ], + "dependencies": [ + "python=3.6.2", + { + "pip": [ + "azureml-core==1.0.69", + "azureml-defaults==1.0.69", + "azureml-telemetry==1.0.69", + "azureml-train-restclients-hyperdrive==1.0.69", + "azureml-train-core==1.0.69", + "scikit-learn==0.20.3", + "scipy==1.2.1", + "numpy==1.16.2", + "joblib==0.13.2" + ] + } + ], + "name": "azureml_ae1acbe6e1e6aabbad900b53c491a17c" + }, + "baseCondaEnvironment": null + }, + "environmentVariables": { + "EXAMPLE_ENV_VAR": "EXAMPLE_VALUE" + }, + "docker": { + "baseImage": "mcr.microsoft.com/azureml/base:openmpi3.1.2-ubuntu16.04", + "baseDockerfile": null, + "baseImageRegistry": { + "address": null + } + }, + "spark": { + "repositories": [], + "packages": [], + "precachePackages": true + }, + "inferencingStackVersion": null + } + }, + "description": null, + "kvTags": {}, + "properties": { + "hasInferenceSchema": "False", + "hasHttps": "False" + }, + "state": "Transitioning" + } + } + }, + "201": { + "description": "The request was accepted.", + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createWorkspace.json new file mode 100644 index 000000000000..12e7eddacf1e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/createWorkspace.json @@ -0,0 +1,140 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-05-01-preview", + "parameters": { + "location": "eastus2euap", + "sku": { + "name": "Basic", + "tier": "Basic" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "friendlyName": "HelloName", + "description": "test description", + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "encryption": { + "status": "Enabled", + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "identity": { + "principalId": "00000000-1111-2222-3333-444444444444", + "tenantId": "00000000-1111-2222-3333-444444444444", + "type": "SystemAssigned" + }, + "sku": { + "name": "Basic", + "tier": "Basic" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "allowPublicAccessWhenBehindVnet": false, + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Basic", + "tier": "Basic" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "allowPublicAccessWhenBehindVnet": false, + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + }, + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteCompute.json new file mode 100644 index 000000000000..b68832ad4a7c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteCompute.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview", + "underlyingResourceAction": "Delete" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteLinkedWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteLinkedWorkspace.json new file mode 100644 index 000000000000..e6e30e2b4bdd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteLinkedWorkspace.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "linkName": "link-1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteService.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteService.json new file mode 100644 index 000000000000..cb31e5e0ee12 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteService.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "serviceName": "service123", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteWorkspace.json new file mode 100644 index 000000000000..cf63fccaed0d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/deleteWorkspace.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getAKSCompute.json new file mode 100644 index 000000000000..07ab113226ce --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getAKSCompute.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getAmlCompute.json new file mode 100644 index 000000000000..af7e1cde3713 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getAmlCompute.json @@ -0,0 +1,49 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "createdOn": "2017-09-26T22:28:08.327Z", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "subnet": "test-subnet-resource-id", + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "Enabled", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + } + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getComputes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getComputes.json new file mode 100644 index 000000000000..7df2cd210bc7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getComputes.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute1234", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute1234", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute1234-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getLinkedWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getLinkedWorkspace.json new file mode 100644 index 000000000000..97803b44a0f3 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getLinkedWorkspace.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "linkName": "link-1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/link-1", + "name": "link-1", + "type": "linkedWorkspaces", + "properties": { + "linkedWorkspaceResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.Synapse/workspaces/linkedWorkspace-1", + "userAssignedIdentityResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai1" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getService.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getService.json new file mode 100644 index 000000000000..9d3c7a7bde81 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getService.json @@ -0,0 +1,149 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-05-01-preview", + "serviceName": "service123" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/services/service123", + "type": "Microsoft.MachineLearningServices/workspaces/services", + "name": "service123", + "properties": { + "computeType": "AKS", + "containerResourceRequirements": { + "cpu": 0.1, + "memoryInGB": 0.5, + "gpu": null, + "fpga": null + }, + "maxConcurrentRequestsPerContainer": 1, + "maxQueueWaitMs": 500, + "computeName": "my-aks-compute", + "namespace": "azureml-workspaces123", + "numReplicas": 1, + "dataCollection": { + "eventHubEnabled": false, + "storageEnabled": false + }, + "appInsightsEnabled": true, + "autoScaler": { + "autoscaleEnabled": false, + "minReplicas": null, + "maxReplicas": null, + "targetUtilization": null, + "refreshPeriodInSeconds": null + }, + "scoringUri": "http://192.168.1.5:80/api/v1/service/service123/score", + "scoringTimeoutMs": null, + "livenessProbeRequirements": { + "failureThreshold": 3, + "successThreshold": 1, + "timeoutSeconds": 120, + "periodSeconds": 5, + "initialDelaySeconds": 310 + }, + "authEnabled": true, + "aadAuthEnabled": false, + "swaggerUri": "http://192.168.1.5/api/v1/service/service123/swagger.json", + "modelConfigMap": { + "accountContext": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "accountName": "workspaces123", + "workspaceId": "57b243e8-3d24-4427-90e0-8dc47f41c387" + }, + "models": { + "sklearn_regression_model1.pkl": { + "version": 2, + "id": "sklearn_regression_model1.pkl:2", + "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc" + } + }, + "modelsInfo": { + "sklearn_regression_model1.pkl": { + "2": { + "version": 2, + "id": "sklearn_regression_model1.pkl:2", + "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc", + "dataCollectorStoragePath": "/modeldata/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/testrg123/workspaces123/service123/sklearn_regression_model1.pkl/2/" + } + } + } + }, + "environmentImageRequest": { + "driverProgram": "score.py", + "assets": [ + { + "id": null, + "mimeType": "application/x-python", + "url": "aml://artifact/LocalUpload/200518T200218a1a8c0af/score.py", + "unpack": false + } + ], + "modelIds": [ + "sklearn_regression_model1.pkl:2" + ], + "environment": { + "name": "AzureML-Scikit-learn-0.20.3", + "version": "3", + "python": { + "interpreterPath": "python", + "userManagedDependencies": false, + "condaDependencies": { + "channels": [ + "conda-forge" + ], + "dependencies": [ + "python=3.6.2", + { + "pip": [ + "azureml-core==1.0.69", + "azureml-defaults==1.0.69", + "azureml-telemetry==1.0.69", + "azureml-train-restclients-hyperdrive==1.0.69", + "azureml-train-core==1.0.69", + "scikit-learn==0.20.3", + "scipy==1.2.1", + "numpy==1.16.2", + "joblib==0.13.2" + ] + } + ], + "name": "azureml_ae1acbe6e1e6aabbad900b53c491a17c" + }, + "baseCondaEnvironment": null + }, + "environmentVariables": { + "EXAMPLE_ENV_VAR": "EXAMPLE_VALUE" + }, + "docker": { + "baseImage": "mcr.microsoft.com/azureml/base:openmpi3.1.2-ubuntu16.04", + "baseDockerfile": null, + "baseImageRegistry": { + "address": null + } + }, + "spark": { + "repositories": [], + "packages": [], + "precachePackages": true + }, + "inferencingStackVersion": null + } + }, + "description": null, + "kvTags": {}, + "properties": { + "hasInferenceSchema": "False", + "hasHttps": "False" + }, + "state": "Healthy" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getServices.json new file mode 100644 index 000000000000..1e099f9c3136 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getServices.json @@ -0,0 +1,274 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/services/service123", + "type": "Microsoft.MachineLearningServices/workspaces/services", + "name": "service123", + "properties": { + "computeType": "AKS", + "containerResourceRequirements": { + "cpu": 0.1, + "memoryInGB": 0.5, + "gpu": null, + "fpga": null + }, + "maxConcurrentRequestsPerContainer": 1, + "maxQueueWaitMs": 500, + "computeName": "my-aks-compute", + "namespace": "azureml-workspaces123", + "numReplicas": 1, + "dataCollection": { + "eventHubEnabled": false, + "storageEnabled": false + }, + "appInsightsEnabled": true, + "autoScaler": { + "autoscaleEnabled": false, + "minReplicas": null, + "maxReplicas": null, + "targetUtilization": null, + "refreshPeriodInSeconds": null + }, + "scoringUri": "http://192.168.1.5:80/api/v1/service/service123/score", + "scoringTimeoutMs": null, + "livenessProbeRequirements": { + "failureThreshold": 3, + "successThreshold": 1, + "timeoutSeconds": 120, + "periodSeconds": 5, + "initialDelaySeconds": 310 + }, + "authEnabled": true, + "aadAuthEnabled": false, + "swaggerUri": "http://192.168.1.5/api/v1/service/service123/swagger.json", + "modelConfigMap": { + "accountContext": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "accountName": "workspaces123", + "workspaceId": "57b243e8-3d24-4427-90e0-8dc47f41c387" + }, + "models": { + "sklearn_regression_model1.pkl": { + "version": 2, + "id": "sklearn_regression_model1.pkl:2", + "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc" + } + }, + "modelsInfo": { + "sklearn_regression_model1.pkl": { + "2": { + "version": 2, + "id": "sklearn_regression_model1.pkl:2", + "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc", + "dataCollectorStoragePath": "/modeldata/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/testrg123/workspaces123/service123/sklearn_regression_model1.pkl/2/" + } + } + } + }, + "environmentImageRequest": { + "driverProgram": "score.py", + "assets": [ + { + "id": null, + "mimeType": "application/x-python", + "url": "aml://artifact/LocalUpload/200518T200218a1a8c0af/score.py", + "unpack": false + } + ], + "modelIds": [ + "sklearn_regression_model1.pkl:2" + ], + "environment": { + "name": "AzureML-Scikit-learn-0.20.3", + "version": "3", + "python": { + "interpreterPath": "python", + "userManagedDependencies": false, + "condaDependencies": { + "channels": [ + "conda-forge" + ], + "dependencies": [ + "python=3.6.2", + { + "pip": [ + "azureml-core==1.0.69", + "azureml-defaults==1.0.69", + "azureml-telemetry==1.0.69", + "azureml-train-restclients-hyperdrive==1.0.69", + "azureml-train-core==1.0.69", + "scikit-learn==0.20.3", + "scipy==1.2.1", + "numpy==1.16.2", + "joblib==0.13.2" + ] + } + ], + "name": "azureml_ae1acbe6e1e6aabbad900b53c491a17c" + }, + "baseCondaEnvironment": null + }, + "environmentVariables": { + "EXAMPLE_ENV_VAR": "EXAMPLE_VALUE" + }, + "docker": { + "baseImage": "mcr.microsoft.com/azureml/base:openmpi3.1.2-ubuntu16.04", + "baseDockerfile": null, + "baseImageRegistry": { + "address": null + } + }, + "spark": { + "repositories": [], + "packages": [], + "precachePackages": true + }, + "inferencingStackVersion": null + } + }, + "description": null, + "kvTags": {}, + "properties": { + "hasInferenceSchema": "False", + "hasHttps": "False" + }, + "state": "Healthy" + } + }, + { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/services/service456", + "type": "Microsoft.MachineLearningServices/workspaces/services", + "name": "service456", + "properties": { + "computeType": "ACI", + "containerResourceRequirements": { + "cpu": 0.1, + "memoryInGB": 0.5, + "gpu": null, + "fpga": null + }, + "scoringUri": "http://ddde8e29-3e3a-42d2-980d-8fb7e005ab81.eastus2.azurecontainer.io/score", + "location": "eastus2", + "authEnabled": true, + "sslEnabled": false, + "appInsightsEnabled": true, + "dataCollection": { + "eventHubEnabled": false, + "storageEnabled": false + }, + "sslCertificate": "", + "sslKey": "", + "cname": null, + "publicIp": "52.177.232.98", + "publicFqdn": "ddde8e29-3e3a-42d2-980d-8fb7e005ab81.eastus2.azurecontainer.io", + "modelConfigMap": { + "accountContext": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "accountName": "workspaces123", + "workspaceId": "57b243e8-3d24-4427-90e0-8dc47f41c387" + }, + "models": { + "sklearn_regression_model1.pkl": { + "version": 2, + "id": "sklearn_regression_model1.pkl:2", + "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc" + } + }, + "modelsInfo": { + "sklearn_regression_model1.pkl": { + "2": { + "version": 2, + "id": "sklearn_regression_model1.pkl:2", + "internalId": "3ab27a5b0d0e48d99f18a5195cc258bc", + "dataCollectorStoragePath": "/modeldata/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/testrg123/workspaces123/service123/sklearn_regression_model1.pkl/2/" + } + } + } + }, + "environmentImageRequest": { + "driverProgram": "score.py", + "assets": [ + { + "id": null, + "mimeType": "application/x-python", + "url": "aml://artifact/LocalUpload/200518T200218a1a8c0af/score.py", + "unpack": false + } + ], + "modelIds": [ + "sklearn_regression_model1.pkl:2" + ], + "environment": { + "name": "AzureML-Scikit-learn-0.20.3", + "version": "3", + "python": { + "interpreterPath": "python", + "userManagedDependencies": false, + "condaDependencies": { + "channels": [ + "conda-forge" + ], + "dependencies": [ + "python=3.6.2", + { + "pip": [ + "azureml-core==1.0.69", + "azureml-defaults==1.0.69", + "azureml-telemetry==1.0.69", + "azureml-train-restclients-hyperdrive==1.0.69", + "azureml-train-core==1.0.69", + "scikit-learn==0.20.3", + "scipy==1.2.1", + "numpy==1.16.2", + "joblib==0.13.2" + ] + } + ], + "name": "azureml_ae1acbe6e1e6aabbad900b53c491a17c" + }, + "baseCondaEnvironment": null + }, + "environmentVariables": { + "EXAMPLE_ENV_VAR": "EXAMPLE_VALUE" + }, + "docker": { + "baseImage": "mcr.microsoft.com/azureml/base:openmpi3.1.2-ubuntu16.04", + "baseDockerfile": null, + "baseImageRegistry": { + "address": null + } + }, + "spark": { + "repositories": [], + "packages": [], + "precachePackages": true + }, + "inferencingStackVersion": null + } + }, + "description": null, + "kvTags": {}, + "properties": { + "hasInferenceSchema": "False", + "hasHttps": "False" + }, + "state": "Healthy" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspace.json new file mode 100644 index 000000000000..bba054226872 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspace.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Enterprise", + "tier": "Enterprise" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "serviceProvisionedResourceGroup": "testworkspace_0000111122223333", + "privateLinkCount": 0, + "allowPublicAccessWhenBehindVnet": false, + "imageBuildCompute": "testcompute", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/testprivatelinkconnection", + "name": "testprivatelinkconnection", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ], + "sharedPrivateLinkResources": [ + { + "name": "testcosmosdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testcosmosdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspacesByResourceGroup.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspacesByResourceGroup.json new file mode 100644 index 000000000000..17d34142984f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspacesByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Basic", + "tier": "Basic" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace1", + "name": "testworkspace1", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Basic", + "tier": "Basic" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName 1", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspacesBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspacesBySubscription.json new file mode 100644 index 000000000000..cac980d8a16d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/getWorkspacesBySubscription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Enterprise", + "tier": "Enterprise" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-5678/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Enterprise", + "tier": "Enterprise" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listKeysAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listKeysAKSCompute.json new file mode 100644 index 000000000000..cbf5355a1d79 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listKeysAKSCompute.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "computeType": "AKS", + "userKubeConfig": "user kube config...", + "adminKubeConfig": "admin kube config...", + "imagePullSecretName": "the image pull secret name" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listLinkedWorkspaces.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listLinkedWorkspaces.json new file mode 100644 index 000000000000..66e3c333bccb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listLinkedWorkspaces.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/link-1", + "name": "link-1", + "type": "linkedWorkspaces", + "properties": { + "linkedWorkspaceResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/linkRg-1/providers/Microsoft.Synapse/workspaces/linkedWorkspace-1", + "userAssignedIdentityResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai1" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/link-2", + "name": "link-2", + "type": "linkedWorkspaces", + "properties": { + "linkedWorkspaceResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/linkRg-2/providers/Microsoft.Synapse/workspaces/linkedWorkspace-2", + "userAssignedIdentityResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/uai2" + } + } + ] + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listWorkspaceKeys.json new file mode 100644 index 000000000000..c67f021a15b1 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/listWorkspaceKeys.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": { + "body": { + "userStorageKey": "r5rKCJ018TLk+bdAi/9YaVzgcQ0nkLsUqGyUN03KsdCFtqG0SjFGPV8+vT1frWqkvBL0bGoPpLc1BlZSSaZmOA==", + "userStorageResourceId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr", + "appInsightsInstrumentationKey": null, + "containerRegistryCredentials": { + "location": null, + "username": "testdemoworkjmjmeykp", + "passwords": [ + { + "name": "password", + "value": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw" + }, + { + "name": "password2", + "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t" + } + ] + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/patchAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/patchAmlCompute.json new file mode 100644 index 000000000000..530ad9288c83 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/patchAmlCompute.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview", + "parameters": { + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/resyncWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/resyncWorkspaceKeys.json new file mode 100644 index 000000000000..4cb6d434ed37 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/resyncWorkspaceKeys.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-05-01-preview" + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateAKSCompute.json new file mode 100644 index 000000000000..4bd1d3db4c7b --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateAKSCompute.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "properties": { + "agentCount": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateAmlCompute.json new file mode 100644 index 000000000000..3879a0fe2130 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateAmlCompute.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-05-01-preview", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "description": "some compute", + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateQuota.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateQuota.json new file mode 100644 index 000000000000..72510002a08f --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateQuota.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2020-05-01-preview", + "parameters": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 100, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 200, + "unit": "Count" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 100, + "unit": "Count", + "status": "Success" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/Standard_DSv2_Family_Cluster_Dedicated_vCPUs", + "type": "Microsoft.MachineLearningServices/workspaces/quotas", + "limit": 200, + "unit": "Count", + "status": "Success" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateWorkspace.json new file mode 100644 index 000000000000..2716523be984 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/updateWorkspace.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-05-01-preview", + "parameters": { + "sku": { + "name": "Enterprise", + "tier": "Enterprise" + }, + "properties": { + "friendlyName": "New friendly name", + "description": "new description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Enterprise", + "tier": "Enterprise" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "New friendly name", + "description": "new description" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceDeletePrivateEndpointConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..dd8f4c3bd990 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceDeletePrivateEndpointConnection.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-05-01-preview", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceGetPrivateEndpointConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..b063bb3699ae --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceGetPrivateEndpointConnection.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-05-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceListPrivateLinkResources.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceListPrivateLinkResources.json new file mode 100644 index 000000000000..f2e5161bbf0a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspaceListPrivateLinkResources.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "api-version": "2020-05-01-preview", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateLinkResources/amlworkspace", + "name": "amlworkspace", + "type": "Microsoft.Storage/workspaces/privateLinkResources", + "properties": { + "groupId": "amlworkspace", + "requiredMembers": [ + "default" + ] + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspacePutPrivateEndpointConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspacePutPrivateEndpointConnection.json new file mode 100644 index 000000000000..6ad178163ad5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/examples/workspacePutPrivateEndpointConnection.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-05-01-preview", + "monitor": "true", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json new file mode 100644 index 000000000000..12dd8bd3a957 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json @@ -0,0 +1,5403 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Workspaces", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2020-05-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.MachineLearningServices/operations": { + "get": { + "tags": [ + "Operation" + ], + "description": "Lists all of the available Azure Machine Learning Workspaces REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Gets the properties of the specified machine learning workspace.", + "operationId": "Workspaces_Get", + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/getWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "Workspaces" + ], + "description": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Workspace": { + "$ref": "./examples/createWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for creating or updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "description": "Deletes a machine learning workspace.", + "operationId": "Workspaces_Delete", + "x-ms-examples": { + "Delete Workspace": { + "$ref": "./examples/deleteWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "204": { + "description": "The machine learning workspace does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "description": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_Update", + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/updateWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all enabled features for a workspace", + "operationId": "WorkspaceFeatures_List", + "x-ms-examples": { + "List Workspace features": { + "$ref": "./examples/ListWorkspaceFeatures.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListAmlUserFeatureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "x-ms-examples": { + "Get Workspaces by Resource Group": { + "$ref": "./examples/getWorkspacesByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ListKeys", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/listWorkspaceKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ResyncKeys", + "x-ms-examples": { + "Resync Workspace Keys": { + "$ref": "./examples/resyncWorkspaceKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usages_List", + "description": "Gets the current usage information as well as limits for AML resources for given subscription and location.", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Usages": { + "$ref": "./examples/ListUsages.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "Returns supported VM Sizes in a location", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-examples": { + "List VM Sizes": { + "$ref": "./examples/ListVMSizesResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas": { + "post": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_Update", + "description": "Update quota for each VM family in workspace.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for update quota is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaUpdateParameters" + }, + "description": "Quota update parameters." + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful.", + "schema": { + "$ref": "#/definitions/UpdateWorkspaceQuotasResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-examples": { + "update quotas": { + "$ref": "./examples/updateQuota.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/Quotas": { + "get": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_List", + "description": "Gets the currently assigned Workspace Quotas based on VMFamily.", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListWorkspaceQuotas" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List workspace quotas by VMFamily": { + "$ref": "./examples/ListWorkspaceQuotasByVMFamily.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "x-ms-examples": { + "Get Workspaces by subscription": { + "$ref": "./examples/getWorkspacesBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "MachineLearningCompute_ListByWorkspace", + "description": "Gets computes in specified workspace.", + "x-ms-examples": { + "Get Computes": { + "$ref": "./examples/getComputes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning computes and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedComputeResourcesList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Get", + "description": "Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.", + "x-ms-examples": { + "Get a AKS Compute": { + "$ref": "./examples/getAKSCompute.json" + }, + "Get a AML Compute": { + "$ref": "./examples/getAmlCompute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_CreateOrUpdate", + "description": "Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a AML Compute": { + "$ref": "./examples/createBasicAmlCompute.json" + }, + "Create AKS Compute": { + "$ref": "./examples/createBasicAKSCompute.json" + }, + "Create a DataFactory Compute": { + "$ref": "./examples/createBasicDataFactoryCompute.json" + }, + "Update a AML Compute": { + "$ref": "./examples/updateAmlCompute.json" + }, + "Update a AKS Compute": { + "$ref": "./examples/updateAKSCompute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/ComputeDefinitionParameter" + } + ], + "responses": { + "200": { + "description": "Compute creation or update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "201": { + "description": "Compute creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "patch": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Update", + "description": "Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a AmlCompute Compute": { + "$ref": "./examples/patchAmlCompute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "description": "Additional parameters for cluster update." + } + ], + "responses": { + "200": { + "description": "Compute update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Delete", + "description": "Deletes specified Machine Learning compute.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Compute": { + "$ref": "./examples/deleteCompute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/UnderlyingResourceActionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "Compute deletion initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes": { + "post": { + "tags": [ + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_ListNodes", + "description": "Get the details (e.g IP address, port etc) of all the compute nodes in the compute.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of IP addresses.", + "schema": { + "$ref": "#/definitions/AmlComputeNodesInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-examples": { + "Get compute nodes information for a compute": { + "$ref": "./examples/amlComputeListNodes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_ListKeys", + "description": "Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).", + "x-ms-examples": { + "List AKS Compute Keys": { + "$ref": "./examples/listKeysAKSCompute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeSecrets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces/skus": { + "get": { + "tags": [ + "WorkspaceSkus" + ], + "description": "Lists all skus with associated features", + "operationId": "ListSkus", + "x-ms-examples": { + "List Skus": { + "$ref": "./examples/ListSkus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/SkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/workspaceGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Put", + "description": "Update the state of specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/workspacePutPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceDeletePrivateEndpointConnection": { + "$ref": "./examples/workspaceDeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "WorkspacePrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByWorkspace", + "description": "Gets the private link resources that need to be created for a workspace.", + "x-ms-examples": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/workspaceListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/linkedWorkspaces": { + "get": { + "tags": [ + "LinkedWorkspaces" + ], + "x-ms-examples": { + "ListLinkedWorkspaces": { + "$ref": "./examples/listLinkedWorkspaces.json" + } + }, + "operationId": "LinkedWorkspaces_List", + "description": "List all linked workspaces under a AML workspace.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the linked workspaces.", + "schema": { + "type": "array", + "description": "array of linked workspaces.", + "items": { + "$ref": "#/definitions/LinkedWorkspace" + } + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/linkedWorkspaces/{linkName}": { + "put": { + "tags": [ + "LinkedWorkspaces" + ], + "operationId": "LinkedWorkspaces_Create", + "description": "Add a new linked workspace.", + "x-ms-examples": { + "CreateLinkedWorkspace": { + "$ref": "./examples/createLinkedWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/LinkName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The object for creating or updating a new linked workspace", + "required": true, + "schema": { + "$ref": "#/definitions/LinkedWorkspaceDto" + } + } + ], + "responses": { + "200": { + "description": "Successfully created the linked workspace.", + "schema": { + "$ref": "#/definitions/LinkedWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "get": { + "tags": [ + "LinkedWorkspaces" + ], + "operationId": "LinkedWorkspaces_Get", + "description": "Get the detail of a linked workspace.", + "x-ms-examples": { + "GetLinkedWorkspace": { + "$ref": "./examples/getLinkedWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/LinkName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the detail of the linked workspace.", + "schema": { + "$ref": "#/definitions/LinkedWorkspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "LinkedWorkspaces" + ], + "operationId": "LinkedWorkspaces_Delete", + "description": "Delete a linked workspace.", + "x-ms-examples": { + "DeleteLinkedWorkspace": { + "$ref": "./examples/deleteLinkedWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/LinkName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the linked workspace." + }, + "204": { + "description": "Specific linked workspace not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/services": { + "get": { + "tags": [ + "MachineLearningServices" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "MachineLearningService_ListByWorkspace", + "description": "Gets services in specified workspace.", + "x-ms-examples": { + "Get Services": { + "$ref": "./examples/getServices.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + }, + { + "$ref": "#/parameters/ModelIdParameter" + }, + { + "$ref": "#/parameters/ModelNameParameter" + }, + { + "$ref": "#/parameters/WebServiceTagParameter" + }, + { + "$ref": "#/parameters/WebServiceTagsParameter" + }, + { + "$ref": "#/parameters/WebServicePropertiesParameter" + }, + { + "$ref": "#/parameters/WebServiceRunIdParameter" + }, + { + "$ref": "#/parameters/WebServiceExpandParameter" + }, + { + "$ref": "#/parameters/WebServiceOrderByParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning services and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedServiceList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/services/{serviceName}": { + "get": { + "tags": [ + "MachineLearningServices" + ], + "operationId": "MachineLearningService_Get", + "description": "Get a Service by name.", + "x-ms-examples": { + "Get Service": { + "$ref": "./examples/getService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "in": "query", + "name": "expand", + "description": "Set to True to include Model details.", + "type": "boolean", + "default": false + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "MachineLearningServices" + ], + "operationId": "MachineLearningService_Delete", + "description": "Delete a specific Service..", + "x-ms-examples": { + "Delete Service": { + "$ref": "./examples/deleteService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + } + ], + "responses": { + "200": { + "description": "The resource exists and was deleted successfully." + }, + "204": { + "description": "The resource does not exist and the request was well formed." + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "MachineLearningServices" + ], + "description": "Creates or updates service. This call will update a service if it exists. This is a nonrecoverable operation. If your intent is to create a new service, do a GET first to verify that it does not exist yet.", + "operationId": "MachineLearningService_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Or Update service": { + "$ref": "./examples/createOrUpdateService.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/WebServiceNameParameter" + }, + { + "in": "body", + "name": "properties", + "description": "The payload that is used to create or update the Service.", + "required": true, + "schema": { + "$ref": "#/definitions/CreateServiceRequest" + } + } + ], + "responses": { + "200": { + "description": "Service creation or update initiated.", + "schema": { + "$ref": "#/definitions/ServiceResource" + } + }, + "201": { + "description": "Service creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "description": "Azure subscription identifier.", + "in": "path", + "type": "string", + "required": true + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "description": "Name of the resource group in which workspace is located.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "ComputeNameParameter": { + "name": "computeName", + "description": "Name of the Azure Machine Learning compute.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "AsyncOperationIdParameter": { + "name": "asyncOperationId", + "description": "Identifier of an asynchronous Azure Machine Learning compute operation.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "description": "The name of the Azure location/region.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "APIVersionParameter": { + "in": "query", + "name": "api-version", + "type": "string", + "description": "Version of Azure Machine Learning resource provider API.", + "required": true + }, + "PaginationParameter": { + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "ComputeDefinitionParameter": { + "in": "body", + "name": "parameters", + "description": "Payload with Machine Learning compute definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeResource" + }, + "x-ms-parameter-location": "method" + }, + "ComputeTypeParameter": { + "in": "query", + "name": "compute-type", + "type": "string", + "description": "Type of compute to filter by.", + "required": false, + "x-ms-parameter-location": "method" + }, + "UnderlyingResourceActionParameter": { + "in": "query", + "name": "underlyingResourceAction", + "type": "string", + "description": "Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.", + "required": true, + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "UnderlyingResourceAction", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the workspace", + "x-ms-parameter-location": "method" + }, + "LinkName": { + "name": "linkName", + "in": "path", + "required": true, + "type": "string", + "description": "Friendly name of the linked workspace", + "x-ms-parameter-location": "method" + }, + "ModelIdParameter": { + "in": "query", + "name": "modelId", + "type": "string", + "description": "The Model Id.", + "required": false, + "x-ms-parameter-location": "method" + }, + "ModelNameParameter": { + "in": "query", + "name": "modelName", + "type": "string", + "description": "The Model name.", + "required": false, + "x-ms-parameter-location": "method" + }, + "WebServiceNameParameter": { + "name": "serviceName", + "description": "Name of the Azure Machine Learning service.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "WebServiceTagParameter": { + "in": "query", + "name": "tag", + "type": "string", + "description": "The object tag.", + "required": false, + "x-ms-parameter-location": "method" + }, + "WebServiceCountParameter": { + "in": "query", + "name": "count", + "type": "integer", + "format": "int32", + "description": "The number of items to retrieve in a page.", + "required": false, + "x-ms-parameter-location": "method" + }, + "WebServiceTagsParameter": { + "in": "query", + "name": "tags", + "type": "string", + "description": "A set of tags with which to filter the returned services. It is a comma separated string of tags key or tags key=value Example: tagKey1,tagKey2,tagKey3=value3 .", + "required": false, + "x-ms-parameter-location": "method" + }, + "WebServicePropertiesParameter": { + "in": "query", + "name": "properties", + "type": "string", + "description": "A set of properties with which to filter the returned services. It is a comma separated string of properties key and/or properties key=value Example: propKey1,propKey2,propKey3=value3 .", + "required": false, + "x-ms-parameter-location": "method" + }, + "WebServiceRunIdParameter": { + "in": "query", + "name": "runId", + "type": "string", + "description": "runId for model associated with service.", + "required": false, + "x-ms-parameter-location": "method" + }, + "WebServiceExpandParameter": { + "in": "query", + "name": "expand", + "type": "boolean", + "description": "Set to True to include Model details.", + "required": false, + "x-ms-parameter-location": "method" + }, + "WebServiceOrderByParameter": { + "in": "query", + "name": "orderby", + "type": "string", + "description": "The option to order the response.", + "required": false, + "default": "UpdatedAtDesc", + "enum": [ + "CreatedAtDesc", + "CreatedAtAsc", + "UpdatedAtDesc", + "UpdatedAtAsc" + ], + "x-ms-enum": { + "name": "OrderString", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Operation": { + "description": "Azure Machine Learning workspace REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display name of operation", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } + } + } + }, + "OperationListResult": { + "description": "An array of operations supported by the resource provider.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of AML workspace operations supported by the AML workspace resource provider." + } + } + }, + "Workspace": { + "type": "object", + "description": "An object that represents a machine learning workspace.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceProperties", + "description": "The properties of the machine learning workspace.", + "x-ms-client-flatten": true + } + } + }, + "WorkspaceProperties": { + "type": "object", + "description": "The properties of a machine learning workspace.", + "properties": { + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "creationTime": { + "format": "date-time", + "description": "The creation time of the machine learning workspace in ISO8601 format.", + "type": "string", + "readOnly": true + }, + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "discoveryUrl": { + "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", + "type": "string" + }, + "provisioningState": { + "type": "string", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning." + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperty", + "description": "The encryption settings of Azure ML workspace." + }, + "hbiWorkspace": { + "type": "boolean", + "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", + "default": false + }, + "serviceProvisionedResourceGroup": { + "type": "string", + "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", + "readOnly": true + }, + "privateLinkCount": { + "type": "integer", + "format": "int32", + "description": "Count of private connections in the workspace", + "readOnly": true + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "allowPublicAccessWhenBehindVnet": { + "type": "boolean", + "description": "The flag to indicate whether to allow public access when behind VNet.", + "default": false + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of private endpoint connections in the workspace." + }, + "sharedPrivateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "description": "The list of shared private link resources in this workspace." + } + } + }, + "WorkspaceUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", + "properties": { + "tags": { + "description": "The resource tags for the machine learning workspace.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." + }, + "properties": { + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "description": "The properties that the machine learning workspace will be updated with.", + "x-ms-client-flatten": true + } + } + }, + "WorkspacePropertiesUpdateParameters": { + "description": "The parameters for updating the properties of a machine learning workspace.", + "properties": { + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace.", + "type": "string" + } + } + }, + "AmlUserFeature": { + "description": "Features enabled for a workspace", + "type": "object", + "properties": { + "id": { + "description": "Specifies the feature ID", + "type": "string" + }, + "displayName": { + "description": "Specifies the feature name ", + "type": "string" + }, + "description": { + "description": "Describes the feature for user experience", + "type": "string" + } + } + }, + "ListAmlUserFeatureResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlUserFeature" + }, + "description": "The list of AML user facing features." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next page of AML user features information." + } + }, + "description": "The List Aml user feature operation response." + }, + "UsageName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "description": "Describes AML Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of AML resource usages." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next page of AML resource usage information." + } + }, + "description": "The List Usages operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "title": "Virtual Machine size name", + "description": "The name of the virtual machine size.", + "readOnly": true + }, + "family": { + "type": "string", + "title": "Virtual Machine family name", + "description": "The family name of the virtual machine size.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "title": "Number of vPUs", + "description": "The number of vCPUs supported by the virtual machine size.", + "readOnly": true + }, + "gpus": { + "type": "integer", + "format": "int32", + "title": "Number of gPUs", + "description": "The number of gPUs supported by the virtual machine size.", + "readOnly": true + }, + "osVhdSizeMB": { + "type": "integer", + "format": "int32", + "title": "OS VHD Disk size", + "description": "The OS VHD disk size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "maxResourceVolumeMB": { + "type": "integer", + "format": "int32", + "title": "Resource volume size", + "description": "The resource volume size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "memoryGB": { + "type": "number", + "format": "double", + "title": "Memory size", + "description": "The amount of memory, in GB, supported by the virtual machine size.", + "readOnly": true + }, + "lowPriorityCapable": { + "type": "boolean", + "title": "Low priority capable", + "description": "Specifies if the virtual machine size supports low priority VMs.", + "readOnly": true + }, + "premiumIO": { + "type": "boolean", + "title": "Premium IO supported", + "description": "Specifies if the virtual machine size supports premium IO.", + "readOnly": true + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "amlCompute": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "description": "The list of virtual machine sizes supported by AmlCompute." + } + }, + "description": "The List Virtual Machine size operation response." + }, + "WorkspaceListResult": { + "description": "The result of a request to list machine learning workspaces.", + "properties": { + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of machine learning workspaces.", + "type": "string" + } + } + }, + "QuotaBaseProperties": { + "properties": { + "id": { + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The properties for Quota update or retrieval." + }, + "QuotaUpdateParameters": { + "properties": { + "value": { + "description": "The list for update quota.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaBaseProperties" + } + } + }, + "description": "Quota update parameters." + }, + "UpdateWorkspaceQuotasResult": { + "properties": { + "value": { + "description": "The list of workspace quota update result.", + "items": { + "$ref": "#/definitions/UpdateWorkspaceQuotas" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next page of Workspace Quota update result.", + "readOnly": true, + "type": "string" + } + }, + "description": "The result of update workspace quota." + }, + "UpdateWorkspaceQuotas": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": false, + "title": "Update Workspace Quota Status.", + "description": "Status of update workspace quota.", + "enum": [ + "Undefined", + "Success", + "Failure", + "InvalidQuotaBelowClusterMinimum", + "InvalidQuotaExceedsSubscriptionLimit", + "InvalidVMFamilyName", + "OperationNotSupportedForSku", + "OperationNotEnabledForRegion" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + } + }, + "description": "The properties for update Quota response." + }, + "ResourceName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Resource Name." + }, + "ResourceQuota": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "name": { + "$ref": "#/definitions/ResourceName", + "description": "Name of the resource.", + "readOnly": true + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The quota assigned to a resource." + }, + "ListWorkspaceQuotas": { + "properties": { + "value": { + "description": "The list of Workspace Quotas by VM Family", + "items": { + "$ref": "#/definitions/ResourceQuota" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch the next page of Workspace Quota information.", + "readOnly": true, + "type": "string" + } + }, + "description": "The List WorkspaceQuotasByVMFamily operation response." + }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned", + "SystemAssigned,UserAssigned", + "UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "$ref": "#/definitions/UserAssignedIdentities", + "description": "The user assigned identities associated with the resource." + } + }, + "description": "Identity for the resource." + }, + "UserAssignedIdentities": { + "description": "dictionary containing all the user assigned identities, with resourceId of the UAI as key.", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentity" + } + }, + "UserAssignedIdentity": { + "description": "User Assigned Identity", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of the user assigned identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of the user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The clientId(aka appId) of the user assigned identity." + } + } + }, + "Resource": { + "description": "Azure Resource Manager resource envelope.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Specifies the resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Specifies the name of the resource.", + "type": "string", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "type": { + "description": "Specifies the type of the resource.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." + } + } + }, + "ResourceId": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource" + } + }, + "required": [ + "id" + ], + "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", + "x-ms-azure-resource": true + }, + "ListWorkspaceKeysResult": { + "type": "object", + "properties": { + "userStorageKey": { + "readOnly": true, + "type": "string" + }, + "userStorageResourceId": { + "readOnly": true, + "type": "string" + }, + "appInsightsInstrumentationKey": { + "readOnly": true, + "type": "string" + }, + "containerRegistryCredentials": { + "readOnly": true, + "$ref": "#/definitions/RegistryListCredentialsResult" + } + } + }, + "RegistryListCredentialsResult": { + "type": "object", + "properties": { + "location": { + "readOnly": true, + "type": "string" + }, + "username": { + "readOnly": true, + "type": "string" + }, + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" + } + } + } + }, + "Password": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string" + }, + "value": { + "readOnly": true, + "type": "string" + } + } + }, + "PaginatedComputeResourcesList": { + "type": "object", + "description": "Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.", + "properties": { + "value": { + "type": "array", + "description": "An array of Machine Learning compute objects wrapped in ARM resource envelope.", + "items": { + "$ref": "#/definitions/ComputeResource" + } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "ComputeResource": { + "type": "object", + "description": "Machine Learning compute object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object", + "properties": { + "properties": { + "description": "Compute properties", + "$ref": "#/definitions/Compute" + } + } + } + ] + }, + "Compute": { + "type": "object", + "description": "Machine Learning compute object.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "computeLocation": { + "description": "Location for the underlying compute", + "type": "string" + }, + "provisioningState": { + "type": "string", + "description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of the Machine Learning compute." + }, + "createdOn": { + "type": "string", + "description": "The date and time when the compute was created.", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "type": "string", + "description": "The date and time when the compute was last modified.", + "format": "date-time", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "ARM resource id of the underlying compute" + }, + "provisioningErrors": { + "type": "array", + "description": "Errors during provisioning", + "items": { + "$ref": "#/definitions/MachineLearningServiceError" + }, + "readOnly": true + }, + "isAttachedCompute": { + "type": "boolean", + "description": "Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.", + "readOnly": true + } + }, + "required": [ + "computeType" + ] + }, + "AKS": { + "description": "A Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "AKS properties", + "properties": { + "clusterFqdn": { + "description": "Cluster full qualified domain name", + "type": "string" + }, + "systemServices": { + "type": "array", + "description": "System services", + "items": { + "$ref": "#/definitions/SystemService" + }, + "readOnly": true + }, + "agentCount": { + "description": "Number of agents", + "type": "integer", + "format": "int32", + "minimum": 1 + }, + "agentVMSize": { + "description": "Agent virtual machine size", + "type": "string" + }, + "sslConfiguration": { + "description": "SSL configuration", + "$ref": "#/definitions/SslConfiguration" + }, + "aksNetworkingConfiguration": { + "description": "AKS networking configuration for vnet", + "$ref": "#/definitions/AksNetworkingConfiguration" + } + } + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "AmlCompute": { + "description": "An Azure Machine Learning compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "AML Compute properties", + "properties": { + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "vmPriority": { + "description": "Virtual Machine priority", + "type": "string", + "enum": [ + "Dedicated", + "LowPriority" + ], + "x-ms-enum": { + "name": "VmPriority", + "modelAsString": true + } + }, + "scaleSettings": { + "description": "Scale settings for AML Compute", + "$ref": "#/definitions/ScaleSettings" + }, + "userAccountCredentials": { + "title": "User account credentials.", + "description": "Credentials for an administrator user account that will be created on each compute node.", + "$ref": "#/definitions/UserAccountCredentials" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId" + }, + "remoteLoginPortPublicAccess": { + "type": "string", + "default": "NotSpecified", + "title": "Close remote Login Access Port", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled", + "NotSpecified" + ], + "x-ms-enum": { + "name": "remoteLoginPortPublicAccess", + "modelAsString": true + } + }, + "allocationState": { + "type": "string", + "readOnly": true, + "title": "Allocation state.", + "description": "Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.", + "enum": [ + "Steady", + "Resizing" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": true + } + }, + "allocationStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Allocation state transition time.", + "description": "The time at which the compute entered its current allocation state." + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered by various compute nodes during node setup.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineLearningServiceError" + } + }, + "currentNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Current node count.", + "description": "The number of compute nodes currently assigned to the compute." + }, + "targetNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Target node count.", + "description": "The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation." + }, + "nodeStateCounts": { + "title": "Node state counts.", + "description": "Counts of various node states on the compute.", + "readOnly": true, + "$ref": "#/definitions/NodeStateCounts" + } + } + } + } + } + ], + "x-ms-discriminator-value": "AmlCompute" + }, + "VirtualMachine": { + "description": "A Machine Learning compute based on Azure Virtual Machines.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "virtualMachineSize": { + "description": "Virtual Machine size", + "type": "string" + }, + "sshPort": { + "description": "Port open for ssh connections.", + "type": "integer", + "format": "int32" + }, + "address": { + "description": "Public IP address of the virtual machine.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for virtual machine", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + } + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "HDInsight": { + "description": "A HDInsight compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "sshPort": { + "description": "Port open for ssh connections on the master node of the cluster.", + "type": "integer", + "format": "int32" + }, + "address": { + "description": "Public IP address of the master node of the cluster.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for master node of the cluster", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + } + } + ], + "x-ms-discriminator-value": "HDInsight" + }, + "DataFactory": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "DataFactory" + }, + "Databricks": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "databricksAccessToken": { + "description": "Databricks access token", + "type": "string" + } + } + } + } + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "DataLakeAnalytics": { + "description": "A DataLakeAnalytics compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "dataLakeStoreAccountName": { + "description": "DataLake Store Account Name", + "type": "string" + } + } + } + } + } + ], + "x-ms-discriminator-value": "DataLakeAnalytics" + }, + "ServicePrincipalCredentials": { + "type": "object", + "description": "Service principal credentials.", + "properties": { + "clientId": { + "description": "Client Id", + "type": "string" + }, + "clientSecret": { + "description": "Client secret", + "type": "string" + } + }, + "required": [ + "clientId", + "clientSecret" + ] + }, + "SystemService": { + "type": "object", + "description": "A system service running on a compute.", + "properties": { + "systemServiceType": { + "description": "The type of this system service.", + "readOnly": true, + "type": "string" + }, + "publicIpAddress": { + "type": "string", + "description": "Public IP address", + "readOnly": true + }, + "version": { + "description": "The version for this type.", + "readOnly": true, + "type": "string" + } + } + }, + "SslConfiguration": { + "type": "object", + "description": "The ssl configuration for scoring", + "properties": { + "status": { + "description": "Enable or disable ssl for scoring", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ] + }, + "cert": { + "description": "Cert data", + "type": "string" + }, + "key": { + "description": "Key data", + "type": "string" + }, + "cname": { + "description": "CNAME of the cert", + "type": "string" + } + } + }, + "AksNetworkingConfiguration": { + "type": "object", + "description": "Advance configuration for AKS networking", + "properties": { + "subnetId": { + "description": "Virtual network subnet resource ID the compute nodes belong to", + "type": "string" + }, + "serviceCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.", + "type": "string" + }, + "dnsServiceIP": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.", + "type": "string" + }, + "dockerBridgeCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.", + "type": "string" + } + } + }, + "UserAccountCredentials": { + "properties": { + "adminUserName": { + "type": "string", + "title": "User name.", + "description": "Name of the administrator user account which can be used to SSH to nodes." + }, + "adminUserSshPublicKey": { + "type": "string", + "title": "SSH public key.", + "description": "SSH public key of the administrator user account." + }, + "adminUserPassword": { + "type": "string", + "title": "Password.", + "description": "Password of the administrator user account." + } + }, + "required": [ + "adminUserName" + ], + "description": "Settings for user account that gets created on each on the nodes of a compute." + }, + "ScaleSettings": { + "type": "object", + "description": "scale settings for AML Compute", + "properties": { + "maxNodeCount": { + "description": "Max number of nodes to use", + "type": "integer", + "format": "int32" + }, + "minNodeCount": { + "description": "Min number of nodes to use", + "type": "integer", + "format": "int32", + "default": 0 + }, + "nodeIdleTimeBeforeScaleDown": { + "type": "string", + "format": "duration", + "description": "Node Idle Time before scaling down amlCompute" + } + }, + "required": [ + "maxNodeCount" + ] + }, + "NodeStateCounts": { + "properties": { + "idleNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Idle node count.", + "description": "Number of compute nodes in idle state." + }, + "runningNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Running node count.", + "description": "Number of compute nodes which are running jobs." + }, + "preparingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preparing node count.", + "description": "Number of compute nodes which are being prepared." + }, + "unusableNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Unusable node count.", + "description": "Number of compute nodes which are in unusable state." + }, + "leavingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Leaving node count.", + "description": "Number of compute nodes which are leaving the amlCompute." + }, + "preemptedNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preempted node count.", + "description": "Number of compute nodes which are in preempted state." + } + }, + "description": "Counts of various compute node states on the amlCompute." + }, + "ClusterUpdateProperties": { + "properties": { + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Scale settings.", + "description": "Desired scale settings for the amlCompute." + } + }, + "description": "The properties of a amlCompute that need to be updated." + }, + "ClusterUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterUpdateProperties", + "description": "The properties of the amlCompute." + } + }, + "description": "AmlCompute update parameters." + }, + "ComputeNodesInformation": { + "type": "object", + "description": "Compute nodes information related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + }, + "required": [ + "computeType" + ] + }, + "AmlComputeNodesInformation": { + "description": "Compute node information related to a AmlCompute.", + "allOf": [ + { + "$ref": "#/definitions/ComputeNodesInformation" + }, + { + "type": "object", + "properties": { + "nodes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlComputeNodeInformation" + }, + "description": "The collection of returned AmlCompute nodes details." + } + } + } + ], + "x-ms-discriminator-value": "AmlCompute" + }, + "AmlComputeNodeInformation": { + "description": "Compute node information related to a AmlCompute.", + "properties": { + "nodeId": { + "readOnly": true, + "type": "string", + "title": "Node ID.", + "description": "ID of the compute node." + }, + "privateIpAddress": { + "readOnly": true, + "type": "string", + "title": "Private IP address.", + "description": "Private IP address of the compute node." + }, + "publicIpAddress": { + "readOnly": true, + "type": "string", + "title": "Public IP address.", + "description": "Public IP address of the compute node." + }, + "port": { + "readOnly": true, + "type": "number", + "format": "int32", + "title": "Port.", + "description": "SSH port number of the node." + }, + "nodeState": { + "readOnly": true, + "type": "string", + "enum": [ + "idle", + "running", + "preparing", + "unusable", + "leaving", + "preempted" + ], + "description": "State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.", + "x-ms-enum": { + "name": "nodeState", + "modelAsString": true + } + }, + "runId": { + "readOnly": true, + "type": "string", + "title": "Run ID.", + "description": "ID of the Experiment running on the node, if any else null." + } + }, + "x-ms-discriminator-value": "AmlCompute" + }, + "VirtualMachineSshCredentials": { + "type": "object", + "description": "Admin credentials for virtual machine", + "properties": { + "username": { + "description": "Username of admin account", + "type": "string" + }, + "password": { + "description": "Password of admin account", + "type": "string" + }, + "publicKeyData": { + "description": "Public key data", + "type": "string" + }, + "privateKeyData": { + "description": "Private key data", + "type": "string" + } + } + }, + "ComputeSecrets": { + "type": "object", + "description": "Secrets related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + } + }, + "required": [ + "computeType" + ] + }, + "AksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "userKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "adminKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "imagePullSecretName": { + "type": "string", + "description": "Image registry pull secret." + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "VirtualMachineSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "administratorAccount": { + "description": "Admin credentials for virtual machine.", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "DatabricksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on Databricks.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "databricksAccessToken": { + "description": "access token for databricks account.", + "type": "string" + } + } + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "ComputeType": { + "type": "string", + "description": "The type of compute", + "enum": [ + "AKS", + "AmlCompute", + "DataFactory", + "VirtualMachine", + "HDInsight", + "Databricks", + "DataLakeAnalytics" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true + } + }, + "MachineLearningServiceError": { + "type": "object", + "description": "Wrapper for error response to follow ARM guidelines.", + "properties": { + "error": { + "description": "The error response.", + "$ref": "#/definitions/ErrorResponse", + "readOnly": true + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response information.", + "properties": { + "code": { + "type": "string", + "description": "Error code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Error message.", + "readOnly": true + }, + "details": { + "type": "array", + "description": "An array of error detail objects.", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "readOnly": true + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "Error detail information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "code", + "message" + ] + }, + "SKUCapability": { + "description": "Features/user capabilities associated with the sku", + "type": "object", + "properties": { + "name": { + "description": "Capability/Feature ID", + "type": "string" + }, + "value": { + "description": "Details about the feature/capability", + "type": "string" + } + } + }, + "ResourceSkuLocationInfo": { + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Location of the SKU" + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is supported." + }, + "zoneDetails": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuZoneDetails" + }, + "description": "Details of capabilities available to a SKU in specific zones." + } + } + }, + "ResourceSkuZoneDetails": { + "properties": { + "name": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of zones that the SKU is available in with the specified capabilities." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "description": "A list of capabilities that are available for the SKU in the specified list of zones." + } + }, + "description": "Describes The zonal capabilities of a SKU." + }, + "WorkspaceSku": { + "description": "Describes Workspace Sku details and features", + "type": "object", + "properties": { + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.)." + }, + "locationInfo": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + }, + "description": "A list of locations and availability zones in those locations where the SKU is available." + }, + "tier": { + "description": "Sku Tier like Basic or Enterprise", + "type": "string", + "readOnly": true + }, + "resourceType": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + }, + "capabilities": { + "description": "List of features/user capabilities associated with the sku", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "readOnly": true + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Restriction" + }, + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + } + }, + "Restriction": { + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The type of restrictions. As of now only possible value for this is location." + }, + "values": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "enum": [ + "NotSpecified", + "NotAvailableForRegion", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ReasonCode", + "modelAsString": true + }, + "description": "The reason for the restriction." + } + }, + "description": "The restriction because of which SKU cannot be used." + }, + "SkuListResult": { + "description": "List of skus with features", + "type": "object", + "properties": { + "value": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceSku" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Workspace Skus. Call ListNext() with this URI to fetch the next page of Workspace Skus" + } + } + }, + "Sku": { + "description": "Sku of the resource", + "type": "object", + "properties": { + "name": { + "description": "Name of the sku", + "type": "string" + }, + "tier": { + "description": "Tier of the sku like Basic or Enterprise", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "SharedPrivateLinkResource": { + "properties": { + "name": { + "description": "Unique name of the private link.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperty", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + } + }, + "SharedPrivateLinkResourceProperty": { + "properties": { + "privateLinkResourceId": { + "description": "The resource id that private link links to.", + "type": "string" + }, + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "requestMessage": { + "description": "Request message.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + } + }, + "description": "Properties of a shared private link resource." + }, + "EncryptionProperty": { + "properties": { + "status": { + "description": "Indicates whether or not the encryption is enabled for the workspace.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Customer Key vault properties." + } + }, + "required": [ + "status", + "keyVaultProperties" + ], + "type": "object" + }, + "KeyVaultProperties": { + "properties": { + "keyVaultArmId": { + "description": "The ArmId of the keyVault where the customer owned encryption key is present.", + "type": "string" + }, + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "identityClientId": { + "description": "For future use - The client id of the identity which will be used to access key vault.", + "type": "string" + } + }, + "required": [ + "keyIdentifier", + "keyVaultArmId" + ], + "type": "object" + }, + "LinkedWorkspace": { + "description": "Linked workspace.", + "type": "object", + "x-ms-azure-resource": true, + "properties": { + "id": { + "type": "string", + "description": "ResourceId of the link of the linked workspace.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Friendly name of the linked workspace.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Resource type of linked workspace.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/LinkedWorkspaceProps" + } + } + }, + "LinkedWorkspaceDto": { + "type": "object", + "description": "object used for creating linked workspace.", + "properties": { + "name": { + "description": "Friendly name of the linked workspace", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/LinkedWorkspaceProps" + } + } + }, + "LinkedWorkspaceProps": { + "type": "object", + "description": "LinkedWorkspace specific properties.", + "properties": { + "linkedWorkspaceResourceId": { + "description": "ResourceId of the link target of the linked workspace.", + "type": "string" + }, + "userAssignedIdentityResourceId": { + "description": "ResourceId of the user assigned identity for the linked workspace.", + "type": "string" + } + } + }, + "ServiceResource": { + "type": "object", + "description": "Machine Learning service object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object", + "properties": { + "properties": { + "description": "Service properties", + "$ref": "#/definitions/ServiceResponseBase" + } + } + } + ] + }, + "ServiceResponseBase": { + "description": "The base service response. The correct inherited response based on computeType will be returned (ex. ACIServiceResponse)", + "required": [ + "computeType" + ], + "type": "object", + "properties": { + "description": { + "description": "The service description.", + "type": "string" + }, + "kvTags": { + "description": "The service tag dictionary. Tags are mutable.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "The service property dictionary. Properties are immutable.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "state": { + "description": "The current state of the service.", + "enum": [ + "Transitioning", + "Healthy", + "Unhealthy", + "Failed", + "Unschedulable" + ], + "type": "string", + "example": "Healthy", + "x-ms-enum": { + "name": "WebServiceState", + "modelAsString": true + }, + "readOnly": true + }, + "error": { + "description": "The error details.", + "allOf": [ + { + "$ref": "#/definitions/ErrorResponse" + } + ], + "readOnly": true + }, + "computeType": { + "description": "The compute environment type for the service.", + "enum": [ + "ACI", + "AKS" + ], + "type": "string", + "example": "AKS", + "x-ms-enum": { + "name": "ComputeEnvironmentType", + "modelAsString": true + } + }, + "deploymentType": { + "description": "The deployment type for the service.", + "enum": [ + "GRPCRealtimeEndpoint", + "HttpRealtimeEndpoint", + "Batch" + ], + "type": "string", + "example": "HttpRealtimeEndpoint", + "x-ms-enum": { + "name": "DeploymentType", + "modelAsString": true + } + } + }, + "discriminator": "computeType" + }, + "PaginatedServiceList": { + "type": "object", + "description": "Paginated list of Machine Learning service objects wrapped in ARM resource envelope.", + "properties": { + "value": { + "readOnly": true, + "type": "array", + "description": "An array of Machine Learning compute objects wrapped in ARM resource envelope.", + "items": { + "$ref": "#/definitions/ServiceResource" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "ACIServiceResponse": { + "description": "The response for an ACI service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceResponseBase" + }, + { + "type": "object", + "properties": { + "containerResourceRequirements": { + "description": "The container resource requirements.", + "$ref": "#/definitions/ContainerResourceRequirements" + }, + "scoringUri": { + "description": "The Uri for sending scoring requests.", + "type": "string", + "readOnly": true + }, + "location": { + "description": "The name of the Azure location/region.", + "type": "string" + }, + "authEnabled": { + "description": "Whether or not authentication is enabled on the service.", + "type": "boolean" + }, + "sslEnabled": { + "description": "Whether or not SSL is enabled.", + "type": "boolean" + }, + "appInsightsEnabled": { + "description": "Whether or not Application Insights is enabled.", + "type": "boolean" + }, + "dataCollection": { + "description": "Details of the data collection options specified.", + "allOf": [ + { + "$ref": "#/definitions/ModelDataCollection" + } + ] + }, + "sslCertificate": { + "description": "The public SSL certificate in PEM format to use if SSL is enabled.", + "type": "string" + }, + "sslKey": { + "description": "The public SSL key in PEM format for the certificate.", + "type": "string" + }, + "cname": { + "description": "The CName for the service.", + "type": "string" + }, + "publicIp": { + "description": "The public IP address for the service.", + "type": "string" + }, + "publicFqdn": { + "description": "The public Fqdn for the service.", + "type": "string" + }, + "swaggerUri": { + "description": "The Uri for sending swagger requests.", + "type": "string", + "readOnly": true + }, + "modelConfigMap": { + "description": "Details on the models and configurations.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true + }, + "models": { + "description": "The list of models.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "environmentImageRequest": { + "description": "The Environment, models and assets used for inferencing.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentImageResponse" + } + ] + }, + "vnetConfiguration": { + "description": "The virtual network configuration.", + "allOf": [ + { + "$ref": "#/definitions/VnetConfiguration" + } + ] + }, + "encryptionProperties": { + "description": "The encryption properties.", + "allOf": [ + { + "$ref": "#/definitions/EncryptionProperties" + } + ] + } + } + } + ], + "x-ms-discriminator-value": "ACI" + }, + "ContainerResourceRequirements": { + "description": "The resource requirements for the container (cpu and memory).", + "type": "object", + "properties": { + "cpu": { + "format": "double", + "description": "The number of CPU cores on the container.", + "type": "number", + "example": 4 + }, + "memoryInGB": { + "format": "double", + "description": "The amount of memory on the container in GB.", + "type": "number", + "example": 64 + }, + "gpu": { + "format": "int32", + "description": "The number of GPU cores in the container.", + "type": "integer" + }, + "fpga": { + "format": "int32", + "description": "The number of FPGA PCIE devices exposed to the container. Must be multiple of 2.", + "type": "integer" + } + } + }, + "ModelDataCollection": { + "description": "The Model data collection properties.", + "type": "object", + "properties": { + "eventHubEnabled": { + "description": "Option for enabling/disabling Event Hub.", + "type": "boolean" + }, + "storageEnabled": { + "description": "Option for enabling/disabling storage.", + "type": "boolean" + } + } + }, + "VnetConfiguration": { + "type": "object", + "properties": { + "vnetName": { + "description": "The name of the virtual network.", + "type": "string" + }, + "subnetName": { + "description": "The name of the virtual network subnet.", + "type": "string" + } + } + }, + "EncryptionProperties": { + "type": "object", + "properties": { + "vaultBaseUrl": { + "description": "vault base Url", + "type": "string" + }, + "keyName": { + "description": "Encryption Key name", + "type": "string" + }, + "keyVersion": { + "description": "Encryption Key Version", + "type": "string" + } + }, + "required": [ + "vaultBaseUrl", + "keyName", + "keyVersion" + ] + }, + "Model": { + "description": "An Azure Machine Learning Model.", + "required": [ + "mimeType", + "name", + "url" + ], + "type": "object", + "properties": { + "id": { + "description": "The Model Id.", + "type": "string", + "example": "sklearn_mnist:1" + }, + "name": { + "description": "The Model name.", + "type": "string", + "example": "sklearn_mnist" + }, + "framework": { + "description": "The Model framework.", + "type": "string" + }, + "frameworkVersion": { + "description": "The Model framework version.", + "type": "string" + }, + "version": { + "format": "int64", + "description": "The Model version assigned by Model Management Service.", + "type": "integer", + "example": 1 + }, + "datasets": { + "description": "The list of datasets associated with the model.", + "type": "array", + "items": { + "$ref": "#/definitions/DatasetReference" + } + }, + "url": { + "description": "The URL of the Model. Usually a SAS URL.", + "type": "string" + }, + "mimeType": { + "description": "The MIME type of Model content. For more details about MIME type, please open https://www.iana.org/assignments/media-types/media-types.xhtml", + "type": "string" + }, + "description": { + "description": "The Model description text.", + "type": "string", + "example": "A mnist model, first version." + }, + "createdTime": { + "format": "date-time", + "description": "The Model creation time (UTC).", + "type": "string" + }, + "modifiedTime": { + "format": "date-time", + "description": "The Model last modified time (UTC).", + "type": "string" + }, + "unpack": { + "description": "Indicates whether we need to unpack the Model during docker Image creation.", + "type": "boolean" + }, + "parentModelId": { + "description": "The Parent Model Id.", + "type": "string", + "example": "sklearn_mnist_root:1" + }, + "runId": { + "description": "The RunId that created this model.", + "type": "string" + }, + "experimentName": { + "description": "The name of the experiment where this model was created.", + "type": "string" + }, + "kvTags": { + "description": "The Model tag dictionary. Items are mutable.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "The Model property dictionary. Properties are immutable.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "derivedModelIds": { + "description": "Models derived from this model", + "type": "array", + "items": { + "type": "string" + } + }, + "sampleInputData": { + "description": "Sample Input Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId}", + "type": "string" + }, + "sampleOutputData": { + "description": "Sample Output Data for the Model. A reference to a dataset in the workspace in the format aml://dataset/{datasetId}", + "type": "string" + }, + "resourceRequirements": { + "description": "Resource requirements for the model", + "$ref": "#/definitions/ContainerResourceRequirements" + } + } + }, + "EnvironmentImageRequest": { + "description": "Request to create a Docker image based on Environment.", + "type": "object", + "properties": { + "driverProgram": { + "description": "The name of the driver file.", + "type": "string" + }, + "assets": { + "description": "The list of assets.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageAsset" + } + }, + "modelIds": { + "description": "The list of model Ids.", + "type": "array", + "items": { + "type": "string" + } + }, + "models": { + "description": "The list of models.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "environment": { + "description": "The details of the AZURE ML environment.", + "allOf": [ + { + "$ref": "#/definitions/ModelEnvironmentDefinition" + } + ] + }, + "environmentReference": { + "description": "The unique identifying details of the AZURE ML environment.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentReference" + } + ] + } + } + }, + "EnvironmentImageResponse": { + "description": "Request to create a Docker image based on Environment.", + "type": "object", + "properties": { + "driverProgram": { + "description": "The name of the driver file.", + "type": "string" + }, + "assets": { + "description": "The list of assets.", + "type": "array", + "items": { + "$ref": "#/definitions/ImageAsset" + } + }, + "modelIds": { + "description": "The list of model Ids.", + "type": "array", + "items": { + "type": "string" + } + }, + "models": { + "description": "The list of models.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "environment": { + "description": "The details of the AZURE ML environment.", + "allOf": [ + { + "$ref": "#/definitions/ModelEnvironmentDefinitionResponse" + } + ] + }, + "environmentReference": { + "description": "The unique identifying details of the AZURE ML environment.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentReference" + } + ] + } + } + }, + "ImageAsset": { + "description": "An Image asset.", + "type": "object", + "properties": { + "id": { + "description": "The Asset Id.", + "type": "string" + }, + "mimeType": { + "description": "The mime type.", + "type": "string" + }, + "url": { + "description": "The Url of the Asset.", + "type": "string" + }, + "unpack": { + "description": "Whether the Asset is unpacked.", + "type": "boolean" + } + } + }, + "ModelEnvironmentDefinition": { + "type": "object", + "properties": { + "name": { + "description": "The name of the environment.", + "type": "string", + "example": "mydevenvironment" + }, + "version": { + "description": "The environment version.", + "type": "string", + "example": "1" + }, + "python": { + "description": "Settings for a Python environment.", + "allOf": [ + { + "$ref": "#/definitions/ModelPythonSection" + } + ] + }, + "environmentVariables": { + "description": "Definition of environment variables to be defined in the environment.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "docker": { + "description": "The definition of a Docker container.", + "allOf": [ + { + "$ref": "#/definitions/ModelDockerSection" + } + ] + }, + "spark": { + "description": "The configuration for a Spark environment.", + "allOf": [ + { + "$ref": "#/definitions/ModelSparkSection" + } + ] + }, + "r": { + "description": "Settings for a R environment.", + "allOf": [ + { + "$ref": "#/definitions/RSection" + } + ] + }, + "inferencingStackVersion": { + "description": "The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: \"latest\".", + "type": "string", + "example": "latest" + } + } + }, + "ModelEnvironmentDefinitionResponse": { + "type": "object", + "properties": { + "name": { + "description": "The name of the environment.", + "type": "string", + "example": "mydevenvironment" + }, + "version": { + "description": "The environment version.", + "type": "string", + "example": "1" + }, + "python": { + "description": "Settings for a Python environment.", + "allOf": [ + { + "$ref": "#/definitions/ModelPythonSection" + } + ] + }, + "environmentVariables": { + "description": "Definition of environment variables to be defined in the environment.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "docker": { + "description": "The definition of a Docker container.", + "allOf": [ + { + "$ref": "#/definitions/ModelDockerSectionResponse" + } + ] + }, + "spark": { + "description": "The configuration for a Spark environment.", + "allOf": [ + { + "$ref": "#/definitions/ModelSparkSection" + } + ] + }, + "r": { + "description": "Settings for a R environment.", + "allOf": [ + { + "$ref": "#/definitions/RSectionResponse" + } + ] + }, + "inferencingStackVersion": { + "description": "The inferencing stack version added to the image. To avoid adding an inferencing stack, do not set this value. Valid values: \"latest\".", + "type": "string", + "example": "latest" + } + } + }, + "EnvironmentReference": { + "type": "object", + "properties": { + "name": { + "description": "Name of the environment.", + "type": "string" + }, + "version": { + "description": "Version of the environment.", + "type": "string" + } + } + }, + "ModelPythonSection": { + "type": "object", + "properties": { + "interpreterPath": { + "description": "The python interpreter path to use if an environment build is not required. The path specified gets used to call the user script.", + "type": "string" + }, + "userManagedDependencies": { + "description": "True means that AzureML reuses an existing python environment; False means that AzureML will create a python environment based on the Conda dependencies specification.", + "type": "boolean" + }, + "condaDependencies": { + "description": "A JObject containing Conda dependencies.", + "type": "object" + }, + "baseCondaEnvironment": { + "type": "string" + } + } + }, + "ContainerRegistry": { + "type": "object", + "properties": { + "address": { + "type": "string" + }, + "username": { + "type": "string", + "x-ms-secret": true + }, + "password": { + "type": "string", + "x-ms-secret": true + } + } + }, + "ContainerRegistryResponse": { + "type": "object", + "properties": { + "address": { + "type": "string" + } + } + }, + "ModelDockerSection": { + "type": "object", + "properties": { + "baseImage": { + "description": "Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile.", + "type": "string", + "example": "ubuntu:latest" + }, + "baseDockerfile": { + "description": "Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage.", + "type": "string", + "example": "FROM ubuntu:latest\r\nRUN echo \"Hello world!\"" + }, + "baseImageRegistry": { + "description": "Image registry that contains the base image.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistry" + } + ] + } + } + }, + "ModelDockerSectionResponse": { + "type": "object", + "properties": { + "baseImage": { + "description": "Base image used for Docker-based runs. Mutually exclusive with BaseDockerfile.", + "type": "string", + "example": "ubuntu:latest" + }, + "baseDockerfile": { + "description": "Base Dockerfile used for Docker-based runs. Mutually exclusive with BaseImage.", + "type": "string", + "example": "FROM ubuntu:latest\r\nRUN echo \"Hello world!\"" + }, + "baseImageRegistry": { + "description": "Image registry that contains the base image.", + "allOf": [ + { + "$ref": "#/definitions/ContainerRegistryResponse" + } + ] + } + } + }, + "SparkMavenPackage": { + "type": "object", + "properties": { + "group": { + "type": "string" + }, + "artifact": { + "type": "string" + }, + "version": { + "type": "string" + } + } + }, + "ModelSparkSection": { + "type": "object", + "properties": { + "repositories": { + "description": "The list of spark repositories.", + "type": "array", + "items": { + "type": "string" + } + }, + "packages": { + "description": "The Spark packages to use.", + "type": "array", + "items": { + "$ref": "#/definitions/SparkMavenPackage" + } + }, + "precachePackages": { + "description": "Whether to precache the packages.", + "type": "boolean" + } + } + }, + "RCranPackage": { + "type": "object", + "properties": { + "name": { + "description": "The package name.", + "type": "string" + }, + "repository": { + "description": "The repository name.", + "type": "string" + } + } + }, + "RGitHubPackage": { + "type": "object", + "properties": { + "repository": { + "description": "Repository address in the format username/repo[/subdir][@ref|#pull].", + "type": "string" + }, + "authToken": { + "description": "Personal access token to install from a private repo", + "type": "string", + "x-ms-secret": true + } + } + }, + "RGitHubPackageResponse": { + "type": "object", + "properties": { + "repository": { + "description": "Repository address in the format username/repo[/subdir][@ref|#pull].", + "type": "string" + } + } + }, + "RSection": { + "type": "object", + "properties": { + "rVersion": { + "description": "The version of R to be installed", + "type": "string" + }, + "userManaged": { + "description": "Indicates whether the environment is managed by user or by AzureML.", + "type": "boolean" + }, + "rscriptPath": { + "description": "The Rscript path to use if an environment build is not required.\r\nThe path specified gets used to call the user script.", + "type": "string" + }, + "snapshotDate": { + "description": "Date of MRAN snapshot to use in YYYY-MM-DD format, e.g. \"2019-04-17\"", + "type": "string" + }, + "cranPackages": { + "description": "The CRAN packages to use.", + "type": "array", + "items": { + "$ref": "#/definitions/RCranPackage" + } + }, + "gitHubPackages": { + "description": "The packages directly from GitHub.", + "type": "array", + "items": { + "$ref": "#/definitions/RGitHubPackage" + } + }, + "customUrlPackages": { + "description": "The packages from custom urls.", + "type": "array", + "items": { + "type": "string" + } + }, + "bioConductorPackages": { + "description": "The packages from Bioconductor.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "RSectionResponse": { + "type": "object", + "properties": { + "rVersion": { + "description": "The version of R to be installed", + "type": "string" + }, + "userManaged": { + "description": "Indicates whether the environment is managed by user or by AzureML.", + "type": "boolean" + }, + "rscriptPath": { + "description": "The Rscript path to use if an environment build is not required.\r\nThe path specified gets used to call the user script.", + "type": "string" + }, + "snapshotDate": { + "description": "Date of MRAN snapshot to use in YYYY-MM-DD format, e.g. \"2019-04-17\"", + "type": "string" + }, + "cranPackages": { + "description": "The CRAN packages to use.", + "type": "array", + "items": { + "$ref": "#/definitions/RCranPackage" + } + }, + "gitHubPackages": { + "description": "The packages directly from GitHub.", + "type": "array", + "items": { + "$ref": "#/definitions/RGitHubPackageResponse" + } + }, + "customUrlPackages": { + "description": "The packages from custom urls.", + "type": "array", + "items": { + "type": "string" + } + }, + "bioConductorPackages": { + "description": "The packages from Bioconductor.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "DatasetReference": { + "description": "The dataset reference object.", + "type": "object", + "properties": { + "name": { + "description": "The name of the dataset reference.", + "type": "string" + }, + "id": { + "description": "The id of the dataset reference.", + "type": "string" + } + } + }, + "AKSVariantResponse": { + "description": "The response for an AKS variant.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ServiceResponseBase" + }, + { + "type": "object", + "properties": { + "isDefault": { + "description": "Is this the default variant.", + "type": "boolean" + }, + "trafficPercentile": { + "format": "float", + "description": "The amount of traffic variant receives.", + "type": "number", + "example": 100 + }, + "type": { + "description": "The type of the variant.", + "enum": [ + "Control", + "Treatment" + ], + "type": "string", + "example": "Control", + "x-ms-enum": { + "name": "VariantType", + "modelAsString": true + } + } + } + } + ], + "x-ms-discriminator-value": "Custom" + }, + "AutoScaler": { + "description": "The Auto Scaler properties.", + "type": "object", + "properties": { + "autoscaleEnabled": { + "description": "Option to enable/disable auto scaling.", + "type": "boolean" + }, + "minReplicas": { + "format": "int32", + "description": "The minimum number of replicas to scale down to.", + "type": "integer", + "example": 1 + }, + "maxReplicas": { + "format": "int32", + "description": "The maximum number of replicas in the cluster.", + "type": "integer", + "example": 3 + }, + "targetUtilization": { + "format": "int32", + "description": "The target utilization percentage to use for determining whether to scale the cluster.", + "type": "integer", + "example": 70 + }, + "refreshPeriodInSeconds": { + "format": "int32", + "description": "The amount of seconds to wait between auto scale updates.", + "type": "integer", + "example": 120 + } + } + }, + "AKSReplicaStatus": { + "type": "object", + "properties": { + "desiredReplicas": { + "format": "int32", + "description": "The desired number of replicas.", + "type": "integer", + "example": 2 + }, + "updatedReplicas": { + "format": "int32", + "description": "The number of updated replicas.", + "type": "integer", + "example": 1 + }, + "availableReplicas": { + "format": "int32", + "description": "The number of available replicas.", + "type": "integer", + "example": 1 + }, + "error": { + "description": "The error details.", + "allOf": [ + { + "$ref": "#/definitions/ErrorResponse" + } + ] + } + } + }, + "LivenessProbeRequirements": { + "description": "The liveness probe requirements.", + "type": "object", + "properties": { + "failureThreshold": { + "format": "int32", + "description": "The number of failures to allow before returning an unhealthy status.", + "type": "integer" + }, + "successThreshold": { + "format": "int32", + "description": "The number of successful probes before returning a healthy status.", + "type": "integer" + }, + "timeoutSeconds": { + "format": "int32", + "description": "The probe timeout in seconds.", + "type": "integer" + }, + "periodSeconds": { + "format": "int32", + "description": "The length of time between probes in seconds.", + "type": "integer" + }, + "initialDelaySeconds": { + "format": "int32", + "description": "The delay before the first probe in seconds.", + "type": "integer" + } + } + }, + "AKSServiceResponse": { + "description": "The response for an AKS service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/AKSVariantResponse" + }, + { + "type": "object", + "properties": { + "models": { + "description": "The list of models.", + "type": "array", + "items": { + "$ref": "#/definitions/Model" + } + }, + "containerResourceRequirements": { + "description": "The container resource requirements.", + "$ref": "#/definitions/ContainerResourceRequirements" + }, + "maxConcurrentRequestsPerContainer": { + "format": "int32", + "description": "The maximum number of concurrent requests per container.", + "type": "integer", + "example": 100 + }, + "maxQueueWaitMs": { + "format": "int32", + "description": "Maximum time a request will wait in the queue (in milliseconds). After this time, the service will return 503 (Service Unavailable)", + "type": "integer", + "example": 250 + }, + "computeName": { + "description": "The name of the compute resource.", + "type": "string" + }, + "namespace": { + "description": "The Kubernetes namespace of the deployment.", + "type": "string", + "example": "default" + }, + "numReplicas": { + "format": "int32", + "description": "The number of replicas on the cluster.", + "type": "integer", + "example": 1 + }, + "dataCollection": { + "description": "Details of the data collection options specified.", + "allOf": [ + { + "$ref": "#/definitions/ModelDataCollection" + } + ] + }, + "appInsightsEnabled": { + "description": "Whether or not Application Insights is enabled.", + "type": "boolean" + }, + "autoScaler": { + "description": "The auto scaler properties.", + "allOf": [ + { + "$ref": "#/definitions/AutoScaler" + } + ] + }, + "scoringUri": { + "description": "The Uri for sending scoring requests.", + "type": "string", + "readOnly": true + }, + "deploymentStatus": { + "description": "The deployment status.", + "readOnly": true, + "allOf": [ + { + "$ref": "#/definitions/AKSReplicaStatus" + } + ] + }, + "scoringTimeoutMs": { + "format": "int32", + "description": "The scoring timeout in milliseconds.", + "type": "integer", + "example": 100 + }, + "livenessProbeRequirements": { + "description": "The liveness probe requirements.", + "allOf": [ + { + "$ref": "#/definitions/LivenessProbeRequirements" + } + ] + }, + "authEnabled": { + "description": "Whether or not authentication is enabled.", + "type": "boolean" + }, + "aadAuthEnabled": { + "description": "Whether or not AAD authentication is enabled.", + "type": "boolean" + }, + "swaggerUri": { + "description": "The Uri for sending swagger requests.", + "type": "string", + "readOnly": true + }, + "modelConfigMap": { + "description": "Details on the models and configurations.", + "type": "object", + "additionalProperties": { + "type": "object" + }, + "readOnly": true + }, + "environmentImageRequest": { + "description": "The Environment, models and assets used for inferencing.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentImageResponse" + } + ] + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "AuthKeys": { + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary key.", + "type": "string" + } + } + }, + "CreateServiceRequest": { + "description": "The base class for creating a service.", + "required": [ + "computeType" + ], + "type": "object", + "properties": { + "description": { + "description": "The description of the service.", + "type": "string" + }, + "kvTags": { + "description": "The service tag dictionary. Tags are mutable.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "properties": { + "description": "The service properties dictionary. Properties are immutable.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "keys": { + "description": "The authentication keys.", + "allOf": [ + { + "$ref": "#/definitions/AuthKeys" + } + ] + }, + "computeType": { + "description": "The compute environment type for the service.", + "enum": [ + "ACI", + "AKS" + ], + "type": "string", + "example": "AKS", + "x-ms-enum": { + "name": "ComputeEnvironmentType", + "modelAsString": true + } + }, + "environmentImageRequest": { + "description": "The Environment, models and assets needed for inferencing.", + "allOf": [ + { + "$ref": "#/definitions/EnvironmentImageRequest" + } + ] + }, + "location": { + "description": "The name of the Azure location/region.", + "type": "string" + } + }, + "discriminator": "computeType" + }, + "ACIServiceCreateRequest": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CreateServiceRequest" + }, + { + "type": "object", + "properties": { + "containerResourceRequirements": { + "description": "The container resource requirements.", + "$ref": "#/definitions/ContainerResourceRequirements" + }, + "authEnabled": { + "description": "Whether or not authentication is enabled on the service.", + "default": false, + "type": "boolean" + }, + "sslEnabled": { + "description": "Whether or not SSL is enabled.", + "default": false, + "type": "boolean" + }, + "appInsightsEnabled": { + "description": "Whether or not Application Insights is enabled.", + "default": false, + "type": "boolean" + }, + "dataCollection": { + "description": "Details of the data collection options specified.", + "allOf": [ + { + "$ref": "#/definitions/ModelDataCollection" + } + ] + }, + "sslCertificate": { + "description": "The public SSL certificate in PEM format to use if SSL is enabled.", + "type": "string" + }, + "sslKey": { + "description": "The public SSL key in PEM format for the certificate.", + "type": "string" + }, + "cname": { + "description": "The CName for the service.", + "type": "string" + }, + "dnsNameLabel": { + "description": "The Dns label for the service.", + "type": "string" + }, + "vnetConfiguration": { + "description": "The virtual network configuration.", + "allOf": [ + { + "$ref": "#/definitions/VnetConfiguration" + } + ] + }, + "encryptionProperties": { + "description": "The encryption properties.", + "allOf": [ + { + "$ref": "#/definitions/EncryptionProperties" + } + ] + } + } + } + ], + "x-ms-discriminator-value": "ACI" + }, + "AKSServiceCreateRequest": { + "description": "The request to create an AKS service.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CreateEndpointVariantRequest" + }, + { + "type": "object", + "properties": { + "numReplicas": { + "format": "int32", + "description": "The number of replicas on the cluster.", + "type": "integer", + "example": 1 + }, + "dataCollection": { + "description": "Details of the data collection options specified.", + "allOf": [ + { + "$ref": "#/definitions/ModelDataCollection" + } + ] + }, + "computeName": { + "description": "The name of the compute resource.", + "type": "string" + }, + "appInsightsEnabled": { + "description": "Whether or not Application Insights is enabled.", + "type": "boolean" + }, + "autoScaler": { + "description": "The auto scaler properties.", + "allOf": [ + { + "$ref": "#/definitions/AutoScaler" + } + ] + }, + "containerResourceRequirements": { + "description": "The container resource requirements.", + "$ref": "#/definitions/ContainerResourceRequirements" + }, + "maxConcurrentRequestsPerContainer": { + "format": "int32", + "description": "The maximum number of concurrent requests per container.", + "type": "integer", + "example": 100 + }, + "maxQueueWaitMs": { + "format": "int32", + "description": "Maximum time a request will wait in the queue (in milliseconds). After this time, the service will return 503 (Service Unavailable)", + "type": "integer", + "example": 250 + }, + "namespace": { + "description": "Kubernetes namespace for the service.", + "type": "string", + "example": "default" + }, + "scoringTimeoutMs": { + "format": "int32", + "description": "The scoring timeout in milliseconds.", + "type": "integer", + "example": 100 + }, + "authEnabled": { + "description": "Whether or not authentication is enabled.", + "type": "boolean" + }, + "livenessProbeRequirements": { + "description": "The liveness probe requirements.", + "allOf": [ + { + "$ref": "#/definitions/LivenessProbeRequirements" + } + ] + }, + "aadAuthEnabled": { + "description": "Whether or not AAD authentication is enabled.", + "type": "boolean" + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "CreateEndpointVariantRequest": { + "description": "The Variant properties.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CreateServiceRequest" + }, + { + "type": "object", + "properties": { + "isDefault": { + "description": "Is this the default variant.", + "type": "boolean" + }, + "trafficPercentile": { + "format": "float", + "description": "The amount of traffic variant receives.", + "type": "number", + "example": 100 + }, + "type": { + "description": "The type of the variant.", + "enum": [ + "Control", + "Treatment" + ], + "type": "string", + "example": "Control", + "x-ms-enum": { + "name": "VariantType", + "modelAsString": true + } + } + } + } + ], + "x-ms-discriminator-value": "Custom" + } + } +} diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index 04e81a82b676..37fb205e426e 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -92,6 +92,15 @@ input-file: - Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json ``` +### Tag: package-2020-05-01-preview + +These settings apply only when `--tag=package-2020-05-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-05-01-preview' +input-file: +- Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json +``` + ### Tag: package-2020-04-01-preview These settings apply only when `--tag=package-2020-04-01-preview` is specified on the command line. @@ -181,6 +190,7 @@ batch: - tag: package-2019-06-01 - tag: package-2019-05-01 - tag: package-2018-11-19 + - tag: package-2020-05-01-preview - tag: package-2020-04-01-preview - tag: package-2020-02-18-preview - tag: package-2018-03-preview @@ -276,6 +286,19 @@ regenerate-manager: true generate-interface: true ``` +### Tag: package-2020-05-01-preview and java + +These settings apply only when `--tag=package-2020-05-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-05-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearningservices.v2020_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/machinelearningservices/mgmt-v2020_05_01_preview +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2020-04-01-preview and java These settings apply only when `--tag=package-2020-04-01-preview --java` is specified on the command line. @@ -321,6 +344,7 @@ input-file: - $(this-folder)/Microsoft.MachineLearningServices/stable/2019-06-01/machineLearningServices.json - $(this-folder)/Microsoft.MachineLearningServices/stable/2019-05-01/machineLearningServices.json - $(this-folder)/Microsoft.MachineLearningServices/stable/2018-11-19/machineLearningServices.json + - $(this-folder)/Microsoft.MachineLearningServices/preview/2020-05-01-preview/machineLearningServices.json - $(this-folder)/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json - $(this-folder)/Microsoft.MachineLearningServices/preview/2020-02-18-preview/machineLearningServices.json - $(this-folder)/Microsoft.MachineLearningServices/preview/2018-03-01-preview/machineLearningServices.json From 2d2f629e7fb35ffa339fc3c5cfb6a9e505c72500 Mon Sep 17 00:00:00 2001 From: Anirban Sarkar <33848291+asarkar84@users.noreply.github.com> Date: Tue, 30 Jun 2020 20:30:58 -0700 Subject: [PATCH 242/318] Fixed the bad output-folder (#9992) * Correcting the swagger to accept downloadToken similar to other download operations Correcting the swagger to accept downloadToken similar to other download operations * Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. * Removing reonly property to allow update operations Removing reonly property to allow update operations * Fixed the bad output-folder Fixed the bad output-folder Co-authored-by: Anirban Sarkar --- specification/billing/resource-manager/readme.go.md | 2 +- specification/billing/resource-manager/readme.ruby.md | 3 ++- 2 files changed, 3 insertions(+), 2 deletions(-) diff --git a/specification/billing/resource-manager/readme.go.md b/specification/billing/resource-manager/readme.go.md index f6bf507cb97e..0fcef38b70b7 100644 --- a/specification/billing/resource-manager/readme.go.md +++ b/specification/billing/resource-manager/readme.go.md @@ -26,7 +26,7 @@ These settings apply only when `--tag=package-2020-05 --go` is specified on the Please also specify `--go-sdk-folder=`. ``` yaml $(tag) == 'package-2020-05' && $(go) -output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-05-01-preview/$(namespace) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-05-01/$(namespace) ``` ### Tag: package-2018-11-preview and go diff --git a/specification/billing/resource-manager/readme.ruby.md b/specification/billing/resource-manager/readme.ruby.md index fcb9843607a5..b56bbe03fe6b 100644 --- a/specification/billing/resource-manager/readme.ruby.md +++ b/specification/billing/resource-manager/readme.ruby.md @@ -12,6 +12,7 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2020-05 - tag: package-2017-04-preview - tag: package-2017-02-preview ``` @@ -22,7 +23,7 @@ These settings apply only when `--tag=package-2020-05 --ruby` is specified on th Please also specify `--ruby-sdks-folder=`. ``` yaml $(tag) == 'package-2020-05' && $(ruby) -namespace: "Azure::Billing::Mgmt::V2020_05" +namespace: "Azure::Billing::Mgmt::V2020_05_01" output-folder: $(ruby-sdks-folder)/management/azure_mgmt_billing/lib ``` From c39163e64a4fc0415c67e488fe6683bd0c5038f7 Mon Sep 17 00:00:00 2001 From: supriyam-dev <65632263+supriyam-dev@users.noreply.github.com> Date: Tue, 30 Jun 2020 22:38:16 -0700 Subject: [PATCH 243/318] [Hub Generated] Review request for Microsoft.Billing to add version preview/2019-10-01-preview (#9815) * BillingRP- Adding the payment instrument disconnect eligibility check api * BillingRP- Adding the payment instrument disconnect eligibility check api * BillingRP- Adding the payment instrument disconnect eligibility check api * BillingRP- Adding the payment instrument disconnect eligibility check api * BillingRP- Adding the payment instrument disconnect eligibility check * BillingRP- Adding the payment instrument disconnect eligibility check --- .../preview/2019-10-01-preview/billing.json | 90 +++++++++++++++++++ ...DetachPaymentMethodEligibilityFailure.json | 36 ++++++++ ...DetachPaymentMethodEligibilitySuccess.json | 14 +++ 3 files changed, 140 insertions(+) create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/ValidateDetachPaymentMethodEligibilityFailure.json create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/ValidateDetachPaymentMethodEligibilitySuccess.json diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json index 0a905a542cea..72c25bf84870 100644 --- a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/billing.json @@ -503,6 +503,48 @@ } } }, + "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles/{billingProfileName}/validateDetachPaymentMethodEligibility": { + "get": { + "tags": [ + "BillingProfiles" + ], + "x-ms-examples": { + "ValidateDetachPaymentMethodEligibilitySuccess": { + "$ref": "./examples/ValidateDetachPaymentMethodEligibilitySuccess.json" + }, + "ValidateDetachPaymentMethodEligibilityFailure": { + "$ref": "./examples/ValidateDetachPaymentMethodEligibilityFailure.json" + } + }, + "operationId": "BillingProfiles_GetEligibilityToDetachPaymentMethod", + "description": "Validates if the default payment method can be detached from the billing profile. The operation is supported for billing accounts with agreement type Microsoft Customer Agreement.", + "parameters": [ + { + "$ref": "#/parameters/billingAccountNameParameter" + }, + { + "$ref": "#/parameters/billingProfileNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DetachPaymentMethodEligibilityResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, "/providers/Microsoft.Billing/billingAccounts/{billingAccountName}/billingProfiles": { "get": { "tags": [ @@ -5785,6 +5827,54 @@ } } }, + "DetachPaymentMethodEligibilityResult": { + "type": "object", + "description": "Result of the detach payment method eligibility validation.", + "properties": { + "isEligible": { + "description": "Specifies whether the payment method is eligible to be detached from the billing profile.", + "type": "boolean", + "readOnly": true + }, + "errorDetails": { + "description": "The list of detach payment method eligibility errors.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/DetachPaymentMethodErrorDetails" + } + } + } + }, + "DetachPaymentMethodErrorDetails": { + "type": "object", + "description": "Error details of the detach payment method eligibility validation.", + "properties": { + "code": { + "description": "Error code for the detach payment method eligibility validation.", + "$ref": "#/definitions/DetachPaymentMethodEligibilityErrorCode" + }, + "message": { + "description": "Error message for the detach payment method eligibility validation.", + "type": "string" + } + } + }, + "DetachPaymentMethodEligibilityErrorCode": { + "type": "string", + "description": "Error code of the detach payment method eligibility validation response.", + "enum": [ + "AzureSubscriptions", + "RecurringCharges", + "ReservedInstances", + "OutstandingCharges", + "PendingCharges" + ], + "x-ms-enum": { + "name": "detachPaymentMethodEligibilityErrorCode", + "modelAsString": true + } + }, "ValidateSubscriptionTransferEligibilityResult": { "type": "object", "description": "Result of the transfer eligibility validation.", diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/ValidateDetachPaymentMethodEligibilityFailure.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/ValidateDetachPaymentMethodEligibilityFailure.json new file mode 100644 index 000000000000..86939989e18c --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/ValidateDetachPaymentMethodEligibilityFailure.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "isEligible": false, + "errorDetails": [ + { + "code": "AzureSubscriptions", + "message": "Payment method cannot be detached as there are active or disabled azure subscriptions on this billing profile." + }, + { + "code": "RecurringCharges", + "message": "Payment method cannot be detached as there are recurring charges on this billing profile." + }, + { + "code": "ReservedInstances", + "message": "Payment method cannot be detached as there are reserved instances on this billing profile." + }, + { + "code": "OutstandingCharges", + "message": "Payment method cannot be detached as there are unpaid outstanding charges on this billing profile." + }, + { + "code": "PendingCharges", + "message": "Payment method cannot be detached as there are pending charges accumulating on this billing profile." + } + ] + } + } + } +} diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/ValidateDetachPaymentMethodEligibilitySuccess.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/ValidateDetachPaymentMethodEligibilitySuccess.json new file mode 100644 index 000000000000..f7a1716c1685 --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2019-10-01-preview/examples/ValidateDetachPaymentMethodEligibilitySuccess.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2019-10-01-preview", + "billingAccountName": "{billingAccountName}", + "billingProfileName": "{billingProfileName}" + }, + "responses": { + "200": { + "body": { + "isEligible": true + } + } + } +} From 61eb4461f61b03ffea7202f0d643e4268fcf6188 Mon Sep 17 00:00:00 2001 From: Feiyue Yu Date: Wed, 1 Jul 2020 13:49:55 +0800 Subject: [PATCH 244/318] Update compute readme.python.md (#9999) --- .../compute/resource-manager/readme.python.md | 30 +++++++++++++++++++ 1 file changed, 30 insertions(+) diff --git a/specification/compute/resource-manager/readme.python.md b/specification/compute/resource-manager/readme.python.md index 53decad609c1..5d0b014f83e8 100644 --- a/specification/compute/resource-manager/readme.python.md +++ b/specification/compute/resource-manager/readme.python.md @@ -44,6 +44,8 @@ Generate all API versions currently shipped for this package ```yaml $(multiapi) && !$(track2) batch: + - tag: package-2020-06-01-only + - tag: package-2020-05-01-only - tag: package-2019-12-01-only - tag: package-2019-11-01-only - tag: package-2019-07-01-only @@ -64,6 +66,8 @@ batch: ```yaml $(multiapi) && $(track2) clear-output-folder: true batch: + - tag: package-2020-06-01-only + - tag: package-2020-05-01-only - tag: package-2019-12-01-only - tag: package-2019-11-01-only - tag: package-2019-07-01-only @@ -88,6 +92,32 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2020-06-01-only and python + +These settings apply only when `--tag=package-2020-06-01-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-06-01-only' +namespace: azure.mgmt.compute.v2020_06_01 +output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compute/v2020_06_01 +python: + namespace: azure.mgmt.compute.v2020_06_01 + output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compute/v2020_06_01 +``` + +### Tag: package-2020-05-01-only and python + +These settings apply only when `--tag=package-2020-05-01-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-05-01-only' +namespace: azure.mgmt.compute.v2020_05_01 +output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compute/v2020_05_01 +python: + namespace: azure.mgmt.compute.v2020_05_01 + output-folder: $(python-sdks-folder)/compute/azure-mgmt-compute/azure/mgmt/compute/v2020_05_01 +``` + ### Tag: package-2019-12-01-only and python These settings apply only when `--tag=package-2019-12-01-only --python` is specified on the command line. From 553d68e20f09196c0b1d5d4d6e6bc7c3f7c745e1 Mon Sep 17 00:00:00 2001 From: Anand Kishore <60298805+ankisho@users.noreply.github.com> Date: Wed, 1 Jul 2020 13:49:19 +0530 Subject: [PATCH 245/318] updated confluent readme for input files & removed phone number property (#9835) * updated confluent readme for input files * Removed phone number validation * Removed phone number property * updated provision state * Removing preview version from Azure public repo --- .../preview/2020-03-01-preview/confluent.json | 697 ------------------ .../examples/OrganizationOperations_List.json | 41 -- .../examples/Organization_Create.json | 91 --- .../examples/Organization_Delete.json | 13 - .../examples/Organization_Get.json | 40 - .../Organization_ListByResourceGroup.json | 44 -- .../Organization_ListBySubscription.json | 43 -- .../examples/Organization_Update.json | 46 -- .../confluent/resource-manager/readme.md | 40 - 9 files changed, 1055 deletions(-) delete mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json delete mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json delete mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json delete mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json delete mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json delete mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json delete mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json delete mode 100644 specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json delete mode 100644 specification/confluent/resource-manager/readme.md diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json deleted file mode 100644 index 5265c290155d..000000000000 --- a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/confluent.json +++ /dev/null @@ -1,697 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "title": "Microsoft.Confluent", - "version": "2020-03-01-preview" - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/providers/Microsoft.Confluent/operations": { - "get": { - "tags": [ - "Organization" - ], - "summary": "List all operations provided by Microsoft.Confluent.", - "operationId": "OrganizationOperations_List", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OperationListResult" - } - }, - "default": { - "description": "Default error response.", - "schema": { - "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "OrganizationOperations_List": { - "$ref": "./examples/OrganizationOperations_List.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Confluent/organizations": { - "get": { - "tags": [ - "Organization" - ], - "summary": "List all organizations under the specified subscription.", - "operationId": "Organization_ListBySubscription", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OrganizationResourceListResult" - } - }, - "default": { - "description": "Default error response.", - "schema": { - "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Organization_ListBySubscription": { - "$ref": "./examples/Organization_ListBySubscription.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations": { - "get": { - "tags": [ - "Organization" - ], - "summary": "List all Organizations under the specified resource group.", - "operationId": "Organization_ListByResourceGroup", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OrganizationResourceListResult" - } - }, - "default": { - "description": "Default error response.", - "schema": { - "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Organization_ListByResourceGroup": { - "$ref": "./examples/Organization_ListByResourceGroup.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Confluent/organizations/{organizationName}": { - "get": { - "tags": [ - "Organization" - ], - "summary": "Get the properties of a specific Organization resource.", - "operationId": "Organization_Get", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/OrganizationResourceNameParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OrganizationResource" - } - }, - "default": { - "description": "Default error response.", - "schema": { - "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "Organization_Get": { - "$ref": "./examples/Organization_Get.json" - } - } - }, - "put": { - "tags": [ - "Organization" - ], - "summary": "Create Organization resource", - "operationId": "Organization_Create", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/OrganizationResourceNameParameter" - }, - { - "in": "body", - "name": "body", - "description": "Organization resource model", - "schema": { - "$ref": "#/definitions/OrganizationResource" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OrganizationResource" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/OrganizationResource" - } - }, - "default": { - "description": "Default error response.", - "schema": { - "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "azure-async-operation" - }, - "x-ms-examples": { - "Organization_Create": { - "$ref": "./examples/Organization_Create.json" - } - } - }, - "patch": { - "tags": [ - "Organization" - ], - "summary": "Update Organization resource", - "operationId": "Organization_Update", - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/OrganizationResourceNameParameter" - }, - { - "in": "body", - "name": "body", - "description": "Updated Organization resource", - "schema": { - "$ref": "#/definitions/OrganizationResourceUpdate" - } - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/OrganizationResource" - } - }, - "default": { - "description": "Default error response.", - "schema": { - "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" - } - } - }, - "x-ms-examples": { - "Confluent_Update": { - "$ref": "./examples/Organization_Update.json" - } - } - }, - "delete": { - "tags": [ - "Organization" - ], - "summary": "Delete Organization resource", - "operationId": "Organization_Delete", - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - }, - { - "$ref": "#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "#/parameters/ResourceGroupParameter" - }, - { - "$ref": "#/parameters/OrganizationResourceNameParameter" - } - ], - "responses": { - "200": { - "description": "Success" - }, - "202": { - "description": "Accepted" - }, - "204": { - "description": "The specified confluent resource does not exist in the subscription." - }, - "default": { - "description": "Default error response.", - "schema": { - "$ref": "#/definitions/ResourceProviderDefaultErrorResponse" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - }, - "x-ms-examples": { - "Confluent_Delete": { - "$ref": "./examples/Organization_Delete.json" - } - } - } - } - }, - "definitions": { - "OperationDisplay": { - "description": "The object that represents the operation.", - "type": "object", - "properties": { - "provider": { - "description": "Service provider: Microsoft.Confluent", - "type": "string" - }, - "resource": { - "description": "Type on which the operation is performed, e.g., 'clusters'.", - "type": "string" - }, - "operation": { - "description": "Operation type, e.g., read, write, delete, etc.", - "type": "string" - }, - "description": { - "description": "Description of the operation, e.g., 'Write confluent'.", - "type": "string" - } - } - }, - "OperationResult": { - "description": "An Confluent REST API operation.", - "type": "object", - "properties": { - "name": { - "description": "Operation name: {provider}/{resource}/{operation}", - "type": "string" - }, - "display": { - "description": "The object that represents the operation.", - "$ref": "#/definitions/OperationDisplay" - } - } - }, - "OperationListResult": { - "description": "Result of GET request to list Confluent operations.", - "type": "object", - "properties": { - "value": { - "description": "List of Confluent operations supported by the Microsoft.Confluent provider.", - "type": "array", - "items": { - "$ref": "#/definitions/OperationResult" - } - }, - "nextLink": { - "description": "URL to get the next set of operation list results if there are any.", - "type": "string" - } - } - }, - "ErrorResponseBody": { - "description": "Response body of Error", - "title": "ErrorResponseBody", - "type": "object", - "properties": { - "code": { - "description": "Error code", - "type": "string", - "readOnly": true - }, - "message": { - "description": "Error message", - "type": "string", - "readOnly": true - }, - "target": { - "description": "Error target", - "type": "string", - "readOnly": true - }, - "details": { - "description": "Error detail", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ErrorResponseBody" - } - } - } - }, - "ResourceProviderDefaultErrorResponse": { - "type": "object", - "description": "Default error response for resource provider", - "title": "ResourceProviderDefaultErrorResponse", - "properties": { - "error": { - "description": "Response body of Error", - "readOnly": true, - "$ref": "#/definitions/ErrorResponseBody" - } - } - }, - "ProvisioningState": { - "enum": [ - "Accepted", - "Creating", - "Updating", - "Deleting", - "Succeeded", - "Failed", - "Canceled" - ], - "type": "string", - "description": "Provision states for confluent RP", - "title": "ProvisioningState", - "x-ms-enum": { - "name": "ProvisionState", - "modelAsString": true - } - }, - "OfferDetail": { - "description": "Confluent Offer detail", - "type": "object", - "properties": { - "publisherId": { - "description": "Publisher Id", - "maxLength": 50, - "type": "string" - }, - "id": { - "description": "Offer Id", - "maxLength": 50, - "type": "string" - }, - "planId": { - "description": "Offer Plan Id", - "maxLength": 50, - "type": "string" - }, - "planName": { - "description": "Offer Plan Name", - "maxLength": 50, - "type": "string" - }, - "termUnit": { - "description": "Offer Plan Term unit", - "maxLength": 25, - "type": "string" - } - } - }, - "UserDetail": { - "description": "Subscriber detail", - "type": "object", - "properties": { - "firstName": { - "description": "First name", - "maxLength": 50, - "type": "string" - }, - "lastName": { - "description": "Last name", - "maxLength": 50, - "type": "string" - }, - "emailAddress": { - "description": "Email address. Validation Pattern: ^\\w+@[a-zA-Z_]+?\\.[a-zA-Z]{2,3}$", - "pattern": "^\\w+@[a-zA-Z_]+?\\.[a-zA-Z]{2,3}$", - "type": "string" - }, - "phoneNumber": { - "description": "Phone number. Validation Pattern: ^(\\+\\d{1,2}\\s)?\\(?\\d{3}\\)?[\\s.-]?\\d{3}[\\s.-]?\\d{4}$", - "pattern": "^(\\+\\d{1,2}\\s)?\\(?\\d{3}\\)?[\\s.-]?\\d{3}[\\s.-]?\\d{4}$", - "type": "string" - } - } - }, - "OrganizationResourceProperties": { - "description": "Organization resource property", - "type": "object", - "properties": { - "createdTime": { - "format": "date-time", - "description": "The creation time of the resource.", - "type": "string", - "readOnly": true - }, - "provisioningState": { - "description": "Provision states for confluent RP", - "$ref": "#/definitions/ProvisioningState" - }, - "organizationId": { - "description": "Id of the Confluent organization.", - "type": "string", - "readOnly": true - }, - "ssoUrl": { - "description": "SSO url for the Confluent organization.", - "type": "string", - "readOnly": true - }, - "offerDetail": { - "description": "Confluent offer detail", - "allOf": [ - { - "$ref": "#/definitions/OfferDetail" - } - ] - }, - "userDetail": { - "description": "Subscriber detail", - "allOf": [ - { - "$ref": "#/definitions/UserDetail" - } - ] - } - } - }, - "OrganizationResource": { - "description": "Organization resource.", - "type": "object", - "x-ms-azure-resource": true, - "properties": { - "id": { - "description": "The ARM id of the resource.", - "type": "string", - "readOnly": true - }, - "name": { - "description": "The name of the resource.", - "type": "string", - "readOnly": true - }, - "type": { - "description": "The type of the resource.", - "type": "string", - "readOnly": true - }, - "properties": { - "x-ms-client-flatten": true, - "description": "Organization resource properties", - "allOf": [ - { - "$ref": "#/definitions/OrganizationResourceProperties" - } - ] - }, - "tags": { - "type": "object", - "description": "Organization resource tags", - "additionalProperties": { - "type": "string" - } - }, - "location": { - "description": "Location of Organization resource", - "type": "string" - } - } - }, - "OrganizationResourceListResult": { - "description": "The response of a list operation.", - "type": "object", - "properties": { - "value": { - "description": "Result of a list operation.", - "type": "array", - "items": { - "$ref": "#/definitions/OrganizationResource" - } - }, - "nextLink": { - "description": "Link to the next set of results, if any.", - "type": "string" - } - } - }, - "OrganizationResourceUpdate": { - "description": "Organization Resource update", - "type": "object", - "properties": { - "tags": { - "description": "ARM resource tags", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - } - }, - "parameters": { - "ApiVersionParameter": { - "name": "api-version", - "in": "query", - "description": "Client Api Version.", - "required": true, - "type": "string", - "enum": [ - "2020-03-01-preview" - ] - }, - "SubscriptionIdParameter": { - "in": "path", - "name": "subscriptionId", - "description": "Microsoft Azure subscription id", - "required": true, - "type": "string" - }, - "ResourceGroupParameter": { - "in": "path", - "name": "resourceGroupName", - "description": "Resource group name", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - "OrganizationResourceNameParameter": { - "in": "path", - "name": "organizationName", - "description": "Organization resource name", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - } - } -} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json deleted file mode 100644 index cf08589e54db..000000000000 --- a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/OrganizationOperations_List.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "api-version": "2020-03-01-preview" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Microsoft.Confluent/organizations/Read", - "display": { - "provider": "Microsoft.Confluent", - "resource": "organizations", - "operation": "Get/List organization resources", - "description": "Read organization" - } - }, - { - "name": "Microsoft.Confluent/organizations/Write", - "display": { - "provider": "Microsoft.Confluent", - "resource": "organizations", - "operation": "Create/Update organization resources", - "description": "Write organization" - } - }, - { - "name": "Microsoft.Confluent/organizations/Delete", - "display": { - "provider": "Microsoft.Confluent", - "resource": "organizations", - "operation": "Delete organization resources", - "description": "Delete organization" - } - } - ], - "nextLink": null - } - } - } -} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json deleted file mode 100644 index 59c760932d81..000000000000 --- a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Create.json +++ /dev/null @@ -1,91 +0,0 @@ -{ - "parameters": { - "api-version": "2020-03-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup", - "organizationName": "myOrganization", - "body": { - "properties": { - "offerDetail": { - "publisherId": "string", - "id": "string", - "planId": "string", - "planName": "string", - "termUnit": "string" - }, - "userDetail": { - "firstName": "string", - "lastName": "string", - "emailAddress": "contoso@microsoft.com", - "phoneNumber": "+91 1111111111" - } - }, - "tags": { - "Environment": "Dev" - }, - "location": "West US" - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", - "name": "myOrganization", - "type": "Microsoft.Confluent/organizations", - "properties": { - "createdTime": "2020-05-09T14:28:47.284Z", - "provisioningState": "Succeeded", - "organizationId": "string", - "ssoUrl": "string", - "offerDetail": { - "publisherId": "string", - "id": "string", - "planId": "string", - "planName": "string", - "termUnit": "string" - }, - "userDetail": { - "firstName": "string", - "lastName": "string", - "emailAddress": "contoso@microsoft.com", - "phoneNumber": "+91 1111111111" - } - }, - "tags": { - "Environment": "Dev" - }, - "location": "West US" - } - }, - "201": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", - "name": "myOrganization", - "type": "Microsoft.Confluent/organizations", - "properties": { - "createdTime": "2020-05-09T14:28:47.284Z", - "provisioningState": "Accepted", - "organizationId": "string", - "ssoUrl": "string", - "offerDetail": { - "publisherId": "string", - "id": "string", - "planId": "string", - "planName": "string", - "termUnit": "string" - }, - "userDetail": { - "firstName": "string", - "lastName": "string", - "emailAddress": "contoso@microsoft.com", - "phoneNumber": "+91 1111111111" - } - }, - "tags": { - "Environment": "Dev" - }, - "location": "West US" - } - } - } -} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json deleted file mode 100644 index 9621d3e6929b..000000000000 --- a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Delete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "api-version": "2020-03-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup", - "organizationName": "myOrganization" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json deleted file mode 100644 index 5b1aab813d2e..000000000000 --- a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Get.json +++ /dev/null @@ -1,40 +0,0 @@ -{ - "parameters": { - "api-version": "2020-03-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup", - "organizationName": "myOrganization" - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", - "name": "myOrganization", - "type": "Microsoft.Confluent/organizations", - "properties": { - "createdTime": "2020-05-09T14:28:47.284Z", - "provisioningState": "Accepted", - "organizationId": "string", - "ssoUrl": "string", - "offerDetail": { - "publisherId": "string", - "id": "string", - "planId": "string", - "planName": "string", - "termUnit": "string" - }, - "userDetail": { - "firstName": "string", - "lastName": "string", - "emailAddress": "contoso@microsoft.com", - "phoneNumber": "+91 1111111111" - } - }, - "tags": { - "Environment": "Dev" - }, - "location": "West US" - } - } - } -} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json deleted file mode 100644 index 6d80f1581538..000000000000 --- a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListByResourceGroup.json +++ /dev/null @@ -1,44 +0,0 @@ -{ - "parameters": { - "api-version": "2020-03-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganizations", - "name": "myOrganizations", - "type": "Microsoft.Confluent/organizations", - "properties": { - "createdTime": "2020-05-09T14:28:47.284Z", - "provisioningState": "Accepted", - "organizationId": "string", - "ssoUrl": "string", - "offerDetail": { - "publisherId": "string", - "id": "string", - "planId": "string", - "planName": "string", - "termUnit": "string" - }, - "userDetail": { - "firstName": "string", - "lastName": "string", - "emailAddress": "contoso@microsoft.com", - "phoneNumber": "+91 1111111111" - } - }, - "tags": { - "Environment": "Dev" - }, - "location": "West US" - } - ], - "nextLink": "string" - } - } - } -} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json deleted file mode 100644 index f605aee4a999..000000000000 --- a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_ListBySubscription.json +++ /dev/null @@ -1,43 +0,0 @@ -{ - "parameters": { - "api-version": "2020-03-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganizations", - "name": "myOrganizations", - "type": "Microsoft.Confluent/organizations", - "properties": { - "createdTime": "2020-05-09T14:28:47.284Z", - "provisioningState": "Accepted", - "organizationId": "string", - "ssoUrl": "string", - "offerDetail": { - "publisherId": "string", - "id": "string", - "planId": "string", - "planName": "string", - "termUnit": "string" - }, - "userDetail": { - "firstName": "string", - "lastName": "string", - "emailAddress": "contoso@microsoft.com", - "phoneNumber": "+91 1111111111" - } - }, - "tags": { - "Environment": "Dev" - }, - "location": "West US" - } - ], - "nextLink": "string" - } - } - } -} diff --git a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json b/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json deleted file mode 100644 index dce805cf8eac..000000000000 --- a/specification/confluent/resource-manager/Microsoft.Confluent/preview/2020-03-01-preview/examples/Organization_Update.json +++ /dev/null @@ -1,46 +0,0 @@ -{ - "parameters": { - "api-version": "2020-03-01-preview", - "subscriptionId": "00000000-0000-0000-0000-000000000000", - "resourceGroupName": "myResourceGroup", - "organizationName": "myOrganization", - "body": { - "tags": { - "env": "dev", - "client": "dev-client" - } - } - }, - "responses": { - "200": { - "body": { - "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.Confluent/organizations/myOrganization", - "name": "myOrganization", - "type": "Microsoft.Confluent/organizations", - "properties": { - "createdTime": "2020-05-09T14:28:47.284Z", - "provisioningState": "Succeeded", - "organizationId": "string", - "ssoUrl": "string", - "offerDetail": { - "publisherId": "string", - "id": "string", - "planId": "string", - "planName": "string", - "termUnit": "string" - }, - "userDetail": { - "firstName": "string", - "lastName": "string", - "emailAddress": "contoso@microsoft.com", - "phoneNumber": "+91 1111111111" - } - }, - "tags": { - "Environment": "Dev" - }, - "location": "West US" - } - } - } -} diff --git a/specification/confluent/resource-manager/readme.md b/specification/confluent/resource-manager/readme.md deleted file mode 100644 index 687ff7737205..000000000000 --- a/specification/confluent/resource-manager/readme.md +++ /dev/null @@ -1,40 +0,0 @@ -# Confluent - -> see https://aka.ms/autorest - -This is the AutoRest configuration file for ContainerInstance. - - - ---- -## Getting Started -To build the SDK for ContainerInstance, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: - -> `autorest` - -To see additional help and options, run: - -> `autorest --help` ---- - -## Configuration - - - -### Basic Information -These are the global settings for the Confluent API. - -``` yaml -title: Microsoft Confluent Client -openapi-type: arm -tag: package-2020-03-preview -``` - -### Tag: package-2020-03-preview - -These settings apply only when `--tag=package-2020-03-preview` is specified on the command line. - -``` yaml $(tag) == 'package-2020-03-preview' -input-file: -- Microsoft.Confluent/preview/2020-03-01-preview/confluent.json -``` From fb0345c4095c815dc303d9af3dc5b98b141c72c7 Mon Sep 17 00:00:00 2001 From: aim-for-better Date: Wed, 1 Jul 2020 16:45:52 +0800 Subject: [PATCH 246/318] Support encryption in transit feature: Add a property when creating a cluster (#9894) Co-authored-by: Zhenyu Zhou --- .../preview/2015-03-01-preview/cluster.json | 26 +++ ...InsightClusterWithEncryptionInTransit.json | 171 ++++++++++++++++++ .../stable/2018-06-01-preview/cluster.json | 26 +++ ...InsightClusterWithEncryptionInTransit.json | 171 ++++++++++++++++++ 4 files changed, 394 insertions(+) create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json create mode 100644 specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json index a67e4f60e3d8..7d865e5b76f7 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/cluster.json @@ -68,6 +68,9 @@ }, "Create cluster with custom network settings": { "$ref": "./examples/CreateHDInsightClusterWithCustomNetworkSettings.json" + }, + "Create cluster with encryption in transit": { + "$ref": "./examples/CreateHDInsightClusterWithEncryptionInTransit.json" } }, "parameters": [ @@ -1011,6 +1014,10 @@ "$ref": "#/definitions/DiskEncryptionProperties", "description": "The disk encryption properties." }, + "encryptionInTransitProperties": { + "$ref": "#/definitions/EncryptionInTransitProperties", + "description": "The encryption-in-transit properties." + }, "minSupportedTlsVersion": { "type": "string", "description": "The minimal supported tls version." @@ -1195,6 +1202,10 @@ "$ref": "#/definitions/DiskEncryptionProperties", "description": "The disk encryption properties." }, + "encryptionInTransitProperties": { + "$ref": "#/definitions/EncryptionInTransitProperties", + "description": "The encryption-in-transit properties." + }, "minSupportedTlsVersion": { "type": "string", "description": "The minimal supported tls version." @@ -1507,6 +1518,21 @@ "msiResourceId": { "type": "string", "description": "Resource ID of Managed Identity that is used to access the key vault." + }, + "encryptionAtHost": { + "type": "boolean", + "default": false, + "description": "Indicates whether or not resource disk encryption is enabled." + } + } + }, + "EncryptionInTransitProperties": { + "description": "The encryption-in-transit properties.", + "properties": { + "isEncryptionInTransitEnabled": { + "type": "boolean", + "default": false, + "description": "Indicates whether or not inter cluster node communication is encrypted in transit." } } }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json new file mode 100644 index 000000000000..857e5c39f419 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/preview/2015-03-01-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2015-03-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Large" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Large" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "default8525", + "key": "storagekey" + } + ] + }, + "encryptionInTransitProperties": { + "isEncryptionInTransitEnabled": true + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "South Central US", + "etag": "3b76ce3d-892c-4036-9d8b-8ade18ba7a4b", + "tags": null, + "properties": { + "clusterVersion": "3.6.1000.67", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.6.1000.67.2001080246.json", + "kind": "Hadoop", + "componentVersion": { + "Hadoop": "2.7" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_a4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a2_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2020-01-10T08:36:39.153", + "quotaInfo": { + "coresUsed": 20 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard", + "encryptionInTransitProperties": { + "isEncryptionInTransitEnabled": true + } + } + } + } + } +} diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json index 09d5ab955690..f0ca0b010cf4 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json @@ -68,6 +68,9 @@ }, "Create cluster with custom network settings": { "$ref": "./examples/CreateHDInsightClusterWithCustomNetworkSettings.json" + }, + "Create cluster with encryption in transit": { + "$ref": "./examples/CreateHDInsightClusterWithEncryptionInTransit.json" } }, "parameters": [ @@ -1011,6 +1014,10 @@ "$ref": "#/definitions/DiskEncryptionProperties", "description": "The disk encryption properties." }, + "encryptionInTransitProperties": { + "$ref": "#/definitions/EncryptionInTransitProperties", + "description": "The encryption-in-transit properties." + }, "minSupportedTlsVersion": { "type": "string", "description": "The minimal supported tls version." @@ -1195,6 +1202,10 @@ "$ref": "#/definitions/DiskEncryptionProperties", "description": "The disk encryption properties." }, + "encryptionInTransitProperties": { + "$ref": "#/definitions/EncryptionInTransitProperties", + "description": "The encryption-in-transit properties." + }, "minSupportedTlsVersion": { "type": "string", "description": "The minimal supported tls version." @@ -1507,6 +1518,21 @@ "msiResourceId": { "type": "string", "description": "Resource ID of Managed Identity that is used to access the key vault." + }, + "encryptionAtHost": { + "type": "boolean", + "default": false, + "description": "Indicates whether or not resource disk encryption is enabled." + } + } + }, + "EncryptionInTransitProperties": { + "description": "The encryption-in-transit properties.", + "properties": { + "isEncryptionInTransitEnabled": { + "type": "boolean", + "default": false, + "description": "Indicates whether or not inter cluster node communication is encrypted in transit." } } }, diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json new file mode 100644 index 000000000000..e791e99a9a26 --- /dev/null +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/examples/CreateHDInsightClusterWithEncryptionInTransit.json @@ -0,0 +1,171 @@ +{ + "parameters": { + "clusterName": "cluster1", + "resourceGroupName": "rg1", + "api-version": "2018-06-01-preview", + "subscriptionId": "subid", + "parameters": { + "properties": { + "clusterVersion": "3.6", + "osType": "Linux", + "tier": "Standard", + "clusterDefinition": { + "kind": "Hadoop", + "configurations": { + "gateway": { + "restAuthCredential.isEnabled": true, + "restAuthCredential.username": "admin", + "restAuthCredential.password": "**********" + } + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "Large" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Large" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "Small" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser", + "password": "**********" + } + } + } + ] + }, + "storageProfile": { + "storageaccounts": [ + { + "name": "mystorage.blob.core.windows.net", + "isDefault": true, + "container": "default8525", + "key": "storagekey" + } + ] + }, + "encryptionInTransitProperties": { + "isEncryptionInTransitEnabled": true + } + } + } + }, + "responses": { + "200": { + "headers": { + "location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.HDInsight/pathToOperationResult" + }, + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg1/providers/Microsoft.HDInsight/clusters/cluster1", + "name": "cluster1", + "type": "Microsoft.HDInsight/clusters", + "location": "South Central US", + "etag": "3b76ce3d-892c-4036-9d8b-8ade18ba7a4b", + "tags": null, + "properties": { + "clusterVersion": "3.6.1000.67", + "osType": "Linux", + "clusterDefinition": { + "blueprint": "https://blueprints.azurehdinsight.net/hadoop-3.6.1000.67.2001080246.json", + "kind": "Hadoop", + "componentVersion": { + "Hadoop": "2.7" + } + }, + "computeProfile": { + "roles": [ + { + "name": "headnode", + "targetInstanceCount": 2, + "hardwareProfile": { + "vmSize": "standard_a4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "workernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a4_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + }, + { + "name": "zookeepernode", + "targetInstanceCount": 3, + "hardwareProfile": { + "vmSize": "standard_a2_v2" + }, + "osProfile": { + "linuxOperatingSystemProfile": { + "username": "sshuser" + } + } + } + ] + }, + "provisioningState": "Succeeded", + "clusterState": "Running", + "createdDate": "2020-01-10T08:36:39.153", + "quotaInfo": { + "coresUsed": 20 + }, + "connectivityEndpoints": [ + { + "name": "SSH", + "protocol": "TCP", + "location": "cluster1-ssh.azurehdinsight.net", + "port": 22 + }, + { + "name": "HTTPS", + "protocol": "TCP", + "location": "cluster1.azurehdinsight.net", + "port": 443 + } + ], + "tier": "Standard", + "encryptionInTransitProperties": { + "isEncryptionInTransitEnabled": true + } + } + } + } + } +} From be8342d0fd79456790a566014b3624f044178de7 Mon Sep 17 00:00:00 2001 From: Lei Ni <7233663+leni-msft@users.noreply.github.com> Date: Wed, 1 Jul 2020 17:40:07 +0800 Subject: [PATCH 247/318] Update pull_request_assignment.yml (#10005) --- .github/pull_request_assignment.yml | 1 + 1 file changed, 1 insertion(+) diff --git a/.github/pull_request_assignment.yml b/.github/pull_request_assignment.yml index e32d1ce22ba2..029a7d00120b 100644 --- a/.github/pull_request_assignment.yml +++ b/.github/pull_request_assignment.yml @@ -96,6 +96,7 @@ - rule: paths: - "specification/mixedreality/**" + - "specification/hdinsight/**" reviewers: - leni-msft From 2b51109fd0623fa3edb1514030df5e66a50d0f8a Mon Sep 17 00:00:00 2001 From: Donald Liu <32778916+PakDLiu@users.noreply.github.com> Date: Wed, 1 Jul 2020 02:43:18 -0700 Subject: [PATCH 248/318] Inherent Tracked Resource and Proxy Resource from common types (#9866) --- .../2020-02-07-preview/hanaonazure.json | 63 +------------------ 1 file changed, 2 insertions(+), 61 deletions(-) diff --git a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2020-02-07-preview/hanaonazure.json b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2020-02-07-preview/hanaonazure.json index a1567dab1709..d83d757ce054 100644 --- a/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2020-02-07-preview/hanaonazure.json +++ b/specification/hanaonazure/resource-manager/Microsoft.HanaOnAzure/preview/2020-02-07-preview/hanaonazure.json @@ -497,65 +497,6 @@ } }, "definitions": { - "Resource": { - "description": "The core properties of ARM resources", - "properties": { - "id": { - "readOnly": true, - "type": "string", - "description": "Fully qualified resource Id for the resource. Ex - /subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/trafficManagerProfiles/{resourceName}" - }, - "name": { - "readOnly": true, - "type": "string", - "description": "The name of the resource" - }, - "type": { - "readOnly": true, - "type": "string", - "description": "The type of the resource. Ex- Microsoft.Network/trafficManagerProfiles." - } - }, - "x-ms-azure-resource": true - }, - "TrackedResource": { - "description": "The resource model definition for a ARM tracked top level resource", - "properties": { - "tags": { - "type": "object", - "additionalProperties": { - "type": "string" - }, - "x-ms-mutability": [ - "read", - "create", - "update" - ], - "description": "Resource tags." - }, - "location": { - "type": "string", - "x-ms-mutability": [ - "read", - "create" - ], - "description": "The Azure Region where the resource lives" - } - }, - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, - "ProxyResource": { - "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", - "allOf": [ - { - "$ref": "#/definitions/Resource" - } - ] - }, "OperationList": { "type": "object", "properties": { @@ -668,7 +609,7 @@ }, "allOf": [ { - "$ref": "#/definitions/TrackedResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" } ], "description": "SAP monitor info on Azure (ARM properties and SAP monitor properties)" @@ -752,7 +693,7 @@ }, "allOf": [ { - "$ref": "#/definitions/ProxyResource" + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" } ], "description": "A provider instance associated with a SAP monitor." From 734319d8284f0bb20ba521808630be3e235ea344 Mon Sep 17 00:00:00 2001 From: Hyonho Lee Date: Wed, 1 Jul 2020 02:47:34 -0700 Subject: [PATCH 249/318] Update description for requireGuestProvisionSignal. (#9962) --- .../Microsoft.Compute/stable/2020-06-01/compute.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json index 2528535c2435..560d81fea158 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json @@ -8514,7 +8514,7 @@ }, "requireGuestProvisionSignal": { "type": "boolean", - "description": "Specifies whether the guest provision signal is required to infer provision success of the virtual machine." + "description": "Specifies whether the guest provision signal is required to infer provision success of the virtual machine. **Note: This property is for private testing only, and all customers must not set the property to false.**" } }, "description": "Specifies the operating system settings for the virtual machine. Some of the settings cannot be changed once VM is provisioned." From ab6b4d787190ceb777412ebf79bd57a8dccbec2c Mon Sep 17 00:00:00 2001 From: Zim Kalinowski Date: Wed, 1 Jul 2020 13:33:32 +0200 Subject: [PATCH 250/318] fixed track2 generation (#9848) From d2b168e8ac5965f5a29f20ea2baed94264c53e1a Mon Sep 17 00:00:00 2001 From: melmullen <50640763+melmullen@users.noreply.github.com> Date: Wed, 1 Jul 2020 18:48:36 -0700 Subject: [PATCH 251/318] [Hub Generated] Review request for Microsoft.CostManagement to add version stable/2020-06-01 (#9982) * Adds base for updating Microsoft.CostManagement from version stable/2019-11-01 to version 2020-06-01 * Updates readme * Updates API version in new specs and examples * Latest * Latest * Latest * Latest * Latest * Latest * Latest * Latest * Latest * Latest * Placed "code" and "message" inside an "error" object so it conforms to the standard error structure (line #3217) --- .../stable/2020-06-01/costmanagement.json | 3283 +++++++++++++++++ .../examples/BillingAccountAlerts.json | 98 + .../BillingAccountDimensionsList.json | 45 + ...lingAccountDimensionsListExpandAndTop.json | 59 + ...illingAccountDimensionsListWithFilter.json | 40 + .../examples/BillingAccountForecast.json | 117 + .../examples/BillingAccountQuery.json | 107 + .../examples/BillingAccountQueryGrouping.json | 69 + .../examples/BillingProfileAlerts.json | 99 + .../examples/BillingProfileForecast.json | 118 + .../2020-06-01/examples/DepartmentAlerts.json | 99 + .../examples/DepartmentDimensionsList.json | 46 + .../DepartmentDimensionsListExpandAndTop.json | 60 + .../DepartmentDimensionsListWithFilter.json | 41 + .../examples/DepartmentForecast.json | 118 + .../2020-06-01/examples/DepartmentQuery.json | 108 + .../examples/DepartmentQueryGrouping.json | 70 + .../examples/DismissResourceGroupAlerts.json | 59 + .../examples/DismissSubscriptionAlerts.json | 58 + .../examples/EnrollmentAccountAlerts.json | 99 + .../EnrollmentAccountDimensionsList.json | 46 + ...mentAccountDimensionsListExpandAndTop.json | 60 + ...llmentAccountDimensionsListWithFilter.json | 41 + .../examples/EnrollmentAccountForecast.json | 118 + .../examples/EnrollmentAccountQuery.json | 108 + .../EnrollmentAccountQueryGrouping.json | 77 + .../ExportCreateOrUpdateByBillingAccount.json | 128 + .../ExportCreateOrUpdateByDepartment.json | 129 + ...portCreateOrUpdateByEnrollmentAccount.json | 129 + ...ExportCreateOrUpdateByManagementGroup.json | 128 + .../ExportCreateOrUpdateByResourceGroup.json | 129 + .../ExportCreateOrUpdateBySubscription.json | 128 + .../ExportDeleteByBillingAccount.json | 11 + .../examples/ExportDeleteByDepartment.json | 12 + .../ExportDeleteByEnrollmentAccount.json | 12 + .../ExportDeleteByManagementGroup.json | 11 + .../examples/ExportDeleteByResourceGroup.json | 12 + .../examples/ExportDeleteBySubscription.json | 11 + .../examples/ExportGetByBillingAccount.json | 47 + .../examples/ExportGetByDepartment.json | 48 + .../ExportGetByEnrollmentAccount.json | 48 + .../examples/ExportGetByManagementGroup.json | 47 + .../examples/ExportGetByResourceGroup.json | 48 + .../examples/ExportGetBySubscription.json | 47 + .../examples/ExportRunByBillingAccount.json | 11 + .../examples/ExportRunByDepartment.json | 12 + .../ExportRunByEnrollmentAccount.json | 12 + .../examples/ExportRunByManagementGroup.json | 11 + .../examples/ExportRunByResourceGroup.json | 12 + .../examples/ExportRunBySubscription.json | 11 + .../ExportRunHistoryGetByBillingAccount.json | 100 + .../ExportRunHistoryGetByDepartment.json | 101 + ...xportRunHistoryGetByEnrollmentAccount.json | 101 + .../ExportRunHistoryGetByManagementGroup.json | 100 + .../ExportRunHistoryGetByResourceGroup.json | 101 + .../ExportRunHistoryGetBySubscription.json | 100 + .../examples/ExportsGetByBillingAccount.json | 89 + .../examples/ExportsGetByDepartment.json | 90 + .../ExportsGetByEnrollmentAccount.json | 90 + .../examples/ExportsGetByManagementGroup.json | 89 + .../examples/ExportsGetByResourceGroup.json | 90 + .../examples/ExportsGetBySubscription.json | 89 + .../ExternalBillingAccountAlerts.json | 98 + .../ExternalBillingAccountForecast.json | 99 + .../ExternalBillingAccountsDimensions.json | 45 + .../ExternalBillingAccountsQuery.json | 99 + .../examples/ExternalSubscriptionAlerts.json | 98 + .../ExternalSubscriptionForecast.json | 82 + .../ExternalSubscriptionsDimensions.json | 45 + .../examples/ExternalSubscriptionsQuery.json | 78 + .../examples/InvoiceSectionAlerts.json | 100 + .../examples/InvoiceSectionForecast.json | 119 + .../MCABillingAccountDimensionsList.json | 45 + ...lingAccountDimensionsListExpandAndTop.json | 59 + ...illingAccountDimensionsListWithFilter.json | 40 + .../examples/MCABillingAccountQuery.json | 107 + .../MCABillingAccountQueryGrouping.json | 69 + .../MCABillingProfileDimensionsList.json | 46 + ...lingProfileDimensionsListExpandAndTop.json | 60 + ...illingProfileDimensionsListWithFilter.json | 41 + .../examples/MCABillingProfileQuery.json | 108 + .../MCABillingProfileQueryGrouping.json | 70 + .../examples/MCACustomerDimensionsList.json | 46 + ...MCACustomerDimensionsListExpandAndTop.json | 60 + .../MCACustomerDimensionsListWithFilter.json | 41 + .../2020-06-01/examples/MCACustomerQuery.json | 108 + .../examples/MCACustomerQueryGrouping.json | 70 + .../MCAInvoiceSectionDimensionsList.json | 47 + ...oiceSectionDimensionsListExpandAndTop.json | 61 + ...nvoiceSectionDimensionsListWithFilter.json | 42 + .../examples/MCAInvoiceSectionQuery.json | 109 + .../MCAInvoiceSectionQueryGrouping.json | 71 + .../ManagementGroupDimensionsList.json | 45 + ...gementGroupDimensionsListExpandAndTop.json | 59 + ...nagementGroupDimensionsListWithFilter.json | 40 + .../examples/ManagementGroupQuery.json | 107 + .../ManagementGroupQueryGrouping.json | 76 + .../2020-06-01/examples/PrivateView.json | 69 + .../examples/PrivateViewCreateOrUpdate.json | 185 + .../examples/PrivateViewDelete.json | 10 + .../2020-06-01/examples/PrivateViewList.json | 131 + .../examples/ResourceGroupAlerts.json | 99 + .../examples/ResourceGroupDimensionsList.json | 56 + .../examples/ResourceGroupForecast.json | 97 + .../examples/ResourceGroupQuery.json | 96 + .../examples/ResourceGroupQueryGrouping.json | 71 + .../examples/SingleResourceGroupAlert.json | 54 + .../examples/SingleSubscriptionAlert.json | 53 + .../examples/SubscriptionAlerts.json | 98 + .../examples/SubscriptionDimensionsList.json | 58 + .../examples/SubscriptionForecast.json | 117 + .../examples/SubscriptionQuery.json | 107 + .../examples/SubscriptionQueryGrouping.json | 74 + .../examples/ViewByResourceGroup.json | 70 + .../ViewCreateOrUpdateByResourceGroup.json | 186 + .../examples/ViewDeleteByResourceGroup.json | 11 + .../examples/ViewListByResourceGroup.json | 132 + .../resource-manager/readme.go.md | 8 + .../resource-manager/readme.md | 21 +- 119 files changed, 11866 insertions(+), 4 deletions(-) create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingProfileAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingProfileForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DismissResourceGroupAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DismissSubscriptionAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByBillingAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByDepartment.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByEnrollmentAccount.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByManagementGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetBySubscription.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountsDimensions.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountsQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionsDimensions.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionsQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/InvoiceSectionAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/InvoiceSectionForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsListExpandAndTop.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsListWithFilter.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateView.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewCreateOrUpdate.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewDelete.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SingleResourceGroupAlert.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SingleSubscriptionAlert.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionAlerts.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionDimensionsList.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionForecast.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionQuery.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionQueryGrouping.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewCreateOrUpdateByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewDeleteByResourceGroup.json create mode 100644 specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewListByResourceGroup.json diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json new file mode 100644 index 000000000000..456686294225 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json @@ -0,0 +1,3283 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-06-01", + "title": "CostManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.CostManagement/views": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_List", + "description": "Lists all views by tenant and object.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "PrivateViewList": { + "$ref": "./examples/PrivateViewList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ViewListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/views": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_ListByScope", + "description": "Lists all views at the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupViewList": { + "$ref": "./examples/ViewListByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ViewListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.CostManagement/views/{viewName}": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_Get", + "description": "Gets the view by view name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "PrivateView": { + "$ref": "./examples/PrivateView.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Views" + ], + "operationId": "Views_CreateOrUpdate", + "description": "The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "CreateOrUpdatePrivateView": { + "$ref": "./examples/PrivateViewCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/View" + }, + "description": "Parameters supplied to the CreateOrUpdate View operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Views" + ], + "operationId": "Views_Delete", + "description": "The operation to delete a view.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "DeletePrivateView": { + "$ref": "./examples/PrivateViewDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/views/{viewName}": { + "get": { + "tags": [ + "Views" + ], + "operationId": "Views_GetByScope", + "description": "Gets the view for the defined scope by view name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupView": { + "$ref": "./examples/ViewByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Views" + ], + "operationId": "Views_CreateOrUpdateByScope", + "description": "The operation to create or update a view. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupCreateOrUpdateView": { + "$ref": "./examples/ViewCreateOrUpdateByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/View" + }, + "description": "Parameters supplied to the CreateOrUpdate View operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/View" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Views" + ], + "operationId": "Views_DeleteByScope", + "description": "The operation to delete a view.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ResourceGroupDeleteView": { + "$ref": "./examples/ViewDeleteByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeViewParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/viewNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "204": { + "description": "NoContent. Resource is not available." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_List", + "description": "Lists the alerts for scope defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "BillingAccountAlerts": { + "$ref": "./examples/BillingAccountAlerts.json" + }, + "BillingProfileAlerts": { + "$ref": "./examples/BillingProfileAlerts.json" + }, + "InvoiceSectionAlerts": { + "$ref": "./examples/InvoiceSectionAlerts.json" + }, + "EnrollmentAccountAlerts": { + "$ref": "./examples/EnrollmentAccountAlerts.json" + }, + "DepartmentAlerts": { + "$ref": "./examples/DepartmentAlerts.json" + }, + "SubscriptionAlerts": { + "$ref": "./examples/SubscriptionAlerts.json" + }, + "ResourceGroupAlerts": { + "$ref": "./examples/ResourceGroupAlerts.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/alerts/{alertId}": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_Get", + "description": "Gets the alert for the scope by alert ID.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionAlerts": { + "$ref": "./examples/SingleSubscriptionAlert.json" + }, + "ResourceGroupAlerts": { + "$ref": "./examples/SingleResourceGroupAlert.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "patch": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_Dismiss", + "description": "Dismisses the specified alert", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionAlerts": { + "$ref": "./examples/DismissSubscriptionAlerts.json" + }, + "ResourceGroupAlerts": { + "$ref": "./examples/DismissResourceGroupAlerts.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/scopeAlertParameter" + }, + { + "$ref": "#/parameters/alertIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DismissAlertPayload" + }, + "description": "Parameters supplied to the Dismiss Alert operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "operationId": "Alerts_ListExternal", + "description": "Lists the Alerts for external cloud provider type defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountAlerts": { + "$ref": "./examples/ExternalBillingAccountAlerts.json" + }, + "ExternalSubscriptionAlerts": { + "$ref": "./examples/ExternalSubscriptionAlerts.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/AlertsResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_Usage", + "description": "Lists the forecast charges for scope defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "BillingAccountForecast": { + "$ref": "./examples/BillingAccountForecast.json" + }, + "BillingProfileForecast": { + "$ref": "./examples/BillingProfileForecast.json" + }, + "InvoiceSectionForecast": { + "$ref": "./examples/InvoiceSectionForecast.json" + }, + "EnrollmentAccountForecast": { + "$ref": "./examples/EnrollmentAccountForecast.json" + }, + "DepartmentForecast": { + "$ref": "./examples/DepartmentForecast.json" + }, + "SubscriptionForecast": { + "$ref": "./examples/SubscriptionForecast.json" + }, + "ResourceGroupForecast": { + "$ref": "./examples/ResourceGroupForecast.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/scopeForecastParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForecastDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Forecast Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/forecast": { + "post": { + "tags": [ + "Forecast" + ], + "operationId": "Forecast_ExternalCloudProviderUsage", + "description": "Lists the forecast charges for external cloud provider type defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountForecast": { + "$ref": "./examples/ExternalBillingAccountForecast.json" + }, + "ExternalSubscriptionForecast": { + "$ref": "./examples/ExternalSubscriptionForecast.json" + } + }, + "parameters": [ + { + "name": "$filter", + "description": "May be used to filter forecasts by properties/usageDate (Utc time), properties/chargeType or properties/grain. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ForecastDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Forecast Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_List", + "description": "Lists the dimensions by the defined scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionDimensionsList-Legacy": { + "$ref": "./examples/SubscriptionDimensionsList.json" + }, + "ResourceGroupDimensionsList-Legacy": { + "$ref": "./examples/ResourceGroupDimensionsList.json" + }, + "ManagementGroupDimensionsList-Legacy": { + "$ref": "./examples/ManagementGroupDimensionsList.json" + }, + "ManagementGroupDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/ManagementGroupDimensionsListExpandAndTop.json" + }, + "ManagementGroupDimensionsListWithFilter-Legacy": { + "$ref": "./examples/ManagementGroupDimensionsListWithFilter.json" + }, + "DepartmentDimensionsList-Legacy": { + "$ref": "./examples/DepartmentDimensionsList.json" + }, + "DepartmentDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/DepartmentDimensionsListExpandAndTop.json" + }, + "DepartmentDimensionsListWithFilter-Legacy": { + "$ref": "./examples/DepartmentDimensionsListWithFilter.json" + }, + "EnrollmentAccountDimensionsList-Legacy": { + "$ref": "./examples/EnrollmentAccountDimensionsList.json" + }, + "EnrollmentAccountDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/EnrollmentAccountDimensionsListExpandAndTop.json" + }, + "EnrollmentAccountDimensionsListWithFilter-Legacy": { + "$ref": "./examples/EnrollmentAccountDimensionsListWithFilter.json" + }, + "BillingAccountDimensionsList-Legacy": { + "$ref": "./examples/BillingAccountDimensionsList.json" + }, + "BillingAccountDimensionsListExpandAndTop-Legacy": { + "$ref": "./examples/BillingAccountDimensionsListExpandAndTop.json" + }, + "BillingAccountDimensionsListWithFilter-Legacy": { + "$ref": "./examples/BillingAccountDimensionsListWithFilter.json" + }, + "BillingAccountDimensionsList-Modern": { + "$ref": "./examples/MCABillingAccountDimensionsList.json" + }, + "BillingAccountDimensionsListExpandAndTop-Modern": { + "$ref": "./examples/MCABillingAccountDimensionsListExpandAndTop.json" + }, + "BillingAccountDimensionsListWithFilter-Modern": { + "$ref": "./examples/MCABillingAccountDimensionsListWithFilter.json" + }, + "BillingProfileDimensionsList-Modern": { + "$ref": "./examples/MCABillingProfileDimensionsList.json" + }, + "BillingProfileDimensionsListExpandAndTop-Modern": { + "$ref": "./examples/MCABillingProfileDimensionsListExpandAndTop.json" + }, + "BillingProfileDimensionsListWithFilter-Modern": { + "$ref": "./examples/MCABillingProfileDimensionsListWithFilter.json" + }, + "InvoiceSectionDimensionsList-Modern": { + "$ref": "./examples/MCAInvoiceSectionDimensionsList.json" + }, + "InvoiceSectionDimensionsListExpandAndTop-Modern": { + "$ref": "./examples/MCAInvoiceSectionDimensionsListExpandAndTop.json" + }, + "InvoiceSectionDimensionsListWithFilter-Modern": { + "$ref": "./examples/MCAInvoiceSectionDimensionsListWithFilter.json" + }, + "CustomerDimensionsList-Modern": { + "$ref": "./examples/MCACustomerDimensionsList.json" + }, + "CustomerDimensionsListExpandAndTop-Modern": { + "$ref": "./examples/MCACustomerDimensionsListExpandAndTop.json" + }, + "CustomerDimensionsListWithFilter-Modern": { + "$ref": "./examples/MCACustomerDimensionsListWithFilter.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeDimensionParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/dimensions": { + "get": { + "tags": [ + "Dimensions" + ], + "x-ms-odata": "#/definitions/Dimension", + "operationId": "Dimensions_ByExternalCloudProviderType", + "description": "Lists the dimensions by the external cloud provider type.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountDimensionList": { + "$ref": "./examples/ExternalBillingAccountsDimensions.json" + }, + "ExternalSubscriptionDimensionList": { + "$ref": "./examples/ExternalSubscriptionsDimensions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter dimensions by properties/category, properties/usageStart, properties/usageEnd. Supported operators are 'eq','lt', 'gt', 'le', 'ge'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$expand", + "description": "May be used to expand the properties/data within a dimension category. By default, data is not included when listing dimensions.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N dimension data.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 1000 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/DimensionsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_Usage", + "description": "Query the usage data for scope defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "SubscriptionQuery-Legacy": { + "$ref": "./examples/SubscriptionQuery.json" + }, + "SubscriptionQueryGrouping-Legacy": { + "$ref": "./examples/SubscriptionQueryGrouping.json" + }, + "ResourceGroupQuery-Legacy": { + "$ref": "./examples/ResourceGroupQuery.json" + }, + "ResourceGroupQueryGrouping-Legacy": { + "$ref": "./examples/ResourceGroupQueryGrouping.json" + }, + "BillingAccountQuery-Legacy": { + "$ref": "./examples/BillingAccountQuery.json" + }, + "BillingAccountQueryGrouping-Legacy": { + "$ref": "./examples/BillingAccountQueryGrouping.json" + }, + "EnrollmentAccountQuery-Legacy": { + "$ref": "./examples/EnrollmentAccountQuery.json" + }, + "EnrollmentAccountQueryGrouping-Legacy": { + "$ref": "./examples/EnrollmentAccountQueryGrouping.json" + }, + "DepartmentQuery-Legacy": { + "$ref": "./examples/DepartmentQuery.json" + }, + "DepartmentQueryGrouping-Legacy": { + "$ref": "./examples/DepartmentQueryGrouping.json" + }, + "ManagementGroupQuery-Legacy": { + "$ref": "./examples/ManagementGroupQuery.json" + }, + "ManagementGroupQueryGrouping-Legacy": { + "$ref": "./examples/ManagementGroupQueryGrouping.json" + }, + "BillingAccountQuery-Modern": { + "$ref": "./examples/MCABillingAccountQuery.json" + }, + "BillingAccountQueryGrouping-Modern": { + "$ref": "./examples/MCABillingAccountQueryGrouping.json" + }, + "BillingProfileQuery-Modern": { + "$ref": "./examples/MCABillingProfileQuery.json" + }, + "BillingProfileQueryGrouping-Modern": { + "$ref": "./examples/MCABillingProfileQueryGrouping.json" + }, + "InvoiceSectionQuery-Modern": { + "$ref": "./examples/MCAInvoiceSectionQuery.json" + }, + "InvoiceSectionQueryGrouping-Modern": { + "$ref": "./examples/MCAInvoiceSectionQueryGrouping.json" + }, + "CustomerQuery-Modern": { + "$ref": "./examples/MCACustomerQuery.json" + }, + "CustomerQueryGrouping-Modern": { + "$ref": "./examples/MCACustomerQueryGrouping.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Query Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/{externalCloudProviderType}/{externalCloudProviderId}/query": { + "post": { + "tags": [ + "Query" + ], + "operationId": "Query_UsageByExternalCloudProviderType", + "description": "Query the usage data for external cloud provider type defined.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExternalBillingAccountQueryList": { + "$ref": "./examples/ExternalBillingAccountsQuery.json" + }, + "ExternalSubscriptionsQuery": { + "$ref": "./examples/ExternalSubscriptionsQuery.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/externalCloudProviderTypeParameter" + }, + { + "$ref": "#/parameters/externalCloudProviderIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QueryDefinition" + }, + "description": "Parameters supplied to the CreateOrUpdate Query Config operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/QueryResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_List", + "description": "The operation to list all exports at the given scope.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportsGetBySubscription": { + "$ref": "./examples/ExportsGetBySubscription.json" + }, + "ExportsGetByResourceGroup": { + "$ref": "./examples/ExportsGetByResourceGroup.json" + }, + "ExportsGetByBillingAccount": { + "$ref": "./examples/ExportsGetByBillingAccount.json" + }, + "ExportsGetByDepartment": { + "$ref": "./examples/ExportsGetByDepartment.json" + }, + "ExportsGetByEnrollmentAccount": { + "$ref": "./examples/ExportsGetByEnrollmentAccount.json" + }, + "ExportsGetByManagementGroup": { + "$ref": "./examples/ExportsGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last execution of each export.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Get", + "description": "The operation to get the export for the defined scope by export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportGetBySubscription": { + "$ref": "./examples/ExportGetBySubscription.json" + }, + "ExportGetByResourceGroup": { + "$ref": "./examples/ExportGetByResourceGroup.json" + }, + "ExportGetByBillingAccount": { + "$ref": "./examples/ExportGetByBillingAccount.json" + }, + "ExportGetByDepartment": { + "$ref": "./examples/ExportGetByDepartment.json" + }, + "ExportGetByEnrollmentAccount": { + "$ref": "./examples/ExportGetByEnrollmentAccount.json" + }, + "ExportGetByManagementGroup": { + "$ref": "./examples/ExportGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + }, + { + "name": "$expand", + "description": "May be used to expand the properties within an export. Currently only 'runHistory' is supported and will return information for the last 10 executions of the export.", + "in": "query", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "Exports" + ], + "operationId": "Exports_CreateOrUpdate", + "description": "The operation to create or update a export. Update operation requires latest eTag to be set in the request. You may obtain the latest eTag by performing a get operation. Create operation does not require eTag.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportCreateOrUpdateBySubscription": { + "$ref": "./examples/ExportCreateOrUpdateBySubscription.json" + }, + "ExportCreateOrUpdateByResourceGroup": { + "$ref": "./examples/ExportCreateOrUpdateByResourceGroup.json" + }, + "ExportCreateOrUpdateByBillingAccount": { + "$ref": "./examples/ExportCreateOrUpdateByBillingAccount.json" + }, + "ExportCreateOrUpdateByDepartment": { + "$ref": "./examples/ExportCreateOrUpdateByDepartment.json" + }, + "ExportCreateOrUpdateByEnrollmentAccount": { + "$ref": "./examples/ExportCreateOrUpdateByEnrollmentAccount.json" + }, + "ExportCreateOrUpdateByManagementGroup": { + "$ref": "./examples/ExportCreateOrUpdateByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Export" + }, + "description": "Parameters supplied to the CreateOrUpdate Export operation." + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "201": { + "description": "Created.", + "schema": { + "$ref": "#/definitions/Export" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Delete", + "description": "The operation to delete a export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportDeleteBySubscription": { + "$ref": "./examples/ExportDeleteBySubscription.json" + }, + "ExportDeleteByResourceGroup": { + "$ref": "./examples/ExportDeleteByResourceGroup.json" + }, + "ExportDeleteByBillingAccount": { + "$ref": "./examples/ExportDeleteByBillingAccount.json" + }, + "ExportDeleteByEnrollmentAccount": { + "$ref": "./examples/ExportDeleteByEnrollmentAccount.json" + }, + "ExportDeleteByDepartment": { + "$ref": "./examples/ExportDeleteByDepartment.json" + }, + "ExportDeleteByManagementGroup": { + "$ref": "./examples/ExportDeleteByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/run": { + "post": { + "tags": [ + "Exports" + ], + "operationId": "Exports_Execute", + "description": "The operation to execute an export.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportRunBySubscription": { + "$ref": "./examples/ExportRunBySubscription.json" + }, + "ExportRunByResourceGroup": { + "$ref": "./examples/ExportRunByResourceGroup.json" + }, + "ExportRunByBillingAccount": { + "$ref": "./examples/ExportRunByBillingAccount.json" + }, + "ExportRunByDepartment": { + "$ref": "./examples/ExportRunByDepartment.json" + }, + "ExportRunByEnrollmentAccount": { + "$ref": "./examples/ExportRunByEnrollmentAccount.json" + }, + "ExportRunByManagementGroup": { + "$ref": "./examples/ExportRunByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/{scope}/providers/Microsoft.CostManagement/exports/{exportName}/runHistory": { + "get": { + "tags": [ + "Exports" + ], + "operationId": "Exports_GetExecutionHistory", + "description": "The operation to get the execution history of an export for the defined scope and export name.", + "externalDocs": { + "url": "https://docs.microsoft.com/en-us/rest/api/costmanagement/" + }, + "x-ms-examples": { + "ExportRunHistoryGetBySubscription": { + "$ref": "./examples/ExportRunHistoryGetBySubscription.json" + }, + "ExportRunHistoryGetByResourceGroup": { + "$ref": "./examples/ExportRunHistoryGetByResourceGroup.json" + }, + "ExportRunHistoryGetByBillingAccount": { + "$ref": "./examples/ExportRunHistoryGetByBillingAccount.json" + }, + "ExportRunHistoryGetByDepartment": { + "$ref": "./examples/ExportRunHistoryGetByDepartment.json" + }, + "ExportRunHistoryGetByEnrollmentAccount": { + "$ref": "./examples/ExportRunHistoryGetByEnrollmentAccount.json" + }, + "ExportRunHistoryGetByManagementGroup": { + "$ref": "./examples/ExportRunHistoryGetByManagementGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/scopeQueryParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "$ref": "#/parameters/exportNameParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/ExportExecutionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/providers/Microsoft.CostManagement/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available cost management REST API operations.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + } + }, + "definitions": { + "ReportConfigDefinition": { + "description": "The definition of a report config.", + "properties": { + "type": { + "description": "The type of the report. Usage represents actual usage, forecast represents forecasted data and UsageAndForecast represents both usage and forecasted data. Actual usage and forecasted data can be differentiated based on dates.", + "type": "string", + "enum": [ + "Usage" + ], + "x-ms-enum": { + "name": "ReportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the report. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "WeekToDate", + "MonthToDate", + "YearToDate", + "Custom" + ], + "x-ms-enum": { + "name": "ReportTimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the report.", + "$ref": "#/definitions/ReportConfigTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this report config.", + "$ref": "#/definitions/ReportConfigDataset" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "ReportConfigTimePeriod": { + "description": "The start and end date for pulling data for the report.", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ReportConfigDataset": { + "description": "The definition of data present in the report.", + "properties": { + "granularity": { + "description": "The granularity of rows in the report.", + "type": "string", + "enum": [ + "Daily", + "Monthly" + ], + "x-ms-enum": { + "name": "ReportGranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "Has configuration information for the data in the report. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/ReportConfigDatasetConfiguration" + }, + "aggregation": { + "type": "object", + "description": "Dictionary of aggregation expression to use in the report. The key of each item in the dictionary is the alias for the aggregated column. Report can have up to 2 aggregation clauses.", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/ReportConfigAggregation" + }, + "maxItems": 2 + }, + "grouping": { + "description": "Array of group by expression to use in the report. Report can have up to 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigGrouping" + }, + "maxItems": 2 + }, + "sorting": { + "description": "Array of order by expression to use in the report.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigSorting" + } + }, + "filter": { + "type": "object", + "description": "Has filter expression to use in the report.", + "$ref": "#/definitions/ReportConfigFilter" + } + } + }, + "ReportConfigDatasetConfiguration": { + "description": "The configuration of dataset in the report.", + "properties": { + "columns": { + "description": "Array of column names to be included in the report. Any valid report column name is allowed. If not provided, then report includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ReportConfigAggregation": { + "description": "The aggregation expression to be used in the report.", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string" + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "ReportConfigSorting": { + "description": "The order by expression to be used in the report.", + "properties": { + "direction": { + "description": "Direction of sort.", + "type": "string", + "enum": [ + "Ascending", + "Descending" + ] + }, + "name": { + "description": "The name of the column to sort.", + "type": "string" + } + }, + "required": [ + "name" + ] + }, + "ReportConfigGrouping": { + "description": "The group by expression to be used in the report.", + "properties": { + "type": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/ReportConfigColumnType" + }, + "name": { + "description": "The name of the column to group. This version supports subscription lowest possible grain.", + "type": "string" + } + }, + "required": [ + "type", + "name" + ] + }, + "ReportConfigFilter": { + "description": "The filter expression to be used in the report.", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/ReportConfigFilter" + }, + "minItems": 2 + }, + "not": { + "description": "The logical \"NOT\" expression.", + "$ref": "#/definitions/ReportConfigFilter" + }, + "dimension": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/ReportConfigComparisonExpression" + }, + "tag": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/ReportConfigComparisonExpression" + } + } + }, + "ReportConfigColumnType": { + "description": "The type of the column in the report.", + "type": "string", + "enum": [ + "Tag", + "Dimension" + ], + "x-ms-enum": { + "name": "ReportConfigColumnType", + "modelAsString": true + } + }, + "ReportConfigComparisonExpression": { + "description": "The comparison expression to be used in the report.", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In", + "Contains" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "ViewListResult": { + "description": "Result of listing views. It contains a list of available views.", + "type": "object", + "properties": { + "value": { + "description": "The list of views.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/View" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "View": { + "description": "States and configurations of Cost Analysis.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ViewProperties", + "title": "View properties" + } + } + }, + "ViewProperties": { + "type": "object", + "description": "The properties of the view.", + "properties": { + "displayName": { + "description": "User input name of the view. Required.", + "type": "string" + }, + "scope": { + "description": "Cost Management scope to save the view on. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for ExternalBillingAccount scope, and '/providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for ExternalSubscription scope.", + "type": "string" + }, + "createdOn": { + "description": "Date the user created this view.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "description": "Date when the user last modified this view.", + "type": "string", + "format": "date-time", + "readOnly": true + }, + "query": { + "description": "Query body configuration. Required.", + "type": "object", + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReportConfigDefinition" + }, + "chart": { + "description": "Chart type of the main view in Cost Analysis. Required.", + "type": "string", + "enum": [ + "Area", + "Line", + "StackedColumn", + "GroupedColumn", + "Table" + ], + "x-ms-enum": { + "name": "ChartType", + "modelAsString": true + } + }, + "accumulated": { + "description": "Show costs accumulated over time.", + "type": "string", + "enum": [ + "true", + "false" + ], + "x-ms-enum": { + "name": "AccumulatedType", + "modelAsString": true + } + }, + "metric": { + "description": "Metric to use when displaying costs.", + "type": "string", + "enum": [ + "ActualCost", + "AmortizedCost", + "AHUB" + ], + "x-ms-enum": { + "name": "MetricType", + "modelAsString": true + } + }, + "kpis": { + "description": "List of KPIs to show in Cost Analysis UI.", + "type": "array", + "items": { + "$ref": "#/definitions/KpiProperties" + } + }, + "pivots": { + "description": "Configuration of 3 sub-views in the Cost Analysis UI.", + "type": "array", + "items": { + "$ref": "#/definitions/PivotProperties" + } + } + } + }, + "KpiProperties": { + "description": "Each KPI must contain a 'type' and 'enabled' key.", + "type": "object", + "properties": { + "type": { + "description": "KPI type (Forecast, Budget).", + "type": "string", + "enum": [ + "Forecast", + "Budget" + ], + "x-ms-enum": { + "name": "KpiTypeType", + "modelAsString": true + } + }, + "id": { + "description": "ID of resource related to metric (budget).", + "type": "string" + }, + "enabled": { + "description": "show the KPI in the UI?", + "type": "boolean" + } + } + }, + "PivotProperties": { + "description": "Each pivot must contain a 'type' and 'name'.", + "type": "object", + "properties": { + "type": { + "description": "Data type to show in view.", + "type": "string", + "enum": [ + "Dimension", + "TagKey" + ], + "x-ms-enum": { + "name": "PivotTypeType", + "modelAsString": true + } + }, + "name": { + "description": "Data field to show in view.", + "type": "string" + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message. \n\nSome Error responses: \n\n * 429 TooManyRequests - Request is throttled. Retry after waiting for the time specified in the \"x-ms-ratelimit-microsoft.consumption-retry-after\" header. \n\n * 503 ServiceUnavailable - Service is temporarily unavailable. Retry after waiting for the time specified in the \"Retry-After\" header.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "tags": { + "readOnly": true, + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + } + }, + "x-ms-azure-resource": true + }, + "ProxyResource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + }, + "eTag": { + "type": "string", + "description": "eTag of the resource. To handle concurrent update scenario, this field will be used to determine whether the user is updating the latest version or not." + } + }, + "x-ms-azure-resource": true + }, + "DimensionsListResult": { + "description": "Result of listing dimensions. It contains a list of available dimensions.", + "type": "object", + "properties": { + "value": { + "description": "The list of dimensions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Dimension" + } + } + } + }, + "Dimension": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DimensionProperties", + "title": "Dimension properties" + } + } + }, + "DimensionProperties": { + "type": "object", + "properties": { + "description": { + "description": "Dimension description.", + "type": "string", + "readOnly": true + }, + "filterEnabled": { + "description": "Filter enabled.", + "type": "boolean", + "readOnly": true + }, + "groupingEnabled": { + "description": "Grouping enabled.", + "type": "boolean", + "readOnly": true + }, + "data": { + "type": "array", + "items": { + "description": "Dimension data item.", + "type": "string", + "readOnly": true + } + }, + "total": { + "description": "Total number of data for the dimension.", + "format": "int32", + "type": "integer", + "readOnly": true + }, + "category": { + "description": "Dimension category.", + "type": "string", + "readOnly": true + }, + "usageStart": { + "description": "Usage start.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "usageEnd": { + "description": "Usage end.", + "format": "date-time", + "type": "string", + "readOnly": true + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "AlertsResult": { + "description": "Result of alerts.", + "type": "object", + "properties": { + "value": { + "description": "List of alerts.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Alert" + } + }, + "nextLink": { + "description": "URL to get the next set of alerts results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Alert": { + "description": "An individual alert.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AlertProperties", + "title": "Alert properties" + } + } + }, + "AlertProperties": { + "type": "object", + "properties": { + "definition": { + "description": "defines the type of alert", + "type": "object", + "properties": { + "type": { + "description": "type of alert", + "type": "string", + "enum": [ + "Budget", + "Invoice", + "Credit", + "Quota", + "General", + "xCloud", + "BudgetForecast" + ], + "x-ms-enum": { + "name": "AlertType", + "modelAsString": true + } + }, + "category": { + "description": "Alert category", + "type": "string", + "enum": [ + "Cost", + "Usage", + "Billing", + "System" + ], + "x-ms-enum": { + "name": "AlertCategory", + "modelAsString": true + } + }, + "criteria": { + "description": "Criteria that triggered alert", + "type": "string", + "enum": [ + "CostThresholdExceeded", + "UsageThresholdExceeded", + "CreditThresholdApproaching", + "CreditThresholdReached", + "QuotaThresholdApproaching", + "QuotaThresholdReached", + "MultiCurrency", + "ForecastCostThresholdExceeded", + "ForecastUsageThresholdExceeded", + "InvoiceDueDateApproaching", + "InvoiceDueDateReached", + "CrossCloudNewDataAvailable", + "CrossCloudCollectionError", + "GeneralThresholdError" + ], + "x-ms-enum": { + "name": "AlertCriteria", + "modelAsString": true + } + } + } + }, + "description": { + "description": "Alert description", + "type": "string" + }, + "source": { + "description": "Source of alert", + "type": "string", + "enum": [ + "Preset", + "User" + ], + "x-ms-enum": { + "name": "AlertSource", + "modelAsString": true + } + }, + "details": { + "description": "Alert details", + "type": "object", + "properties": { + "timeGrainType": { + "description": "Type of timegrain cadence", + "type": "string", + "enum": [ + "None", + "Monthly", + "Quarterly", + "Annually", + "BillingMonth", + "BillingQuarter", + "BillingAnnual" + ], + "x-ms-enum": { + "name": "AlertTimeGrainType", + "modelAsString": true + } + }, + "periodStartDate": { + "description": "datetime of periodStartDate", + "type": "string" + }, + "triggeredBy": { + "description": "notificationId that triggered this alert", + "type": "string" + }, + "resourceGroupFilter": { + "description": "array of resourceGroups to filter by", + "type": "array", + "items": {} + }, + "resourceFilter": { + "description": "array of resources to filter by", + "type": "array", + "items": {} + }, + "meterFilter": { + "description": "array of meters to filter by", + "type": "array", + "items": {} + }, + "tagFilter": { + "description": "tags to filter by", + "type": "object", + "properties": {} + }, + "threshold": { + "description": "notification threshold percentage as a decimal which activated this alert", + "type": "number", + "format": "decimal" + }, + "operator": { + "description": "operator used to compare currentSpend with amount", + "type": "string", + "enum": [ + "None", + "EqualTo", + "GreaterThan", + "GreaterThanOrEqualTo", + "LessThan", + "LessThanOrEqualTo" + ], + "x-ms-enum": { + "name": "AlertOperator", + "modelAsString": true + } + }, + "amount": { + "description": "budget threshold amount", + "type": "number", + "format": "decimal" + }, + "unit": { + "description": "unit of currency being used", + "type": "string" + }, + "currentSpend": { + "description": "current spend", + "type": "number", + "format": "decimal" + }, + "contactEmails": { + "description": "list of emails to contact", + "type": "array", + "items": { + "type": "string" + } + }, + "contactGroups": { + "description": "list of action groups to broadcast to", + "type": "array", + "items": { + "type": "string" + } + }, + "contactRoles": { + "description": "list of contact roles", + "type": "array", + "items": { + "type": "string" + } + }, + "overridingAlert": { + "description": "overriding alert", + "type": "string" + } + } + }, + "costEntityId": { + "description": "related budget", + "type": "string" + }, + "status": { + "description": "alert status", + "type": "string", + "enum": [ + "None", + "Active", + "Overridden", + "Resolved", + "Dismissed" + ], + "x-ms-enum": { + "name": "AlertStatus", + "modelAsString": true + } + }, + "creationTime": { + "description": "dateTime in which alert was created", + "type": "string" + }, + "closeTime": { + "description": "dateTime in which alert was closed", + "type": "string" + }, + "modificationTime": { + "description": "dateTime in which alert was last modified", + "type": "string" + }, + "statusModificationUserName": { + "description": "", + "type": "string" + }, + "statusModificationTime": { + "description": "dateTime in which the alert status was last modified", + "type": "string" + } + } + }, + "DismissAlertPayload": { + "description": "The request payload to update an alert", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AlertProperties", + "title": "Alert properties" + } + } + }, + "QueryResult": { + "description": "Result of query. It contains all columns listed under groupings and aggregation.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/QueryProperties", + "title": "Query properties" + } + } + }, + "QueryProperties": { + "type": "object", + "properties": { + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string" + }, + "columns": { + "description": "Array of columns", + "type": "array", + "items": { + "$ref": "#/definitions/QueryColumn" + } + }, + "rows": { + "description": "Array of rows", + "type": "array", + "items": { + "type": "array", + "items": {} + } + } + } + }, + "QueryColumn": { + "type": "object", + "properties": { + "name": { + "description": "The name of column.", + "type": "string" + }, + "type": { + "description": "The type of column.", + "type": "string" + } + } + }, + "OperationListResult": { + "description": "Result of listing cost management operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of cost management operations supported by the Microsoft.CostManagement resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A Cost management REST API operation.", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "The object that represents the operation.", + "properties": { + "provider": { + "description": "Service provider: Microsoft.CostManagement.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Resource on which the operation is performed: Dimensions, Query.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Operation type: Read, write, delete, etc.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "ForecastDefinition": { + "description": "The definition of a forecast.", + "properties": { + "type": { + "description": "The type of the forecast.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ForecastType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the forecast. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "MonthToDate", + "BillingMonthToDate", + "TheLastMonth", + "TheLastBillingMonth", + "WeekToDate", + "Custom" + ], + "x-ms-enum": { + "name": "ForecastTimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the forecast.", + "$ref": "#/definitions/QueryTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this forecast.", + "$ref": "#/definitions/QueryDataset" + }, + "includeActualCost": { + "description": "a boolean determining if actualCost will be included", + "type": "boolean" + }, + "includeFreshPartialCost": { + "description": "a boolean determining if FreshPartialCost will be included", + "type": "boolean" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "QueryDefinition": { + "description": "The definition of a query.", + "properties": { + "type": { + "description": "The type of the query.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ExportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the query. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "MonthToDate", + "BillingMonthToDate", + "TheLastMonth", + "TheLastBillingMonth", + "WeekToDate", + "Custom" + ], + "x-ms-enum": { + "name": "TimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the query.", + "$ref": "#/definitions/QueryTimePeriod" + }, + "dataset": { + "description": "Has definition for data in this query.", + "$ref": "#/definitions/QueryDataset" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "QueryTimePeriod": { + "description": "The start and end date for pulling data for the query.", + "properties": { + "from": { + "description": "The start date to pull data from.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date to pull data to.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "QueryDataset": { + "description": "The definition of data present in the query.", + "properties": { + "granularity": { + "description": "The granularity of rows in the query.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "Has configuration information for the data in the export. The configuration will be ignored if aggregation and grouping are provided.", + "$ref": "#/definitions/QueryDatasetConfiguration" + }, + "aggregation": { + "type": "object", + "description": "Dictionary of aggregation expression to use in the query. The key of each item in the dictionary is the alias for the aggregated column. Query can have up to 2 aggregation clauses.", + "additionalProperties": { + "type": "object", + "$ref": "#/definitions/QueryAggregation" + }, + "maxItems": 2 + }, + "grouping": { + "description": "Array of group by expression to use in the query. Query can have up to 2 group by clauses.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryGrouping" + }, + "maxItems": 2 + }, + "filter": { + "type": "object", + "description": "Has filter expression to use in the query.", + "$ref": "#/definitions/QueryFilter" + } + } + }, + "QueryDatasetConfiguration": { + "description": "The configuration of dataset in the query.", + "properties": { + "columns": { + "description": "Array of column names to be included in the query. Any valid query column name is allowed. If not provided, then query includes all columns.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "QueryAggregation": { + "description": "The aggregation expression to be used in the query.", + "properties": { + "name": { + "description": "The name of the column to aggregate.", + "type": "string" + }, + "function": { + "description": "The name of the aggregation function to use.", + "type": "string", + "enum": [ + "Sum" + ], + "x-ms-enum": { + "name": "FunctionType", + "modelAsString": true + } + } + }, + "required": [ + "name", + "function" + ] + }, + "QueryGrouping": { + "description": "The group by expression to be used in the query.", + "properties": { + "type": { + "description": "Has type of the column to group.", + "$ref": "#/definitions/QueryColumnType" + }, + "name": { + "description": "The name of the column to group.", + "type": "string" + } + }, + "required": [ + "type", + "name" + ] + }, + "QueryFilter": { + "description": "The filter expression to be used in the export.", + "properties": { + "and": { + "description": "The logical \"AND\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryFilter" + }, + "minItems": 2 + }, + "or": { + "description": "The logical \"OR\" expression. Must have at least 2 items.", + "type": "array", + "items": { + "$ref": "#/definitions/QueryFilter" + }, + "minItems": 2 + }, + "not": { + "description": "The logical \"NOT\" expression.", + "$ref": "#/definitions/QueryFilter" + }, + "dimension": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/QueryComparisonExpression" + }, + "tag": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/QueryComparisonExpression" + } + } + }, + "QueryColumnType": { + "description": "The type of the column in the export.", + "type": "string", + "enum": [ + "Tag", + "Dimension" + ], + "x-ms-enum": { + "name": "QueryColumnType", + "modelAsString": true + } + }, + "QueryComparisonExpression": { + "description": "The comparison expression to be used in the query.", + "properties": { + "name": { + "description": "The name of the column to use in comparison.", + "type": "string" + }, + "operator": { + "description": "The operator to use for comparison.", + "type": "string", + "enum": [ + "In" + ], + "x-ms-enum": { + "name": "OperatorType", + "modelAsString": true + } + }, + "values": { + "description": "Array of values to use for comparison", + "type": "array", + "items": { + "type": "string" + }, + "minItems": 1 + } + }, + "required": [ + "name", + "operator", + "values" + ] + }, + "ExportListResult": { + "description": "Result of listing exports. It contains a list of available exports in the scope provided.", + "type": "object", + "properties": { + "value": { + "description": "The list of exports.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Export" + } + } + } + }, + "Export": { + "description": "An export resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportProperties", + "title": "Export properties" + } + } + }, + "ExportProperties": { + "description": "The properties of the export.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/CommonExportProperties" + } + ], + "properties": { + "schedule": { + "description": "Has schedule information for the export.", + "$ref": "#/definitions/ExportSchedule" + } + } + }, + "CommonExportProperties": { + "description": "The common properties of the export.", + "type": "object", + "properties": { + "format": { + "description": "The format of the export being delivered. Currently only 'Csv' is supported.", + "type": "string", + "enum": [ + "Csv" + ], + "x-ms-enum": { + "name": "FormatType", + "modelAsString": true + } + }, + "deliveryInfo": { + "description": "Has delivery information for the export.", + "$ref": "#/definitions/ExportDeliveryInfo" + }, + "definition": { + "description": "Has the definition for the export.", + "$ref": "#/definitions/ExportDefinition" + }, + "runHistory": { + "description": "If requested, has the most recent execution history for the export.", + "$ref": "#/definitions/ExportExecutionListResult" + }, + "nextRunTimeEstimate": { + "description": "If the export has an active schedule, provides an estimate of the next execution time.", + "type": "string", + "format": "date-time", + "readOnly": true + } + }, + "required": [ + "deliveryInfo", + "definition" + ] + }, + "ExportSchedule": { + "description": "The schedule associated with the export.", + "type": "object", + "properties": { + "status": { + "description": "The status of the export's schedule. If 'Inactive', the export's schedule is paused.", + "type": "string", + "enum": [ + "Active", + "Inactive" + ], + "x-ms-enum": { + "name": "StatusType", + "modelAsString": true + } + }, + "recurrence": { + "description": "The schedule recurrence.", + "type": "string", + "enum": [ + "Daily", + "Weekly", + "Monthly", + "Annually" + ], + "x-ms-enum": { + "name": "RecurrenceType", + "modelAsString": true + } + }, + "recurrencePeriod": { + "description": "Has start and end date of the recurrence. The start date must be in future. If present, the end date must be greater than start date.", + "$ref": "#/definitions/ExportRecurrencePeriod" + } + }, + "required": [ + "recurrence" + ] + }, + "ExportDeliveryInfo": { + "description": "The delivery information associated with a export.", + "type": "object", + "properties": { + "destination": { + "description": "Has destination for the export being delivered.", + "$ref": "#/definitions/ExportDeliveryDestination" + } + }, + "required": [ + "destination" + ] + }, + "ExportRecurrencePeriod": { + "description": "The start and end date for recurrence schedule.", + "type": "object", + "properties": { + "from": { + "description": "The start date of recurrence.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date of recurrence.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from" + ] + }, + "ExportDeliveryDestination": { + "description": "The destination information for the delivery of the export. To allow access to a storage account, you must register the account's subscription with the Microsoft.CostManagementExports resource provider. This is required once per subscription. When creating an export in the Azure portal, it is done automatically, however API users need to register the subscription. For more information see https://docs.microsoft.com/en-us/azure/azure-resource-manager/resource-manager-supported-services .", + "type": "object", + "properties": { + "resourceId": { + "description": "The resource id of the storage account where exports will be delivered.", + "type": "string" + }, + "container": { + "description": "The name of the container where exports will be uploaded.", + "type": "string" + }, + "rootFolderPath": { + "description": "The name of the directory where exports will be uploaded.", + "type": "string" + } + }, + "required": [ + "resourceId", + "container" + ] + }, + "ExportDefinition": { + "description": "The definition of an export.", + "type": "object", + "properties": { + "type": { + "description": "The type of the export. Note that 'Usage' is equivalent to 'ActualCost' and is applicable to exports that do not yet provide data for charges or amortization for service reservations.", + "type": "string", + "enum": [ + "Usage", + "ActualCost", + "AmortizedCost" + ], + "x-ms-enum": { + "name": "ExportType", + "modelAsString": true + } + }, + "timeframe": { + "description": "The time frame for pulling data for the export. If custom, then a specific time period must be provided.", + "type": "string", + "enum": [ + "MonthToDate", + "BillingMonthToDate", + "TheLastMonth", + "TheLastBillingMonth", + "WeekToDate", + "Custom" + ], + "x-ms-enum": { + "name": "TimeframeType", + "modelAsString": true + } + }, + "timePeriod": { + "description": "Has time period for pulling data for the export.", + "$ref": "#/definitions/ExportTimePeriod" + }, + "dataSet": { + "description": "The definition for data in the export.", + "$ref": "#/definitions/ExportDataset" + } + }, + "required": [ + "type", + "timeframe" + ] + }, + "ExportDataset": { + "description": "The definition for data in the export.", + "type": "object", + "properties": { + "granularity": { + "description": "The granularity of rows in the export. Currently only 'Daily' is supported.", + "type": "string", + "enum": [ + "Daily" + ], + "x-ms-enum": { + "name": "GranularityType", + "modelAsString": true + } + }, + "configuration": { + "description": "The export dataset configuration.", + "$ref": "#/definitions/ExportDatasetConfiguration" + } + } + }, + "ExportDatasetConfiguration": { + "description": "The export dataset configuration. Allows columns to be selected for the export. If not provided then the export will include all available columns.", + "type": "object", + "properties": { + "columns": { + "description": "Array of column names to be included in the export. If not provided then the export will include all available columns. The available columns can vary by customer channel (see examples).", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ExportTimePeriod": { + "description": "The date range for data in the export. This should only be specified with timeFrame set to 'Custom'. The maximum date range is 3 months.", + "type": "object", + "properties": { + "from": { + "description": "The start date for export data.", + "type": "string", + "format": "date-time" + }, + "to": { + "description": "The end date for export data.", + "type": "string", + "format": "date-time" + } + }, + "required": [ + "from", + "to" + ] + }, + "ExportExecutionListResult": { + "description": "Result of listing the execution history of an export.", + "type": "object", + "properties": { + "value": { + "description": "A list of export executions.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExportExecution" + } + } + } + }, + "ExportExecution": { + "description": "An export execution.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ExportExecutionProperties", + "title": "Export execution properties" + } + } + }, + "ExportExecutionProperties": { + "description": "The properties of the export execution.", + "type": "object", + "properties": { + "executionType": { + "description": "The type of the export execution.", + "type": "string", + "enum": [ + "OnDemand", + "Scheduled" + ], + "x-ms-enum": { + "name": "ExecutionType", + "modelAsString": true + } + }, + "status": { + "description": "The last known status of the export execution.", + "type": "string", + "enum": [ + "Queued", + "InProgress", + "Completed", + "Failed", + "Timeout", + "NewDataNotAvailable", + "DataNotAvailable" + ], + "x-ms-enum": { + "name": "ExecutionStatus", + "modelAsString": true + } + }, + "submittedBy": { + "description": "The identifier for the entity that executed the export. For OnDemand executions it is the user email. For scheduled executions it is 'System'.", + "type": "string" + }, + "submittedTime": { + "description": "The time when export was queued to be executed.", + "type": "string", + "format": "date-time" + }, + "processingStartTime": { + "description": "The time when export was picked up to be executed.", + "type": "string", + "format": "date-time" + }, + "processingEndTime": { + "description": "The time when the export execution finished.", + "type": "string", + "format": "date-time" + }, + "fileName": { + "description": "The name of the exported file.", + "type": "string" + }, + "runSettings": { + "description": "The export settings that were in effect for this execution.", + "$ref": "#/definitions/CommonExportProperties" + }, + "error": { + "description": "The details of any error.", + "$ref": "#/definitions/ErrorDetails" + } + } + } + }, + "parameters": { + "viewNameParameter": { + "name": "viewName", + "in": "path", + "description": "View name", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "scopeViewParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with view operations. This includes 'subscriptions/{subscriptionId}' for subscription scope, 'subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for BillingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/invoiceSections/{invoiceSectionId}' for InvoiceSection scope, 'providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, 'providers/Microsoft.CostManagement/externalBillingAccounts/{externalBillingAccountName}' for External Billing Account scope and 'providers/Microsoft.CostManagement/externalSubscriptions/{externalSubscriptionName}' for External Subscription scope.", + "x-ms-parameter-location": "method" + }, + "scopeDimensionParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with dimension operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId}' for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and 'providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeAlertParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with alerts operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeForecastParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with forecast operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "scopeQueryParameter": { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope associated with query and export operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resourceGroup scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for Billing Account scope and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/departments/{departmentId}' for Department scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/enrollmentAccounts/{enrollmentAccountId}' for EnrollmentAccount scope, '/providers/Microsoft.Management/managementGroups/{managementGroupId} for Management Group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}/invoiceSections/{invoiceSectionId}' for invoiceSection scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/customers/{customerId}' specific for partners.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request (e.g. '2020-06-01')." + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "Azure Resource Group Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "billingAccountIdParameter": { + "name": "billingAccountId", + "in": "path", + "description": "BillingAccount ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "managementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "description": "ManagementGroup ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "departmentIdParameter": { + "name": "departmentId", + "in": "path", + "description": "Department ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "enrollmentAccountIdParameter": { + "name": "enrollmentAccountId", + "in": "path", + "description": "Enrollment Account ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "exportNameParameter": { + "name": "exportName", + "in": "path", + "description": "Export Name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "externalCloudProviderTypeParameter": { + "name": "externalCloudProviderType", + "in": "path", + "required": true, + "type": "string", + "enum": [ + "externalSubscriptions", + "externalBillingAccounts" + ], + "x-ms-enum": { + "name": "externalCloudProviderType", + "modelAsString": true + }, + "description": "The external cloud provider type associated with dimension/query operations. This includes 'externalSubscriptions' for linked account and 'externalBillingAccounts' for consolidated account.", + "x-ms-parameter-location": "method" + }, + "externalCloudProviderIdParameter": { + "name": "externalCloudProviderId", + "in": "path", + "required": true, + "type": "string", + "description": "This can be '{externalSubscriptionId}' for linked account or '{externalBillingAccountId}' for consolidated account used with dimension/query operations.", + "x-ms-parameter-location": "method" + }, + "alertIdParameter": { + "name": "alertId", + "in": "path", + "description": "Alert ID", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountAlerts.json new file mode 100644 index 000000000000..8a6b536c3278 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsList.json new file mode 100644 index 000000000000..8f2f6f365cb4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "100", + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..b5521f5bfb68 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..572606fcd52a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountDimensionsListWithFilter.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "100", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/100" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountForecast.json new file mode 100644 index 000000000000..02e9d2896bfd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountForecast.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "JapanUnifia-Trial", + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + "RVIIOT-TRIAL", + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + "VSTSHOL-1595322048000", + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + "gs-stms-dev", + 20180429, + "Forecast", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountQuery.json new file mode 100644 index 000000000000..80d3082985f3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountQuery.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "70664866", + "scope": "providers/Microsoft.Billing/billingAccounts/70664866", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountQueryGrouping.json new file mode 100644 index 000000000000..cc666efa60dd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingAccountQueryGrouping.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "70664866", + "scope": "providers/Microsoft.Billing/billingAccounts/70664866", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingProfileAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingProfileAlerts.json new file mode 100644 index 000000000000..4c1bcb9cf37c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingProfileAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingProfileForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingProfileForecast.json new file mode 100644 index 000000000000..7b29eb2e07db --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/BillingProfileForecast.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "JapanUnifia-Trial", + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + "RVIIOT-TRIAL", + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + "VSTSHOL-1595322048000", + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + "gs-stms-dev", + 20180429, + "Forecast", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentAlerts.json new file mode 100644 index 000000000000..31d5dd87d70d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "12345:6789", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsList.json new file mode 100644 index 000000000000..4aa6dec17440 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "100", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..066a3bc16f25 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsListExpandAndTop.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "100", + "departmentId": "123", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsListWithFilter.json new file mode 100644 index 000000000000..f486f6e36fa2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentDimensionsListWithFilter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "100", + "departmentId": "123", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/departments/123/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentForecast.json new file mode 100644 index 000000000000..affaf9d67402 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentForecast.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12345:6789", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/departments/123/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "JapanUnifia-Trial", + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + "RVIIOT-TRIAL", + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + "VSTSHOL-1595322048000", + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + "gs-stms-dev", + 20180429, + "Forecast", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentQuery.json new file mode 100644 index 000000000000..59cd36defe51 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "70664866", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentQueryGrouping.json new file mode 100644 index 000000000000..27ae96d00be2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DepartmentQueryGrouping.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "70664866", + "departmentId": "123", + "scope": "providers/Microsoft.Billing/billingAccounts/100/departments/123", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/departments/123/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DismissResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DismissResourceGroupAlerts.json new file mode 100644 index 000000000000..d72950db27ea --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DismissResourceGroupAlerts.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "alertId": "22222222-2222-2222-2222-222222222222", + "parameters": { + "properties": { + "status": "Dismissed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Dismissed", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DismissSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DismissSubscriptionAlerts.json new file mode 100644 index 000000000000..2b9751ea4241 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/DismissSubscriptionAlerts.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "alertId": "22222222-2222-2222-2222-222222222222", + "parameters": { + "properties": { + "status": "Dismissed" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Dismissed", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountAlerts.json new file mode 100644 index 000000000000..eff8e650fe77 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "12345:6789", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsList.json new file mode 100644 index 000000000000..1c23de80068c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..98551eb4e953 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsListExpandAndTop.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..7de518cb7769 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountDimensionsListWithFilter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountForecast.json new file mode 100644 index 000000000000..f7673b462b25 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountForecast.json @@ -0,0 +1,118 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12345:6789", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/enrollmentAccounts/456/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "JapanUnifia-Trial", + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + "RVIIOT-TRIAL", + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + "VSTSHOL-1595322048000", + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + "gs-stms-dev", + 20180429, + "Forecast", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountQuery.json new file mode 100644 index 000000000000..d8adb4734eea --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountQueryGrouping.json new file mode 100644 index 000000000000..34d2421e5a3a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/EnrollmentAccountQueryGrouping.json @@ -0,0 +1,77 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "70664866", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/70664866/enrollmentAccounts/456/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByBillingAccount.json new file mode 100644 index 000000000000..64869be56a4e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByBillingAccount.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByDepartment.json new file mode 100644 index 000000000000..1f118968e004 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByDepartment.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json new file mode 100644 index 000000000000..b829ecc1d0eb --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByEnrollmentAccount.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByManagementGroup.json new file mode 100644 index 000000000000..5bc26d149df5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByManagementGroup.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByResourceGroup.json new file mode 100644 index 000000000000..fa215b9ff077 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateByResourceGroup.json @@ -0,0 +1,129 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateBySubscription.json new file mode 100644 index 000000000000..22592d3bfc96 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportCreateOrUpdateBySubscription.json @@ -0,0 +1,128 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport", + "parameters": { + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "responses": { + "201": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "MonthToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByBillingAccount.json new file mode 100644 index 000000000000..723a1b70c13d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByBillingAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByDepartment.json new file mode 100644 index 000000000000..9bff0064a096 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByDepartment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByEnrollmentAccount.json new file mode 100644 index 000000000000..a9caf9fa5729 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByEnrollmentAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByManagementGroup.json new file mode 100644 index 000000000000..d0d9845db934 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByManagementGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByResourceGroup.json new file mode 100644 index 000000000000..430c0b81c4b2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteByResourceGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteBySubscription.json new file mode 100644 index 000000000000..74d07239431b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportDeleteBySubscription.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByBillingAccount.json new file mode 100644 index 000000000000..bb66830c00b6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByBillingAccount.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-Id}/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-05-01T00:00:00Z", + "to": "2020-05-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByDepartment.json new file mode 100644 index 000000000000..415eef4ef834 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByDepartment.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByEnrollmentAccount.json new file mode 100644 index 000000000000..92d21fd96154 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByEnrollmentAccount.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2019-09-01T00:00:00Z", + "to": "2019-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByManagementGroup.json new file mode 100644 index 000000000000..d8df71f3ddba --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByManagementGroup.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2019-09-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "UsageDate", + "MeterId", + "InstanceId", + "ResourceLocation", + "UsageQuantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByResourceGroup.json new file mode 100644 index 000000000000..58dacbf4d372 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-06-30T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetBySubscription.json new file mode 100644 index 000000000000..b3c6a550c6f4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportGetBySubscription.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport", + "name": "TestExport", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2019-06-01T00:00:00Z", + "to": "2019-07-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByBillingAccount.json new file mode 100644 index 000000000000..723a1b70c13d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByBillingAccount.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByDepartment.json new file mode 100644 index 000000000000..9bff0064a096 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByDepartment.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByEnrollmentAccount.json new file mode 100644 index 000000000000..a9caf9fa5729 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByEnrollmentAccount.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByManagementGroup.json new file mode 100644 index 000000000000..d0d9845db934 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByManagementGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByResourceGroup.json new file mode 100644 index 000000000000..430c0b81c4b2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunByResourceGroup.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunBySubscription.json new file mode 100644 index 000000000000..74d07239431b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunBySubscription.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByBillingAccount.json new file mode 100644 index 000000000000..23d2afb0ba7c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByBillingAccount.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/{billingAccount-id}/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByDepartment.json new file mode 100644 index 000000000000..5812ec43b27f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByDepartment.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/1234", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByEnrollmentAccount.json new file mode 100644 index 000000000000..3cc2d9bdd01e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByEnrollmentAccount.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2019-01-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByManagementGroup.json new file mode 100644 index 000000000000..d271d702dd30 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByManagementGroup.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledForTestExport/TestExportSchedule/20180729-20180804/TestExportSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByResourceGroup.json new file mode 100644 index 000000000000..b6aaae782d44 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetByResourceGroup.json @@ -0,0 +1,101 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetBySubscription.json new file mode 100644 index 000000000000..1dc83a7d386e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportRunHistoryGetBySubscription.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "exportName": "TestExport" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/1e25d58a-a3b0-4916-9542-6e04a89bc100", + "properties": { + "executionType": "OnDemand", + "status": "Completed", + "submittedBy": "john.doe@gmail.com", + "submittedTime": "2018-08-03T07:52:15.6016681Z", + "processingStartTime": "2018-08-03T07:52:16.9123797Z", + "processingEndTime": "2018-08-03T07:52:28.0373318Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_1e25d58a-a3b0-4916-9542-6e04a89bc100.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/JohnDoeSchedule/Run/11ac6811-dca3-46ad-b326-4704cf0c58ef", + "properties": { + "executionType": "Scheduled", + "status": "Completed", + "submittedBy": "System", + "submittedTime": "2018-08-03T09:03:58.5710244Z", + "processingStartTime": "2018-08-03T09:03:58.5710244Z", + "processingEndTime": "2018-08-03T09:04:19.7223808Z", + "fileName": "ScheduledTestsForJohnDoe/JohnDoeSchedule/20180729-20180804/JohnDoeSchedule_11ac6811-dca3-46ad-b326-4704cf0c58ef.csv", + "runSettings": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ScheduledTestsForJohnDoe" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByBillingAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByBillingAccount.json new file mode 100644 index 000000000000..e360bb9b5280 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByBillingAccount.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "123456", + "scope": "providers/Microsoft.Billing/billingAccounts/123456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/123456/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByDepartment.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByDepartment.json new file mode 100644 index 000000000000..3bdc6e63fd5a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByDepartment.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12", + "departmentId": "1234", + "scope": "providers/Microsoft.Billing/billingAccounts/12/departments/123" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12/departments/1234/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByEnrollmentAccount.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByEnrollmentAccount.json new file mode 100644 index 000000000000..abbb4951a11e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByEnrollmentAccount.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "100", + "enrollmentAccountId": "456", + "scope": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/100/enrollmentAccounts/456/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByManagementGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByManagementGroup.json new file mode 100644 index 000000000000..9bf48014812b --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByManagementGroup.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "managementGroupId": "TestMG", + "scope": "providers/Microsoft.Management/managementGroups/TestMG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/TestMG/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByResourceGroup.json new file mode 100644 index 000000000000..1ba77e1fa614 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetByResourceGroup.json @@ -0,0 +1,90 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "MYDEVTESTRG", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetBySubscription.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetBySubscription.json new file mode 100644 index 000000000000..c842a554eca8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExportsGetBySubscription.json @@ -0,0 +1,89 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport1", + "name": "TestExport1", + "type": "Microsoft.CostManagement/exports", + "properties": { + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "Custom", + "timePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + }, + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/exports/TestExport2", + "name": "TestExport2", + "type": "Microsoft.CostManagement/exports", + "properties": { + "schedule": { + "status": "Active", + "recurrence": "Weekly", + "recurrencePeriod": { + "from": "2020-06-01T00:00:00Z", + "to": "2020-10-31T00:00:00Z" + } + }, + "format": "Csv", + "deliveryInfo": { + "destination": { + "resourceId": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Storage/storageAccounts/ccmeastusdiag182", + "container": "exports", + "rootFolderPath": "ad-hoc" + } + }, + "definition": { + "type": "ActualCost", + "timeframe": "WeekToDate", + "dataSet": { + "granularity": "Daily", + "configuration": { + "columns": [ + "Date", + "MeterId", + "ResourceId", + "ResourceLocation", + "Quantity" + ] + } + } + } + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountAlerts.json new file mode 100644 index 000000000000..3172c3380a43 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountForecast.json new file mode 100644 index 000000000000..b73840ab14bc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountForecast.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 0.0, + "Forecast", + "USD" + ], + [ + 30.2572751438, + "Forecast", + "USD" + ], + [ + 0.076757602000000022, + "Forecast", + "USD" + ], + [ + 50.430964190400012, + "Forecast", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountsDimensions.json new file mode 100644 index 000000000000..5172c0cdcdb6 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountsDimensions.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceType_2019-12-01_2019-12-31", + "name": "dimensions_ResourceType_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 0, + "category": "ResourceType", + "description": "Resource type", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/dimensions_ResourceId_2019-12-01_2019-12-31", + "name": "dimensions_ResourceId_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 0, + "category": "ResourceId", + "description": "Resource ID", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountsQuery.json new file mode 100644 index 000000000000..56e1a522099c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalBillingAccountsQuery.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalBillingAccounts", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalBillingAccounts/100/query/6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "name": "6dc7b06a-d90a-4df5-b655-ce6cf1c0814d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ServiceName", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 0.0, + "abc db", + "USD" + ], + [ + 30.2572751438, + "abc compute cloud", + "USD" + ], + [ + 0.076757602000000022, + "abc file system", + "USD" + ], + [ + 50.430964190400012, + "abc elasticache", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionAlerts.json new file mode 100644 index 000000000000..fe966bbe5f8e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionForecast.json new file mode 100644 index 000000000000..2ffa4801b11d --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionForecast.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", + "name": "d99477af-7510-40ee-aca2-e59bdca0d10d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionsDimensions.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionsDimensions.json new file mode 100644 index 000000000000..5320be178ef0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionsDimensions.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceType_2019-12-01_2019-12-31", + "name": "dimensions_ResourceType_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 0, + "category": "ResourceType", + "description": "Resource type", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/123/dimensions_ResourceId_2019-12-01_2019-12-31", + "name": "dimensions_ResourceId_2019-12-01_2019-12-31", + "type": "microsoft.consumption/dimensions", + "properties": { + "data": [], + "total": 0, + "category": "ResourceId", + "description": "Resource ID", + "usageStart": "2019-12-01T00:00:00Z", + "usageEnd": "2019-12-31T00:00:00Z", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionsQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionsQuery.json new file mode 100644 index 000000000000..5a4dfd8e3e27 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ExternalSubscriptionsQuery.json @@ -0,0 +1,78 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "externalCloudProviderId": "100", + "externalCloudProviderType": "externalSubscriptions", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.CostManagement/externalSubscriptions/100/query/d99477af-7510-40ee-aca2-e59bdca0d10d", + "name": "d99477af-7510-40ee-aca2-e59bdca0d10d", + "type": "Microsoft.CostManagement/query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/InvoiceSectionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/InvoiceSectionAlerts.json new file mode 100644 index 000000000000..deaecbf35558 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/InvoiceSectionAlerts.json @@ -0,0 +1,100 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/InvoiceSectionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/InvoiceSectionForecast.json new file mode 100644 index 000000000000..e0b840457c2c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/InvoiceSectionForecast.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Forecast?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "JapanUnifia-Trial", + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + "RVIIOT-TRIAL", + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + "VSTSHOL-1595322048000", + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + "gs-stms-dev", + 20180429, + "Forecast", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsList.json new file mode 100644 index 000000000000..accdaebf5212 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..81839ef51c4e --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsListExpandAndTop.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsListWithFilter.json new file mode 100644 index 000000000000..ab76379cbce0 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountDimensionsListWithFilter.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountQuery.json new file mode 100644 index 000000000000..8abfb5dc2eca --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountQuery.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountQueryGrouping.json new file mode 100644 index 000000000000..648ebf053be2 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingAccountQueryGrouping.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsList.json new file mode 100644 index 000000000000..11d84a74f6c9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..2102cbb9407a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsListExpandAndTop.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsListWithFilter.json new file mode 100644 index 000000000000..118eda5d0cfd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileDimensionsListWithFilter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileQuery.json new file mode 100644 index 000000000000..89e2f2fb78ca --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileQueryGrouping.json new file mode 100644 index 000000000000..3946eb12c2cf --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCABillingProfileQueryGrouping.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsList.json new file mode 100644 index 000000000000..0a63b2667392 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsList.json @@ -0,0 +1,46 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..738eb52bf1f8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsListExpandAndTop.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsListWithFilter.json new file mode 100644 index 000000000000..dc9903eb348a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerDimensionsListWithFilter.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "customerId": "13579", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerQuery.json new file mode 100644 index 000000000000..41a095e8750c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerQuery.json @@ -0,0 +1,108 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerQueryGrouping.json new file mode 100644 index 000000000000..a4629cc12c8c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCACustomerQueryGrouping.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "customerId": "5678", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/customers/5678/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsList.json new file mode 100644 index 000000000000..381d346fa3ba --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..17dedb5444fc --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsListExpandAndTop.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceGroup_2019-10-01_2019-10-31", + "name": "dimensions_ResourceGroup_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceType_2019-10-01_2019-10-31", + "name": "dimensions_ResourceType_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json new file mode 100644 index 000000000000..9dc3219f73e3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionDimensionsListWithFilter.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/microsoft.CostManagement/dimensions_ResourceId_2019-10-01_2019-10-31", + "name": "dimensions_ResourceId_2019-10-01_2019-10-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2019-10-01T00:00:00-07:00", + "usageEnd": "2019-10-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionQuery.json new file mode 100644 index 000000000000..ddacc8d3b487 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionQuery.json @@ -0,0 +1,109 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionQueryGrouping.json new file mode 100644 index 000000000000..c680c09d1ac3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/MCAInvoiceSectionQueryGrouping.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingAccountId": "12345:6789", + "billingProfileId": "13579", + "invoiceSectionId": "9876", + "scope": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Billing/billingAccounts/12345:6789/billingProfiles/13579/invoiceSections/9876/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsList.json new file mode 100644 index 000000000000..46d654b664b9 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsListExpandAndTop.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsListExpandAndTop.json new file mode 100644 index 000000000000..616047e5e4bf --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsListExpandAndTop.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "managementGroupId": "MyMgId", + "$expand": "properties/data", + "$top": 5, + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "thoroetrg01", + "default-notificationhubs-westus", + "jedikeyvaultrg", + "contosocodeflow8d4a", + "noobaa" + ], + "total": 377, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.automation/automationaccounts", + "microsoft.databricks/workspaces", + "microsoft.dbformysql/servers", + "microsoft.containerregistry/registries", + "microsoft.search/searchservices" + ], + "total": 37, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsListWithFilter.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsListWithFilter.json new file mode 100644 index 000000000000..de501d6cc1ee --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupDimensionsListWithFilter.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "managementGroupId": "MyMgId", + "$expand": "properties/data", + "$top": 5, + "$filter": "properties/category eq 'resourceId'", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/urphealthaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/67e24f6b-1ec2-4c90-993a-dc2d25b00b6c/resourcegroups/defaultresourcegroup-eus/providers/microsoft.operationalinsights/workspaces/defaultworkspace-67e24f6b-1ec2-4c90-993a-dc2d25b00b6c-eus", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/rg-sql-ha/providers/microsoft.compute/virtualmachines/sql-4qqp1", + "/subscriptions/a98d6dc5-eb8f-46cf-8938-f1fb08f03706/resourcegroups/databricks-rg-testwsp-xijmsdubneexm/providers/microsoft.compute/disks/488cdb42bf74474a98075415be3f806c-containerrootvolume" + ], + "total": 1409, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true, + "nextLink": "http://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Dimensions?$filter=properties/category eq 'resourceId'&$top=5&api-version=2019-10-01&$expand=properties/data&$skiptoken=AQAAAA%3D%3D" + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupQuery.json new file mode 100644 index 000000000000..8bb619cee8e3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupQuery.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 0.16677720329728665, + "gs-stms-dev", + 20180331, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupQueryGrouping.json new file mode 100644 index 000000000000..0f3b0ef56cd3 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ManagementGroupQueryGrouping.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "managementGroupId": "MyMgId", + "scope": "providers/Microsoft.Management/managementGroups/MyMgId", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query/ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "name": "ad67fd91-c131-4bda-9ba9-7187ecb1cebd", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": "https://management.azure.com/providers/Microsoft.Management/managementGroups/MyMgId/providers/Microsoft.CostManagement/Query?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D", + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 20.359416562625452, + "VSTSHOL-1595322048000", + 20180331, + "USD" + ], + [ + 173.41979241290323, + "RVIIOT-TRIAL", + 20180331, + "USD" + ], + [ + 19.545363672276512, + "JapanUnifia-Trial", + 20180331, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateView.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateView.json new file mode 100644 index 000000000000..8128f186ee34 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateView.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "viewName": "swaggerExample" + }, + "responses": { + "200": { + "body": { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewCreateOrUpdate.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewCreateOrUpdate.json new file mode 100644 index 000000000000..917f49d96253 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewCreateOrUpdate.json @@ -0,0 +1,185 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "viewName": "swaggerExample", + "parameters": { + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "200": { + "body": { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewDelete.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewDelete.json new file mode 100644 index 000000000000..a03a55d4b016 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewDelete.json @@ -0,0 +1,10 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "viewName": "TestView" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewList.json new file mode 100644 index 000000000000..f70ddf2c6c81 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/PrivateViewList.json @@ -0,0 +1,131 @@ +{ + "parameters": { + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + }, + { + "id": "/providers/Microsoft.CostManagement/views/swaggerExample2", + "name": "swaggerExample2", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example 2", + "scope": "", + "query": { + "type": "Usage", + "timeframe": "LastMonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "GroupedColumn", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupAlerts.json new file mode 100644 index 000000000000..2db6d3dd5bf8 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupAlerts.json @@ -0,0 +1,99 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupDimensionsList.json new file mode 100644 index 000000000000..d0f789435863 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupDimensionsList.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "system.orlando", + "$expand": "properties/data", + "$top": 5, + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.storage/storageaccounts" + ], + "total": 1, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/system.orlando/providers/microsoft.CostManagement/dimensions_ResourceId_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceId_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/authprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/systemevents", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/armadminprod", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/srphytenaccount", + "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/system.orlando/providers/microsoft.storage/storageaccounts/publicsystemportal" + ], + "total": 27, + "category": "ResourceId", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource Id", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupForecast.json new file mode 100644 index 000000000000..6ed0b4095bcd --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupForecast.json @@ -0,0 +1,97 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180331, + "Forecast", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupQuery.json new file mode 100644 index 000000000000..052910483e76 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupQuery.json @@ -0,0 +1,96 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "subscriptionId": "55312978-ba1b-415c-9304-c4b9c43c0481", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/55312978-ba1b-415c-9304-c4b9c43c0481/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180417, + "USD" + ], + [ + 20.10333307059661, + "ScreenSharingTest-peer", + 20180418, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupQueryGrouping.json new file mode 100644 index 000000000000..da7cb4d9a91f --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ResourceGroupQueryGrouping.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceType" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/Query/9af9459d-441d-4055-9ed0-83d4c4a363fb", + "name": "9af9459d-441d-4055-9ed0-83d4c4a363fb", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceType", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "Microsoft.SqlServer", + 20180417, + "USD" + ], + [ + 20.10333307059661, + "Microsoft.Compute", + 20180418, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SingleResourceGroupAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SingleResourceGroupAlert.json new file mode 100644 index 000000000000..d4f3f72ef83a --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SingleResourceGroupAlert.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "ScreenSharingTest-peer", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer", + "alertId": "22222222-2222-2222-2222-222222222222" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/ScreenSharingTest-peer/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SingleSubscriptionAlert.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SingleSubscriptionAlert.json new file mode 100644 index 000000000000..cd881b8ea598 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SingleSubscriptionAlert.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "alertId": "22222222-2222-2222-2222-222222222222" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/22222222-2222-2222-2222-222222222222", + "name": "22222222-2222-2222-2222-222222222222", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "22222222-2222-2222-2222-222222222222_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionAlerts.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionAlerts.json new file mode 100644 index 000000000000..0880df01a3b4 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionAlerts.json @@ -0,0 +1,98 @@ +{ + "parameters": { + "api-version": "2018-08-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/00000000-0000-0000-0000-000000000000", + "name": "00000000-0000-0000-0000-000000000000", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "00000000-0000-0000-0000-000000000000_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 161000.12, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2020-04-27T11:07:52.7143901Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2020-04-28T11:06:02.8999373Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/alerts/11111111-1111-1111-111111111111", + "name": "11111111-1111-1111-111111111111", + "type": "Microsoft.CostManagement/alerts", + "properties": { + "definition": { + "type": "Budget", + "category": "Cost", + "criteria": "CostThresholdExceeded" + }, + "description": "", + "source": "Preset", + "details": { + "timeGrainType": "Quarterly", + "periodStartDate": "2020-03-01T00:00:00Z", + "triggeredBy": "11111111-1111-1111-111111111111_1_01", + "resourceGroupFilter": [], + "resourceFilter": [], + "meterFilter": [], + "tagFilter": {}, + "threshold": 0.8, + "operator": "GreaterThan", + "amount": 200000.0, + "unit": "USD", + "currentSpend": 171000.32, + "contactEmails": [ + "1234@contoso.com" + ], + "contactGroups": [], + "contactRoles": [], + "overridingAlert": null + }, + "costEntityId": "budget1", + "status": "Active", + "creationTime": "2019-06-24T05:51:52.8713179Z", + "closeTime": "0001-01-01T00:00:00", + "modificationTime": "2019-08-31T17:51:55.1808807Z", + "statusModificationUserName": null, + "statusModificationTime": "0001-01-01T00:00:00" + } + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionDimensionsList.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionDimensionsList.json new file mode 100644 index 000000000000..89e401409972 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionDimensionsList.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "$top": 5, + "$expand": "properties/data", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceGroup_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "dcrg", + "rg", + "offlinegalleryrg", + "system.orlando.adminkeyvault", + "system.orlando.keyvault" + ], + "total": 68, + "category": "ResourceGroup", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource group", + "filterEnabled": true, + "groupingEnabled": true + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/dimensions_ResourceType_2018-05-01_2018-05-31_5", + "name": "dimensions_ResourceType_2018-05-01_2018-05-31_5", + "type": "microsoft.CostManagement/dimensions", + "properties": { + "data": [ + "microsoft.storage/storageaccounts", + "microsoft.web.admin/role", + "microsoft.sql/servers", + "microsoft.compute/virtualmachines" + ], + "total": 4, + "category": "ResourceType", + "usageStart": "2018-05-01T00:00:00-07:00", + "usageEnd": "2018-05-31T00:00:00-07:00", + "description": "Resource type", + "filterEnabled": true, + "groupingEnabled": true + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionForecast.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionForecast.json new file mode 100644 index 000000000000..dafbb3828f33 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionForecast.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + }, + "includeActualCost": false, + "includeFreshPartialCost": false + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "CostStatus", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180331, + "Forecast", + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod", + 20180331, + "Forecast", + "USD" + ], + [ + 0.14384913581657052, + "ssbciotelement01", + 20180401, + "Forecast", + "USD" + ], + [ + 0.009865586851323632, + "ict_stratandplan_goldsprova_prod", + 20180429, + "Forecast", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionQuery.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionQuery.json new file mode 100644 index 000000000000..c9d3f535ad9c --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionQuery.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "filter": { + "and": [ + { + "or": [ + { + "dimension": { + "name": "ResourceLocation", + "operator": "In", + "values": [ + "East US", + "West Europe" + ] + } + }, + { + "tag": { + "name": "Environment", + "operator": "In", + "values": [ + "UAT", + "Prod" + ] + } + } + ] + }, + { + "dimension": { + "name": "ResourceGroup", + "operator": "In", + "values": [ + "API" + ] + } + } + ] + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "UsageDate", + "type": "Number" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 2.10333307059661, + "ScreenSharingTest-peer", + 20180331, + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod", + 20180331, + "USD" + ], + [ + 0.14384913581657052, + "ssbciotelement01", + 20180401, + "USD" + ], + [ + 0.009865586851323632, + "ict_stratandplan_goldsprova_prod", + 20180429, + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionQueryGrouping.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionQueryGrouping.json new file mode 100644 index 000000000000..f155bfd59622 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/SubscriptionQueryGrouping.json @@ -0,0 +1,74 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000", + "parameters": { + "type": "Usage", + "timeframe": "TheLastMonth", + "dataset": { + "granularity": "None", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [ + { + "type": "Dimension", + "name": "ResourceGroup" + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.CostManagement/Query/00000000-0000-0000-0000-000000000000", + "name": "55312978-ba1b-415c-9304-cfd9c43c0481", + "type": "microsoft.costmanagement/Query", + "properties": { + "nextLink": null, + "columns": [ + { + "name": "PreTaxCost", + "type": "Number" + }, + { + "name": "ResourceGroup", + "type": "String" + }, + { + "name": "Currency", + "type": "String" + } + ], + "rows": [ + [ + 0.009865586851323632, + "Ict_StratAndPlan_GoldSprova_Prod_0", + "USD" + ], + [ + 218.68795741935486, + "Ict_StratAndPlan_GoldSprova_Prod_1", + "USD" + ], + [ + 2.10333307059661, + "ScreenSharingTest-peer1", + "USD" + ], + [ + 0.14384913581657052, + "Ssbciotelement01", + "USD" + ] + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewByResourceGroup.json new file mode 100644 index 000000000000..68f6fe7333ca --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewByResourceGroup.json @@ -0,0 +1,70 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "viewName": "swaggerExample", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewCreateOrUpdateByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewCreateOrUpdateByResourceGroup.json new file mode 100644 index 000000000000..65b1475171ec --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewCreateOrUpdateByResourceGroup.json @@ -0,0 +1,186 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "swaggerExample", + "parameters": { + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + }, + "200": { + "body": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + } + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewDeleteByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewDeleteByResourceGroup.json new file mode 100644 index 000000000000..c613cb7cecff --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewDeleteByResourceGroup.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "viewName": "TestView" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewListByResourceGroup.json b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewListByResourceGroup.json new file mode 100644 index 000000000000..9f71cbfbe7f5 --- /dev/null +++ b/specification/cost-management/resource-manager/Microsoft.CostManagement/stable/2020-06-01/examples/ViewListByResourceGroup.json @@ -0,0 +1,132 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample", + "name": "swaggerExample", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ff9fe66f1d10\"", + "properties": { + "displayName": "swagger Example", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "MonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "Table", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.CostManagement/views/swaggerExample2", + "name": "swaggerExample2", + "type": "Microsoft.CostManagement/Views", + "eTag": "\"1d4ffa5a9c2430c\"", + "properties": { + "displayName": "swagger Example 2", + "scope": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG", + "query": { + "type": "Usage", + "timeframe": "LastMonthToDate", + "dataset": { + "granularity": "Daily", + "aggregation": { + "totalCost": { + "name": "PreTaxCost", + "function": "Sum" + } + }, + "grouping": [], + "sorting": [ + { + "direction": "Ascending", + "name": "UsageDate" + } + ] + } + }, + "chart": "GroupedColumn", + "accumulated": "true", + "metric": "ActualCost", + "kpis": [ + { + "type": "Forecast", + "id": null, + "enabled": true + }, + { + "type": "Budget", + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MYDEVTESTRG/providers/Microsoft.Consumption/budgets/swaggerDemo", + "enabled": true + } + ], + "pivots": [ + { + "type": "Dimension", + "name": "ServiceName" + }, + { + "type": "Dimension", + "name": "MeterCategory" + }, + { + "type": "TagKey", + "name": "swaggerTagKey" + } + ] + } + } + ] + } + } + } +} diff --git a/specification/cost-management/resource-manager/readme.go.md b/specification/cost-management/resource-manager/readme.go.md index 19a211b46d9d..4259fa52ed37 100644 --- a/specification/cost-management/resource-manager/readme.go.md +++ b/specification/cost-management/resource-manager/readme.go.md @@ -66,3 +66,11 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-06' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-01/$(namespace) +``` diff --git a/specification/cost-management/resource-manager/readme.md b/specification/cost-management/resource-manager/readme.md index 12dadfcd7709..85e079d2ccba 100644 --- a/specification/cost-management/resource-manager/readme.md +++ b/specification/cost-management/resource-manager/readme.md @@ -26,18 +26,30 @@ These are the global settings for the Cost Management API. ``` yaml openapi-type: arm -tag: package-2019-11 +tag: package-2020-06 azure-validator: false ``` --- +### Tag: package-2020-06 + +These settings apply only when `--tag=package-2020-06` is specified on the command line. + +```yaml $(tag) == 'package-2020-06' +input-file: + - Microsoft.CostManagement/stable/2020-06-01/costmanagement.json +``` + +======= + +>>>>>>> Stashed changes ### Tag: package-2019-11 These settings apply only when `--tag=package-2019-11` is specified on the command line. -```yaml $(tag) == 'package-2019-11' +``` yaml $(tag) == 'package-2019-11' input-file: - Microsoft.CostManagement/stable/2019-11-01/costmanagement.json ``` @@ -46,10 +58,11 @@ input-file: These settings apply only when `--tag=package-2019-10` is specified on the command line. -```yaml $(tag) == 'package-2019-10' +``` yaml $(tag) == 'package-2019-10' input-file: - Microsoft.CostManagement/stable/2019-10-01/costmanagement.json ``` + ### Tag: package-2019-09 These settings apply only when `--tag=package-2019-09` is specified on the command line. @@ -207,7 +220,6 @@ csharp: clear-output-folder: true ``` - ## Go See configuration in [readme.go.md](./readme.go.md) @@ -327,6 +339,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.CostManagement/stable/2020-06-01/costmanagement.json - $(this-folder)/Microsoft.CostManagement/stable/2019-11-01/costmanagement.json - $(this-folder)/Microsoft.CostManagement/stable/2019-10-01/costmanagement.json - $(this-folder)/Microsoft.CostManagement/stable/2019-09-01/costmanagement.json From c27a5d39bea6a4e9b53503150b79ff637390e9a4 Mon Sep 17 00:00:00 2001 From: Vitaliy Fedonkin Date: Wed, 1 Jul 2020 18:58:24 -0700 Subject: [PATCH 252/318] ApiManagement - stateCommentDocumentation fix (#10007) Co-authored-by: vfedonkin --- .../stable/2019-12-01/definitions.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json index 83499631fc01..82942d61ad52 100644 --- a/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json +++ b/specification/apimanagement/resource-manager/Microsoft.ApiManagement/stable/2019-12-01/definitions.json @@ -4529,7 +4529,7 @@ }, "stateComment": { "type": "string", - "description": "Optional subscription comment added by an administrator." + "description": "Optional subscription comment added by an administrator when the state is changed to the 'rejected'." }, "allowTracing": { "type": "boolean", @@ -4685,7 +4685,7 @@ }, "stateComment": { "type": "string", - "description": "Comments describing subscription state change by the administrator." + "description": "Comments describing subscription state change by the administrator when the state is changed to the 'rejected'." }, "allowTracing": { "type": "boolean", From 6c9921e60630400953ffae3a1bdb2578e7d23b48 Mon Sep 17 00:00:00 2001 From: Cameron Taggart Date: Wed, 1 Jul 2020 20:07:14 -0600 Subject: [PATCH 253/318] add Microsoft.AVS 2020-03-20 API spec (#9859) * add Microsot.AVS 2020-03-20 API spec * fix spelling * prettier * empty object {} passed in to create * multi-api for Java & Go * prettier * review preview for go * mark properties required * add tags to PrivateCloudUpdate --- .../Authorizations_CreateOrUpdate.json | 34 + .../examples/Authorizations_Delete.json | 14 + .../examples/Authorizations_Get.json | 23 + .../examples/Authorizations_List.json | 24 + .../examples/Clusters_CreateOrUpdate.json | 52 + .../2020-03-20/examples/Clusters_Delete.json | 14 + .../2020-03-20/examples/Clusters_Get.json | 31 + .../2020-03-20/examples/Clusters_List.json | 33 + .../2020-03-20/examples/Clusters_Update.json | 50 + .../HcxEnterpriseSites_CreateOrUpdate.json | 34 + .../examples/HcxEnterpriseSites_Delete.json | 13 + .../examples/HcxEnterpriseSites_Get.json | 22 + .../examples/HcxEnterpriseSites_List.json | 23 + .../Locations_CheckQuotaAvailability.json | 18 + .../Locations_CheckTrialAvailability.json | 15 + .../2020-03-20/examples/Operations_List.json | 22 + .../PrivateClouds_CreateOrUpdate.json | 119 ++ .../examples/PrivateClouds_Delete.json | 13 + .../examples/PrivateClouds_Get.json | 60 + .../examples/PrivateClouds_List.json | 63 + .../PrivateClouds_ListAdminCredentials.json | 18 + .../PrivateClouds_ListInSubscription.json | 60 + .../examples/PrivateClouds_Update.json | 114 + .../stable/2020-03-20/vmware.json | 1897 +++++++++++++++++ .../vmware/resource-manager/readme.go.md | 10 + .../vmware/resource-manager/readme.java.md | 14 + .../vmware/resource-manager/readme.md | 19 +- 27 files changed, 2808 insertions(+), 1 deletion(-) create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_CreateOrUpdate.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_Delete.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_Get.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_List.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_CreateOrUpdate.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Delete.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Get.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_List.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Update.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_CreateOrUpdate.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_Delete.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_Get.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_List.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Locations_CheckQuotaAvailability.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Locations_CheckTrialAvailability.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Operations_List.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_CreateOrUpdate.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Delete.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Get.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_List.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListAdminCredentials.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListInSubscription.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Update.json create mode 100644 specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/vmware.json diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_CreateOrUpdate.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_CreateOrUpdate.json new file mode 100644 index 000000000000..db6ed1cace6b --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_CreateOrUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "authorizationName": "authorization1", + "authorization": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/authorizations/authorization1", + "name": "authorization1", + "properties": { + "provisioningState": "Succeeded", + "expressRouteAuthorizationId": "/subscriptions/5206f269-120b-41ef-a95b-0dce7109de61/resourceGroups/tnt34-cust-mockp02-spearj2dev/providers/Microsoft.Network/expressroutecircuits/tnt34-cust-mockp02-spearj2dev-er/authorizations/myauth", + "expressRouteAuthorizationKey": "37b0db3b-3b17-4c7b-bf76-bf13b01bcadc" + }, + "type": "Microsoft.AVS/privateClouds/authorizations" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/authorizations/authorization1", + "name": "authorization1", + "properties": { + "provisioningState": "Updating" + }, + "type": "Microsoft.AVS/privateClouds/authorizations" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_Delete.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_Delete.json new file mode 100644 index 000000000000..c04b6f07ea36 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "authorizationName": "authorization1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_Get.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_Get.json new file mode 100644 index 000000000000..f46d701b5ed1 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_Get.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "authorizationName": "authorization1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/authorizations/authorization1", + "name": "authorization1", + "properties": { + "provisioningState": "Succeeded", + "expressRouteAuthorizationId": "/subscriptions/5206f269-120b-41ef-a95b-0dce7109de61/resourceGroups/tnt34-cust-mockp02-spearj2dev/providers/Microsoft.Network/expressroutecircuits/tnt34-cust-mockp02-spearj2dev-er/authorizations/myauth", + "expressRouteAuthorizationKey": "37b0db3b-3b17-4c7b-bf76-bf13b01bcadc" + }, + "type": "Microsoft.AVS/privateClouds/authorizations" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_List.json new file mode 100644 index 000000000000..59b726fb2677 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Authorizations_List.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/authorizations/authorization1", + "name": "authorization1", + "properties": { + "provisioningState": "Succeeded", + "expressRouteAuthorizationId": "/subscriptions/5206f269-120b-41ef-a95b-0dce7109de61/resourceGroups/tnt34-cust-mockp02-spearj2dev/providers/Microsoft.Network/expressroutecircuits/tnt34-cust-mockp02-spearj2dev-er/authorizations/myauth", + "expressRouteAuthorizationKey": "37b0db3b-3b17-4c7b-bf76-bf13b01bcadc" + }, + "type": "Microsoft.AVS/privateClouds/authorizations" + } + ] + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_CreateOrUpdate.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_CreateOrUpdate.json new file mode 100644 index 000000000000..0d432400c265 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_CreateOrUpdate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "clusterName": "cluster1", + "cluster": { + "sku": { + "name": "AV20" + }, + "properties": { + "clusterSize": 3 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1", + "name": "cluster1", + "sku": { + "name": "AV20" + }, + "properties": { + "clusterSize": 3, + "hosts": [ + "fakehost22.nyc1.kubernetes.center", + "fakehost23.nyc1.kubernetes.center", + "fakehost24.nyc1.kubernetes.center" + ], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.AVS/privateClouds/clusters" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1", + "name": "cluster1", + "sku": { + "name": "AV20" + }, + "properties": { + "clusterSize": 3, + "provisioningState": "Updating" + }, + "type": "Microsoft.AVS/privateClouds/clusters" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Delete.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Delete.json new file mode 100644 index 000000000000..9636f193d773 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Delete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "clusterName": "cluster1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Get.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Get.json new file mode 100644 index 000000000000..51ce81ce9109 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Get.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "clusterName": "cluster1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1", + "name": "cluster1", + "sku": { + "name": "AV20" + }, + "properties": { + "clusterSize": 4, + "hosts": [ + "fakehost22.nyc1.kubernetes.center", + "fakehost23.nyc1.kubernetes.center", + "fakehost24.nyc1.kubernetes.center", + "fakehost25.nyc1.kubernetes.center" + ], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.AVS/privateClouds/clusters" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_List.json new file mode 100644 index 000000000000..a56f1768ae13 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_List.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1", + "name": "cluster1", + "sku": { + "name": "AV20" + }, + "properties": { + "clusterSize": 3, + "hosts": [ + "fakehost22.nyc1.kubernetes.center", + "fakehost23.nyc1.kubernetes.center", + "fakehost24.nyc1.kubernetes.center" + ], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.AVS/privateClouds/clusters" + } + ] + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Update.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Update.json new file mode 100644 index 000000000000..6d53d28ca362 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Clusters_Update.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "clusterName": "cluster1", + "clusterUpdate": { + "properties": { + "clusterSize": 4 + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1", + "name": "cluster1", + "sku": { + "name": "AV20" + }, + "properties": { + "clusterSize": 4, + "hosts": [ + "fakehost22.nyc1.kubernetes.center", + "fakehost23.nyc1.kubernetes.center", + "fakehost24.nyc1.kubernetes.center", + "fakehost25.nyc1.kubernetes.center" + ], + "provisioningState": "Succeeded" + }, + "type": "Microsoft.AVS/privateClouds/clusters" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/clusters/cluster1", + "name": "cluster1", + "sku": { + "name": "AV20" + }, + "properties": { + "clusterSize": 4, + "provisioningState": "Updating" + }, + "type": "Microsoft.AVS/privateClouds/clusters" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_CreateOrUpdate.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_CreateOrUpdate.json new file mode 100644 index 000000000000..a76beef41897 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_CreateOrUpdate.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "hcxEnterpriseSiteName": "site1", + "hcxEnterpriseSite": {} + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/hcxEnterpriseSites/site1", + "name": "site1", + "properties": { + "activationKey": "0276EF1A9A1749A5A362BF73EA9F8D0D", + "status": "Available" + }, + "type": "Microsoft.AVS/privateClouds/hcxEnterpriseSites" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/hcxEnterpriseSites/site1", + "name": "site1", + "properties": { + "activationKey": "0276EF1A9A1749A5A362BF73EA9F8D0D", + "status": "Available" + }, + "type": "Microsoft.AVS/privateClouds/hcxEnterpriseSites" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_Delete.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_Delete.json new file mode 100644 index 000000000000..0e2b3b7683fa --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "hcxEnterpriseSiteName": "site1" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_Get.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_Get.json new file mode 100644 index 000000000000..32249e4d0ec0 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_Get.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "hcxEnterpriseSiteName": "site1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/hcxEnterpriseSites/site1", + "name": "site1", + "properties": { + "activationKey": "0276EF1A9A1749A5A362BF73EA9F8D0D", + "status": "Available" + }, + "type": "Microsoft.AVS/privateClouds/hcxEnterpriseSites" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_List.json new file mode 100644 index 000000000000..68d80d3e14c4 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/HcxEnterpriseSites_List.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1/hcxEnterpriseSites/site1", + "name": "site1", + "properties": { + "activationKey": "0276EF1A9A1749A5A362BF73EA9F8D0D", + "status": "Available" + }, + "type": "Microsoft.AVS/privateClouds/hcxEnterpriseSites" + } + ] + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Locations_CheckQuotaAvailability.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Locations_CheckQuotaAvailability.json new file mode 100644 index 000000000000..11b355054e5f --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Locations_CheckQuotaAvailability.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-03-20", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "hostsRemaining": { + "AV20": 0, + "AV36": 999 + }, + "quotaEnabled": "Enabled" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Locations_CheckTrialAvailability.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Locations_CheckTrialAvailability.json new file mode 100644 index 000000000000..fc41a1e8b540 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Locations_CheckTrialAvailability.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "{subscription-id}", + "api-version": "2020-03-20", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "status": "TrialAvailable", + "availableHosts": 4 + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Operations_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Operations_List.json new file mode 100644 index 000000000000..36fea5ade871 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/Operations_List.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-03-20" + }, + "responses": { + "200": { + "body": [ + { + "display": { + "description": "Creates a private cloud", + "operation": "Create Private Cloud", + "provider": "Azure VMware Solution", + "resource": "Private Cloud" + }, + "name": "Microsoft.AVS/privateClouds/create", + "origin": "user,system" + } + ], + "nextLink": "string" + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_CreateOrUpdate.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_CreateOrUpdate.json new file mode 100644 index 000000000000..cc919583e275 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_CreateOrUpdate.json @@ -0,0 +1,119 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "privateCloud": { + "location": "eastus2", + "sku": { + "name": "AV36" + }, + "properties": { + "networkBlock": "192.168.48.0/22", + "managementCluster": { + "clusterSize": 4 + } + }, + "tags": {} + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", + "location": "eastus2", + "name": "cloud1", + "sku": { + "name": "AV36" + }, + "properties": { + "networkBlock": "192.168.48.0/22", + "circuit": { + "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", + "primarySubnet": "192.168.53.0/30", + "secondarySubnet": "192.168.53.4/30" + }, + "managementCluster": { + "clusterId": 1, + "clusterSize": 4, + "hosts": [ + "fakehost18.nyc1.kubernetes.center", + "fakehost19.nyc1.kubernetes.center", + "fakehost20.nyc1.kubernetes.center", + "fakehost21.nyc1.kubernetes.center" + ] + }, + "endpoints": { + "nsxtManager": "https://192.168.50.3/", + "vcsa": "https://192.168.50.2/" + }, + "identitySources": [ + { + "alias": "groupAlias", + "baseGroupDN": "ou=baseGroup", + "baseUserDN": "ou=baseUser", + "domain": "domain1", + "name": "group1", + "primaryServer": "ldaps://1.1.1.1:636/", + "secondaryServer": "ldaps://1.1.1.2:636/", + "ssl": "Enabled" + } + ], + "internet": "Disabled", + "provisioningState": "Succeeded" + }, + "tags": {}, + "type": "Microsoft.AVS/privateClouds" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", + "location": "eastus2", + "name": "cloud1", + "sku": { + "name": "AV36" + }, + "properties": { + "networkBlock": "192.168.48.0/22", + "circuit": { + "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", + "primarySubnet": "192.168.53.0/30", + "secondarySubnet": "192.168.53.4/30" + }, + "managementCluster": { + "clusterId": 1, + "clusterSize": 4, + "hosts": [ + "fakehost18.nyc1.kubernetes.center", + "fakehost19.nyc1.kubernetes.center", + "fakehost20.nyc1.kubernetes.center", + "fakehost21.nyc1.kubernetes.center" + ] + }, + "endpoints": { + "nsxtManager": "https://192.168.50.3/", + "vcsa": "https://192.168.50.2/" + }, + "identitySources": [ + { + "alias": "groupAlias", + "baseGroupDN": "ou=baseGroup", + "baseUserDN": "ou=baseUser", + "domain": "domain1", + "name": "group1", + "primaryServer": "ldaps://1.1.1.1:636/", + "secondaryServer": "ldaps://1.1.1.2:636/", + "ssl": "Enabled" + } + ], + "internet": "Disabled", + "provisioningState": "Updating" + }, + "tags": {}, + "type": "Microsoft.AVS/privateClouds" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Delete.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Delete.json new file mode 100644 index 000000000000..04c08417f575 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Delete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Get.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Get.json new file mode 100644 index 000000000000..7af8414e147d --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Get.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", + "location": "eastus2", + "name": "cloud1", + "sku": { + "name": "AV36" + }, + "properties": { + "networkBlock": "192.168.48.0/22", + "circuit": { + "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", + "primarySubnet": "192.168.53.0/30", + "secondarySubnet": "192.168.53.4/30", + "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" + }, + "managementCluster": { + "clusterId": 1, + "clusterSize": 4, + "hosts": [ + "fakehost18.nyc1.kubernetes.center", + "fakehost19.nyc1.kubernetes.center", + "fakehost20.nyc1.kubernetes.center", + "fakehost21.nyc1.kubernetes.center" + ] + }, + "endpoints": { + "nsxtManager": "https://192.168.50.3/", + "vcsa": "https://192.168.50.2/", + "hcxCloudManager": "https://192.168.50.4/" + }, + "identitySources": [ + { + "alias": "groupAlias", + "baseGroupDN": "ou=baseGroup", + "baseUserDN": "ou=baseUser", + "domain": "domain1", + "name": "group1", + "primaryServer": "ldaps://1.1.1.1:636/", + "secondaryServer": "ldaps://1.1.1.2:636/", + "ssl": "Enabled" + } + ], + "internet": "Disabled", + "provisioningState": "Succeeded" + }, + "tags": {}, + "type": "Microsoft.AVS/privateClouds" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_List.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_List.json new file mode 100644 index 000000000000..9fa095b684de --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_List.json @@ -0,0 +1,63 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", + "location": "eastus2", + "name": "cloud1", + "sku": { + "name": "AV36" + }, + "properties": { + "networkBlock": "192.168.48.0/22", + "circuit": { + "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", + "primarySubnet": "192.168.53.0/30", + "secondarySubnet": "192.168.53.4/30", + "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" + }, + "managementCluster": { + "clusterId": 1, + "clusterSize": 4, + "hosts": [ + "fakehost18.nyc1.kubernetes.center", + "fakehost19.nyc1.kubernetes.center", + "fakehost20.nyc1.kubernetes.center", + "fakehost21.nyc1.kubernetes.center" + ] + }, + "endpoints": { + "nsxtManager": "https://192.168.50.3/", + "vcsa": "https://192.168.50.2/", + "hcxCloudManager": "https://192.168.50.4/" + }, + "identitySources": [ + { + "alias": "groupAlias", + "baseGroupDN": "ou=baseGroup", + "baseUserDN": "ou=baseUser", + "domain": "domain1", + "name": "group1", + "primaryServer": "ldaps://1.1.1.1:636/", + "secondaryServer": "ldaps://1.1.1.2:636/", + "ssl": "Enabled" + } + ], + "internet": "Disabled", + "provisioningState": "Succeeded" + }, + "tags": {}, + "type": "Microsoft.AVS/privateClouds" + } + ] + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListAdminCredentials.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListAdminCredentials.json new file mode 100644 index 000000000000..d7652c5fff6d --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListAdminCredentials.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1" + }, + "responses": { + "200": { + "body": { + "nsxtPassword": "$(1X4Dkk", + "nsxtUsername": "admin", + "vcenterPassword": "iG17wC^-", + "vcenterUsername": "cloudadmin@vmcp.local" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListInSubscription.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListInSubscription.json new file mode 100644 index 000000000000..5f5c1555c0a9 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_ListInSubscription.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": [ + { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", + "location": "eastus2", + "name": "cloud1", + "sku": { + "name": "AV36" + }, + "properties": { + "networkBlock": "192.168.48.0/22", + "circuit": { + "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", + "primarySubnet": "192.168.53.0/30", + "secondarySubnet": "192.168.53.4/30", + "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" + }, + "managementCluster": { + "clusterId": 1, + "clusterSize": 4, + "hosts": [ + "fakehost18.nyc1.kubernetes.center", + "fakehost19.nyc1.kubernetes.center", + "fakehost20.nyc1.kubernetes.center", + "fakehost21.nyc1.kubernetes.center" + ] + }, + "endpoints": { + "nsxtManager": "https://192.168.50.3/", + "vcsa": "https://192.168.50.2/", + "hcxCloudManager": "https://192.168.50.4/" + }, + "identitySources": [ + { + "alias": "groupAlias", + "baseGroupDN": "ou=baseGroup", + "baseUserDN": "ou=baseUser", + "domain": "domain1", + "name": "group1", + "primaryServer": "ldaps://1.1.1.1:636/", + "secondaryServer": "ldaps://1.1.1.2:636/", + "ssl": "Enabled" + } + ], + "internet": "Disabled", + "provisioningState": "Succeeded" + }, + "tags": {}, + "type": "Microsoft.AVS/privateClouds" + } + ] + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Update.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Update.json new file mode 100644 index 000000000000..2ea9820cebe1 --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/examples/PrivateClouds_Update.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2020-03-20", + "subscriptionId": "{subscription-id}", + "resourceGroupName": "group1", + "privateCloudName": "cloud1", + "privateCloudUpdate": { + "properties": { + "managementCluster": { + "clusterSize": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", + "location": "eastus2", + "name": "cloud1", + "sku": { + "name": "AV36" + }, + "properties": { + "networkBlock": "192.168.48.0/22", + "circuit": { + "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", + "primarySubnet": "192.168.53.0/30", + "secondarySubnet": "192.168.53.4/30", + "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" + }, + "managementCluster": { + "clusterId": 1, + "clusterSize": 4, + "hosts": [ + "fakehost18.nyc1.kubernetes.center", + "fakehost19.nyc1.kubernetes.center", + "fakehost20.nyc1.kubernetes.center", + "fakehost21.nyc1.kubernetes.center" + ] + }, + "endpoints": { + "nsxtManager": "https://192.168.50.3/", + "vcsa": "https://192.168.50.2/", + "hcxCloudManager": "https://192.168.50.4/" + }, + "identitySources": [ + { + "alias": "groupAlias", + "baseGroupDN": "ou=baseGroup", + "baseUserDN": "ou=baseUser", + "domain": "domain1", + "name": "group1", + "primaryServer": "ldaps://1.1.1.1:636/", + "secondaryServer": "ldaps://1.1.1.2:636/", + "ssl": "Enabled" + } + ], + "internet": "Disabled", + "provisioningState": "Succeeded" + }, + "tags": {}, + "type": "Microsoft.AVS/privateClouds" + } + }, + "201": { + "body": { + "id": "/subscriptions/{subscription-id}/resourceGroups/group1/providers/Microsoft.AVS/privateClouds/cloud1", + "location": "eastus2", + "name": "cloud1", + "sku": "AV36", + "properties": { + "networkBlock": "192.168.48.0/22", + "circuit": { + "expressRouteID": "/subscriptions/{subscription-id}/resourceGroups/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2/providers/Microsoft.Network/expressroutecircuits/tnt13-41a90db2-9d5e-4bd5-a77a-5ce7b58213d6-eastus2-xconnect", + "primarySubnet": "192.168.53.0/30", + "secondarySubnet": "192.168.53.4/30", + "expressRoutePrivatePeeringID": "/subscriptions/{subscription-id}/resourceGroups/tnt42-cust-p01-dmo01/providers/Microsoft.Network/expressroutecircuits/tnt42-cust-p01-dmo01-er/peerings/AzurePrivatePeering" + }, + "managementCluster": { + "clusterId": 1, + "clusterSize": 4, + "hosts": [ + "fakehost18.nyc1.kubernetes.center", + "fakehost19.nyc1.kubernetes.center", + "fakehost20.nyc1.kubernetes.center", + "fakehost21.nyc1.kubernetes.center" + ] + }, + "endpoints": { + "nsxtManager": "https://192.168.50.3/", + "vcsa": "https://192.168.50.2/" + }, + "identitySources": [ + { + "alias": "groupAlias", + "baseGroupDN": "ou=baseGroup", + "baseUserDN": "ou=baseUser", + "domain": "domain1", + "name": "group1", + "primaryServer": "ldaps://1.1.1.1:636/", + "secondaryServer": "ldaps://1.1.1.2:636/", + "ssl": "Enabled" + } + ], + "internet": "Disabled", + "provisioningState": "Updating" + }, + "tags": {}, + "type": "Microsoft.AVS/privateClouds" + } + } + } +} diff --git a/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/vmware.json b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/vmware.json new file mode 100644 index 000000000000..1a8d82df26ce --- /dev/null +++ b/specification/vmware/resource-manager/Microsoft.AVS/stable/2020-03-20/vmware.json @@ -0,0 +1,1897 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure VMware Solution API", + "description": "Azure VMware Solution API", + "version": "2020-03-20" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "tags": [ + { + "name": "PrivateClouds", + "description": "" + }, + { + "name": "Clusters", + "description": "" + }, + { + "name": "Operations", + "description": "" + }, + { + "name": "Locations", + "description": "" + }, + { + "name": "HcxEnterpriseSites", + "description": "" + }, + { + "name": "Authorizations", + "description": "" + } + ], + "parameters": { + "privateCloudName": { + "name": "privateCloudName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the private cloud", + "x-ms-parameter-location": "method" + }, + "clusterName": { + "name": "clusterName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the cluster in the private cloud", + "x-ms-parameter-location": "method" + }, + "hcxEnterpriseSiteName": { + "name": "hcxEnterpriseSiteName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the HCX Enterprise Site in the private cloud", + "x-ms-parameter-location": "method" + }, + "authorizationName": { + "name": "authorizationName", + "in": "path", + "required": true, + "type": "string", + "description": "Name of the ExpressRoute Circuit Authorization in the private cloud", + "x-ms-parameter-location": "method" + } + }, + "paths": { + "/providers/Microsoft.AVS/operations": { + "get": { + "tags": [ + "Operations" + ], + "description": "Lists all of the available operations", + "operationId": "Operations_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request has succeeded", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkTrialAvailability": { + "post": { + "tags": [ + "Locations" + ], + "description": "Return trial status for subscription by region", + "operationId": "Locations_CheckTrialAvailability", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "Azure region" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request has succeeded", + "schema": { + "$ref": "#/definitions/Trial" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CheckQuotaAvailability": { + "$ref": "./examples/Locations_CheckTrialAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/locations/{location}/checkQuotaAvailability": { + "post": { + "tags": [ + "Locations" + ], + "description": "Return quota for subscription by region", + "operationId": "Locations_CheckQuotaAvailability", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "Azure region" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Request has succeeded", + "schema": { + "$ref": "#/definitions/Quota" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "CheckQuotaAvailability": { + "$ref": "./examples/Locations_CheckQuotaAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds": { + "get": { + "operationId": "PrivateClouds_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "PrivateClouds" + ], + "summary": "List private clouds in a resource group", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PrivateCloudList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PrivateClouds_List": { + "$ref": "./examples/PrivateClouds_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.AVS/privateClouds": { + "get": { + "operationId": "PrivateClouds_ListInSubscription", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "PrivateClouds" + ], + "summary": "List private clouds in a subscription", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PrivateCloudList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PrivateClouds_List": { + "$ref": "./examples/PrivateClouds_ListInSubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}": { + "get": { + "operationId": "PrivateClouds_Get", + "tags": [ + "PrivateClouds" + ], + "summary": "Get a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PrivateCloud" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PrivateClouds_Get": { + "$ref": "./examples/PrivateClouds_Get.json" + } + } + }, + "put": { + "operationId": "PrivateClouds_CreateOrUpdate", + "x-ms-long-running-operation": true, + "tags": [ + "PrivateClouds" + ], + "summary": "Create or update a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "name": "privateCloud", + "description": "The private cloud", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateCloud" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PrivateCloud" + } + }, + "201": { + "description": "accepted operation", + "schema": { + "$ref": "#/definitions/PrivateCloud" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PrivateClouds_CreateOrUpdate": { + "$ref": "./examples/PrivateClouds_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "PrivateClouds_Update", + "x-ms-long-running-operation": true, + "tags": [ + "PrivateClouds" + ], + "summary": "Update a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "name": "privateCloudUpdate", + "description": "The private cloud properties to be updated", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateCloudUpdate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/PrivateCloud" + } + }, + "201": { + "description": "accepted operation", + "schema": { + "$ref": "#/definitions/PrivateCloud" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PrivateClouds_Update": { + "$ref": "./examples/PrivateClouds_Update.json" + } + } + }, + "delete": { + "operationId": "PrivateClouds_Delete", + "x-ms-long-running-operation": true, + "tags": [ + "PrivateClouds" + ], + "summary": "Delete a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The delete has succeeded" + }, + "202": { + "description": "Accepted. The delete will complete asynchronously" + }, + "204": { + "description": "No Content. No private cloud to delete" + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PrivateClouds_Delete": { + "$ref": "./examples/PrivateClouds_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters": { + "get": { + "operationId": "Clusters_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "Clusters" + ], + "summary": "List clusters in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/ClusterList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Clusters_List": { + "$ref": "./examples/Clusters_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/clusters/{clusterName}": { + "get": { + "operationId": "Clusters_Get", + "tags": [ + "Clusters" + ], + "summary": "Get a cluster by name in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "#/parameters/clusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Clusters_Get": { + "$ref": "./examples/Clusters_Get.json" + } + } + }, + "put": { + "operationId": "Clusters_CreateOrUpdate", + "x-ms-long-running-operation": true, + "tags": [ + "Clusters" + ], + "summary": "Create or update a cluster in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private cloud." + }, + { + "$ref": "#/parameters/clusterName" + }, + { + "name": "cluster", + "description": "A cluster in the private cloud", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "accepted operation", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Clusters_CreateOrUpdate": { + "$ref": "./examples/Clusters_CreateOrUpdate.json" + } + } + }, + "patch": { + "operationId": "Clusters_Update", + "x-ms-long-running-operation": true, + "tags": [ + "Clusters" + ], + "summary": "Update a cluster in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "#/parameters/clusterName" + }, + { + "name": "clusterUpdate", + "description": "The cluster properties to be updated", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "accepted operation", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Clusters_Update": { + "$ref": "./examples/Clusters_Update.json" + } + } + }, + "delete": { + "operationId": "Clusters_Delete", + "x-ms-long-running-operation": true, + "tags": [ + "Clusters" + ], + "summary": "Delete a cluster in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "#/parameters/clusterName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The delete has succeeded" + }, + "202": { + "description": "Accepted. The delete will complete asynchronously" + }, + "204": { + "description": "No Content. No cluster to delete" + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Clusters_Delete": { + "$ref": "./examples/Clusters_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/listAdminCredentials": { + "post": { + "operationId": "PrivateClouds_ListAdminCredentials", + "tags": [ + "PrivateClouds" + ], + "summary": "List the admin credentials for the private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/AdminCredentials" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "PrivateClouds_ListAdminCredentials": { + "$ref": "./examples/PrivateClouds_ListAdminCredentials.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites": { + "get": { + "operationId": "HcxEnterpriseSites_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "HcxEnterpriseSites" + ], + "summary": "List HCX Enterprise Sites in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/HcxEnterpriseSiteList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "HcxEnterpriseSites_List": { + "$ref": "./examples/HcxEnterpriseSites_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/hcxEnterpriseSites/{hcxEnterpriseSiteName}": { + "get": { + "operationId": "HcxEnterpriseSites_Get", + "tags": [ + "HcxEnterpriseSites" + ], + "summary": "Get an HCX Enterprise Site by name in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "#/parameters/hcxEnterpriseSiteName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/HcxEnterpriseSite" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "HcxEnterpriseSites_Get": { + "$ref": "./examples/HcxEnterpriseSites_Get.json" + } + } + }, + "put": { + "operationId": "HcxEnterpriseSites_CreateOrUpdate", + "tags": [ + "HcxEnterpriseSites" + ], + "summary": "Create or update an HCX Enterprise Site in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private cloud." + }, + { + "$ref": "#/parameters/hcxEnterpriseSiteName" + }, + { + "name": "hcxEnterpriseSite", + "description": "The HCX Enterprise Site", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful update", + "schema": { + "$ref": "#/definitions/HcxEnterpriseSite" + } + }, + "201": { + "description": "successful create", + "schema": { + "$ref": "#/definitions/HcxEnterpriseSite" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "HcxEnterpriseSites_CreateOrUpdate": { + "$ref": "./examples/HcxEnterpriseSites_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "HcxEnterpriseSites_Delete", + "tags": [ + "HcxEnterpriseSites" + ], + "summary": "Delete an HCX Enterprise Site in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "#/parameters/hcxEnterpriseSiteName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The delete has succeeded" + }, + "204": { + "description": "No Content. No HCX Enterprise Site to delete" + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "HcxEnterpriseSites_Delete": { + "$ref": "./examples/HcxEnterpriseSites_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations": { + "get": { + "operationId": "Authorizations_List", + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "tags": [ + "Authorizations" + ], + "summary": "List ExpressRoute Circuit Authorizations in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/ExpressRouteAuthorizationList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Authorizations_List": { + "$ref": "./examples/Authorizations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AVS/privateClouds/{privateCloudName}/authorizations/{authorizationName}": { + "get": { + "operationId": "Authorizations_Get", + "tags": [ + "Authorizations" + ], + "summary": "Get an ExpressRoute Circuit Authorization by name in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "#/parameters/authorizationName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/ExpressRouteAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Authorizations_Get": { + "$ref": "./examples/Authorizations_Get.json" + } + } + }, + "put": { + "operationId": "Authorizations_CreateOrUpdate", + "x-ms-long-running-operation": true, + "tags": [ + "Authorizations" + ], + "summary": "Create or update an ExpressRoute Circuit Authorization in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "name": "privateCloudName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private cloud." + }, + { + "$ref": "#/parameters/authorizationName" + }, + { + "name": "authorization", + "description": "An ExpressRoute Circuit Authorization", + "in": "body", + "required": true, + "schema": { + "type": "object" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "successful operation", + "schema": { + "$ref": "#/definitions/ExpressRouteAuthorization" + } + }, + "201": { + "description": "accepted operation", + "schema": { + "$ref": "#/definitions/ExpressRouteAuthorization" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Authorizations_CreateOrUpdate": { + "$ref": "./examples/Authorizations_CreateOrUpdate.json" + } + } + }, + "delete": { + "operationId": "Authorizations_Delete", + "x-ms-long-running-operation": true, + "tags": [ + "Authorizations" + ], + "summary": "Delete an ExpressRoute Circuit Authorization in a private cloud", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/privateCloudName" + }, + { + "$ref": "#/parameters/authorizationName" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The delete has succeeded" + }, + "202": { + "description": "Accepted. The delete will complete asynchronously" + }, + "204": { + "description": "No Content. No ExpressRoute Circuit Authorization to delete" + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "Authorizations_Delete": { + "$ref": "./examples/Authorizations_Delete.json" + } + } + } + } + }, + "definitions": { + "Trial": { + "description": "Subscription trial availability", + "properties": { + "status": { + "description": "Trial status", + "type": "string", + "enum": [ + "TrialAvailable", + "TrialUsed", + "TrialDisabled" + ], + "readOnly": true, + "x-ms-enum": { + "name": "TrialStatus", + "modelAsString": true + } + }, + "availableHosts": { + "description": "Number of trial hosts available", + "type": "integer", + "readOnly": true + } + } + }, + "Quota": { + "description": "Subscription quotas", + "properties": { + "hostsRemaining": { + "description": "Remaining hosts quota by sku type", + "type": "object", + "readOnly": true, + "additionalProperties": { + "type": "integer", + "readOnly": true + } + }, + "quotaEnabled": { + "description": "Host quota is active for current subscription", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "readOnly": true, + "x-ms-enum": { + "name": "QuotaEnabled", + "modelAsString": true + } + } + } + }, + "Resource": { + "description": "The core properties of ARM resources", + "properties": { + "id": { + "description": "Resource ID.", + "readOnly": true, + "type": "string" + }, + "name": { + "description": "Resource name.", + "readOnly": true, + "type": "string" + }, + "type": { + "description": "Resource type.", + "readOnly": true, + "type": "string" + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location" + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags" + } + } + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "description": "An error returned by the API", + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + }, + "description": "API error response" + }, + "OperationList": { + "description": "Pageable list of operations", + "properties": { + "value": { + "description": "List of operations", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next page if any", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation being performed on this object", + "type": "string", + "readOnly": true + }, + "display": { + "description": "Contains the localized display information for this operation", + "readOnly": true, + "properties": { + "provider": { + "description": "Localized friendly form of the resource provider name", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "Localized friendly form of the resource type related to this operation", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "Localized friendly name for the operation", + "type": "string", + "readOnly": true + }, + "description": { + "description": "Localized friendly description for the operation", + "type": "string", + "readOnly": true + } + } + } + } + }, + "ExpressRouteAuthorization": { + "description": "ExpressRoute Circuit Authorization", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The properties of an ExpressRoute Circuit Authorization resource", + "$ref": "#/definitions/ExpressRouteAuthorizationProperties", + "x-ms-client-flatten": true + } + } + }, + "ExpressRouteAuthorizationProperties": { + "description": "The properties of an ExpressRoute Circuit Authorization resource", + "properties": { + "provisioningState": { + "description": "The state of the ExpressRoute Circuit Authorization provisioning", + "type": "string", + "readOnly": true, + "enum": [ + "Succeeded", + "Failed", + "Updating" + ], + "x-ms-enum": { + "name": "ExpressRouteAuthorizationProvisioningState", + "modelAsString": true + } + }, + "expressRouteAuthorizationId": { + "description": "The ID of the ExpressRoute Circuit Authorization", + "type": "string", + "readOnly": true + }, + "expressRouteAuthorizationKey": { + "description": "The key of the ExpressRoute Circuit Authorization", + "type": "string", + "readOnly": true + } + } + }, + "ExpressRouteAuthorizationList": { + "description": "A paged list of ExpressRoute Circuit Authorizations", + "properties": { + "value": { + "description": "The items on a page", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ExpressRouteAuthorization" + } + }, + "nextLink": { + "description": "URL to get the next page if any", + "type": "string", + "readOnly": true + } + } + }, + "Circuit": { + "description": "An ExpressRoute Circuit", + "properties": { + "primarySubnet": { + "type": "string", + "readOnly": true, + "description": "CIDR of primary subnet" + }, + "secondarySubnet": { + "type": "string", + "readOnly": true, + "description": "CIDR of secondary subnet" + }, + "expressRouteID": { + "type": "string", + "readOnly": true, + "description": "Identifier of the ExpressRoute Circuit (Microsoft Colo only)" + }, + "expressRoutePrivatePeeringID": { + "type": "string", + "readOnly": true, + "description": "ExpressRoute Circuit private peering identifier" + } + } + }, + "Endpoints": { + "description": "Endpoint addresses", + "properties": { + "nsxtManager": { + "description": "Endpoint for the NSX-T Data Center manager", + "type": "string", + "readOnly": true + }, + "vcsa": { + "description": "Endpoint for Virtual Center Server Appliance", + "type": "string", + "readOnly": true + }, + "hcxCloudManager": { + "description": "Endpoint for the HCX Cloud Manager", + "type": "string", + "readOnly": true + } + } + }, + "IdentitySource": { + "description": "vCenter Single Sign On Identity Source", + "properties": { + "name": { + "description": "The name of the identity source", + "type": "string" + }, + "alias": { + "description": "The domain's NetBIOS name", + "type": "string" + }, + "domain": { + "description": "The domain's dns name", + "type": "string" + }, + "baseUserDN": { + "description": "The base distinguished name for users", + "type": "string" + }, + "baseGroupDN": { + "description": "The base distinguished name for groups", + "type": "string" + }, + "primaryServer": { + "description": "Primary server URL", + "type": "string" + }, + "secondaryServer": { + "description": "Secondary server URL", + "type": "string" + }, + "ssl": { + "description": "Protect LDAP communication using SSL certificate (LDAPS)", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "SslEnum", + "modelAsString": true + } + }, + "username": { + "description": "The ID of an Active Directory user with a minimum of read-only access to Base DN for users and group", + "type": "string" + }, + "password": { + "description": "The password of the Active Directory user with a minimum of read-only access to Base DN for users and groups.", + "type": "string", + "x-ms-secret": true + } + } + }, + "PrivateCloud": { + "description": "A private cloud resource", + "required": [ + "location", + "sku", + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "description": "The private cloud SKU", + "$ref": "#/definitions/Sku" + }, + "properties": { + "description": "The properties of a private cloud resource", + "$ref": "#/definitions/PrivateCloudProperties", + "x-ms-client-flatten": true + } + } + }, + "PrivateCloudUpdate": { + "description": "An update to a private cloud resource", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags." + }, + "properties": { + "description": "The updatable properties of a private cloud resource", + "$ref": "#/definitions/PrivateCloudUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "PrivateCloudUpdateProperties": { + "description": "The properties of a private cloud resource that may be updated", + "properties": { + "managementCluster": { + "description": "The default cluster used for management", + "$ref": "#/definitions/ManagementCluster" + }, + "internet": { + "description": "Connectivity to internet is enabled or disabled", + "type": "string", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "InternetEnum", + "modelAsString": true + } + }, + "identitySources": { + "description": "vCenter Single Sign On Identity Sources", + "type": "array", + "items": { + "$ref": "#/definitions/IdentitySource" + } + } + } + }, + "PrivateCloudProperties": { + "description": "The properties of a private cloud resource", + "required": [ + "managementCluster", + "networkBlock" + ], + "allOf": [ + { + "$ref": "#/definitions/PrivateCloudUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "description": "The provisioning state", + "type": "string", + "readOnly": true, + "enum": [ + "Succeeded", + "Failed", + "Cancelled", + "Pending", + "Building", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "PrivateCloudProvisioningState", + "modelAsString": true + } + }, + "circuit": { + "description": "An ExpressRoute Circuit", + "$ref": "#/definitions/Circuit" + }, + "endpoints": { + "description": "The endpoints", + "readOnly": true, + "$ref": "#/definitions/Endpoints" + }, + "networkBlock": { + "description": "The block of addresses should be unique across VNet in your subscription as well as on-premise. Make sure the CIDR format is conformed to (A.B.C.D/X) where A,B,C,D are between 0 and 255, and X is between 0 and 22", + "type": "string" + }, + "managementNetwork": { + "description": "Network used to access vCenter Server and NSX-T Manager", + "type": "string", + "readOnly": true + }, + "provisioningNetwork": { + "description": "Used for virtual machine cold migration, cloning, and snapshot migration", + "type": "string", + "readOnly": true + }, + "vmotionNetwork": { + "description": "Used for live migration of virtual machines", + "type": "string", + "readOnly": true + }, + "vcenterPassword": { + "description": "Optionally, set the vCenter admin password when the private cloud is created", + "type": "string", + "x-ms-secret": true + }, + "nsxtPassword": { + "description": "Optionally, set the NSX-T Manager password when the private cloud is created", + "type": "string", + "x-ms-secret": true + }, + "vcenterCertificateThumbprint": { + "description": "Thumbprint of the vCenter Server SSL certificate", + "type": "string", + "readOnly": true + }, + "nsxtCertificateThumbprint": { + "description": "Thumbprint of the NSX-T Manager SSL certificate", + "type": "string", + "readOnly": true + } + } + }, + "Cluster": { + "description": "A cluster resource", + "required": [ + "sku", + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "sku": { + "description": "The cluster SKU", + "$ref": "#/definitions/Sku" + }, + "properties": { + "description": "The properties of a cluster resource", + "$ref": "#/definitions/ClusterProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterUpdate": { + "description": "An update of a cluster resource", + "properties": { + "properties": { + "description": "The properties of a cluster resource that may be updated", + "$ref": "#/definitions/ClusterUpdateProperties", + "x-ms-client-flatten": true + } + } + }, + "ClusterUpdateProperties": { + "description": "The properties of a cluster that may be updated", + "properties": { + "clusterSize": { + "description": "The cluster size", + "type": "integer" + } + } + }, + "ManagementCluster": { + "description": "The properties of a default cluster", + "required": [ + "clusterSize" + ], + "allOf": [ + { + "$ref": "#/definitions/ClusterUpdateProperties" + } + ], + "properties": { + "clusterId": { + "description": "The identity", + "type": "integer", + "readOnly": true + }, + "hosts": { + "description": "The hosts", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "ClusterProperties": { + "description": "The properties of a cluster", + "allOf": [ + { + "$ref": "#/definitions/ManagementCluster" + } + ], + "properties": { + "provisioningState": { + "description": "The state of the cluster provisioning", + "type": "string", + "readOnly": true, + "enum": [ + "Succeeded", + "Failed", + "Cancelled", + "Deleting", + "Updating" + ], + "x-ms-enum": { + "name": "ClusterProvisioningState", + "modelAsString": true + } + } + } + }, + "PrivateCloudList": { + "description": "A paged list of private clouds", + "properties": { + "value": { + "description": "The items on the page", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/PrivateCloud" + } + }, + "nextLink": { + "description": "URL to get the next page if any", + "type": "string", + "readOnly": true + } + } + }, + "ClusterList": { + "description": "A paged list of clusters", + "properties": { + "value": { + "description": "The items on a page", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Cluster" + } + }, + "nextLink": { + "description": "URL to get the next page if any", + "type": "string", + "readOnly": true + } + } + }, + "AdminCredentials": { + "description": "Administrative credentials for accessing vCenter and NSX-T", + "properties": { + "nsxtUsername": { + "description": "NSX-T Manager username", + "type": "string", + "readOnly": true + }, + "nsxtPassword": { + "description": "NSX-T Manager password", + "type": "string", + "readOnly": true, + "x-ms-secret": true + }, + "vcenterUsername": { + "description": "vCenter admin username", + "type": "string", + "readOnly": true + }, + "vcenterPassword": { + "description": "vCenter admin password", + "type": "string", + "readOnly": true, + "x-ms-secret": true + } + } + }, + "Sku": { + "description": "The resource model definition representing SKU", + "properties": { + "name": { + "type": "string", + "description": "The name of the SKU." + } + }, + "required": [ + "name" + ] + }, + "HcxEnterpriseSiteList": { + "description": "A paged list of HCX Enterprise Sites", + "properties": { + "value": { + "description": "The items on a page", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/HcxEnterpriseSite" + } + }, + "nextLink": { + "description": "URL to get the next page if any", + "type": "string", + "readOnly": true + } + } + }, + "HcxEnterpriseSite": { + "description": "An HCX Enterprise Site resource", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "The properties of an HCX Enterprise Site resource", + "$ref": "#/definitions/HcxEnterpriseSiteProperties", + "x-ms-client-flatten": true + } + } + }, + "HcxEnterpriseSiteProperties": { + "description": "The properties of an HCX Enterprise Site", + "properties": { + "activationKey": { + "description": "The activation key", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The status of the HCX Enterprise Site", + "type": "string", + "readOnly": true, + "enum": [ + "Available", + "Consumed", + "Deactivated", + "Deleted" + ], + "x-ms-enum": { + "name": "HcxEnterpriseSiteStatus", + "modelAsString": true + } + } + } + } + } +} diff --git a/specification/vmware/resource-manager/readme.go.md b/specification/vmware/resource-manager/readme.go.md index 1e87a5f5d07b..86e7eb2df060 100644 --- a/specification/vmware/resource-manager/readme.go.md +++ b/specification/vmware/resource-manager/readme.go.md @@ -13,9 +13,19 @@ go: ``` yaml $(go) && $(multiapi) batch: + - tag: package-2020-03-20 - tag: package-2019-08-09-preview ``` +### Tag: package-2020-03-20 and go + +These settings apply only when `--tag=package-2020-03-20 --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-03-20' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-03-20/$(namespace) +``` + ### Tag: package-2019-08-09-preview and go These settings apply only when `--tag=package-2019-08-09-preview --go` is specified on the command line. diff --git a/specification/vmware/resource-manager/readme.java.md b/specification/vmware/resource-manager/readme.java.md index 4d9b9ee0af9b..0962072b7879 100644 --- a/specification/vmware/resource-manager/readme.java.md +++ b/specification/vmware/resource-manager/readme.java.md @@ -16,9 +16,23 @@ java: ``` yaml $(java) && $(multiapi) batch: + - tag: package-2020-03-20 - tag: package-2019-08-09-preview ``` +### Tag: package-2020-03-20 and java + +These settings apply only when `--tag=package-2020-03-20 --java` is specified on the command line. +Please also specify the `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-03-20' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.avs.v2020_03_20 + output-folder: $(azure-libraries-for-java-folder)/sdk/avs/mgmt-v2020_03_20 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2019-08-09-preview and java These settings apply only when `--tag=package-2019-08-09 --java` is specified on the command line. diff --git a/specification/vmware/resource-manager/readme.md b/specification/vmware/resource-manager/readme.md index 89553bfed17c..05a79fd9de3a 100644 --- a/specification/vmware/resource-manager/readme.md +++ b/specification/vmware/resource-manager/readme.md @@ -21,7 +21,23 @@ These are the global settings for the VMware Solution API. ``` yaml openapi-type: arm -tag: package-2019-08-09-preview +tag: package-2020-03-20 +``` + +### Tag: package-2020-03-20 + +These settings apply only when `--tag=package-2020-03-20` is specified on the command line. + +``` yaml $(tag) == 'package-2020-03-20' +input-file: +- Microsoft.AVS/stable/2020-03-20/vmware.json +directive: + - suppress: R3020 + from: vmware.json + reason: Microsoft.AVS was chosen over Microsoft.AzureVMwareSolution + - suppress: R3010 + from: vmware.json + reason: list by immediate parent operations are defined ``` ### Tag: package-2019-08-09-preview @@ -92,6 +108,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.AVS/stable/2020-03-20/vmware.json - $(this-folder)/Microsoft.AVS/preview/2019-08-09-preview/vmware.json ``` From be2510a84b5da51c9b83d1a9fddf148bb7f15ef3 Mon Sep 17 00:00:00 2001 From: Aditi Mukhtyar <67336737+admukhty@users.noreply.github.com> Date: Wed, 1 Jul 2020 19:45:49 -0700 Subject: [PATCH 254/318] Updating Microsoft.Insights swagger spec to include api-version for Management groups (#9938) --- ...pdateManagementGroupDiagnosticSetting.json | 51 +++ ...eleteManagementGroupDiagnosticSetting.json | 11 + .../getManagementGroupDiagnosticSetting.json | 33 ++ ...listManagementGroupDiagnosticSettings.json | 35 ++ ...managementGroupDiagnosticSettings_API.json | 345 ++++++++++++++++++ .../monitor/resource-manager/readme.md | 10 + .../monitor/resource-manager/readme.python.md | 15 + 7 files changed, 500 insertions(+) create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/createOrUpdateManagementGroupDiagnosticSetting.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/deleteManagementGroupDiagnosticSetting.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/getManagementGroupDiagnosticSetting.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/listManagementGroupDiagnosticSettings.json create mode 100644 specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/createOrUpdateManagementGroupDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/createOrUpdateManagementGroupDiagnosticSetting.json new file mode 100644 index 000000000000..c765841de5f9 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/createOrUpdateManagementGroupDiagnosticSetting.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "managementGroupId": "testChildMG7", + "name": "setting1", + "api-version": "2020-01-01-preview", + "parameters": { + "properties": { + "storageAccountId": "/subscriptions/bfaef57f-297e-4210-bfe5-27c18cc671f7/resourceGroups/FuncAppRunners/providers/Microsoft.Storage/storageAccounts/testpersonalb6a5", + "workspaceId": "/subscriptions/9cf7cc0a-0ba1-4624-bc82-97e1ee25dc45/resourceGroups/mgTest/providers/Microsoft.OperationalInsights/workspaces/mgTestWorkspace", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "eventHubName": "myeventhub", + "logs": [ + { + "category": "Administrative", + "enabled": true + }, + { + "category": "Policy", + "enabled": true + } + ] + } + } + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "providers/Microsoft.Management/managementGroups/testChildMG7/providers/microsoft.insights/diagnosticSettings/setting1", + "type": "Microsoft.Insights/diagnosticSettings", + "name": "setting1", + "location": "global", + "properties": { + "storageAccountId": "/subscriptions/bfaef57f-297e-4210-bfe5-27c18cc671f7/resourceGroups/FuncAppRunners/providers/Microsoft.Storage/storageAccounts/testpersonalb6a5", + "workspaceId": "/subscriptions/9cf7cc0a-0ba1-4624-bc82-97e1ee25dc45/resourceGroups/mgTest/providers/Microsoft.OperationalInsights/workspaces/mgTestWorkspace", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "logs": [ + { + "category": "Administrative", + "enabled": true + }, + { + "category": "Policy", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/deleteManagementGroupDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/deleteManagementGroupDiagnosticSetting.json new file mode 100644 index 000000000000..5c1d1c0d10a2 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/deleteManagementGroupDiagnosticSetting.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "managementGroupId": "testChildMG7", + "name": "setting1", + "api-version": "2020-01-01-preview" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/getManagementGroupDiagnosticSetting.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/getManagementGroupDiagnosticSetting.json new file mode 100644 index 000000000000..1268d7325b59 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/getManagementGroupDiagnosticSetting.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "managementGroupId": "testChildMG7", + "name": "setting1", + "api-version": "2020-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "id": "providers/Microsoft.Management/managementGroups/testChildMG7/providers/microsoft.insights/diagnosticSettings/setting1", + "type": "Microsoft.Insights/diagnosticSettings", + "name": "setting1", + "location": "global", + "properties": { + "storageAccountId": "/subscriptions/bfaef57f-297e-4210-bfe5-27c18cc671f7/resourceGroups/FuncAppRunners/providers/Microsoft.Storage/storageAccounts/testpersonalb6a5", + "workspaceId": "/subscriptions/9cf7cc0a-0ba1-4624-bc82-97e1ee25dc45/resourceGroups/mgTest/providers/Microsoft.OperationalInsights/workspaces/mgTestWorkspace", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "logs": [ + { + "category": "Administrative", + "enabled": true + }, + { + "category": "Policy", + "enabled": true + } + ] + } + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/listManagementGroupDiagnosticSettings.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/listManagementGroupDiagnosticSettings.json new file mode 100644 index 000000000000..4da36a78f062 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/examples/listManagementGroupDiagnosticSettings.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "managementGroupId": "testChildMG7", + "api-version": "2020-01-01-preview" + }, + "responses": { + "200": { + "headers": {}, + "body": { + "value": [ + { + "id": "providers/Microsoft.Management/managementGroups/testChildMG7/providers/microsoft.insights/diagnosticSettings/setting1", + "type": "Microsoft.Insights/diagnosticSettings", + "name": "setting1", + "properties": { + "storageAccountId": "/subscriptions/bfaef57f-297e-4210-bfe5-27c18cc671f7/resourceGroups/FuncAppRunners/providers/Microsoft.Storage/storageAccounts/testpersonalb6a5", + "workspaceId": "/subscriptions/9cf7cc0a-0ba1-4624-bc82-97e1ee25dc45/resourceGroups/mgTest/providers/Microsoft.OperationalInsights/workspaces/mgTestWorkspace", + "eventHubAuthorizationRuleId": "/subscriptions/fb9f25f9-5785-4510-a38f-a62f188eb9f8/resourceGroups/montest/providers/microsoft.eventhub/namespaces/mynamespace/eventhubs/myeventhub/authorizationrules/myrule", + "logs": [ + { + "category": "Administrative", + "enabled": true + }, + { + "category": "Policy", + "enabled": true + } + ] + } + } + ] + } + } + } +} diff --git a/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json new file mode 100644 index 000000000000..c072d651d2f7 --- /dev/null +++ b/specification/monitor/resource-manager/Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json @@ -0,0 +1,345 @@ +{ + "swagger": "2.0", + "info": { + "title": "MonitorManagementClient", + "x-ms-code-generation-settings": { + "name": "MonitorManagementClient" + }, + "version": "2020-01-01-preview" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/microsoft.management/managementGroups/{managementGroupId}/providers/microsoft.insights/diagnosticSettings/{name}": { + "get": { + "tags": [ + "ManagementGroupDiagnosticSettings" + ], + "operationId": "ManagementGroupDiagnosticSettings_Get", + "description": "Gets the active management group diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get more information about diagnostic setting.", + "schema": { + "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" + } + } + }, + "x-ms-examples": { + "Gets the management group diagnostic setting": { + "$ref": "./examples/getManagementGroupDiagnosticSetting.json" + } + } + }, + "put": { + "tags": [ + "ManagementGroupDiagnosticSettings" + ], + "operationId": "ManagementGroupDiagnosticSettings_CreateOrUpdate", + "description": "Creates or updates management group diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" + }, + "description": "Parameters supplied to the operation." + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to create a management group diagnostic setting", + "schema": { + "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" + } + } + }, + "x-ms-examples": { + "Creates or Updates the management group diagnostic setting": { + "$ref": "./examples/createOrUpdateManagementGroupDiagnosticSetting.json" + } + } + }, + "delete": { + "tags": [ + "ManagementGroupDiagnosticSettings" + ], + "operationId": "ManagementGroupDiagnosticSettings_Delete", + "description": "Deletes existing management group diagnostic settings for the specified resource.", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/NameParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to remove a management group diagnostic setting" + }, + "204": { + "description": "Successful request to remove a management group diagnostic setting" + } + }, + "x-ms-examples": { + "Deletes the management group diagnostic setting": { + "$ref": "./examples/deleteManagementGroupDiagnosticSetting.json" + } + } + } + }, + "/providers/microsoft.management/managementGroups/{managementGroupId}/providers/microsoft.insights/diagnosticSettings": { + "get": { + "tags": [ + "ManagementGroupDiagnosticSettings" + ], + "operationId": "ManagementGroupDiagnosticSettings_List", + "description": "Gets the active management group diagnostic settings list for the specified management group.", + "parameters": [ + { + "$ref": "#/parameters/ManagementGroupIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + }, + "200": { + "description": "Successful request to get more information about management group diagnostic setting", + "schema": { + "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResourceCollection" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "Gets the management group diagnostic setting": { + "$ref": "./examples/listManagementGroupDiagnosticSettings.json" + } + } + } + } + }, + "definitions": { + "ManagementGroupProxyOnlyResource": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "Azure resource Id" + }, + "name": { + "type": "string", + "readOnly": true, + "description": "Azure resource name" + }, + "type": { + "type": "string", + "readOnly": true, + "description": "Azure resource type" + }, + "location": { + "type": "string", + "description": "Location of the resource" + } + }, + "x-ms-azure-resource": true, + "description": "A proxy only azure resource object" + }, + "ManagementGroupLogSettings": { + "properties": { + "category": { + "type": "string", + "description": "Name of a Management Group Diagnostic Log category for a resource type this setting is applied to." + }, + "enabled": { + "type": "boolean", + "description": "a value indicating whether this log is enabled." + } + }, + "required": [ + "category", + "enabled" + ], + "description": "Part of Management Group diagnostic setting. Specifies the settings for a particular log." + }, + "ManagementGroupDiagnosticSettings": { + "properties": { + "storageAccountId": { + "type": "string", + "description": "The resource ID of the storage account to which you would like to send Diagnostic Logs." + }, + "serviceBusRuleId": { + "type": "string", + "description": "The service bus rule Id of the diagnostic setting. This is here to maintain backwards compatibility." + }, + "eventHubAuthorizationRuleId": { + "type": "string", + "description": "The resource Id for the event hub authorization rule." + }, + "eventHubName": { + "type": "string", + "description": "The name of the event hub. If none is specified, the default event hub will be selected." + }, + "logs": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagementGroupLogSettings" + }, + "description": "The list of logs settings." + }, + "workspaceId": { + "type": "string", + "description": "The full ARM resource ID of the Log Analytics workspace to which you would like to send Diagnostic Logs. Example: /subscriptions/4b9e8510-67ab-4e9a-95a9-e2f1e570ea9c/resourceGroups/insights-integration/providers/Microsoft.OperationalInsights/workspaces/viruela2" + } + }, + "description": "The management group diagnostic settings." + }, + "ManagementGroupDiagnosticSettingsResource": { + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ManagementGroupProxyOnlyResource" + } + ], + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ManagementGroupDiagnosticSettings", + "description": "Properties of a Management Group Diagnostic Settings Resource." + } + }, + "description": "The management group diagnostic setting resource." + }, + "ManagementGroupDiagnosticSettingsResourceCollection": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ManagementGroupDiagnosticSettingsResource" + }, + "description": "The collection of management group diagnostic settings resources." + } + }, + "description": "Represents a collection of management group diagnostic settings resources." + }, + "ErrorResponse": { + "description": "Describes the format of Error response.", + "type": "object", + "properties": { + "code": { + "description": "Error code", + "type": "string" + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client Api Version." + }, + "ManagementGroupIdParameter": { + "name": "managementGroupId", + "in": "path", + "required": true, + "type": "string", + "description": "The management group id.", + "x-ms-parameter-location": "method", + "x-ms-skip-url-encoding": true + }, + "NameParameter": { + "name": "name", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the diagnostic setting.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/monitor/resource-manager/readme.md b/specification/monitor/resource-manager/readme.md index aa10b3d13604..8f7c32bb18f6 100644 --- a/specification/monitor/resource-manager/readme.md +++ b/specification/monitor/resource-manager/readme.md @@ -31,6 +31,15 @@ openapi-type: arm tag: package-2019-06 ``` +### Tag: package-2020-01-01-preview-only + +These settings apply only when `--tag=package-2020-01-01-preview-only` is specified on the command line. + +```yaml $(tag) == 'package-2020-01-01-preview-only' +input-file: +- Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json +``` + ### Tag: package-2020-03 These settings apply only when `--tag=package-2020-03` is specified on the command line. @@ -625,6 +634,7 @@ input-file: - $(this-folder)/Microsoft.Insights/preview/2018-11-27-preview/vmInsightsOnboarding_API.json - $(this-folder)/Microsoft.Insights/preview/2019-10-17-preview/privateLinkScopes_API.json - $(this-folder)/Microsoft.Insights/preview/2017-05-01-preview/subscriptionDiagnosticsSettings_API.json + - $(this-folder)/Microsoft.Insights/preview/2020-01-01-preview/managementGroupDiagnosticSettings_API.json - $(this-folder)/Microsoft.Insights/stable/2019-03-01/actionGroups_API.json - $(this-folder)/Microsoft.Insights/stable/2018-09-01/actionGroups_API.json - $(this-folder)/Microsoft.Insights/stable/2018-03-01/actionGroups_API.json diff --git a/specification/monitor/resource-manager/readme.python.md b/specification/monitor/resource-manager/readme.python.md index 6d84860e3278..8d483156a925 100644 --- a/specification/monitor/resource-manager/readme.python.md +++ b/specification/monitor/resource-manager/readme.python.md @@ -30,6 +30,7 @@ Generate all API versions currently shipped for this package ```yaml $(multiapi) && !$(track2) batch: + - tag: package-2020-01-01-preview-only - tag: package-2019-10-17-preview-only - tag: package-2019-06-01-only - tag: package-2019-03-01-only @@ -53,6 +54,7 @@ batch: ```yaml $(multiapi) && $(track2) clear-output-folder: true batch: + - tag: package-2020-01-01-preview-only - tag: package-2019-10-17-preview-only - tag: package-2019-06-01-only - tag: package-2019-03-01-only @@ -80,6 +82,19 @@ clear-output-folder: false perform-load: false ``` +### Tag: package-2020-01-01-preview-only and python + +These settings apply only when `--tag=package-2020-01-01-preview-only --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-01-01-preview-only' +namespace: $(python-base-namespace).v2020_01_01_preview +output-folder: $(python-sdks-folder)/$(python-base-folder)/v2020_01_01_preview +python: + namespace: $(python-base-namespace).v2020_01_01_preview + output-folder: $(python-sdks-folder)/$(python-base-folder)/v2020_01_01_preview +``` + ### Tag: package-2019-10-17-preview-only and python These settings apply only when `--tag=package-2019-10-17-preview-only --python` is specified on the command line. From cc4c9386597f5056c943c4c34269c2772b94f4db Mon Sep 17 00:00:00 2001 From: phkanekal <53630238+phkanekal@users.noreply.github.com> Date: Wed, 1 Jul 2020 20:17:44 -0700 Subject: [PATCH 255/318] Add swagger spec for Synapse Sql Gen3 resources (#9873) * add swagger spec for Synapse Sql Gen3 resources * add enum values for Status * address comments --- custom-words.txt | 2 + specification/synapse/common/v1/types.json | 115 ++ .../examples/DeleteSqlDatabase.json | 14 + .../examples/DeleteSqlPool.json | 14 + .../examples/GetAvailableOperations.json | 1326 +++++++++++++++++ .../GetAzureAsyncOperationHeader.json | 25 + .../examples/GetLocationHeader.json | 21 + .../examples/GetSqlDatabase.json | 32 + .../examples/GetSqlPool.json | 38 + .../examples/ListSqlDatabasesByWorkspace.json | 54 + .../examples/ListSqlPoolsByWorkspace.json | 66 + .../examples/PatchSqlDatabase.json | 34 + .../examples/PatchSqlPool.json | 45 + .../examples/PutSqlDatabase.json | 60 + .../examples/PutSqlPool.json | 76 + .../2020-04-01-preview/operations.json | 390 +++++ .../2020-04-01-preview/sqlDatabase.json | 374 +++++ .../preview/2020-04-01-preview/sqlPool.json | 407 +++++ .../synapse/resource-manager/readme.md | 15 + 19 files changed, 3108 insertions(+) create mode 100644 specification/synapse/common/v1/types.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/DeleteSqlDatabase.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/DeleteSqlPool.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetAvailableOperations.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetAzureAsyncOperationHeader.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetLocationHeader.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetSqlDatabase.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetSqlPool.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/ListSqlDatabasesByWorkspace.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/ListSqlPoolsByWorkspace.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PatchSqlDatabase.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PatchSqlPool.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PutSqlDatabase.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PutSqlPool.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/operations.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json create mode 100644 specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json diff --git a/custom-words.txt b/custom-words.txt index 127b44f4e57b..c59d6461e5d1 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1447,9 +1447,11 @@ sparkconf sparql SPDX SQLAG +sqldatabase SQLDB SQLDW SQLMI +sqlpool SQLRDS sqlvirtualmachine sqlvm diff --git a/specification/synapse/common/v1/types.json b/specification/synapse/common/v1/types.json new file mode 100644 index 000000000000..6aaf16bf83f5 --- /dev/null +++ b/specification/synapse/common/v1/types.json @@ -0,0 +1,115 @@ +{ + "swagger": "2.0", + "info": { + "version": "v1", + "title": "Common types" + }, + "paths": {}, + "definitions": { + "ErrorContract": { + "title": "Error details.", + "description": "Contains details when the response code indicates an error.", + "type": "object", + "properties": { + "error": { + "description": "The error details.", + "$ref": "../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" + } + } + }, + "Sku": { + "description": "An ARM Resource SKU.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU, typically, a letter + Number code, e.g. P3.", + "type": "string" + }, + "tier": { + "description": "The tier or edition of the particular SKU, e.g. Basic, Premium.", + "type": "string" + } + } + }, + "SystemData": { + "description": "ARM System Data.", + "type": "object", + "properties": { + "createdBy": { + "description": "A string identifier for the identity that created the resource.", + "type": "string", + "readOnly": true + }, + "createdByType": { + "description": "The type of identity that created the resource: ", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "readOnly": true + }, + "createdAt": { + "format": "date-time", + "description": "The timestamp of resource creation (UTC).", + "type": "string", + "readOnly": true + }, + "lastModifiedBy": { + "description": "A string identifier for the identity that last modified the resource.", + "type": "string", + "readOnly": true + }, + "lastModifiedByType": { + "description": "The type of identity that last modified the resource: ", + "enum": [ + "User", + "Application", + "ManagedIdentity", + "Key" + ], + "type": "string", + "readOnly": true + }, + "lastModifiedAt": { + "format": "date-time", + "description": "The timestamp of last modification (UTC).", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "WorkspaceNameParameter": { + "name": "workspaceName", + "in": "path", + "description": "The name of the workspace.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlPoolNameParameter": { + "name": "sqlPoolName", + "in": "path", + "description": "The name of the sql pool.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SqlDatabaseNameParameter": { + "name": "sqlDatabaseName", + "in": "path", + "description": "The name of the sql database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/DeleteSqlDatabase.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/DeleteSqlDatabase.json new file mode 100644 index 000000000000..e50953c5b841 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/DeleteSqlDatabase.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "2f3558ae-f104-4a73-851c-e65379e2b603", + "resourceGroupName": "rg_0d5198a3-5ea3-4764-881b-3add9685f04a", + "workspaceName": "srv_c038a93a-ec62-41e2-ba6d-43241e032800", + "sqlDatabaseName": "77b1b250-7830-4e9e-bae2-4fef2ae1629a", + "api-version": "2020-04-01-preview" + }, + "responses": { + "202": {}, + "204": {}, + "200": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/DeleteSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/DeleteSqlPool.json new file mode 100644 index 000000000000..6c7ec0021bf8 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/DeleteSqlPool.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "7acf3c90-d2f8-463f-871f-f62d3458e5cf", + "resourceGroupName": "rg_99d213d8-4c1e-4377-9c69-302d415c7bd3", + "workspaceName": "srv_3905c586-c620-4898-99ea-add626afacaf", + "sqlPoolName": "0990ca4e-e154-4f0f-a1fe-2f6d3aafe515", + "api-version": "2020-04-01-preview" + }, + "responses": { + "202": {}, + "200": {}, + "204": {} + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetAvailableOperations.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetAvailableOperations.json new file mode 100644 index 000000000000..8cb785d7f131 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetAvailableOperations.json @@ -0,0 +1,1326 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": [ + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get Integration Runtime Operation result.", + "description": "Get any Integration Runtime." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Managed Identity SQL Control Settings", + "operation": "Update Managed Identity SQL Control Settings", + "description": "Update Managed Identity SQL Control Settings on the workspace" + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/managedIdentitySqlControlSettings/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Managed Identity SQL Control Settings", + "operation": "Get Managed Identity SQL Control Settings", + "description": "Get Managed Identity SQL Control Settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/operations/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Available Operations", + "operation": "Read Available Operations.", + "description": "Read Available Operations from the Synapse Resource Provider." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/nodes/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get Integration Runtime Node.", + "description": "Get any Integration Runtime Node." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/nodes/delete", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Delete Integration Runtime Node.", + "description": "Delete any Integration Runtime Node." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/nodes/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Patch Integration Runtime Node.", + "description": "Patch any Integration Runtime Node." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/nodes/ipAddress/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get Integration Runtime Ip Address", + "description": "Get Integration Runtime Ip Address" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationruntimes/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Create or Update Integration Runtimes.", + "description": "Create or Update any Integration Runtimes." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/delete", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Delete Integration Runtimes", + "description": "Delete any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/getStatus/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get an Integration Runtime Status", + "description": "Get any Integration Runtime's Status" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/start/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Start an Integration Runtime", + "description": "Start any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/stop/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Stop an Integration Runtime", + "description": "Stop any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/getConnectionInfo/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get Connection Info of an Integration Runtime", + "description": "Get Connection Info of any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/regenerateAuthKey/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Regenerate auth key of an Integration Runtime", + "description": "Regenerate auth key of any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/listAuthKeys/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "List Auth Keys of an Integration Runtime", + "description": "List Auth Keys of any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/removeNode/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Remove an Integration Runtime node", + "description": "Remove any Integration Runtime node" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/monitoringData/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get an Integration Runtime's monitoring data", + "description": "Get any Integration Runtime's monitoring data" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/syncCredentials/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Sync credential on an Integration Runtime", + "description": "Sync credential on any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/upgrade/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Upgrade an Integration Runtime", + "description": "Upgrade any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/removeLinks/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Remove an Integration Runtime link", + "description": "Remove any Integration Runtime link" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/enableInteractiveQuery/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Enable Interactive query on an Integration Runtime", + "description": "Enable Interactive query on any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/disableInteractiveQuery/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Disable Interactive query on an Integration Runtime", + "description": "Disable Interactive query on any Integration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/refreshObjectMetadata/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Refresh Object metadata on an Intergration Runtime", + "description": "Refresh Object metadata on any Intergration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/integrationRuntimes/getObjectMetadata/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Integration Runtimes.", + "operation": "Get Object metadata on an Intergration Runtime", + "description": "Get Object metadata on any Intergration Runtime" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/firewallRules/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "IP Firewall Rule.", + "operation": "Create or update IP Firewall Rule.", + "description": "Create or update any IP Firewall Rule." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/firewallRules/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "IP Firewall Rule.", + "operation": "Read IP Firewall Rule", + "description": "Read IP Firewall Rule" + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/firewallRules/delete", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "IP Firewall Rule.", + "operation": "Delete IP Firewall Rule", + "description": "Delete any IP Firewall Rule." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/replaceAllIpFirewallRules/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Workspaces", + "operation": "Replace all Ip Firewall Rules for the Workspace.", + "description": "Replaces all Ip Firewall Rules for the Workspace." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlDatabases/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics Databases", + "operation": "Create or Update SQL Analytics Databases.", + "description": "Create or Update any SQL Analytics Databases." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlDatabases/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics Databases", + "operation": "Read SQL Analytics Databases.", + "description": "Read any SQL Analytics Databases." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Create or Update SQL Analytics pools.", + "description": "Create or Update any SQL Analytics pools." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Read SQL Analytics pools.", + "description": "Read any SQL Analytics pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/dataWarehouseQueries/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Queries", + "operation": "Read SQL Analytics pool Queries.", + "description": "Read any SQL Analytics pool Queries." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/geoBackupPolicies/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Geo Backup Policies", + "operation": "Read SQL Analytics pool Geo Backup Policies.", + "description": "Read any SQL Analytics pool Geo Backup Policies." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/dataWarehouseUserActivities/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool User Activities", + "operation": "Read SQL Analytics pool User Activities.", + "description": "Read any SQL Analytics pool User Activities." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/restorePoints/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Restore Points", + "operation": "Read SQL Analytics pool Restore Points.", + "description": "Read any SQL Analytics pool Restore Points." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/dataWarehouseQueries/dataWarehouseQuerySteps/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Query Steps", + "operation": "Read SQL Analytics pool Query Steps.", + "description": "Read any SQL Analytics pool Query Steps." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/maintenanceWindows/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Maintenance Windows", + "operation": "Read SQL Analytics pool Maintenance Windows.", + "description": "Read any SQL Analytics pool Maintenance Windows." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/maintenanceWindowOptions/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Maintenance Window Options", + "operation": "Read SQL Analytics pool Maintenance Window Options.", + "description": "Read any SQL Analytics pool Maintenance Window Options." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/replicationLinks/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Replication Links", + "operation": "Read SQL Analytics pool Replication Links.", + "description": "Read any SQL Analytics pool Replication Links." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Transparent Data Encryption Configuration", + "operation": "Read SQL Analytics pool Transparent Data Encryption Configuration.", + "description": "Read any SQL Analytics pool Transparent Data Encryption Configuration." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption/operationResults/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Transparent Data Encryption Configuration Operation Results", + "operation": "Read SQL Analytics pool Transparent Data Encryption Configuration Operation Results.", + "description": "Read any SQL Analytics pool Transparent Data Encryption Configuration Operation Results." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Auditing Settings", + "operation": "Read SQL Analytics pool Auditing Settings.", + "description": "Read any SQL Analytics pool Auditing Settings." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/operations/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Operations", + "operation": "Read SQL Analytics pool Operations.", + "description": "Read any SQL Analytics pool Operations." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/usages/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Usages", + "operation": "Read SQL Analytics pool Usages.", + "description": "Read any SQL Analytics pool Usages." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/currentSensitivityLabels/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Current Sensitivity Labels", + "operation": "Read SQL Analytics pool Current Sensitivity Labels.", + "description": "Read any SQL Analytics pool Current Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/recommendedSensitivityLabels/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Recommended Sensitivity Labels", + "operation": "Read SQL Analytics pool Recommended Sensitivity Labels.", + "description": "Read any SQL Analytics pool Recommended Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Schemas", + "operation": "Read SQL Analytics pool Schemas.", + "description": "Read any SQL Analytics pool Schemas." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Schema Tables", + "operation": "Read SQL Analytics pool Schema Tables.", + "description": "Read any SQL Analytics pool Schema Tables." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Schema Table Columns", + "operation": "Read SQL Analytics pool Schema Table Columns.", + "description": "Read any SQL Analytics pool Schema Table Columns." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/connectionPolicies/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Connection Policies", + "operation": "Read SQL Analytics pool Connection Policies.", + "description": "Read any SQL Analytics pool Connection Policies." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment", + "operation": "Read SQL Analytics pool Vulnerability Assessment.", + "description": "Read any SQL Analytics pool Vulnerability Assessment." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment Scan Records", + "operation": "Read SQL Analytics pool Vulnerability Assessment Scan Records.", + "description": "Read any SQL Analytics pool Vulnerability Assessment Scan Records." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Security Alert Policies", + "operation": "Read Sql Analytics pool Threat Detection Policies.", + "description": "Read any Sql Analytics pool Threat Detection Policies." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/delete", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Delete SQL Analytics pools.", + "description": "Delete any SQL Analytics pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/pause/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Pause SQL Analytics pools.", + "description": "Pause any SQL Analytics pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/resume/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Resume SQL Analytics pools.", + "description": "Resume any SQL Analytics pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/restorePoints/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Restore Points", + "operation": "Create SQL Analytics pool Restore Point.", + "description": "Create a SQL Analytics pool Restore Point." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/move/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pools", + "operation": "Rename SQL Analytics pools.", + "description": "Rename any SQL Analytics pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/enable/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Sensitivity Labels", + "operation": "Enable SQL Analytics pool Sensitivity Labels.", + "description": "Enable any SQL Analytics pool Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/disable/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Sensitivity Labels", + "operation": "Disable SQL Analytics pool Sensitivity Labels.", + "description": "Disable any SQL Analytics pool Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/initiateScan/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment Scan Records", + "operation": "Initiate SQL Analytics pool Vulnerability Assessment Scan Records.", + "description": "Initiate any SQL Analytics pool Vulnerability Assessment Scan Records." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/scans/export/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment Scan Records", + "operation": "Export SQL Analytics pool Vulnerability Assessment Scan Records.", + "description": "Export any SQL Analytics pool Vulnerability Assessment Scan Records." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/maintenanceWindows/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Maintenance Windows", + "operation": "Create or Update SQL Analytics pool Maintenance Windows.", + "description": "Read any SQL Analytics pool Maintenance Windows." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/auditingSettings/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Auditing Settings", + "operation": "Create or Update SQL Analytics pool Auditing Settings.", + "description": "Create or Update any SQL Analytics pool Auditing Settings." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Sensitivity Labels", + "operation": "Create or update SQL Analytics pool Sensitivity Labels.", + "description": "Create or Update any SQL Analytics pool Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/transparentDataEncryption/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Transparent Data Encryption Configuration", + "operation": "Create or Update SQL Analytics pool Transparent Data Encryption Configuration.", + "description": "Create or Update any SQL Analytics pool Transparent Data Encryption Configuration." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/securityAlertPolicies/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Security Alert Policies", + "operation": "Create or Update SQL Analytics pool Threat Detection Policies.", + "description": "Create or Update any SQL Analytics pool Threat Detection Policies." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment Rule Baseline", + "operation": "Create or Update SQL Analytics pool Vulnerability Assessment Rule Baseline.", + "description": "Create or Update any SQL Analytics pool Vulnerability Assessment Rule Baseline." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/schemas/tables/columns/sensitivityLabels/delete", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Sensitivity Labels", + "operation": "Delete SQL Analytics pool Sensitivity Labels.2", + "description": "Delete any SQL Analytics pool Sensitivity Labels." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/delete", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment", + "operation": "Delete SQL Analytics pool Vulnerability Assessment.", + "description": "Delete any SQL Analytics pool Vulnerability Assessment." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/vulnerabilityAssessments/rules/baselines/delete", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Vulnerability Assessment Rule Baseline", + "operation": "Delete SQL Analytics pool Vulnerability Assessment Rule Baseline.", + "description": "Delete any SQL Analytics pool Vulnerability Assessment Rule Baseline." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/operationStatus/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Async Operation Status.", + "operation": "Read Async Operation Status.", + "description": "Read any Async Operation Status." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/operationResults/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Async Operation Result", + "operation": "Read Async Operation Result.", + "description": "Read any Async Operation Result." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/operationResults/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Async Operation Result", + "operation": "Read Async Operation Result.", + "description": "Read any Async Operation Result." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/checkNameAvailability/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Check Name Availability", + "operation": "Checks Workspace name availability.", + "description": "Checks Workspace name availability." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/bigDataPools/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Spark pools", + "operation": "Create or Update Spark pools.", + "description": "Create or Update any Spark pools." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/bigDataPools/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Spark pools", + "operation": "Read Spark pools.", + "description": "Read any Spark pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/bigDataPools/delete", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Spark pools", + "operation": "Delete Spark pools.", + "description": "Delete any Spark pools." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/metadataSync/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Metadata Sync Config", + "operation": "Read SQL Analytics pool Metadata Sync Config", + "description": "Read SQL Analytics pool Metadata Sync Config" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/sqlPools/metadataSync/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "SQL Analytics pool Metadata Sync Config", + "operation": "Create or Update SQL Analytics pool Metadata Sync Config", + "description": "Create or Update SQL Analytics pool Metadata Sync Config" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/register/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Synapse Resource Provider.", + "operation": "Registers the Synapse Resource Provider.", + "description": "Registers the Synapse Resource Provider and enables the creation of Workspaces." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/administrators/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Administrators", + "operation": "Set Active Directory Administrator", + "description": "Set Active Directory Administrator on the Workspace" + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/administrators/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Administrators", + "operation": "Get Workspace Active Directory Administrator", + "description": "Get Workspace Active Directory Administrator" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/administrators/delete", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Administrators", + "operation": "Delete Workspace Active Directory Administrator", + "description": "Delete Workspace Active Directory Administrator" + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Workspaces", + "operation": "Create or Update Workspaces.", + "description": "Create or Update any Workspaces." + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Workspaces", + "operation": "Read Workspaces.", + "description": "Read any Workspaces." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/delete", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Workspaces", + "operation": "Delete Workspaces.", + "description": "Delete any Workspaces." + }, + "origin": "user, system" + }, + { + "name": "Microsoft.Synapse/workspaces/privateEndpointConnectionProxies/validate/action", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Validate Private Endpoint Connection Proxy", + "operation": "Validates Private Endpoint Connection Proxy", + "description": "Validates Private Endpoint Connection Proxy" + }, + "origin": "system" + }, + { + "name": "Microsoft.Synapse/workspaces/privateEndpointConnectionProxies/write", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Private Endpoint Connection Proxy", + "operation": "Create or Update Private Endpoint Connection Proxy", + "description": "Create or Update Private Endpoint Connection Proxy" + }, + "origin": "system" + }, + { + "name": "Microsoft.Synapse/workspaces/privateEndpointConnectionProxies/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Private Endpoint Connection Proxy", + "operation": "Read Private Endpoint Connection Proxies", + "description": "Read any Private Endpoint Connection Proxy" + }, + "origin": "system" + }, + { + "name": "Microsoft.Synapse/workspaces/privateLinkResources/read", + "isDataAction": "false", + "display": { + "provider": "Synapse Resource Provider.", + "resource": "Private Link Resources", + "operation": "Get Private Link Resources", + "description": "Get a list of Private Link Resources" + }, + "origin": "user" + }, + { + "name": "Microsoft.Synapse/workspaces/providers/Microsoft.Insights/metricDefinitions/read", + "isDataAction": null, + "display": { + "provider": "Microsoft Azure Synapse Analytics", + "resource": "Workspace", + "operation": "Read workspace metric definitions", + "description": "Gets the available metrics for workspace" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "PipelineFailedRuns", + "displayName": "Failed pipeline runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "PipelineSucceededRuns", + "displayName": "Succeeded pipeline runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "PipelineCancelledRuns", + "displayName": "Cancelled pipeline runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "ActivityFailedRuns", + "displayName": "Failed activity runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "ActivityType", + "displayName": "Activity Type", + "toBeExportedForShoebox": true + }, + { + "name": "PipelineName", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Activity", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "ActivitySucceededRuns", + "displayName": "Succeeded activity runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "ActivityType", + "displayName": "Activity Type", + "toBeExportedForShoebox": true + }, + { + "name": "PipelineName", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Activity", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "ActivityCancelledRuns", + "displayName": "Cancelled activity runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "ActivityType", + "displayName": "Activity Type", + "toBeExportedForShoebox": true + }, + { + "name": "PipelineName", + "displayName": "Pipeline", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + }, + { + "name": "Name", + "displayName": "Activity", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "TriggerFailedRuns", + "displayName": "Failed trigger runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "Name", + "displayName": "Trigger", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "TriggerSucceededRuns", + "displayName": "Succeeded trigger runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "Name", + "displayName": "Trigger", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + } + ] + }, + { + "name": "TriggerCancelledRuns", + "displayName": "Cancelled trigger runs", + "displayDescription": null, + "unit": "Count", + "aggregationType": "Total", + "sourceMdmAccount": "MicrosoftDataFactoryProdShoebox", + "sourceMdmNamespace": "ADFMetrics", + "dimensions": [ + { + "name": "Name", + "displayName": "Trigger", + "toBeExportedForShoebox": true + }, + { + "name": "FailureType", + "displayName": "Failure Type", + "toBeExportedForShoebox": true + } + ] + } + ] + } + } + }, + { + "name": "Microsoft.Synapse/workspaces/providers/Microsoft.Insights/diagnosticSettings/read", + "isDataAction": null, + "display": { + "provider": "Microsoft Azure Synapse Analytics", + "resource": "Workspace", + "operation": "Read diagnostic setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "Microsoft.Synapse/workspaces/providers/Microsoft.Insights/diagnosticSettings/write", + "isDataAction": null, + "display": { + "provider": "Microsoft Azure Synapse Analytics", + "resource": "Workspace", + "operation": "Write diagnostic setting", + "description": "Creates or updates the diagnostic setting for the resource" + }, + "origin": "system" + }, + { + "name": "Microsoft.Synapse/workspaces/providers/Microsoft.Insights/logDefinitions/read", + "isDataAction": null, + "display": { + "provider": "Microsoft Azure Synapse Analytics", + "resource": "The log definition of workspace", + "operation": "Read workspace log definitions", + "description": "Gets the available logs for workspace" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "logSpecifications": [ + { + "name": "ActivityRuns", + "displayName": "Activity runs", + "blobDuration": "PT1H" + }, + { + "name": "PipelineRuns", + "displayName": "Pipeline runs", + "blobDuration": "PT1H" + }, + { + "name": "TriggerRuns", + "displayName": "Trigger runs", + "blobDuration": "PT1H" + } + ] + } + } + } + ] + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetAzureAsyncOperationHeader.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetAzureAsyncOperationHeader.json new file mode 100644 index 000000000000..2883c2f2c3c2 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetAzureAsyncOperationHeader.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "operationId": "01234567-89ab-4def-0123-456789abcdef", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": { + "body": { + "status": "InProgress" + } + }, + "404": {}, + "500": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetLocationHeader.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetLocationHeader.json new file mode 100644 index 000000000000..d67fbd8f288f --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetLocationHeader.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup1", + "workspaceName": "workspace1", + "operationId": "01234567-89ab-4def-0123-456789abcdef", + "api-version": "2019-06-01-preview" + }, + "responses": { + "200": {}, + "204": {}, + "default": { + "body": { + "error": { + "code": "Error code", + "message": "Error message" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetSqlDatabase.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetSqlDatabase.json new file mode 100644 index 000000000000..fdc8ffd556ea --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetSqlDatabase.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "be5385c6-6a34-406c-a2f9-385075bcfdfd", + "resourceGroupName": "rg_b912b40b-7bb5-46ef-a140-46a23db11507", + "workspaceName": "srv_c52efdc9-f302-4686-a871-be9960d20510", + "sqlDatabaseName": "ce71c93c-ba61-47b9-b382-8e463e147233", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 263882790666240, + "databaseGuid": "00000000-0000-0000-0000-000000000004" + }, + "location": "westus", + "id": "/subscriptions/be5385c6-6a34-406c-a2f9-385075bcfdfd/resourceGroups/rg_b912b40b-7bb5-46ef-a140-46a23db11507/providers/Microsoft.Synapse/workspaces/srv_c52efdc9-f302-4686-a871-be9960d20510/sqlDatabases/ce71c93c-ba61-47b9-b382-8e463e147233", + "name": "ce71c93c-ba61-47b9-b382-8e463e147233", + "type": "Microsoft.Synapse/workspaces/sqlDatabases" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetSqlPool.json new file mode 100644 index 000000000000..2e1cb8884a38 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/GetSqlPool.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "c7a943a4-d175-47e0-86b7-5d284ff1eb03", + "resourceGroupName": "rg_4209256d-4845-480a-80be-7da86a699a6f", + "workspaceName": "srv_ec5902c6-9b6a-43dc-9700-b6833bbf1722", + "sqlPoolName": "533e014b-e85e-413e-9d8b-861d17c31d3f", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "DW1000f", + "tier": "Synapse" + }, + "kind": "v3", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-06-19T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T04:05:06Z" + }, + "properties": { + "status": "Online", + "sqlPoolGuid": "00000000-0000-0000-0000-000000000004", + "currentServiceObjectiveName": "DW1000f", + "requestedServiceObjectiveName": "DW2000f" + }, + "location": "westus", + "id": "/subscriptions/c7a943a4-d175-47e0-86b7-5d284ff1eb03/resourceGroups/rg_4209256d-4845-480a-80be-7da86a699a6f/providers/Microsoft.Synapse/workspaces/srv_ec5902c6-9b6a-43dc-9700-b6833bbf1722/sqlPools/533e014b-e85e-413e-9d8b-861d17c31d3f", + "name": "533e014b-e85e-413e-9d8b-861d17c31d3f", + "type": "Microsoft.Synapse/workspaces/sqlPools" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/ListSqlDatabasesByWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/ListSqlDatabasesByWorkspace.json new file mode 100644 index 000000000000..0d1a67528a49 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/ListSqlDatabasesByWorkspace.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "31a4e624-29fd-48db-b875-c6f4b33bb0d8", + "resourceGroupName": "rg_6dba758f-d8a3-4c8d-82e8-b4cfea8694cb", + "workspaceName": "srv_c839a9e6-9103-4c47-bbc7-f7f3b8760682", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2015-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2015-02-03T04:05:06Z" + }, + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 263882790666240, + "databaseGuid": "00000000-0000-0000-0000-000000000004" + }, + "location": "westus", + "id": "/subscriptions/31a4e624-29fd-48db-b875-c6f4b33bb0d8/resourceGroups/rg_6dba758f-d8a3-4c8d-82e8-b4cfea8694cb/providers/Microsoft.Synapse/workspaces/srv_c839a9e6-9103-4c47-bbc7-f7f3b8760682/sqlDatabases/ac9cb38c-2061-475e-85aa-5b0fe0df409c", + "name": "ac9cb38c-2061-475e-85aa-5b0fe0df409c", + "type": "Microsoft.Synapse/workspaces/sqlDatabases" + }, + { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-02-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-02-03T04:05:06Z" + }, + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 263882790666240, + "databaseGuid": "00000000-0000-0000-0000-000000000004" + }, + "location": "westus", + "id": "/subscriptions/31a4e624-29fd-48db-b875-c6f4b33bb0d8/resourceGroups/rg_6dba758f-d8a3-4c8d-82e8-b4cfea8694cb/providers/Microsoft.Synapse/workspaces/srv_c839a9e6-9103-4c47-bbc7-f7f3b8760682/sqlDatabases/9e5f5f6e-50b7-4e28-a27d-550f3d8cb780", + "name": "9e5f5f6e-50b7-4e28-a27d-550f3d8cb780", + "type": "Microsoft.Synapse/workspaces/sqlDatabases" + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/ListSqlPoolsByWorkspace.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/ListSqlPoolsByWorkspace.json new file mode 100644 index 000000000000..3ad7c07714d8 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/ListSqlPoolsByWorkspace.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "7ce9daee-5f09-4e99-8161-055611a72c3a", + "resourceGroupName": "rg_bd765c92-453d-49f9-8424-4465316d33e7", + "workspaceName": "srv_7b27bdcf-2ca2-4daf-a225-04d10b937af4", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "DW1000f", + "tier": "Synapse" + }, + "kind": "v3", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-06-19T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T04:05:06Z" + }, + "properties": { + "status": "Online", + "sqlPoolGuid": "00000000-0000-0000-0000-000000000004", + "currentServiceObjectiveName": "DW1000f", + "requestedServiceObjectiveName": "DW2000f" + }, + "location": "westus", + "id": "/subscriptions/7ce9daee-5f09-4e99-8161-055611a72c3a/resourceGroups/rg_bd765c92-453d-49f9-8424-4465316d33e7/providers/Microsoft.Synapse/workspaces/srv_7b27bdcf-2ca2-4daf-a225-04d10b937af4/sqlPools/0516c4a6-7779-4f07-9b64-cb7c2171a16b", + "name": "0516c4a6-7779-4f07-9b64-cb7c2171a16b", + "type": "Microsoft.Synapse/workspaces/sqlPools" + }, + { + "sku": { + "name": "DW1000f", + "tier": "Synapse" + }, + "kind": "v3", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-07-19T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-07-19T04:05:06Z" + }, + "properties": { + "status": "Online", + "sqlPoolGuid": "00000000-0000-0000-0000-000000000004", + "currentServiceObjectiveName": "DW1000f", + "requestedServiceObjectiveName": "DW2000f" + }, + "location": "westus", + "id": "/subscriptions/7ce9daee-5f09-4e99-8161-055611a72c3a/resourceGroups/rg_bd765c92-453d-49f9-8424-4465316d33e7/providers/Microsoft.Synapse/workspaces/srv_7b27bdcf-2ca2-4daf-a225-04d10b937af4/sqlPools/61cec6de-e93a-4ab6-8210-d11eb9130dce", + "name": "61cec6de-e93a-4ab6-8210-d11eb9130dce", + "type": "Microsoft.Synapse/workspaces/sqlPools" + } + ] + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PatchSqlDatabase.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PatchSqlDatabase.json new file mode 100644 index 000000000000..8ca5d92c8d21 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PatchSqlDatabase.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "b431a23e-2678-45da-9dfc-2e0bc8f1b8cb", + "resourceGroupName": "rg_0e643e48-6f86-46cf-99f2-aa1ab47afa63", + "workspaceName": "srv_5694fdc5-e11f-45a3-85c0-25e90909a391", + "sqlDatabaseName": "5f3ea441-d318-4f98-9789-192498a0e176", + "api-version": "2020-04-01-preview", + "parameters": {} + }, + "responses": { + "202": {}, + "200": { + "body": { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-06-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-03T04:05:06Z" + }, + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 263882790666240, + "databaseGuid": "00000000-0000-0000-0000-000000000004" + }, + "location": "westus", + "id": "/subscriptions/b431a23e-2678-45da-9dfc-2e0bc8f1b8cb/resourceGroups/rg_0e643e48-6f86-46cf-99f2-aa1ab47afa63/providers/Microsoft.Synapse/workspaces/srv_5694fdc5-e11f-45a3-85c0-25e90909a391/sqlDatabases/5f3ea441-d318-4f98-9789-192498a0e176", + "name": "5f3ea441-d318-4f98-9789-192498a0e176", + "type": "Microsoft.Synapse/workspaces/sqlDatabases" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PatchSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PatchSqlPool.json new file mode 100644 index 000000000000..efa061f1be10 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PatchSqlPool.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "c3ccca71-3828-41b0-9988-8982d1416c58", + "resourceGroupName": "rg_0b597c8d-a1e6-4a7b-bd02-d3f8383a4f8a", + "workspaceName": "srv_9b68d6df-e85b-4f42-84ab-a5bf19bc7d64", + "sqlPoolName": "6584cfe4-b6eb-4d84-a612-f8460da43119", + "api-version": "2020-04-01-preview", + "parameters": { + "sku": { + "name": "DW2000f", + "tier": "Synapse" + } + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "sku": { + "name": "DW2000f", + "tier": "Synapse" + }, + "kind": "v3", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-06-19T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T04:05:06Z" + }, + "properties": { + "status": "Online", + "sqlPoolGuid": "00000000-0000-0000-0000-000000000004", + "currentServiceObjectiveName": "DW2000f", + "requestedServiceObjectiveName": "DW2000f" + }, + "location": "westus", + "id": "/subscriptions/c3ccca71-3828-41b0-9988-8982d1416c58/resourceGroups/rg_0b597c8d-a1e6-4a7b-bd02-d3f8383a4f8a/providers/Microsoft.Synapse/workspaces/srv_9b68d6df-e85b-4f42-84ab-a5bf19bc7d64/sqlPools/6584cfe4-b6eb-4d84-a612-f8460da43119", + "name": "6584cfe4-b6eb-4d84-a612-f8460da43119", + "type": "Microsoft.Synapse/workspaces/sqlPools" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PutSqlDatabase.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PutSqlDatabase.json new file mode 100644 index 000000000000..f76fb611af94 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PutSqlDatabase.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "d9e39bed-00e1-4f5e-883e-6d94be335056", + "resourceGroupName": "rg_88eed28c-5243-4f02-8251-bfa1e69e7057", + "workspaceName": "srv_85d31a1e-718b-4bda-9e53-a91230dd4ce5", + "sqlDatabaseName": "73164535-f22d-4daa-b014-1f23bbe361b7", + "api-version": "2020-04-01-preview", + "parameters": { + "tags": { + "tag1": "val1" + }, + "location": "westus" + } + }, + "responses": { + "202": {}, + "201": { + "body": { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-06-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-03T04:05:06Z" + }, + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 263882790666240, + "databaseGuid": "00000000-0000-0000-0000-000000000004" + }, + "location": "westus", + "id": "/subscriptions/d9e39bed-00e1-4f5e-883e-6d94be335056/resourceGroups/rg_88eed28c-5243-4f02-8251-bfa1e69e7057/providers/Microsoft.Synapse/workspaces/srv_85d31a1e-718b-4bda-9e53-a91230dd4ce5/sqlDatabases/73164535-f22d-4daa-b014-1f23bbe361b7", + "name": "73164535-f22d-4daa-b014-1f23bbe361b7", + "type": "Microsoft.Synapse/workspaces/sqlDatabases" + } + }, + "200": { + "body": { + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-06-03T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-03T04:05:06Z" + }, + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "maxSizeBytes": 263882790666240, + "databaseGuid": "00000000-0000-0000-0000-000000000004" + }, + "location": "westus", + "id": "/subscriptions/3e8c19f4-eeef-4cb9-bc14-2c3dd459e8a8/resourceGroups/rg_ce5b9d27-ae43-4fe0-986e-95d1df21adf5/providers/Microsoft.Synapse/workspaces/srv_6eeb976d-3b48-4a1f-b45f-d59797b23dac/sqlDatabases/428975cf-c682-4347-8412-468fcf11f988", + "name": "428975cf-c682-4347-8412-468fcf11f988", + "type": "Microsoft.Synapse/workspaces/sqlDatabases" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PutSqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PutSqlPool.json new file mode 100644 index 000000000000..0039a7fe438c --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/examples/PutSqlPool.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "subscriptionId": "2ce559e9-b582-446a-8eb3-0cd81e07b7df", + "resourceGroupName": "rg_fb5ce457-3576-425e-b22d-7300689fbea0", + "workspaceName": "srv_1e04aaa9-b30e-46ad-af06-7a21202bcc6c", + "sqlPoolName": "22c317e3-97a3-4ae3-9e91-a3456a5fff31", + "api-version": "2020-04-01-preview", + "parameters": { + "tags": { + "tag1": "val1" + }, + "sku": { + "name": "DW1000f", + "tier": "Synapse" + }, + "location": "westus" + } + }, + "responses": { + "202": {}, + "200": { + "body": { + "sku": { + "name": "DW2000f", + "tier": "Synapse" + }, + "kind": "v3", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-06-19T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T04:05:06Z" + }, + "properties": { + "status": "Online", + "sqlPoolGuid": "00000000-0000-0000-0000-000000000004", + "currentServiceObjectiveName": "DW2000f", + "requestedServiceObjectiveName": "DW2000f" + }, + "location": "westus", + "id": "/subscriptions/2ce559e9-b582-446a-8eb3-0cd81e07b7df/resourceGroups/rg_fb5ce457-3576-425e-b22d-7300689fbea0/providers/Microsoft.Synapse/workspaces/srv_1e04aaa9-b30e-46ad-af06-7a21202bcc6c/sqlPools/22c317e3-97a3-4ae3-9e91-a3456a5fff31", + "name": "22c317e3-97a3-4ae3-9e91-a3456a5fff31", + "type": "Microsoft.Synapse/workspaces/sqlPools" + } + }, + "201": { + "body": { + "sku": { + "name": "DW1000f", + "tier": "Synapse" + }, + "kind": "v3", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-06-19T04:05:06Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-06-19T04:05:06Z" + }, + "properties": { + "status": "Online", + "sqlPoolGuid": "00000000-0000-0000-0000-000000000004", + "currentServiceObjectiveName": "DW1000f", + "requestedServiceObjectiveName": "DW1000f" + }, + "location": "westus", + "id": "/subscriptions/f028e7fd-444a-41a2-a52d-fe8098b4770a/resourceGroups/rg_c76505cf-a02e-4fdf-8368-be830115f1dc/providers/Microsoft.Synapse/workspaces/srv_3a830420-3bdd-4ccc-a95a-9a2ac3cd0a19/sqlPools/8b5cfcb4-b074-4130-8060-803771147fc7", + "name": "8b5cfcb4-b074-4130-8060-803771147fc7", + "type": "Microsoft.Synapse/workspaces/sqlPools" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/operations.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/operations.json new file mode 100644 index 000000000000..8fa81e529e62 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/operations.json @@ -0,0 +1,390 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-04-01-preview", + "title": "SynapseManagementClient", + "description": "Azure Synapse Analytics APIs" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "securityDefinitions": { + "azure_auth": { + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "type": "oauth2", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "paths": { + "/providers/Microsoft.Synapse/operations": { + "get": { + "operationId": "Operations_List", + "summary": "All operations", + "description": "Get all available operations", + "tags": [ + "Operations" + ], + "deprecated": false, + "consumes": [], + "produces": [ + "application/json" + ], + "responses": { + "200": { + "schema": { + "type": "array", + "items": { + "$ref": "#/definitions/AvailableRpOperation" + } + }, + "description": "" + } + }, + "x-ms-examples": { + "Get available operations": { + "$ref": "./examples/GetAvailableOperations.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/operationResults/{operationId}": { + "get": { + "operationId": "Operations_GetLocationHeaderResult", + "summary": "Get operation result", + "description": "Get the result of an operation", + "tags": [ + "Operations" + ], + "deprecated": false, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "operationId", + "description": "Operation ID", + "required": true + } + ], + "responses": { + "200": { + "description": "" + }, + "204": { + "description": "" + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get location header result": { + "$ref": "./examples/GetLocationHeader.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/operationStatuses/{operationId}": { + "get": { + "operationId": "Operations_GetAzureAsyncHeaderResult", + "summary": "Get operation status", + "description": "Get the status of an operation", + "tags": [ + "Operations" + ], + "deprecated": false, + "consumes": [], + "produces": [ + "application/json" + ], + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "type": "string", + "in": "path", + "name": "operationId", + "description": "Operation ID", + "required": true + } + ], + "responses": { + "200": { + "schema": { + "$ref": "#/definitions/OperationResource" + }, + "description": "" + }, + "404": { + "description": "" + }, + "500": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-examples": { + "Get azure async operation header result": { + "$ref": "./examples/GetAzureAsyncOperationHeader.json" + } + } + } + } + }, + "definitions": { + "AvailableRpOperation": { + "type": "object", + "description": "An operation that is available in this resource provider", + "properties": { + "display": { + "$ref": "#/definitions/AvailableRpOperationDisplayInfo", + "description": "Display properties of the operation" + }, + "isDataAction": { + "type": "string", + "description": "Whether this operation is a data action" + }, + "name": { + "type": "string", + "description": "Operation name" + }, + "properties": { + "$ref": "#/definitions/OperationMetaPropertyInfo", + "description": "Operation properties", + "x-ms-client-flatten": true + }, + "origin": { + "type": "string", + "description": "Operation origin" + } + } + }, + "OperationResource": { + "type": "object", + "description": "An operation", + "properties": { + "id": { + "type": "string", + "description": "Operation ID" + }, + "name": { + "type": "string", + "description": "Operation name" + }, + "status": { + "enum": [ + "InProgress", + "Succeeded", + "Failed", + "Canceled" + ], + "description": "Operation status", + "type": "string", + "x-ms-enum": { + "name": "OperationStatus", + "modelAsString": true + } + }, + "properties": { + "type": "object", + "description": "Operation properties", + "x-ms-client-flatten": true + }, + "error": { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse", + "description": "Errors from the operation" + }, + "startTime": { + "type": "string", + "format": "date-time", + "description": "Operation start time" + }, + "endTime": { + "type": "string", + "format": "date-time", + "description": "Operation start time" + }, + "percentComplete": { + "type": "number", + "description": "Completion percentage of the operation" + } + } + }, + "AvailableRpOperationDisplayInfo": { + "type": "object", + "description": "Description of an available operation", + "properties": { + "description": { + "type": "string", + "description": "Operation description" + }, + "resource": { + "type": "string", + "description": "Resource type" + }, + "provider": { + "type": "string", + "description": "Resource provider name" + }, + "operation": { + "type": "string", + "description": "Operation name" + } + } + }, + "OperationMetaPropertyInfo": { + "type": "object", + "description": "What is this?", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/OperationMetaServiceSpecification", + "description": "Operation service specification" + } + } + }, + "OperationMetaServiceSpecification": { + "type": "object", + "description": "What is this?", + "properties": { + "metricSpecifications": { + "type": "array", + "description": "Service metric specifications", + "items": { + "$ref": "#/definitions/OperationMetaMetricSpecification" + } + }, + "logSpecifications": { + "type": "array", + "description": "Service log specifications", + "items": { + "$ref": "#/definitions/OperationMetaLogSpecification" + } + } + } + }, + "OperationMetaMetricSpecification": { + "type": "object", + "description": "What is this?", + "properties": { + "sourceMdmNamespace": { + "type": "string", + "description": "The source MDM namespace" + }, + "displayName": { + "type": "string", + "description": "Metric display name" + }, + "name": { + "type": "string", + "description": "Metric unique name" + }, + "aggregationType": { + "type": "string", + "description": "Metric aggregation type" + }, + "displayDescription": { + "type": "string", + "description": "Metric description" + }, + "sourceMdmAccount": { + "type": "string", + "description": "The source MDM account" + }, + "enableRegionalMdmAccount": { + "type": "boolean", + "description": "Whether the regional MDM account is enabled" + }, + "unit": { + "type": "string", + "description": "Metric units" + }, + "dimensions": { + "type": "array", + "description": "Metric dimensions", + "items": { + "$ref": "#/definitions/OperationMetaMetricDimensionSpecification" + } + }, + "supportsInstanceLevelAggregation": { + "type": "boolean", + "description": "Whether the metric supports instance-level aggregation" + }, + "metricFilterPattern": { + "type": "string", + "description": "Metric filter" + } + } + }, + "OperationMetaLogSpecification": { + "type": "object", + "description": "What is this?", + "properties": { + "displayName": { + "type": "string", + "description": "Log display name" + }, + "blobDuration": { + "type": "string", + "description": "Time range the log covers" + }, + "name": { + "type": "string", + "description": "Log unique name" + } + } + }, + "OperationMetaMetricDimensionSpecification": { + "type": "object", + "description": "What is this?", + "properties": { + "displayName": { + "type": "string", + "description": "Dimension display name" + }, + "name": { + "type": "string", + "description": "Dimension unique name" + }, + "toBeExportedForShoebox": { + "type": "boolean", + "description": "Whether this metric should be exported for Shoebox" + } + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json new file mode 100644 index 000000000000..efff72a45220 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json @@ -0,0 +1,374 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-04-01-preview", + "title": "SynapseSqlManagementClient", + "description": "The Azure Synapse SQL management API provides a RESTful set of web APIs that interact with Azure Synapse SQL services to manage your resources. The API enables users to create, retrieve, update, and delete SqlPools, SqlDatabases, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlDatabases/{sqlDatabaseName}": { + "get": { + "tags": [ + "SqlDatabases" + ], + "description": "Gets a SqlDatabase.", + "operationId": "SqlDatabases_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/SqlDatabaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified SqlDatabase.", + "schema": { + "$ref": "#/definitions/SqlDatabase" + } + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-examples": { + "Gets a sqldatabase.": { + "$ref": "./examples/GetSqlDatabase.json" + } + } + }, + "put": { + "tags": [ + "SqlDatabases" + ], + "description": "Creates a new SqlDatabase or updates an existing SqlDatabase.", + "operationId": "SqlDatabases_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/SqlDatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested SqlDatabase resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlDatabase" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SqlDatabase.", + "schema": { + "$ref": "#/definitions/SqlDatabase" + } + }, + "202": { + "description": "Creating or updating the SqlDatabase is in progress." + }, + "201": { + "description": "Successfully created the SqlDatabase.", + "schema": { + "$ref": "#/definitions/SqlDatabase" + } + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates a sqldatabase.": { + "$ref": "./examples/PutSqlDatabase.json" + } + } + }, + "delete": { + "tags": [ + "SqlDatabases" + ], + "description": "Deletes the SqlDatabase.", + "operationId": "SqlDatabases_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/SqlDatabaseNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SqlDatabase." + }, + "202": { + "description": "Deleting the SqlDatabase is in progress." + }, + "204": { + "description": "The specified SqlDatabase does not exist." + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a sqldatabase.": { + "$ref": "./examples/DeleteSqlDatabase.json" + } + } + }, + "patch": { + "tags": [ + "SqlDatabases" + ], + "description": "Updates an existing database.", + "operationId": "SqlDatabases_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/SqlDatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested SqlDatabase resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlDatabaseUpdate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/SqlDatabase" + } + }, + "202": { + "description": "Updating the database is in progress." + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates a sqldatabase.": { + "$ref": "./examples/PatchSqlDatabase.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlDatabases": { + "get": { + "tags": [ + "SqlDatabases" + ], + "description": "Gets a list of sql databases.", + "operationId": "SqlDatabases_ListByWorkspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of sql databases.", + "schema": { + "$ref": "#/definitions/SqlDatabaseListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets a list of sql databases.": { + "$ref": "./examples/ListSqlDatabasesByWorkspace.json" + } + } + } + } + }, + "definitions": { + "SqlDatabaseProperties": { + "description": "The sql database's properties.", + "type": "object", + "properties": { + "collation": { + "description": "The collation of the database.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "maxSizeBytes": { + "format": "int64", + "description": "The max size of the database expressed in bytes.", + "type": "integer" + }, + "databaseGuid": { + "format": "uuid", + "description": "The Guid of the database.", + "type": "string", + "readOnly": true + } + } + }, + "SqlDatabase": { + "description": "A sql database resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "systemData": { + "$ref": "../../../../common/v1/types.json#/definitions/SystemData", + "description": "SystemData of SqlDatabase.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SqlDatabaseProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlDatabaseUpdate": { + "description": "A sql database resource.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/SqlDatabaseProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlDatabaseListResult": { + "description": "A list of databases.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlDatabase" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json new file mode 100644 index 000000000000..cba91ee61f96 --- /dev/null +++ b/specification/synapse/resource-manager/Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json @@ -0,0 +1,407 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-04-01-preview", + "title": "SynapseSqlManagementClient", + "description": "The Azure Synapse SQL management API provides a RESTful set of web APIs that interact with Azure Synapse SQL services to manage your resources. The API enables users to create, retrieve, update, and delete SqlPools, SqlDatabases, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools/{sqlPoolName}": { + "get": { + "tags": [ + "SqlPools" + ], + "description": "Gets a SqlPool.", + "operationId": "SqlPools_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/SqlPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified SqlPool.", + "schema": { + "$ref": "#/definitions/SqlPool" + } + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-examples": { + "Gets a sqlpool.": { + "$ref": "./examples/GetSqlPool.json" + } + } + }, + "put": { + "tags": [ + "SqlPools" + ], + "description": "Creates a new SqlPool or updates an existing SqlPool.", + "operationId": "SqlPools_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/SqlPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested SqlPool resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlPool" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SqlPool.", + "schema": { + "$ref": "#/definitions/SqlPool" + } + }, + "202": { + "description": "Creating or updating the SqlPool is in progress." + }, + "201": { + "description": "Successfully created the SqlPool.", + "schema": { + "$ref": "#/definitions/SqlPool" + } + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates a sqlpool.": { + "$ref": "./examples/PutSqlPool.json" + } + } + }, + "delete": { + "tags": [ + "SqlPools" + ], + "description": "Deletes the SqlPool.", + "operationId": "SqlPools_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/SqlPoolNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the SqlPool." + }, + "202": { + "description": "Deleting the SqlPool is in progress." + }, + "204": { + "description": "The specified SqlPool does not exist." + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Deletes a sqlpool.": { + "$ref": "./examples/DeleteSqlPool.json" + } + } + }, + "patch": { + "tags": [ + "SqlPools" + ], + "description": "Updates an existing sqlpool.", + "operationId": "SqlPools_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/SqlPoolNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested SqlPool resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/SqlPoolUpdate" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the SqlPool.", + "schema": { + "$ref": "#/definitions/SqlPool" + } + }, + "202": { + "description": "Updating the SqlPool is in progress." + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates a sqlpool.": { + "$ref": "./examples/PatchSqlPool.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Synapse/workspaces/{workspaceName}/sqlPools": { + "get": { + "tags": [ + "SqlPools" + ], + "description": "Gets a list of sql pools.", + "operationId": "SqlPools_ListByWorkspace", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "../../../../common/v1/types.json#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of sql pools.", + "schema": { + "$ref": "#/definitions/SqlPoolListResult" + } + }, + "default": { + "schema": { + "$ref": "../../../../common/v1/types.json#/definitions/ErrorContract" + }, + "description": "" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Gets a list of sql pools.": { + "$ref": "./examples/ListSqlPoolsByWorkspace.json" + } + } + } + } + }, + "definitions": { + "SqlPoolProperties": { + "description": "The sql pool's properties.", + "type": "object", + "properties": { + "status": { + "description": "The status of the sql pool.", + "enum": [ + "Invisible", + "Online", + "Offline", + "Creating", + "Inaccessible", + "Pausing", + "Paused", + "Resuming", + "Scaling", + "Dropping", + "Error", + "Unknown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SqlPoolStatus", + "modelAsString": true + } + }, + "sqlPoolGuid": { + "format": "uuid", + "description": "The Guid of the sql pool.", + "type": "string", + "readOnly": true + }, + "currentServiceObjectiveName": { + "description": "The current service level objective name of the sql pool.", + "type": "string", + "readOnly": true + }, + "requestedServiceObjectiveName": { + "description": "The requested service level objective name of the sql pool.", + "type": "string", + "readOnly": true + } + } + }, + "SqlPool": { + "description": "A sql pool resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "../../../../common/v1/types.json#/definitions/Sku", + "description": "The sql pool SKU. The list of SKUs may vary by region and support offer." + }, + "kind": { + "description": "Kind of SqlPool.", + "type": "string", + "readOnly": true + }, + "systemData": { + "$ref": "../../../../common/v1/types.json#/definitions/SystemData", + "description": "SystemData of SqlPool.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/SqlPoolProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "SqlPoolUpdate": { + "description": "A sql pool resource.", + "type": "object", + "properties": { + "sku": { + "$ref": "../../../../common/v1/types.json#/definitions/Sku", + "description": "The name and tier of the SKU." + }, + "properties": { + "$ref": "#/definitions/SqlPoolProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "SqlPoolListResult": { + "description": "A list of sql pools.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/SqlPool" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/synapse/resource-manager/readme.md b/specification/synapse/resource-manager/readme.md index 220b68f46ab2..870c1484aa8c 100644 --- a/specification/synapse/resource-manager/readme.md +++ b/specification/synapse/resource-manager/readme.md @@ -49,6 +49,18 @@ input-file: - Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json ``` +### Tag: package-2020-04-01-preview + +These settings apply only when `--tag=package-2020-04-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-04-01-preview' +input-file: +- Microsoft.Synapse/preview/2020-04-01-preview/operations.json +- Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json +- Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json + +``` + ## Suppressions ``` yaml @@ -130,6 +142,9 @@ input-file: - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privateLinkResources.json - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privateEndpointConnections.json - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/privatelinkhub.json + - $(this-folder)/Microsoft.Synapse/preview/2020-04-01-preview/operations.json + - $(this-folder)/Microsoft.Synapse/preview/2020-04-01-preview/sqlPool.json + - $(this-folder)/Microsoft.Synapse/preview/2020-04-01-preview/sqlDatabase.json ``` From 064ddffbfafb8dff25b037de30179e33c112c08c Mon Sep 17 00:00:00 2001 From: Tanyi Chen Date: Thu, 2 Jul 2020 15:48:17 +0800 Subject: [PATCH 256/318] Java update (#10022) * update app config java * update avs java readme --- .../resource-manager/readme.java.md | 14 ++++++++++++++ .../vmware/resource-manager/readme.java.md | 11 +++++------ 2 files changed, 19 insertions(+), 6 deletions(-) diff --git a/specification/appconfiguration/resource-manager/readme.java.md b/specification/appconfiguration/resource-manager/readme.java.md index b8c72208580f..f20aca80ff98 100644 --- a/specification/appconfiguration/resource-manager/readme.java.md +++ b/specification/appconfiguration/resource-manager/readme.java.md @@ -16,10 +16,24 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-appconfiguration ``` yaml $(java) && $(multiapi) batch: + - tag: package-2020-06-01 - tag: package-2019-10-01 - tag: package-2019-02-01-preview ``` +### Tag: package-2020-06-01 and java + +These settings apply only when `--tag=package-2020-06-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag)=='package-2020-06-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.appconfiguration.v2020_06_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/appconfiguration/mgmt-v2020_06_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2019-10-01 and java These settings apply only when `--tag=package-2019-10-01 --java` is specified on the command line. diff --git a/specification/vmware/resource-manager/readme.java.md b/specification/vmware/resource-manager/readme.java.md index 0962072b7879..48dbcd130384 100644 --- a/specification/vmware/resource-manager/readme.java.md +++ b/specification/vmware/resource-manager/readme.java.md @@ -4,12 +4,11 @@ These settings apply only when `--java` is specified on the command line. Please also specify `--azure-libraries-for-java-folder=`. ``` yaml $(java) -java: - azure-arm: true - namespace: com.microsoft.azure.management.avs - override-client-name: AvsClient - license-header: MICROSOFT_MIT_NO_CODEGEN - output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-avs +azure-arm: true +namespace: com.microsoft.azure.management.avs +override-client-name: AvsClient +license-header: MICROSOFT_MIT_NO_CODEGEN +output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-avs ``` ### Java multi-api From 3329aa5ffd7927fb78b37a68721e00772c61aa06 Mon Sep 17 00:00:00 2001 From: stuartko <47676853+stuartko@users.noreply.github.com> Date: Thu, 2 Jul 2020 06:26:44 -0700 Subject: [PATCH 257/318] Template Specs: Dropping "Model" suffix from TemplateSpec and TemplateSpecVersion (#9998) --- .../2019-06-01-preview/templateSpecs.json | 28 +++++++++---------- .../resources/resource-manager/readme.md | 6 ++-- 2 files changed, 17 insertions(+), 17 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json index 9cc8d212cd87..dd273dcb47bf 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json +++ b/specification/resources/resource-manager/Microsoft.Resources/preview/2019-06-01-preview/templateSpecs.json @@ -64,7 +64,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TemplateSpecModel" + "$ref": "#/definitions/TemplateSpec" }, "description": "Template Spec supplied to the operation." } @@ -73,13 +73,13 @@ "200": { "description": "OK - The Template Spec update request has succeeded.", "schema": { - "$ref": "#/definitions/TemplateSpecModel" + "$ref": "#/definitions/TemplateSpec" } }, "201": { "description": "Template Spec created.", "schema": { - "$ref": "#/definitions/TemplateSpecModel" + "$ref": "#/definitions/TemplateSpec" } }, "default": { @@ -127,7 +127,7 @@ "200": { "description": "OK -- Template Spec tags are updated.", "schema": { - "$ref": "#/definitions/TemplateSpecModel" + "$ref": "#/definitions/TemplateSpec" } }, "default": { @@ -167,7 +167,7 @@ "200": { "description": "OK - Returns information about the Template Spec.", "schema": { - "$ref": "#/definitions/TemplateSpecModel" + "$ref": "#/definitions/TemplateSpec" } }, "default": { @@ -333,7 +333,7 @@ "in": "body", "required": true, "schema": { - "$ref": "#/definitions/TemplateSpecVersionModel" + "$ref": "#/definitions/TemplateSpecVersion" }, "description": "Template Spec Version supplied to the operation." } @@ -342,13 +342,13 @@ "200": { "description": "OK - The Template Spec Version has been successfully updated.", "schema": { - "$ref": "#/definitions/TemplateSpecVersionModel" + "$ref": "#/definitions/TemplateSpecVersion" } }, "201": { "description": "Template Spec Version created.", "schema": { - "$ref": "#/definitions/TemplateSpecVersionModel" + "$ref": "#/definitions/TemplateSpecVersion" } }, "default": { @@ -399,7 +399,7 @@ "200": { "description": "OK -- Template Spec Version tags are updated.", "schema": { - "$ref": "#/definitions/TemplateSpecVersionModel" + "$ref": "#/definitions/TemplateSpecVersion" } }, "default": { @@ -442,7 +442,7 @@ "200": { "description": "OK - Returns information about the Template Spec version.", "schema": { - "$ref": "#/definitions/TemplateSpecVersionModel" + "$ref": "#/definitions/TemplateSpecVersion" } }, "default": { @@ -544,7 +544,7 @@ } }, "definitions": { - "TemplateSpecModel": { + "TemplateSpec": { "required": [ "location" ], @@ -600,7 +600,7 @@ "value": { "type": "array", "items": { - "$ref": "#/definitions/TemplateSpecModel" + "$ref": "#/definitions/TemplateSpec" }, "description": "An array of Template Specs." }, @@ -675,7 +675,7 @@ } } }, - "TemplateSpecVersionModel": { + "TemplateSpecVersion": { "required": [ "properties", "location" @@ -738,7 +738,7 @@ "value": { "type": "array", "items": { - "$ref": "#/definitions/TemplateSpecVersionModel" + "$ref": "#/definitions/TemplateSpecVersion" }, "description": "An array of Template Spec versions." }, diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index 358f01e9d22b..b09c755b4088 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -580,8 +580,8 @@ directive: - suppress: R3006 #BodyTopLevelProperties from: templateSpecs.json where: - - $.definitions.TemplateSpecModel.properties - - $.definitions.TemplateSpecVersionModel.properties + - $.definitions.TemplateSpec.properties + - $.definitions.TemplateSpecVersion.properties - $.definitions.TemplateSpecUpdateModel.properties - $.definitions.TemplateSpecVersionUpdateModel.properties reason: Currently systemData is not allowed @@ -591,7 +591,7 @@ directive: reason: Tooling issue - suppress: TrackedResourceListByResourceGroup from: templateSpecs.json - where: $.definitions.TemplateSpecVersionModel + where: $.definitions.TemplateSpecVersion reason: Tooling issue ``` From 9591b3b74b54fd1248dfaa7f07a2faf4d89a5f68 Mon Sep 17 00:00:00 2001 From: Shangwei Sun <63389531+sunsw1994@users.noreply.github.com> Date: Fri, 3 Jul 2020 00:46:32 +0800 Subject: [PATCH 258/318] [Synapse]-Update data plane monitoring swagger (#9865) * Update data plane monitoring swagger * remove 401 from response --- .../Monitoring_GetApplicationDetails.json | 39 -- .../Monitoring_GetHistoryServerData.json | 30 - ...Monitoring_GetHistoryServerDiagnostic.json | 52 -- .../Monitoring_GetHistoryServerGraph.json | 36 -- ...Monitoring_GetHistoryServerProperties.json | 15 - .../examples/Monitoring_GetSparkJobList.json | 6 +- .../Monitoring_GetSqlJobQueryString.json | 13 + .../2019-11-01-preview/monitoring.json | 557 ++---------------- specification/synapse/data-plane/readme.md | 13 + 9 files changed, 71 insertions(+), 690 deletions(-) delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetApplicationDetails.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerData.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerDiagnostic.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerGraph.json delete mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerProperties.json create mode 100644 specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetSqlJobQueryString.json diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetApplicationDetails.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetApplicationDetails.json deleted file mode 100644 index 1880cfce5cf4..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetApplicationDetails.json +++ /dev/null @@ -1,39 +0,0 @@ -{ - "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview", - "poolName": "thePoolName", - "livyId": "theLivyId" - }, - "responses": { - "200": { - "body": { - "nJobs": 1, - "sparkJobs": [ - { - "state": "Failure", - "name": "sparkjobname", - "submitter": "submittername", - "compute": "ComputeName", - "sparkApplicationId": "sparkApplicationId", - "livyId": "LivyIdValue", - "timing": [ - "Ended || Submitting || In Progress", - "553h 11m" - ], - "sparkJobDefinition": null, - "pipeline": [], - "jobType": "Spark session || Batch Job", - "submitTime": "2019-11-11T15:08:52.9554438-08:00", - "endTime": "2019-11-11T15:08:56.2314317-08:00", - "queuedDuration": "1s", - "runningDuration": "2s", - "totalDuration": "3s" - } - ] - } - }, - "401": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerData.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerData.json deleted file mode 100644 index c65804ab0942..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerData.json +++ /dev/null @@ -1,30 +0,0 @@ -{ - "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview", - "poolName": "thePoolName", - "livyId": "theLivyId", - "appId": "theapplicationId", - "attemptId": "theattemptId" - }, - "responses": { - "200": { - "body": { - "data": { - "handlerPath": "/enhancement/v1/data", - "inputs": [], - "outputs": [], - "tables": { - "operation": "fill in here", - "options": [] - }, - "config": { - "isHiveEnabled": false - } - } - } - }, - "401": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerDiagnostic.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerDiagnostic.json deleted file mode 100644 index 9cd092208eab..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerDiagnostic.json +++ /dev/null @@ -1,52 +0,0 @@ -{ - "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview", - "poolName": "thePoolName", - "livyId": "theLivyId", - "appId": "theapplicationId", - "attemptId": "theattemptId" - }, - "responses": { - "200": { - "body": { - "data": { - "stages": { - "dataAvg": 0, - "timeAvg": 0, - "id": 0, - "attemptId": 0, - "name": "reduce at SparkPi.scala:38", - "dataSkewTask": [ - 5 - ], - "timeSkewTask": [ - 0 - ], - "tasks": [ - 0, - 0, - 823 - ] - }, - "executors": { - "isDynamicAllocationOn": false, - "executorInstances": 3, - "startTime": 1571267103455, - "endTime": 1571267120032, - "events": [ - 1571267110853, - 1, - 1, - 0 - ], - "executorCores": "2", - "executorMemory": "7g" - } - } - } - }, - "401": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerGraph.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerGraph.json deleted file mode 100644 index a2db0e496b45..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerGraph.json +++ /dev/null @@ -1,36 +0,0 @@ -{ - "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview", - "poolName": "thePoolName", - "livyId": "theLivyId", - "appId": "theapplicationId", - "attemptId": "theattemptId" - }, - "responses": { - "200": { - "body": { - "data": { - "isAppFinished": true, - "jobs": { - "time": 8515, - "startTime": 1571267111504, - "id": 0, - "edges": [ - { - "id": 1, - "childId": 2 - } - ], - "nodes": [ - 0 - ] - }, - "stages": null - } - } - }, - "401": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerProperties.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerProperties.json deleted file mode 100644 index 822115335b9e..000000000000 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetHistoryServerProperties.json +++ /dev/null @@ -1,15 +0,0 @@ -{ - "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", - "api-version": "2019-11-01-preview" - }, - "responses": { - "200": { - "body": { - "webProxyEndpoint": "history server URL" - } - }, - "401": {} - } -} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetSparkJobList.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetSparkJobList.json index a21200723ecf..724a0c528678 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetSparkJobList.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetSparkJobList.json @@ -1,7 +1,6 @@ { "parameters": { - "workspaceName": "myWorkspace", - "SynapseDnsSuffix": "dev.azuresynapse.net", + "endpoint": "myWorkspace.dev.azuresynapse.net", "api-version": "2019-11-01-preview" }, "responses": { @@ -31,7 +30,6 @@ } ] } - }, - "401": {} + } } } diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetSqlJobQueryString.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetSqlJobQueryString.json new file mode 100644 index 000000000000..68acf471e8fd --- /dev/null +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/examples/Monitoring_GetSqlJobQueryString.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "endpoint": "myWorkspace.dev.azuresynapse.net", + "api-version": "2019-11-01-preview" + }, + "responses": { + "200": { + "body": { + "query": "select * from ( SELECT COUNT(*) OVER() AS total_count,'Running' as [status],'0' as [request_id],'SQL On-demand' as [SQL Resource],s.login_name as [login_name],s.Session_Id as [session_id],r.start_time as [submit_time],r.start_time as [start_time],'N/A' as [end_time],r.command as [commandClause],sqltext.TEXT as [command],r.total_elapsed_time as [Duration],'N/A' as [Queued Duration],r.total_elapsed_time as [Running Duration],'N/A' as [Data processed in bytes],'N/A' as [group_name],'N/A' as [Source],'N/A' as [Pipeline],'N/A' as [importance],'N/A' as [classifier_name],Row_number() over ( ORDER BY r.start_time desc) as rownum FROM sys.dm_exec_requests r CROSS APPLY sys.dm_exec_sql_text(sql_handle) sqltext JOIN sys.dm_exec_sessions s ON r.session_id = s.session_id where (r.start_time between CONVERT(datetime,'2020-06-04T17:14:17Z') and CONVERT(datetime,'2020-06-05T17:14:22Z')) and s.session_id not in (select distinct Session_Id from sys.dm_exec_requests where command like'%@@Azure.Synapse.Monitoring.SQLQuerylist%')) tbl where rownum between 0 and 100-- @@Azure.Synapse.Monitoring.SQLQuerylist" + } + } + } +} diff --git a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json index 329d7ceb91e9..3c1a7163b5fc 100644 --- a/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json +++ b/specification/synapse/data-plane/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json @@ -5,18 +5,11 @@ "title": "SynapseClient" }, "x-ms-parameterized-host": { - "hostTemplate": "{workspaceName}.{SynapseDnsSuffix}", + "hostTemplate": "{endpoint}", + "useSchemePrefix": false, "parameters": [ { - "name": "workspaceName", - "description": "The name of the workspace to execute operations on.", - "required": true, - "type": "string", - "in": "path", - "x-ms-skip-url-encoding": true - }, - { - "$ref": "#/parameters/SynapseDnsSuffixInPath" + "$ref": "#/parameters/Endpoint" } ] }, @@ -30,70 +23,6 @@ "application/json" ], "paths": { - "/monitoring/workloadTypes/spark/pools/{poolName}/livyIds/{livyId}/applications/{appId}/attemptIds/{attemptId}/historyServerData": { - "get": { - "tags": [ - "Monitoring" - ], - "operationId": "Monitoring_GetHistoryServerData", - "description": "Get History Server Data for a given workspace, pool, livyid, appid and attemptId", - "x-ms-examples": { - "Get history server data": { - "$ref": "./examples/Monitoring_GetHistoryServerData.json" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "poolName", - "description": "The spark pool name.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "livyId", - "description": "The livy id.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "appId", - "description": "The application id.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "attemptId", - "description": "The attempt id.", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/HistoryServerDataResponse" - } - }, - "401": { - "description": "Unauthorized" - } - } - } - }, "/monitoring/workloadTypes/spark/Applications": { "get": { "tags": [ @@ -106,65 +35,19 @@ "$ref": "./examples/Monitoring_GetSparkJobList.json" } }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/SparkJobListViewResponse" - } - }, - "401": { - "description": "Unauthorized" - } - } - } - }, - "/monitoring/workloadTypes/spark/pools/{poolName}/livyIds/{livyId}": { - "get": { - "tags": [ - "Monitoring" - ], - "operationId": "Monitoring_GetApplicationDetails", - "description": "Get one spark application details given the workspace name, pool name and livyid.", - "x-ms-examples": { - "Get list of spark application": { - "$ref": "./examples/Monitoring_GetApplicationDetails.json" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], "parameters": [ { - "name": "poolName", - "description": "The spark pool name.", - "in": "path", - "required": true, - "type": "string" + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "description": "Can provide a guid, which is helpful for debugging and to provide better customer support" }, { - "name": "livyId", - "description": "The livy id.", - "in": "path", + "name": "api-version", + "in": "query", "required": true, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { @@ -173,173 +56,61 @@ "schema": { "$ref": "#/definitions/SparkJobListViewResponse" } - }, - "401": { - "description": "Unauthorized" } } } }, - "/monitoring/workloadTypes/spark/historyServerProperties": { + "/monitoring/workloadTypes/sql/querystring": { "get": { "tags": [ "Monitoring" ], - "operationId": "Monitoring_GetHistoryServerProperties", - "description": "Get History server properties.", + "operationId": "Monitoring_GetSqlJobQueryString", + "description": "Get SQL OD/DW Query for the workspace.", "x-ms-examples": { - "Get history server properties": { - "$ref": "./examples/Monitoring_GetHistoryServerProperties.json" + "Get SOL job query string": { + "$ref": "./examples/Monitoring_GetSqlJobQueryString.json" } }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], "parameters": [ { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/HistoryServerPropertiesResponse" - } + "name": "x-ms-client-request-id", + "in": "header", + "required": false, + "type": "string", + "description": "Can provide a guid, which is helpful for debugging and to provide better customer support" }, - "401": { - "description": "Unauthorized" - } - } - } - }, - "/monitoring/workloadTypes/spark/pools/{poolName}/livyIds/{livyId}/applications/{appId}/attemptIds/{attemptId}/historyServerDiagnostic": { - "get": { - "tags": [ - "Monitoring" - ], - "operationId": "Monitoring_GetHistoryServerDiagnostic", - "description": "Get History Server Diagnostic Data for a given workspace, pool, livyid, appid and attemptId", - "x-ms-examples": { - "Get history server diagnostic data": { - "$ref": "./examples/Monitoring_GetHistoryServerDiagnostic.json" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ { - "name": "poolName", - "description": "The spark pool name.", - "in": "path", + "name": "api-version", + "in": "query", "required": true, "type": "string" }, { - "name": "livyId", - "description": "The livy id.", - "in": "path", - "required": true, + "name": "filter", + "in": "query", + "required": false, "type": "string" }, { - "name": "appId", - "description": "The application id.", - "in": "path", - "required": true, + "name": "$orderby", + "in": "query", + "required": false, "type": "string" }, { - "name": "attemptId", - "description": "The attempt id.", - "in": "path", - "required": true, + "name": "skip", + "in": "query", + "required": false, "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" } ], "responses": { "200": { "description": "Success", "schema": { - "$ref": "#/definitions/HistoryServerDiagnosticResponse" + "$ref": "#/definitions/SqlQueryStringDataModel" } - }, - "401": { - "description": "Unauthorized" - } - } - } - }, - "/monitoring/workloadTypes/spark/pools/{poolName}/livyIds/{livyId}/applications/{appId}/attemptIds/{attemptId}/historyServerGraph": { - "get": { - "tags": [ - "Monitoring" - ], - "operationId": "Monitoring_GetHistoryServerGraph", - "description": "Get History Server Graph Data for a given workspace, pool, livyid, appid and attemptId", - "x-ms-examples": { - "Get history server graph data": { - "$ref": "./examples/Monitoring_GetHistoryServerGraph.json" - } - }, - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "parameters": [ - { - "name": "poolName", - "description": "The spark pool name.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "livyId", - "description": "The livy id.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "appId", - "description": "The application id.", - "in": "path", - "required": true, - "type": "string" - }, - { - "name": "attemptId", - "description": "The attempt id.", - "in": "path", - "required": true, - "type": "string" - }, - { - "$ref": "#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success", - "schema": { - "$ref": "#/definitions/HistoryServerGraphResponse" - } - }, - "401": { - "description": "Unauthorized" } } } @@ -422,273 +193,31 @@ } } }, - "HistoryServerPropertiesResponse": { + "SqlQueryStringDataModel": { "type": "object", "properties": { - "webProxyEndpoint": { + "query": { "type": "string" } } - }, - "HistoryServerDataResponse": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/Data" - } - } - }, - "Data": { - "type": "object", - "properties": { - "handlerPath": { - "type": "string" - }, - "inputs": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "outputs": { - "uniqueItems": false, - "type": "array", - "items": { - "type": "string" - } - }, - "tables": { - "$ref": "#/definitions/Tables" - }, - "config": { - "$ref": "#/definitions/Config" - } - } - }, - "Tables": { - "type": "object", - "properties": { - "operation": { - "type": "string" - }, - "options": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Option" - } - } - } - }, - "Config": { - "type": "object", - "properties": { - "isHiveEnabled": { - "type": "boolean" - } - } - }, - "Option": { - "type": "object", - "properties": { - "additionalProp1": { - "type": "string" - }, - "additionalProp2": { - "type": "string" - }, - "additionalProp3": { - "type": "string" - } - } - }, - "HistoryServerDiagnosticResponse": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/HistoryServerDiagnosticResponseData" - } - } - }, - "HistoryServerDiagnosticResponseData": { - "type": "object", - "properties": { - "stages": { - "$ref": "#/definitions/Stages" - }, - "executors": { - "$ref": "#/definitions/Executors" - } - } - }, - "Stages": { - "type": "object", - "properties": { - "dataAvg": { - "format": "int32", - "type": "integer" - }, - "timeAvg": { - "format": "int32", - "type": "integer" - }, - "id": { - "format": "int32", - "type": "integer" - }, - "attemptId": { - "format": "int32", - "type": "integer" - }, - "name": { - "type": "string" - }, - "dataSkewTask": { - "uniqueItems": false, - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - }, - "timeSkewTask": { - "uniqueItems": false, - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - }, - "tasks": { - "uniqueItems": false, - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - } - } - }, - "Executors": { - "type": "object", - "properties": { - "isDynamicAllocationOn": { - "type": "boolean" - }, - "executorInstances": { - "format": "int32", - "type": "integer" - }, - "startTime": { - "format": "int32", - "type": "integer" - }, - "endTime": { - "format": "int32", - "type": "integer" - }, - "events": { - "uniqueItems": false, - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - }, - "executorCores": { - "type": "string" - }, - "executorMemory": { - "type": "string" - } - } - }, - "HistoryServerGraphResponse": { - "type": "object", - "properties": { - "data": { - "$ref": "#/definitions/HistoryServerGraphResponseData" - } - } - }, - "HistoryServerGraphResponseData": { - "type": "object", - "properties": { - "isAppFinished": { - "type": "boolean" - }, - "jobs": { - "$ref": "#/definitions/Jobs" - }, - "stages": { - "$ref": "#/definitions/Stages" - } - } - }, - "Jobs": { - "type": "object", - "properties": { - "time": { - "format": "int32", - "type": "integer" - }, - "startTime": { - "format": "int32", - "type": "integer" - }, - "id": { - "format": "int32", - "type": "integer" - }, - "edges": { - "uniqueItems": false, - "type": "array", - "items": { - "$ref": "#/definitions/Edge" - } - }, - "nodes": { - "uniqueItems": false, - "type": "array", - "items": { - "format": "int32", - "type": "integer" - } - } - } - }, - "Edge": { - "type": "object", - "properties": { - "id": { - "format": "int32", - "type": "integer" - }, - "childId": { - "format": "int32", - "type": "integer" - } - } } }, "parameters": { + "Endpoint": { + "name": "endpoint", + "description": "The workspace development endpoint, for example https://myworkspace.dev.azuresynapse.net.", + "required": true, + "type": "string", + "in": "path", + "x-ms-skip-url-encoding": true, + "x-ms-parameter-location": "client" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", "required": true, "type": "string", "description": "The Synapse client API Version." - }, - "SynapseDnsSuffixInPath": { - "name": "SynapseDnsSuffix", - "in": "path", - "required": true, - "type": "string", - "default": "dev.azuresynapse.net", - "x-ms-skip-url-encoding": true, - "description": "Gets the DNS suffix used as the base for all Synapse service requests.", - "x-ms-parameter-location": "client" } } } diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md index 90987da109b6..21d88e28aa0c 100644 --- a/specification/synapse/data-plane/readme.md +++ b/specification/synapse/data-plane/readme.md @@ -43,6 +43,10 @@ tag: package-access-control-2020-02-01-preview tag: package-vnet-2019-06-01-preview ``` +``` yaml $(package-monitoring) +tag: package-monitoring-2019-11-01-preview +``` + ### Tag: package-spark-2019-11-01-preview These settings apply only when `--tag=package-spark-2019-11-01-preview` is specified on the command line. @@ -80,6 +84,15 @@ input-file: - Microsoft.Synapse/preview/2019-06-01-preview/managedPrivateEndpoints.json ``` +### Tag: package-monitoring-2019-11-01-preview + +These settings apply only when `--tag=package-monitoring-2019-11-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-monitoring-2019-11-01-preview' +input-file: +- Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json +``` + ## Suppression ``` yaml directive: From f4178c1c505dc55af9ac9dd27195164940489077 Mon Sep 17 00:00:00 2001 From: Sanjai Ganesh Jeenagiri Date: Thu, 2 Jul 2020 20:26:07 -0700 Subject: [PATCH 259/318] Pipeline for creating data container with repo contents (#9917) * pipeline, docker files * adding datacontainerpipelinereview to trigger * trigger datacontainerreview-2 * trigger * Trigger-repo * moved variable imagename prefix into pipeline * IMAGE_TAG_PREFIX fix * REPOSITORY_NAME_PREFIX * pass source directory arg and copy .git folder * git checkout master -f * build and push separate. schedule only. push to single repo. docker arg * adding logging * build-arg * /home/vsts/work/1/s * ${SOURCE_DIRECTORY} * reverting to build parameter * quotes * default value to source directly * ARG after FROM * Remove default value * repocontents . map volume * repocontents . map volume * Update Dockerfile * source folder * source folder * scripts/datacontainer * CONTAINER_REGISTRY_repository_name * working directory * checking env. remove chmod * add chmod * add RUN chmod * removing run.sh * removing chmod * add chmod * USE CONTAINER_REGISTRY_CONNECTION_NAME * USE CONTAINER_REGISTRY_CONNECTION_NAME * docker login * env * removing spaces * removing repository details from docker tasks * CONTAINER_REGISTRY_LOGIN_SERVER * adding input repository: $(CONTAINER_REGISTRY_REPOSITORY_NAME) * containerRegistry: '***' * containerRegistry: $(CONTAINER_REGISTRY_NAME) * cleanup yaml * removing mkdir * move pipeline yml Co-authored-by: Sanjai Ganesh --- .../azure-pipelines-data-container.yml | 38 +++++++++++++++++++ scripts/datacontainer/Dockerfile | 15 ++++++++ scripts/datacontainer/run.sh | 17 +++++++++ 3 files changed, 70 insertions(+) create mode 100644 .azure-pipelines/azure-pipelines-data-container.yml create mode 100644 scripts/datacontainer/Dockerfile create mode 100644 scripts/datacontainer/run.sh diff --git a/.azure-pipelines/azure-pipelines-data-container.yml b/.azure-pipelines/azure-pipelines-data-container.yml new file mode 100644 index 000000000000..e3d3f4956006 --- /dev/null +++ b/.azure-pipelines/azure-pipelines-data-container.yml @@ -0,0 +1,38 @@ +schedules: +- cron: "0 0 * * *" + displayName: Daily build + branches: + include: + - master + always: true + +pool: + vmImage: 'Ubuntu-16.04' + +variables: + IMAGE_TAG_PREFIX: $[format('1.0.{0:HHm}', pipeline.startTime)] + +steps: +- task: Docker@2 + displayName: Login to ACR + inputs: + command: login + Dockerfile: scripts/datacontainer/Dockerfile + containerRegistry: $(CONTAINER_REGISTRY_SERVICE_CONNECTION) + +- task: CopyFiles@2 + inputs: + SourceFolder: $(Build.SourcesDirectory) + contents: .git/** + targetFolder: $(Build.SourcesDirectory)/scripts/datacontainer + +- task: Docker@2 + displayName: Build and Push + inputs: + command: buildAndPush + Dockerfile: scripts/datacontainer/Dockerfile + containerRegistry: $(CONTAINER_REGISTRY_SERVICE_CONNECTION) + repository: $(CONTAINER_REGISTRY_REPOSITORY_NAME) + tags: | + latest + $(IMAGE_TAG_PREFIX)$(Build.BuildNumber) diff --git a/scripts/datacontainer/Dockerfile b/scripts/datacontainer/Dockerfile new file mode 100644 index 000000000000..f36ab2eb398e --- /dev/null +++ b/scripts/datacontainer/Dockerfile @@ -0,0 +1,15 @@ +FROM alpine:3.8 + +RUN apk update && \ + apk add git + +RUN mkdir -p /usr/data/specrepo/ +COPY .git /usr/data/specrepo/.git + +WORKDIR /usr/data/scripts/ +COPY run.sh run.sh +RUN chmod +x run.sh + +RUN mkdir -p /usr/data/openapispecs/ +WORKDIR /usr/data/openapispecs +ENTRYPOINT /usr/data/scripts/run.sh diff --git a/scripts/datacontainer/run.sh b/scripts/datacontainer/run.sh new file mode 100644 index 000000000000..b83512783af3 --- /dev/null +++ b/scripts/datacontainer/run.sh @@ -0,0 +1,17 @@ + +#!/bin/bash + +timestamp=`date +%Y/%m/%d-%H:%M:%S` +echo "[$timestamp] Copying files to /usr/data/openapispecs" +cp -R /usr/data/specrepo/.git/* /usr/data/openapispecs/.git/ + +timestamp=`date +%Y/%m/%d-%H:%M:%S` +echo "[$timestamp] Running git checkout master" +git checkout $specRetrievalGitBranch -f + +timestamp=`date +%Y/%m/%d-%H:%M:%S` +echo "[$timestamp] Deleting directory /usr/data/specrepo" +rm -R /usr/data/specrepo/ + +timestamp=`date +%Y/%m/%d-%H:%M:%S` +echo "[$timestamp] Init completed successfully. OpenAPI specs are present in /usr/data/openapispecs." From c57ad5f5b7f30d8da1a7aae9f7801e4714f3d155 Mon Sep 17 00:00:00 2001 From: Moustafa Eid Date: Fri, 3 Jul 2020 20:08:25 -0700 Subject: [PATCH 260/318] Frontdoor RP v05-01 to use WAF from RP 04-01 (#9964) * revert WAF to use 04-01 * remove json file from md * remove WAF files --- .../examples/WafListManagedRuleSets.json | 69 -- .../2020-05-01/examples/WafListPolicies.json | 130 --- .../examples/WafPolicyCreateOrUpdate.json | 492 ---------- .../2020-05-01/examples/WafPolicyDelete.json | 13 - .../2020-05-01/examples/WafPolicyGet.json | 127 --- .../2020-05-01/webapplicationfirewall.json | 902 ------------------ .../frontdoor/resource-manager/readme.md | 3 +- .../examples/WafListAllPolicies.json | 102 -- .../2020-05-01/examples/WafListPolicies.json | 103 -- .../examples/WafPolicyCreateOrUpdate.json | 258 ----- .../2020-05-01/examples/WafPolicyDelete.json | 13 - .../2020-05-01/examples/WafPolicyGet.json | 140 --- .../2020-05-01/webapplicationfirewall.json | 743 --------------- .../network/resource-manager/readme.md | 1 - 14 files changed, 1 insertion(+), 3095 deletions(-) delete mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListManagedRuleSets.json delete mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json delete mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json delete mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json delete mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json delete mode 100644 specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json delete mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json delete mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json delete mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json delete mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json delete mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json delete mode 100644 specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListManagedRuleSets.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListManagedRuleSets.json deleted file mode 100644 index b6ee1c3ee4db..000000000000 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListManagedRuleSets.json +++ /dev/null @@ -1,69 +0,0 @@ -{ - "parameters": { - "api-version": "2020-05-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "DefaultRuleSet_1.0", - "id": "/subscriptions/subid/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets", - "type": "Microsoft.Network/frontdoorwebapplicationfirewallmanagedrulesets", - "properties": { - "provisioningState": "Succeeded", - "ruleSetId": "8125d145-ddc5-4d90-9bc3-24c5f2de69a2", - "ruleSetType": "DefaultRuleSet", - "ruleSetVersion": "1.0", - "ruleGroups": [ - { - "ruleGroupName": "SQLI", - "description": "SQL injection", - "rules": [ - { - "ruleId": "942100", - "description": "SQL Injection Attack Detected via libinjection", - "defaultState": "Enabled", - "defaultAction": "Block" - }, - { - "ruleId": "942110", - "description": "SQL Injection Attack: Common Injection Testing Detected", - "defaultState": "Enabled", - "defaultAction": "Block" - } - ] - }, - { - "ruleGroupName": "XSS", - "description": "Cross-site scripting", - "rules": [ - { - "ruleId": "941100", - "description": "XSS Attack Detected via libinjection", - "defaultState": "Enabled", - "defaultAction": "Block" - }, - { - "ruleId": "941101", - "description": "XSS Attack Detected via libinjection", - "defaultState": "Enabled", - "defaultAction": "Block" - }, - { - "ruleId": "941110", - "description": "XSS Filter - Category 1: Script Tag Vector", - "defaultState": "Enabled", - "defaultAction": "Block" - } - ] - } - ] - } - } - ] - } - } - } -} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json deleted file mode 100644 index 8617a12656df..000000000000 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json +++ /dev/null @@ -1,130 +0,0 @@ -{ - "parameters": { - "api-version": "2020-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Policy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", - "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "location": "WestUs", - "properties": { - "resourceState": "Enabled", - "provisioningState": "Succeeded", - "policySettings": { - "enabledState": "Enabled", - "mode": "Prevention", - "redirectUrl": "http://www.bing.com", - "customBlockResponseStatusCode": 499, - "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" - }, - "customRules": { - "rules": [ - { - "name": "Rule1", - "priority": 1, - "enabledState": "Enabled", - "ruleType": "RateLimitRule", - "rateLimitDurationInMinutes": 0, - "rateLimitThreshold": 1000, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "selector": null, - "operator": "IPMatch", - "negateCondition": false, - "matchValue": [ - "192.168.1.0/24", - "10.0.0.0/24" - ], - "transforms": [] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "enabledState": "Enabled", - "ruleType": "MatchRule", - "rateLimitDurationInMinutes": 0, - "rateLimitThreshold": 0, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "selector": null, - "operator": "GeoMatch", - "negateCondition": false, - "matchValue": [ - "CH" - ] - }, - { - "matchVariable": "RequestHeader", - "selector": "UserAgent", - "operator": "Contains", - "negateCondition": false, - "matchValue": [ - "windows" - ], - "transforms": [ - "Lowercase" - ] - } - ], - "action": "Block" - } - ] - }, - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "DefaultRuleSet", - "ruleSetVersion": "1.0", - "exclusions": [ - { - "matchVariable": "RequestHeaderNames", - "selectorMatchOperator": "Equals", - "selector": "User-Agent" - } - ], - "ruleGroupOverrides": [ - { - "ruleGroupName": "SQLI", - "rules": [ - { - "ruleId": "942100", - "enabledState": "Enabled", - "action": "Redirect" - }, - { - "ruleId": "942110", - "enabledState": "Disabled" - } - ] - } - ] - } - ] - }, - "frontendEndpointLinks": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontdoors/fd1/frontendendpoints/fd1-azurefd-net" - } - ] - } - } - ] - } - } - } -} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json deleted file mode 100644 index f4c1a6c18373..000000000000 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json +++ /dev/null @@ -1,492 +0,0 @@ -{ - "parameters": { - "api-version": "2020-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "policyName": "Policy1", - "parameters": { - "properties": { - "policySettings": { - "redirectUrl": "http://www.bing.com", - "customBlockResponseStatusCode": 499, - "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" - }, - "customRules": { - "rules": [ - { - "name": "Rule1", - "priority": 1, - "ruleType": "RateLimitRule", - "rateLimitThreshold": 1000, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "operator": "IPMatch", - "matchValue": [ - "192.168.1.0/24", - "10.0.0.0/24" - ] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "operator": "GeoMatch", - "matchValue": [ - "CH" - ] - }, - { - "matchVariable": "RequestHeader", - "operator": "Contains", - "selector": "UserAgent", - "matchValue": [ - "windows" - ], - "transforms": [ - "Lowercase" - ] - } - ], - "action": "Block" - } - ] - }, - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "DefaultRuleSet", - "ruleSetVersion": "1.0", - "exclusions": [ - { - "matchVariable": "RequestHeaderNames", - "selectorMatchOperator": "Equals", - "selector": "User-Agent" - } - ], - "ruleGroupOverrides": [ - { - "ruleGroupName": "SQLI", - "exclusions": [ - { - "matchVariable": "RequestCookieNames", - "selectorMatchOperator": "StartsWith", - "selector": "token" - } - ], - "rules": [ - { - "ruleId": "942100", - "enabledState": "Enabled", - "action": "Redirect", - "exclusions": [ - { - "matchVariable": "QueryStringArgNames", - "selectorMatchOperator": "Equals", - "selector": "query" - } - ] - }, - { - "ruleId": "942110", - "enabledState": "Disabled" - } - ] - } - ] - } - ] - } - } - } - }, - "responses": { - "200": { - "body": { - "name": "Policy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", - "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "location": "WestUs", - "properties": { - "resourceState": "Enabled", - "provisioningState": "Succeeded", - "policySettings": { - "enabledState": "Enabled", - "mode": "Prevention", - "redirectUrl": "http://www.bing.com", - "customBlockResponseStatusCode": 499, - "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" - }, - "customRules": { - "rules": [ - { - "name": "Rule1", - "priority": 1, - "enabledState": "Enabled", - "ruleType": "RateLimitRule", - "rateLimitDurationInMinutes": 0, - "rateLimitThreshold": 1000, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "selector": null, - "operator": "IPMatch", - "negateCondition": false, - "matchValue": [ - "192.168.1.0/24", - "10.0.0.0/24" - ], - "transforms": [] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "enabledState": "Enabled", - "ruleType": "MatchRule", - "rateLimitDurationInMinutes": 0, - "rateLimitThreshold": 0, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "selector": null, - "operator": "GeoMatch", - "negateCondition": false, - "matchValue": [ - "CH" - ] - }, - { - "matchVariable": "RequestHeader", - "selector": "UserAgent", - "operator": "Contains", - "negateCondition": false, - "matchValue": [ - "windows" - ], - "transforms": [ - "Lowercase" - ] - } - ], - "action": "Block" - } - ] - }, - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "DefaultRuleSet", - "ruleSetVersion": "1.0", - "exclusions": [ - { - "matchVariable": "RequestHeaderNames", - "selectorMatchOperator": "Equals", - "selector": "User-Agent" - } - ], - "ruleGroupOverrides": [ - { - "ruleGroupName": "SQLI", - "exclusions": [ - { - "matchVariable": "RequestCookieNames", - "selectorMatchOperator": "StartsWith", - "selector": "token" - } - ], - "rules": [ - { - "ruleId": "942100", - "enabledState": "Enabled", - "action": "Redirect", - "exclusions": [ - { - "matchVariable": "QueryStringArgNames", - "selectorMatchOperator": "Equals", - "selector": "query" - } - ] - }, - { - "ruleId": "942110", - "enabledState": "Disabled" - } - ] - } - ] - } - ] - }, - "frontendEndpointLinks": [] - } - } - }, - "201": { - "body": { - "name": "Policy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", - "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "location": "WestUs", - "properties": { - "resourceState": "Enabled", - "provisioningState": "Succeeded", - "policySettings": { - "enabledState": "Enabled", - "mode": "Prevention", - "redirectUrl": "http://www.bing.com", - "customBlockResponseStatusCode": 499, - "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" - }, - "customRules": { - "rules": [ - { - "name": "Rule1", - "priority": 1, - "enabledState": "Enabled", - "ruleType": "RateLimitRule", - "rateLimitDurationInMinutes": 0, - "rateLimitThreshold": 1000, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "selector": null, - "operator": "IPMatch", - "negateCondition": false, - "matchValue": [ - "192.168.1.0/24", - "10.0.0.0/24" - ], - "transforms": [] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "enabledState": "Enabled", - "ruleType": "MatchRule", - "rateLimitDurationInMinutes": 0, - "rateLimitThreshold": 0, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "selector": null, - "operator": "GeoMatch", - "negateCondition": false, - "matchValue": [ - "CH" - ] - }, - { - "matchVariable": "RequestHeader", - "selector": "UserAgent", - "operator": "Contains", - "negateCondition": false, - "matchValue": [ - "windows" - ], - "transforms": [ - "Lowercase" - ] - } - ], - "action": "Block" - } - ] - }, - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "DefaultRuleSet", - "ruleSetVersion": "1.0", - "exclusions": [ - { - "matchVariable": "RequestHeaderNames", - "selectorMatchOperator": "Equals", - "selector": "User-Agent" - } - ], - "ruleGroupOverrides": [ - { - "ruleGroupName": "SQLI", - "exclusions": [ - { - "matchVariable": "RequestCookieNames", - "selectorMatchOperator": "StartsWith", - "selector": "token" - } - ], - "rules": [ - { - "ruleId": "942100", - "enabledState": "Enabled", - "action": "Redirect", - "exclusions": [ - { - "matchVariable": "QueryStringArgNames", - "selectorMatchOperator": "Equals", - "selector": "query" - } - ] - }, - { - "ruleId": "942110", - "enabledState": "Disabled" - } - ] - } - ] - } - ] - }, - "frontendEndpointLinks": [] - } - } - }, - "202": { - "body": { - "name": "Policy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", - "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "location": "WestUs", - "properties": { - "resourceState": "Enabled", - "provisioningState": "Succeeded", - "policySettings": { - "enabledState": "Enabled", - "mode": "Prevention", - "redirectUrl": "http://www.bing.com", - "customBlockResponseStatusCode": 499, - "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" - }, - "customRules": { - "rules": [ - { - "name": "Rule1", - "priority": 1, - "enabledState": "Enabled", - "ruleType": "RateLimitRule", - "rateLimitDurationInMinutes": 0, - "rateLimitThreshold": 1000, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "selector": null, - "operator": "IPMatch", - "negateCondition": false, - "matchValue": [ - "192.168.1.0/24", - "10.0.0.0/24" - ], - "transforms": [] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "enabledState": "Enabled", - "ruleType": "MatchRule", - "rateLimitDurationInMinutes": 0, - "rateLimitThreshold": 0, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "selector": null, - "operator": "GeoMatch", - "negateCondition": false, - "matchValue": [ - "CH" - ] - }, - { - "matchVariable": "RequestHeader", - "selector": "UserAgent", - "operator": "Contains", - "negateCondition": false, - "matchValue": [ - "windows" - ], - "transforms": [ - "Lowercase" - ] - } - ], - "action": "Block" - } - ] - }, - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "DefaultRuleSet", - "ruleSetVersion": "1.0", - "exclusions": [ - { - "matchVariable": "RequestHeaderNames", - "selectorMatchOperator": "Equals", - "selector": "User-Agent" - } - ], - "ruleGroupOverrides": [ - { - "ruleGroupName": "SQLI", - "exclusions": [ - { - "matchVariable": "RequestCookieNames", - "selectorMatchOperator": "StartsWith", - "selector": "token" - } - ], - "rules": [ - { - "ruleId": "942100", - "enabledState": "Enabled", - "action": "Redirect", - "exclusions": [ - { - "matchVariable": "QueryStringArgNames", - "selectorMatchOperator": "Equals", - "selector": "query" - } - ] - }, - { - "ruleId": "942110", - "enabledState": "Disabled" - } - ] - } - ] - } - ] - }, - "frontendEndpointLinks": [] - } - } - } - } -} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json deleted file mode 100644 index c887714443bf..000000000000 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "api-version": "2020-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "policyName": "Policy1" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json deleted file mode 100644 index aef1b725a529..000000000000 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json +++ /dev/null @@ -1,127 +0,0 @@ -{ - "parameters": { - "api-version": "2020-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "policyName": "Policy1" - }, - "responses": { - "200": { - "body": { - "name": "Policy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/Policy1", - "type": "Microsoft.Network/frontdoorwebapplicationfirewallpolicies", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "location": "WestUs", - "properties": { - "resourceState": "Enabled", - "provisioningState": "Succeeded", - "policySettings": { - "enabledState": "Enabled", - "mode": "Prevention", - "redirectUrl": "http://www.bing.com", - "customBlockResponseStatusCode": 499, - "customBlockResponseBody": "PGh0bWw+CjxoZWFkZXI+PHRpdGxlPkhlbGxvPC90aXRsZT48L2hlYWRlcj4KPGJvZHk+CkhlbGxvIHdvcmxkCjwvYm9keT4KPC9odG1sPg==" - }, - "customRules": { - "rules": [ - { - "name": "Rule1", - "priority": 1, - "enabledState": "Enabled", - "ruleType": "RateLimitRule", - "rateLimitDurationInMinutes": 0, - "rateLimitThreshold": 1000, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "selector": null, - "operator": "IPMatch", - "negateCondition": false, - "matchValue": [ - "192.168.1.0/24", - "10.0.0.0/24" - ], - "transforms": [] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "enabledState": "Enabled", - "ruleType": "MatchRule", - "rateLimitDurationInMinutes": 0, - "rateLimitThreshold": 0, - "matchConditions": [ - { - "matchVariable": "RemoteAddr", - "selector": null, - "operator": "GeoMatch", - "negateCondition": false, - "matchValue": [ - "CH" - ] - }, - { - "matchVariable": "RequestHeader", - "selector": "UserAgent", - "operator": "Contains", - "negateCondition": false, - "matchValue": [ - "windows" - ], - "transforms": [ - "Lowercase" - ] - } - ], - "action": "Block" - } - ] - }, - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "DefaultRuleSet", - "ruleSetVersion": "1.0", - "exclusions": [ - { - "matchVariable": "RequestHeaderNames", - "selectorMatchOperator": "Equals", - "selector": "User-Agent" - } - ], - "ruleGroupOverrides": [ - { - "ruleGroupName": "SQLI", - "rules": [ - { - "ruleId": "942100", - "enabledState": "Enabled", - "action": "Redirect" - }, - { - "ruleId": "942110", - "enabledState": "Disabled" - } - ] - } - ] - } - ] - }, - "frontendEndpointLinks": [ - { - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/frontdoors/fd1/frontendendpoints/fd1-azurefd-net" - } - ] - } - } - } - } -} diff --git a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json b/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json deleted file mode 100644 index e1deda8ac3cd..000000000000 --- a/specification/frontdoor/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json +++ /dev/null @@ -1,902 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2020-05-01", - "title": "WebApplicationFirewallManagement", - "description": "APIs to manage web application firewall rules." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/frontDoorWebApplicationFirewallPolicies": { - "get": { - "tags": [ - "WebApplicationFirewallPolicies" - ], - "description": "Lists all of the protection policies within a resource group.", - "operationId": "Policies_List", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicyList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List Policies in a Resource Group": { - "$ref": "./examples/WafListPolicies.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallPolicies/{policyName}": { - "get": { - "tags": [ - "WebApplicationFirewallPolicies" - ], - "description": "Retrieve protection policy with specified name within a resource group.", - "operationId": "Policies_Get", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/PolicyNameParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Get Policy": { - "$ref": "./examples/WafPolicyGet.json" - } - } - }, - "put": { - "tags": [ - "WebApplicationFirewallPolicies" - ], - "description": "Create or update policy with specified rule set name within a resource group.", - "operationId": "Policies_CreateOrUpdate", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/PolicyNameParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - }, - { - "description": "Policy to be created.", - "in": "body", - "name": "parameters", - "required": true, - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - } - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - } - }, - "201": { - "description": "Created. The request has been fulfilled and a new protection policy has been created.", - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - } - }, - "202": { - "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously.", - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-examples": { - "Creates specific policy": { - "$ref": "./examples/WafPolicyCreateOrUpdate.json" - } - }, - "x-ms-long-running-operation": true - }, - "delete": { - "tags": [ - "WebApplicationFirewallPolicies" - ], - "description": "Deletes Policy", - "operationId": "Policies_Delete", - "parameters": [ - { - "$ref": "#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/PolicyNameParameter" - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Delete successful." - }, - "202": { - "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." - }, - "204": { - "description": "No Content. The request has been accepted but the policy was not found." - } - }, - "x-ms-examples": { - "Delete protection policy": { - "$ref": "./examples/WafPolicyDelete.json" - } - }, - "x-ms-long-running-operation": true - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/FrontDoorWebApplicationFirewallManagedRuleSets": { - "get": { - "tags": [ - "WebApplicationFirewallManagedRuleSets" - ], - "description": "Lists all available managed rule sets.", - "operationId": "ManagedRuleSets_List", - "parameters": [ - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Success. The operation returns a list of all available web application firewall managed rule sets.", - "schema": { - "$ref": "#/definitions/ManagedRuleSetDefinitionList" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "#/definitions/ErrorResponse" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "List Policies in a Resource Group": { - "$ref": "./examples/WafListManagedRuleSets.json" - } - } - } - } - }, - "definitions": { - "WebApplicationFirewallPolicy": { - "description": "Defines web application firewall policy.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "description": "Properties of the web application firewall policy.", - "$ref": "#/definitions/WebApplicationFirewallPolicyProperties" - }, - "etag": { - "type": "string", - "description": "Gets a unique read-only string that changes whenever the resource is updated." - } - }, - "allOf": [ - { - "$ref": "./network.json#/definitions/Resource" - } - ] - }, - "WebApplicationFirewallPolicyProperties": { - "description": "Defines web application firewall policy properties.", - "properties": { - "policySettings": { - "description": "Describes settings for the policy.", - "$ref": "#/definitions/PolicySettings" - }, - "customRules": { - "description": "Describes custom rules inside the policy.", - "$ref": "#/definitions/CustomRuleList" - }, - "managedRules": { - "description": "Describes managed rules inside the policy.", - "$ref": "#/definitions/ManagedRuleSetList" - }, - "frontendEndpointLinks": { - "description": "Describes Frontend Endpoints associated with this Web Application Firewall policy.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/FrontendEndpointLink" - } - }, - "routingRuleLinks": { - "description": "Describes Routing Rules associated with this Web Application Firewall policy.", - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/RoutingRuleLink" - } - }, - "provisioningState": { - "readOnly": true, - "type": "string", - "description": "Provisioning state of the policy." - }, - "resourceState": { - "title": "Resource status of the policy.", - "readOnly": true, - "enum": [ - "Creating", - "Enabling", - "Enabled", - "Disabling", - "Disabled", - "Deleting" - ], - "type": "string", - "x-ms-enum": { - "name": "PolicyResourceState", - "modelAsString": true - } - } - } - }, - "WebApplicationFirewallPolicyList": { - "description": "Defines a list of WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - }, - "description": "List of WebApplicationFirewallPolicies within a resource group." - }, - "nextLink": { - "type": "string", - "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." - } - } - }, - "PolicySettings": { - "description": "Defines top-level WebApplicationFirewallPolicy configuration settings.", - "properties": { - "enabledState": { - "description": "Describes if the policy is in enabled or disabled state. Defaults to Enabled if not specified.", - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ], - "x-ms-enum": { - "name": "PolicyEnabledState", - "modelAsString": true - } - }, - "mode": { - "description": "Describes if it is in detection mode or prevention mode at policy level.", - "type": "string", - "enum": [ - "Prevention", - "Detection" - ], - "x-ms-enum": { - "name": "PolicyMode", - "modelAsString": true - } - }, - "redirectUrl": { - "description": "If action type is redirect, this field represents redirect URL for the client.", - "type": "string" - }, - "customBlockResponseStatusCode": { - "description": "If the action type is block, customer can override the response status code.", - "type": "integer" - }, - "customBlockResponseBody": { - "description": "If the action type is block, customer can override the response body. The body must be specified in base64 encoding.", - "type": "string", - "pattern": "^(?:[A-Za-z0-9+/]{4})*(?:[A-Za-z0-9+/]{2}==|[A-Za-z0-9+/]{3}=|[A-Za-z0-9+/]{4})$" - } - } - }, - "CustomRuleList": { - "description": "Defines contents of custom rules", - "properties": { - "rules": { - "description": "List of rules", - "type": "array", - "items": { - "$ref": "#/definitions/CustomRule" - } - } - } - }, - "CustomRule": { - "description": "Defines contents of a web application rule", - "required": [ - "priority", - "ruleType", - "matchConditions", - "action" - ], - "properties": { - "name": { - "type": "string", - "description": "Describes the name of the rule.", - "maxLength": 128 - }, - "priority": { - "description": "Describes priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.", - "type": "integer" - }, - "enabledState": { - "description": "Describes if the custom rule is in enabled or disabled state. Defaults to Enabled if not specified.", - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ], - "x-ms-enum": { - "name": "CustomRuleEnabledState", - "modelAsString": true - } - }, - "ruleType": { - "description": "Describes type of rule.", - "type": "string", - "enum": [ - "MatchRule", - "RateLimitRule" - ], - "x-ms-enum": { - "name": "RuleType", - "modelAsString": true - } - }, - "rateLimitDurationInMinutes": { - "description": "Time window for resetting the rate limit count. Default is 1 minute.", - "type": "integer", - "minimum": 0, - "maximum": 5 - }, - "rateLimitThreshold": { - "description": "Number of allowed requests per client within the time window.", - "type": "integer", - "minimum": 0 - }, - "matchConditions": { - "description": "List of match conditions.", - "type": "array", - "items": { - "$ref": "#/definitions/MatchCondition" - } - }, - "action": { - "description": "Describes what action to be applied when rule matches.", - "$ref": "#/definitions/ActionType" - } - } - }, - "TransformType": { - "description": "Describes what transforms applied before matching.", - "type": "string", - "enum": [ - "Lowercase", - "Uppercase", - "Trim", - "UrlDecode", - "UrlEncode", - "RemoveNulls" - ], - "x-ms-enum": { - "name": "TransformType", - "modelAsString": true - } - }, - "MatchCondition": { - "description": "Define a match condition.", - "required": [ - "matchVariable", - "operator", - "matchValue" - ], - "properties": { - "matchVariable": { - "description": "Request variable to compare with.", - "type": "string", - "enum": [ - "RemoteAddr", - "RequestMethod", - "QueryString", - "PostArgs", - "RequestUri", - "RequestHeader", - "RequestBody", - "Cookies", - "SocketAddr" - ], - "x-ms-enum": { - "name": "MatchVariable", - "modelAsString": true - } - }, - "selector": { - "description": "Match against a specific key from the QueryString, PostArgs, RequestHeader or Cookies variables. Default is null.", - "type": "string" - }, - "operator": { - "description": "Comparison type to use for matching with the variable value.", - "type": "string", - "enum": [ - "Any", - "IPMatch", - "GeoMatch", - "Equal", - "Contains", - "LessThan", - "GreaterThan", - "LessThanOrEqual", - "GreaterThanOrEqual", - "BeginsWith", - "EndsWith", - "RegEx" - ], - "x-ms-enum": { - "name": "Operator", - "modelAsString": true - } - }, - "negateCondition": { - "description": "Describes if the result of this condition should be negated.", - "type": "boolean" - }, - "matchValue": { - "description": "List of possible match values.", - "type": "array", - "items": { - "type": "string" - } - }, - "transforms": { - "description": "List of transforms.", - "type": "array", - "items": { - "$ref": "#/definitions/TransformType" - } - } - } - }, - "ManagedRuleSetList": { - "description": "Defines the list of managed rule sets for the policy.", - "properties": { - "managedRuleSets": { - "description": "List of rule sets.", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedRuleSet" - } - } - } - }, - "ManagedRuleSet": { - "type": "object", - "description": "Defines a managed rule set.", - "required": [ - "ruleSetType", - "ruleSetVersion" - ], - "properties": { - "ruleSetType": { - "description": "Defines the rule set type to use.", - "type": "string" - }, - "ruleSetVersion": { - "description": "Defines the version of the rule set to use.", - "type": "string" - }, - "exclusions": { - "type": "array", - "items": { - "$ref": "#/definitions/ManagedRuleExclusion" - }, - "description": "Describes the exclusions that are applied to all rules in the set." - }, - "ruleGroupOverrides": { - "description": "Defines the rule group overrides to apply to the rule set.", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedRuleGroupOverride" - } - } - } - }, - "ManagedRuleGroupOverride": { - "description": "Defines a managed rule group override setting.", - "required": [ - "ruleGroupName" - ], - "properties": { - "ruleGroupName": { - "description": "Describes the managed rule group to override.", - "type": "string" - }, - "exclusions": { - "type": "array", - "items": { - "$ref": "#/definitions/ManagedRuleExclusion" - }, - "description": "Describes the exclusions that are applied to all rules in the group." - }, - "rules": { - "description": "List of rules that will be disabled. If none specified, all rules in the group will be disabled.", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedRuleOverride" - } - } - } - }, - "ManagedRuleOverride": { - "description": "Defines a managed rule group override setting.", - "required": [ - "ruleId" - ], - "properties": { - "ruleId": { - "description": "Identifier for the managed rule.", - "type": "string" - }, - "enabledState": { - "description": "Describes if the managed rule is in enabled or disabled state. Defaults to Disabled if not specified.", - "$ref": "#/definitions/ManagedRuleEnabledState" - }, - "action": { - "description": "Describes the override action to be applied when rule matches.", - "$ref": "#/definitions/ActionType" - }, - "exclusions": { - "type": "array", - "items": { - "$ref": "#/definitions/ManagedRuleExclusion" - }, - "description": "Describes the exclusions that are applied to this specific rule." - } - } - }, - "ManagedRuleSetDefinitionList": { - "description": "List of managed rule set definitions available for use in a policy.", - "properties": { - "value": { - "description": "List of managed rule set definitions.", - "readOnly": true, - "type": "array", - "items": { - "$ref": "#/definitions/ManagedRuleSetDefinition" - } - }, - "nextLink": { - "type": "string", - "description": "URL to retrieve next set of managed rule set definitions." - } - } - }, - "ManagedRuleSetDefinition": { - "description": "Describes the a managed rule set definition.", - "properties": { - "properties": { - "description": "Properties for a managed rule set definition.", - "x-ms-client-flatten": true, - "$ref": "#/definitions/ManagedRuleSetDefinitionProperties" - } - }, - "allOf": [ - { - "$ref": "./network.json#/definitions/Resource" - } - ] - }, - "ManagedRuleSetDefinitionProperties": { - "description": "Properties for a managed rule set definition.", - "properties": { - "provisioningState": { - "type": "string", - "readOnly": true, - "description": "Provisioning state of the managed rule set." - }, - "ruleSetId": { - "type": "string", - "readOnly": true, - "description": "Id of the managed rule set." - }, - "ruleSetType": { - "type": "string", - "readOnly": true, - "description": "Type of the managed rule set." - }, - "ruleSetVersion": { - "type": "string", - "readOnly": true, - "description": "Version of the managed rule set type." - }, - "ruleGroups": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ManagedRuleGroupDefinition" - }, - "description": "Rule groups of the managed rule set." - } - } - }, - "ManagedRuleGroupDefinition": { - "description": "Describes a managed rule group.", - "properties": { - "ruleGroupName": { - "type": "string", - "readOnly": true, - "description": "Name of the managed rule group." - }, - "description": { - "type": "string", - "readOnly": true, - "description": "Description of the managed rule group." - }, - "rules": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/ManagedRuleDefinition" - }, - "description": "List of rules within the managed rule group." - } - } - }, - "ManagedRuleDefinition": { - "description": "Describes a managed rule definition.", - "properties": { - "ruleId": { - "description": "Identifier for the managed rule.", - "readOnly": true, - "type": "string" - }, - "defaultState": { - "description": "Describes the default state for the managed rule.", - "readOnly": true, - "$ref": "#/definitions/ManagedRuleEnabledState" - }, - "defaultAction": { - "description": "Describes the default action to be applied when the managed rule matches.", - "readOnly": true, - "$ref": "#/definitions/ActionType" - }, - "description": { - "description": "Describes the functionality of the managed rule.", - "readOnly": true, - "type": "string" - } - } - }, - "ManagedRuleExclusion": { - "required": [ - "matchVariable", - "selectorMatchOperator", - "selector" - ], - "description": "Exclude variables from managed rule evaluation.", - "properties": { - "matchVariable": { - "type": "string", - "enum": [ - "RequestHeaderNames", - "RequestCookieNames", - "QueryStringArgNames", - "RequestBodyPostArgNames" - ], - "description": "The variable type to be excluded.", - "x-ms-enum": { - "name": "ManagedRuleExclusionMatchVariable", - "modelAsString": true - } - }, - "selectorMatchOperator": { - "type": "string", - "enum": [ - "Equals", - "Contains", - "StartsWith", - "EndsWith", - "EqualsAny" - ], - "description": "Comparison operator to apply to the selector when specifying which elements in the collection this exclusion applies to.", - "x-ms-enum": { - "name": "ManagedRuleExclusionSelectorMatchOperator", - "modelAsString": true - } - }, - "selector": { - "type": "string", - "description": "Selector value for which elements in the collection this exclusion applies to." - } - } - }, - "ActionType": { - "description": "Defines the action to take on rule match.", - "type": "string", - "enum": [ - "Allow", - "Block", - "Log", - "Redirect" - ], - "x-ms-enum": { - "name": "ActionType", - "modelAsString": true - } - }, - "ManagedRuleEnabledState": { - "description": "Describes if the managed rule is in enabled or disabled state.", - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ], - "x-ms-enum": { - "name": "ManagedRuleEnabledState", - "modelAsString": true - } - }, - "ErrorResponse": { - "description": "Error response indicates Front Door service is not able to process the incoming request. The reason is provided in the error message.", - "type": "object", - "properties": { - "code": { - "description": "Error code.", - "readOnly": true, - "type": "string" - }, - "message": { - "description": "Error message indicating why the operation failed.", - "readOnly": true, - "type": "string" - } - } - }, - "FrontendEndpointLink": { - "description": "Defines the Resource ID for a Frontend Endpoint.", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - } - } - }, - "RoutingRuleLink": { - "description": "Defines the Resource ID for a Routing Rule.", - "type": "object", - "readOnly": true, - "properties": { - "id": { - "type": "string", - "description": "Resource ID." - } - } - } - }, - "parameters": { - "PolicyNameParameter": { - "name": "policyName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 128, - "x-ms-parameter-location": "method", - "description": "The name of the Web Application Firewall Policy." - }, - "ResourceGroupNameParameter": { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "pattern": "^[a-zA-Z0-9_\\-\\(\\)\\.]*[^\\.]$", - "minLength": 1, - "maxLength": 80, - "x-ms-parameter-location": "method", - "description": "Name of the Resource group within the Azure subscription." - } - } -} diff --git a/specification/frontdoor/resource-manager/readme.md b/specification/frontdoor/resource-manager/readme.md index 4caa6148067b..3e959cde8d90 100644 --- a/specification/frontdoor/resource-manager/readme.md +++ b/specification/frontdoor/resource-manager/readme.md @@ -40,7 +40,7 @@ input-file: - Microsoft.Network/stable/2020-05-01/network.json - Microsoft.Network/stable/2019-11-01/networkexperiment.json - Microsoft.Network/stable/2020-05-01/frontdoor.json -- Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json +- Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json directive: - where: - $.paths @@ -272,7 +272,6 @@ input-file: - $(this-folder)/Microsoft.Network/stable/2020-05-01/network.json - $(this-folder)/Microsoft.Network/stable/2019-11-01/networkexperiment.json - $(this-folder)/Microsoft.Network/stable/2020-05-01/frontdoor.json - - $(this-folder)/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json - $(this-folder)/Microsoft.Network/stable/2020-04-01/network.json - $(this-folder)/Microsoft.Network/stable/2020-04-01/frontdoor.json - $(this-folder)/Microsoft.Network/stable/2020-04-01/webapplicationfirewall.json diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json deleted file mode 100644 index 32158faaedfd..000000000000 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListAllPolicies.json +++ /dev/null @@ -1,102 +0,0 @@ -{ - "parameters": { - "api-version": "2020-05-01", - "subscriptionId": "subid" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Policy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", - "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "location": "WestUs", - "properties": { - "resourceState": "Enabled", - "provisioningState": "Succeeded", - "policySettings": { - "state": "Enabled", - "mode": "Prevention", - "maxRequestBodySizeInKb": 128, - "fileUploadLimitInMb": 750, - "requestBodyCheck": true - }, - "customRules": [ - { - "name": "Rule1", - "priority": 1, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "negationConditon": false, - "matchValues": [ - "192.168.1.0/24", - "10.0.0.0/24" - ], - "transforms": [] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "negationConditon": false, - "matchValues": [ - "192.168.1.0/24" - ] - }, - { - "matchVariables": [ - { - "variableName": "RequestHeader", - "selector": "UserAgent" - } - ], - "operator": "Contains", - "negationConditon": false, - "matchValues": [ - "Windows" - ] - } - ], - "action": "Block" - } - ], - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "OWASP", - "ruleSetVersion": "3.0" - } - ] - } - } - } - ] - } - } - } -} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json deleted file mode 100644 index 0faa1a7f616f..000000000000 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafListPolicies.json +++ /dev/null @@ -1,103 +0,0 @@ -{ - "parameters": { - "api-version": "2020-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "name": "Policy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", - "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "location": "WestUs", - "properties": { - "resourceState": "Enabled", - "provisioningState": "Succeeded", - "policySettings": { - "state": "Enabled", - "mode": "Detection", - "maxRequestBodySizeInKb": 128, - "fileUploadLimitInMb": 750, - "requestBodyCheck": true - }, - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "OWASP", - "ruleSetVersion": "3.0" - } - ] - }, - "customRules": [ - { - "name": "Rule1", - "priority": 1, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "negationConditon": false, - "matchValues": [ - "192.168.1.0/24", - "10.0.0.0/24" - ], - "transforms": [] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "negationConditon": false, - "matchValues": [ - "192.168.1.0/24" - ] - }, - { - "matchVariables": [ - { - "variableName": "RequestHeader", - "selector": "UserAgent" - } - ], - "operator": "Contains", - "negationConditon": false, - "matchValues": [ - "Windows" - ] - } - ], - "action": "Block" - } - ] - } - } - ] - } - } - } -} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json deleted file mode 100644 index 63ec90cd9645..000000000000 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyCreateOrUpdate.json +++ /dev/null @@ -1,258 +0,0 @@ -{ - "parameters": { - "api-version": "2020-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "policyName": "Policy1", - "parameters": { - "location": "WestUs", - "properties": { - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "OWASP", - "ruleSetVersion": "3.0" - } - ] - }, - "customRules": [ - { - "name": "Rule1", - "priority": 1, - "ruleType": "MatchRule", - "action": "Block", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "matchValues": [ - "192.168.1.0/24", - "10.0.0.0/24" - ] - } - ] - }, - { - "name": "Rule2", - "priority": 2, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "matchValues": [ - "192.168.1.0/24" - ] - }, - { - "matchVariables": [ - { - "variableName": "RequestHeaders", - "selector": "UserAgent" - } - ], - "operator": "Contains", - "matchValues": [ - "Windows" - ] - } - ], - "action": "Block" - } - ] - } - } - }, - "responses": { - "200": { - "body": { - "name": "Policy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", - "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "location": "WestUs", - "properties": { - "resourceState": "Enabled", - "provisioningState": "Succeeded", - "policySettings": { - "state": "Enabled", - "mode": "Detection", - "maxRequestBodySizeInKb": 128, - "fileUploadLimitInMb": 750, - "requestBodyCheck": true - }, - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "OWASP", - "ruleSetVersion": "3.0" - } - ] - }, - "customRules": [ - { - "name": "Rule1", - "priority": 1, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "negationConditon": false, - "matchValues": [ - "192.168.1.0/24", - "10.0.0.0/24" - ], - "transforms": [] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "negationConditon": false, - "matchValues": [ - "192.168.1.0/24" - ] - }, - { - "matchVariables": [ - { - "variableName": "RequestHeader", - "selector": "UserAgent" - } - ], - "operator": "Contains", - "negationConditon": false, - "matchValues": [ - "Windows" - ] - } - ], - "action": "Block" - } - ] - } - } - }, - "201": { - "body": { - "name": "Policy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", - "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "location": "WestUs", - "properties": { - "resourceState": "Enabled", - "provisioningState": "Succeeded", - "policySettings": { - "state": "Enabled", - "mode": "Detection", - "maxRequestBodySizeInKb": 128, - "fileUploadLimitInMb": 750, - "requestBodyCheck": true - }, - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "OWASP", - "ruleSetVersion": "3.0" - } - ] - }, - "customRules": [ - { - "name": "Rule1", - "priority": 1, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "negationConditon": false, - "matchValues": [ - "192.168.1.0/24", - "10.0.0.0/24" - ], - "transforms": [] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "negationConditon": false, - "matchValues": [ - "192.168.1.0/24" - ] - }, - { - "matchVariables": [ - { - "variableName": "RequestHeader", - "selector": "UserAgent" - } - ], - "operator": "Contains", - "negationConditon": false, - "matchValues": [ - "Windows" - ] - } - ], - "action": "Block" - } - ] - } - } - } - } -} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json deleted file mode 100644 index c887714443bf..000000000000 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyDelete.json +++ /dev/null @@ -1,13 +0,0 @@ -{ - "parameters": { - "api-version": "2020-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "policyName": "Policy1" - }, - "responses": { - "200": {}, - "202": {}, - "204": {} - } -} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json deleted file mode 100644 index 50555ffcb9ad..000000000000 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/examples/WafPolicyGet.json +++ /dev/null @@ -1,140 +0,0 @@ -{ - "parameters": { - "api-version": "2020-05-01", - "subscriptionId": "subid", - "resourceGroupName": "rg1", - "policyName": "Policy1" - }, - "responses": { - "200": { - "body": { - "name": "Policy1", - "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/Policy1", - "type": "Microsoft.Network/applicationgatewaywebapplicationfirewallpolicies", - "tags": { - "key1": "value1", - "key2": "value2" - }, - "location": "WestUs", - "properties": { - "resourceState": "Enabled", - "provisioningState": "Succeeded", - "policySettings": { - "state": "Enabled", - "mode": "Prevention", - "maxRequestBodySizeInKb": 128, - "fileUploadLimitInMb": 750, - "requestBodyCheck": true - }, - "customRules": [ - { - "name": "Rule1", - "priority": 1, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "negationConditon": false, - "matchValues": [ - "192.168.1.0/24", - "10.0.0.0/24" - ], - "transforms": [] - } - ], - "action": "Block" - }, - { - "name": "Rule2", - "priority": 2, - "ruleType": "MatchRule", - "matchConditions": [ - { - "matchVariables": [ - { - "variableName": "RemoteAddr", - "selector": null - } - ], - "operator": "IPMatch", - "negationConditon": false, - "matchValues": [ - "192.168.1.0/24" - ] - }, - { - "matchVariables": [ - { - "variableName": "RequestHeader", - "selector": "UserAgent" - } - ], - "operator": "Contains", - "negationConditon": false, - "matchValues": [ - "Windows" - ] - } - ], - "action": "Block" - } - ], - "managedRules": { - "managedRuleSets": [ - { - "ruleSetType": "OWASP", - "ruleSetVersion": "3.0", - "ruleGroupOverrides": [ - { - "ruleGroupName": "REQUEST-942-APPLICATION-ATTACK-SQLI", - "rules": [ - { - "ruleId": "942130", - "state": "Disabled" - }, - { - "ruleId": "942110", - "state": "Disabled" - } - ] - }, - { - "ruleGroupName": "REQUEST-920-PROTOCOL-ENFORCEMENT", - "rules": [ - { - "ruleId": "920100", - "state": "Disabled" - }, - { - "ruleId": "920120", - "state": "Disabled" - } - ] - } - ] - } - ], - "exclusions": [ - { - "matchVariable": "RequestHeaderNames", - "selectorMatchOperator": "Equals", - "selector": "testHeader1" - }, - { - "matchVariable": "RequestHeaderNames", - "selectorMatchOperator": "StartsWith", - "selector": "testHeader2" - } - ] - } - } - } - } - } -} diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json deleted file mode 100644 index 111927abcdca..000000000000 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json +++ /dev/null @@ -1,743 +0,0 @@ -{ - "swagger": "2.0", - "info": { - "version": "2020-05-01", - "title": "WebApplicationFirewallManagement", - "description": "APIs to manage web application firewall rules." - }, - "host": "management.azure.com", - "schemes": [ - "https" - ], - "consumes": [ - "application/json" - ], - "produces": [ - "application/json" - ], - "security": [ - { - "azure_auth": [ - "user_impersonation" - ] - } - ], - "securityDefinitions": { - "azure_auth": { - "type": "oauth2", - "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", - "flow": "implicit", - "description": "Azure Active Directory OAuth2 Flow.", - "scopes": { - "user_impersonation": "impersonate your user account" - } - } - }, - "paths": { - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { - "get": { - "tags": [ - "WebApplicationFirewallPolicies" - ], - "description": "Lists all of the protection policies within a resource group.", - "operationId": "WebApplicationFirewallPolicies_List", - "x-ms-examples": { - "Lists all WAF policies in a resource group": { - "$ref": "./examples/WafListPolicies.json" - } - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./network.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies": { - "get": { - "tags": [ - "WebApplicationFirewallPolicies" - ], - "description": "Gets all the WAF policies in a subscription.", - "operationId": "WebApplicationFirewallPolicies_ListAll", - "x-ms-examples": { - "Lists all WAF policies in a subscription": { - "$ref": "./examples/WafListAllPolicies.json" - } - }, - "parameters": [ - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicyListResult" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./network.json#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Network/ApplicationGatewayWebApplicationFirewallPolicies/{policyName}": { - "get": { - "tags": [ - "WebApplicationFirewallPolicies" - ], - "description": "Retrieve protection policy with specified name within a resource group.", - "operationId": "WebApplicationFirewallPolicies_Get", - "x-ms-examples": { - "Gets a WAF policy within a resource group": { - "$ref": "./examples/WafPolicyGet.json" - } - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "policyName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 128, - "description": "The name of the policy." - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./network.json#/definitions/CloudError" - } - } - } - }, - "put": { - "tags": [ - "WebApplicationFirewallPolicies" - ], - "description": "Creates or update policy with specified rule set name within a resource group.", - "operationId": "WebApplicationFirewallPolicies_CreateOrUpdate", - "x-ms-examples": { - "Creates or updates a WAF policy within a resource group": { - "$ref": "./examples/WafPolicyCreateOrUpdate.json" - } - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "policyName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 128, - "description": "The name of the policy." - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "description": "Policy to be created.", - "in": "body", - "name": "parameters", - "required": true, - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - } - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "OK. The request has succeeded.", - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - } - }, - "201": { - "description": "Created. The request has been fulfilled and a new protection policy has been created.", - "schema": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - } - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./network.json#/definitions/CloudError" - } - } - } - }, - "delete": { - "tags": [ - "WebApplicationFirewallPolicies" - ], - "description": "Deletes Policy.", - "operationId": "WebApplicationFirewallPolicies_Delete", - "x-ms-examples": { - "Deletes a WAF policy within a resource group": { - "$ref": "./examples/WafPolicyDelete.json" - } - }, - "parameters": [ - { - "name": "resourceGroupName", - "in": "path", - "required": true, - "type": "string", - "description": "The name of the resource group." - }, - { - "name": "policyName", - "in": "path", - "required": true, - "type": "string", - "maxLength": 128, - "description": "The name of the policy." - }, - { - "$ref": "./network.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "./network.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "202": { - "description": "Accepted. The request has been accepted for processing and the operation will complete asynchronously." - }, - "204": { - "description": "No Content. The request has been accepted but the policy was not found." - }, - "200": { - "description": "Delete successful." - }, - "default": { - "description": "Error response describing why the operation failed.", - "schema": { - "$ref": "./network.json#/definitions/CloudError" - } - } - }, - "x-ms-long-running-operation": true, - "x-ms-long-running-operation-options": { - "final-state-via": "location" - } - } - } - }, - "definitions": { - "WebApplicationFirewallPolicy": { - "description": "Defines web application firewall policy.", - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/WebApplicationFirewallPolicyPropertiesFormat", - "description": "Properties of the web application firewall policy." - }, - "etag": { - "readOnly": true, - "type": "string", - "description": "A unique read-only string that changes whenever the resource is updated." - } - }, - "allOf": [ - { - "$ref": "./network.json#/definitions/Resource" - } - ] - }, - "WebApplicationFirewallPolicyPropertiesFormat": { - "description": "Defines web application firewall policy properties.", - "required": [ - "managedRules" - ], - "properties": { - "policySettings": { - "description": "The PolicySettings for policy.", - "$ref": "#/definitions/PolicySettings" - }, - "customRules": { - "description": "The custom rules inside the policy.", - "type": "array", - "items": { - "$ref": "#/definitions/WebApplicationFirewallCustomRule" - } - }, - "applicationGateways": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "./applicationGateway.json#/definitions/ApplicationGateway" - }, - "description": "A collection of references to application gateways." - }, - "provisioningState": { - "readOnly": true, - "$ref": "./network.json#/definitions/ProvisioningState", - "description": "The provisioning state of the web application firewall policy resource." - }, - "resourceState": { - "title": "Resource status of the policy.", - "readOnly": true, - "type": "string", - "description": "Resource status of the policy.", - "enum": [ - "Creating", - "Enabling", - "Enabled", - "Disabling", - "Disabled", - "Deleting" - ], - "x-ms-enum": { - "name": "WebApplicationFirewallPolicyResourceState", - "modelAsString": true - } - }, - "managedRules": { - "description": "Describes the managedRules structure.", - "$ref": "#/definitions/ManagedRulesDefinition" - }, - "httpListeners": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "./network.json#/definitions/SubResource" - }, - "description": "A collection of references to application gateway http listeners." - }, - "pathBasedRules": { - "readOnly": true, - "type": "array", - "items": { - "$ref": "./network.json#/definitions/SubResource" - }, - "description": "A collection of references to application gateway path rules." - } - } - }, - "WebApplicationFirewallPolicyListResult": { - "description": "Result of the request to list WebApplicationFirewallPolicies. It contains a list of WebApplicationFirewallPolicy objects and a URL link to get the next set of results.", - "properties": { - "value": { - "type": "array", - "readOnly": true, - "items": { - "$ref": "#/definitions/WebApplicationFirewallPolicy" - }, - "description": "List of WebApplicationFirewallPolicies within a resource group." - }, - "nextLink": { - "readOnly": true, - "type": "string", - "description": "URL to get the next set of WebApplicationFirewallPolicy objects if there are any." - } - } - }, - "ManagedRulesDefinition": { - "description": "Allow to exclude some variable satisfy the condition for the WAF check.", - "required": [ - "managedRuleSets" - ], - "properties": { - "exclusions": { - "type": "array", - "items": { - "$ref": "#/definitions/OwaspCrsExclusionEntry" - }, - "description": "The Exclusions that are applied on the policy." - }, - "managedRuleSets": { - "type": "array", - "items": { - "$ref": "#/definitions/ManagedRuleSet" - }, - "description": "The managed rule sets that are associated with the policy." - } - } - }, - "PolicySettings": { - "description": "Defines contents of a web application firewall global configuration.", - "properties": { - "state": { - "description": "The state of the policy.", - "type": "string", - "enum": [ - "Disabled", - "Enabled" - ], - "x-ms-enum": { - "name": "WebApplicationFirewallEnabledState", - "modelAsString": true - } - }, - "mode": { - "description": "The mode of the policy.", - "type": "string", - "enum": [ - "Prevention", - "Detection" - ], - "x-ms-enum": { - "name": "WebApplicationFirewallMode", - "modelAsString": true - } - }, - "requestBodyCheck": { - "type": "boolean", - "description": "Whether to allow WAF to check request Body." - }, - "maxRequestBodySizeInKb": { - "type": "integer", - "format": "int32", - "maximum": 128, - "exclusiveMaximum": false, - "minimum": 8, - "exclusiveMinimum": false, - "description": "Maximum request body size in Kb for WAF." - }, - "fileUploadLimitInMb": { - "type": "integer", - "format": "int32", - "minimum": 0, - "exclusiveMinimum": false, - "description": "Maximum file upload size in Mb for WAF." - } - } - }, - "WebApplicationFirewallCustomRule": { - "description": "Defines contents of a web application rule.", - "required": [ - "priority", - "ruleType", - "matchConditions", - "action" - ], - "properties": { - "name": { - "type": "string", - "description": "The name of the resource that is unique within a policy. This name can be used to access the resource.", - "maxLength": 128 - }, - "etag": { - "type": "string", - "readOnly": true, - "description": "A unique read-only string that changes whenever the resource is updated." - }, - "priority": { - "description": "Priority of the rule. Rules with a lower value will be evaluated before rules with a higher value.", - "type": "integer" - }, - "ruleType": { - "description": "The rule type.", - "type": "string", - "enum": [ - "MatchRule", - "Invalid" - ], - "x-ms-enum": { - "name": "WebApplicationFirewallRuleType", - "modelAsString": true - } - }, - "matchConditions": { - "description": "List of match conditions.", - "type": "array", - "items": { - "$ref": "#/definitions/MatchCondition" - } - }, - "action": { - "description": "Type of Actions.", - "type": "string", - "enum": [ - "Allow", - "Block", - "Log" - ], - "x-ms-enum": { - "name": "WebApplicationFirewallAction", - "modelAsString": true - } - } - } - }, - "Transform": { - "description": "Transforms applied before matching.", - "type": "string", - "enum": [ - "Lowercase", - "Trim", - "UrlDecode", - "UrlEncode", - "RemoveNulls", - "HtmlEntityDecode" - ], - "x-ms-enum": { - "name": "WebApplicationFirewallTransform", - "modelAsString": true - } - }, - "MatchVariable": { - "description": "Define match variables.", - "required": [ - "variableName" - ], - "properties": { - "variableName": { - "description": "Match Variable.", - "type": "string", - "enum": [ - "RemoteAddr", - "RequestMethod", - "QueryString", - "PostArgs", - "RequestUri", - "RequestHeaders", - "RequestBody", - "RequestCookies" - ], - "x-ms-enum": { - "name": "WebApplicationFirewallMatchVariable", - "modelAsString": true - } - }, - "selector": { - "description": "The selector of match variable.", - "type": "string" - } - } - }, - "MatchCondition": { - "description": "Define match conditions.", - "required": [ - "matchVariables", - "operator", - "matchValues" - ], - "properties": { - "matchVariables": { - "description": "List of match variables.", - "type": "array", - "items": { - "$ref": "#/definitions/MatchVariable" - } - }, - "operator": { - "description": "The operator to be matched.", - "type": "string", - "enum": [ - "IPMatch", - "Equal", - "Contains", - "LessThan", - "GreaterThan", - "LessThanOrEqual", - "GreaterThanOrEqual", - "BeginsWith", - "EndsWith", - "Regex", - "GeoMatch" - ], - "x-ms-enum": { - "name": "WebApplicationFirewallOperator", - "modelAsString": true - } - }, - "negationConditon": { - "description": "Whether this is negate condition or not.", - "type": "boolean" - }, - "matchValues": { - "description": "Match value.", - "type": "array", - "items": { - "type": "string" - } - }, - "transforms": { - "description": "List of transforms.", - "type": "array", - "items": { - "$ref": "#/definitions/Transform" - } - } - } - }, - "ManagedRuleSet": { - "type": "object", - "description": "Defines a managed rule set.", - "required": [ - "ruleSetType", - "ruleSetVersion" - ], - "properties": { - "ruleSetType": { - "description": "Defines the rule set type to use.", - "type": "string" - }, - "ruleSetVersion": { - "description": "Defines the version of the rule set to use.", - "type": "string" - }, - "ruleGroupOverrides": { - "description": "Defines the rule group overrides to apply to the rule set.", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedRuleGroupOverride" - } - } - } - }, - "ManagedRuleGroupOverride": { - "description": "Defines a managed rule group override setting.", - "required": [ - "ruleGroupName" - ], - "properties": { - "ruleGroupName": { - "description": "The managed rule group to override.", - "type": "string" - }, - "rules": { - "description": "List of rules that will be disabled. If none specified, all rules in the group will be disabled.", - "type": "array", - "items": { - "$ref": "#/definitions/ManagedRuleOverride" - } - } - } - }, - "ManagedRuleOverride": { - "description": "Defines a managed rule group override setting.", - "required": [ - "ruleId" - ], - "properties": { - "ruleId": { - "description": "Identifier for the managed rule.", - "type": "string" - }, - "state": { - "description": "The state of the managed rule. Defaults to Disabled if not specified.", - "type": "string", - "enum": [ - "Disabled" - ], - "x-ms-enum": { - "name": "ManagedRuleEnabledState", - "modelAsString": true - } - } - } - }, - "OwaspCrsExclusionEntry": { - "required": [ - "matchVariable", - "selectorMatchOperator", - "selector" - ], - "description": "Allow to exclude some variable satisfy the condition for the WAF check.", - "properties": { - "matchVariable": { - "type": "string", - "enum": [ - "RequestHeaderNames", - "RequestCookieNames", - "RequestArgNames" - ], - "description": "The variable to be excluded.", - "x-ms-enum": { - "name": "OwaspCrsExclusionEntryMatchVariable", - "modelAsString": true - } - }, - "selectorMatchOperator": { - "type": "string", - "enum": [ - "Equals", - "Contains", - "StartsWith", - "EndsWith", - "EqualsAny" - ], - "description": "When matchVariable is a collection, operate on the selector to specify which elements in the collection this exclusion applies to.", - "x-ms-enum": { - "name": "OwaspCrsExclusionEntrySelectorMatchOperator", - "modelAsString": true - } - }, - "selector": { - "type": "string", - "description": "When matchVariable is a collection, operator used to specify which elements in the collection this exclusion applies to." - } - } - } - } -} diff --git a/specification/network/resource-manager/readme.md b/specification/network/resource-manager/readme.md index 9db19ff5ac47..8de4b3291bc9 100644 --- a/specification/network/resource-manager/readme.md +++ b/specification/network/resource-manager/readme.md @@ -82,7 +82,6 @@ input-file: - Microsoft.Network/stable/2020-05-01/virtualWan.json - Microsoft.Network/stable/2020-05-01/vmssNetworkInterface.json - Microsoft.Network/stable/2020-05-01/vmssPublicIpAddress.json - - Microsoft.Network/stable/2020-05-01/webapplicationfirewall.json ``` ### Tag: package-2020-04 From 0759640718ca4980a6cf5d18b15bc5dbb1867d4b Mon Sep 17 00:00:00 2001 From: Aneesh Ponneth <39756889+anponnet@users.noreply.github.com> Date: Mon, 6 Jul 2020 07:24:59 +0530 Subject: [PATCH 261/318] Release new version of DBE API - SKU changes (#9488) --- .../2020-05-01-preview/databoxedge.json | 6694 +++++++++++++++++ .../2020-05-01-preview/examples/AlertGet.json | 37 + .../examples/AlertGetAllInDevice.json | 58 + .../examples/AvailableSkusList.json | 52 + .../examples/BandwidthScheduleDelete.json | 17 + .../examples/BandwidthScheduleGet.json | 30 + .../BandwidthScheduleGetAllInDevice.json | 33 + .../examples/BandwidthSchedulePut.json | 51 + .../examples/ContainerDelete.json | 20 + .../examples/ContainerGet.json | 28 + .../examples/ContainerListAllInDevice.json | 56 + .../examples/ContainerPut.json | 43 + .../examples/ContainerRefresh.json | 26 + .../examples/DataBoxEdgeDeviceDelete.json | 19 + .../examples/DataBoxEdgeDeviceGetByName.json | 35 + .../DataBoxEdgeDeviceGetByResourceGroup.json | 72 + .../DataBoxEdgeDeviceGetBySubscription.json | 71 + .../examples/DataBoxEdgeDevicePatch.json | 50 + .../examples/DataBoxEdgeDevicePut.json | 41 + .../examples/DownloadUpdatesPost.json | 24 + .../examples/ExtendedInfoPost.json | 34 + .../examples/InstallUpdatesPost.json | 24 + .../2020-05-01-preview/examples/JobsGet.json | 31 + .../2020-05-01-preview/examples/ListSkus.json | 51 + .../examples/NetworkSettingsGet.json | 58 + .../examples/NodeGetAllInDevice.json | 50 + .../examples/OperationsGet.json | 675 ++ .../examples/OperationsStatusGet.json | 31 + .../examples/OrderDelete.json | 19 + .../2020-05-01-preview/examples/OrderGet.json | 57 + .../examples/OrderGetAllInDevice.json | 61 + .../2020-05-01-preview/examples/OrderPut.json | 85 + .../examples/RoleDelete.json | 17 + .../2020-05-01-preview/examples/RoleGet.json | 41 + .../examples/RoleGetAllInDevice.json | 44 + .../2020-05-01-preview/examples/RolePut.json | 85 + .../examples/SACDelete.json | 20 + .../2020-05-01-preview/examples/SACGet.json | 30 + .../examples/SACGetAllInDevice.json | 44 + .../2020-05-01-preview/examples/SACPut.json | 50 + .../examples/ScanForUpdatesPost.json | 24 + .../examples/SecuritySettingsUpdatePost.json | 33 + .../examples/ShareDelete.json | 20 + .../2020-05-01-preview/examples/ShareGet.json | 45 + .../examples/ShareGetAllInDevice.json | 48 + .../2020-05-01-preview/examples/SharePut.json | 72 + .../examples/ShareRefreshPost.json | 25 + .../examples/StorageAccountDelete.json | 19 + .../examples/StorageAccountGet.json | 29 + .../StorageAccountGetAllInDevice.json | 35 + .../examples/StorageAccountPut.json | 47 + .../examples/TriggerDelete.json | 20 + .../examples/TriggerGet.json | 34 + .../examples/TriggerGetAllInDevice.json | 37 + .../examples/TriggerPut.json | 53 + .../examples/UpdateSummaryGet.json | 38 + .../examples/UploadCertificatePost.json | 38 + .../examples/UserDelete.json | 26 + .../2020-05-01-preview/examples/UserGet.json | 30 + .../examples/UserGetAllInDevice.json | 38 + .../2020-05-01-preview/examples/UserPut.json | 44 + .../resource-manager/readme.cli.md | 1 + .../databoxedge/resource-manager/readme.md | 25 +- .../resource-manager/readme.python.md | 24 + .../resource-manager/readme.ruby.md | 11 + 65 files changed, 9779 insertions(+), 1 deletion(-) create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/databoxedge.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AlertGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AlertGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AvailableSkusList.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthSchedulePut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerListAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerPut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerRefresh.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetByName.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetByResourceGroup.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetBySubscription.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDevicePatch.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDevicePut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DownloadUpdatesPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ExtendedInfoPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/InstallUpdatesPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/JobsGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ListSkus.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/NetworkSettingsGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/NodeGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OperationsGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OperationsStatusGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderPut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RolePut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACPut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ScanForUpdatesPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SecuritySettingsUpdatePost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SharePut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareRefreshPost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountPut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerPut.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UpdateSummaryGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UploadCertificatePost.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserDelete.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserGet.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserGetAllInDevice.json create mode 100644 specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserPut.json diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/databoxedge.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/databoxedge.json new file mode 100644 index 000000000000..67ad3b4498b1 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/databoxedge.json @@ -0,0 +1,6694 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-05-01-preview", + "title": "DataBoxEdgeManagementClient" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.DataBoxEdge/operations": { + "get": { + "tags": [ + "Operations" + ], + "summary": "List all the supported operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of supported operations.", + "schema": { + "$ref": "#/definitions/OperationsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OperationsGet": { + "$ref": "./examples/OperationsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/availableSkus": { + "get": { + "tags": [ + "AvailableSkus" + ], + "summary": "List all the available Skus and information related to them.", + "operationId": "AvailableSkus_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Lists the available Skus and information related to them.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeSkuList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "AvailableSkus": { + "$ref": "./examples/AvailableSkusList.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets all the Data Box Edge/Data Box Gateway devices in a subscription.", + "operationId": "Devices_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of Data Box Edge/Data Box Gateway devices.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetBySubscription": { + "$ref": "./examples/DataBoxEdgeDeviceGetBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets all the Data Box Edge/Data Box Gateway devices in a resource group.", + "operationId": "Devices_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$expand", + "in": "query", + "description": "Specify $expand=details to populate additional fields related to the resource or Specify $skipToken= to populate the next page in the list.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of Data Box Edge/Data Box Gateway devices.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetByResourceGroup": { + "$ref": "./examples/DataBoxEdgeDeviceGetByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets the properties of the Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Data Box Edge/Data Box Gateway device.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DataBoxEdgeDeviceGetByName": { + "$ref": "./examples/DataBoxEdgeDeviceGetByName.json" + } + } + }, + "put": { + "tags": [ + "Devices" + ], + "description": "Creates or updates a Data Box Edge/Data Box Gateway resource.", + "operationId": "Devices_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "DataBoxEdgeDevice", + "in": "body", + "description": "The resource object.", + "required": true, + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the resource.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DataBoxEdgeDevicePut": { + "$ref": "./examples/DataBoxEdgeDevicePut.json" + } + } + }, + "delete": { + "tags": [ + "Devices" + ], + "description": "Deletes the Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the resource." + }, + "202": { + "description": "Accepted the request to delete the resource." + }, + "204": { + "description": "The resource is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DataBoxEdgeDeviceDelete": { + "$ref": "./examples/DataBoxEdgeDeviceDelete.json" + } + } + }, + "patch": { + "tags": [ + "Devices" + ], + "description": "Modifies a Data Box Edge/Data Box Gateway resource.", + "operationId": "Devices_Update", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The resource parameters.", + "required": true, + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevicePatch" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the resource.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDevice" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "DataBoxEdgeDevicePatch": { + "$ref": "./examples/DataBoxEdgeDevicePatch.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts": { + "get": { + "tags": [ + "Alerts" + ], + "description": "Gets all the alerts for a Data Box Edge/Data Box Gateway device.", + "operationId": "Alerts_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of alerts.", + "schema": { + "$ref": "#/definitions/AlertList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "AlertGetAllInDevice": { + "$ref": "./examples/AlertGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/alerts/{name}": { + "get": { + "tags": [ + "Alerts" + ], + "summary": "Gets an alert by name.", + "operationId": "Alerts_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The alert name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The alert details.", + "schema": { + "$ref": "#/definitions/Alert" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "AlertGet": { + "$ref": "./examples/AlertGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules": { + "get": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Gets all the bandwidth schedules for a Data Box Edge/Data Box Gateway device.", + "operationId": "BandwidthSchedules_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of bandwidth schedules.", + "schema": { + "$ref": "#/definitions/BandwidthSchedulesList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "BandwidthScheduleGetAllInDevice": { + "$ref": "./examples/BandwidthScheduleGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/bandwidthSchedules/{name}": { + "get": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Gets the properties of the specified bandwidth schedule.", + "operationId": "BandwidthSchedules_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The bandwidth schedule.", + "schema": { + "$ref": "#/definitions/BandwidthSchedule" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "BandwidthScheduleGet": { + "$ref": "./examples/BandwidthScheduleGet.json" + } + } + }, + "put": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Creates or updates a bandwidth schedule.", + "operationId": "BandwidthSchedules_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name which needs to be added/updated.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The bandwidth schedule to be added or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/BandwidthSchedule" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the bandwidth schedule.", + "schema": { + "$ref": "#/definitions/BandwidthSchedule" + } + }, + "202": { + "description": "Accepted the request to create or update the bandwidth schedule." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BandwidthSchedulePut": { + "$ref": "./examples/BandwidthSchedulePut.json" + } + } + }, + "delete": { + "tags": [ + "BandwidthSchedules" + ], + "description": "Deletes the specified bandwidth schedule.", + "operationId": "BandwidthSchedules_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The bandwidth schedule name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the bandwidth schedule." + }, + "202": { + "description": "Accepted the request to delete the bandwidth schedule." + }, + "204": { + "description": "Successfully deleted the bandwidth schedule." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "BandwidthScheduleDelete": { + "$ref": "./examples/BandwidthScheduleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/downloadUpdates": { + "post": { + "tags": [ + "Devices" + ], + "summary": "Downloads the updates on a Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_DownloadUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully downloaded the updates on the device." + }, + "202": { + "description": "Accepted the request to download the updates on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "DownloadUpdatesPost": { + "$ref": "./examples/DownloadUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/getExtendedInformation": { + "post": { + "tags": [ + "Devices" + ], + "description": "Gets additional information for the specified Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_GetExtendedInformation", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The additional information.", + "schema": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfo" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ExtendedInfoPost": { + "$ref": "./examples/ExtendedInfoPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/installUpdates": { + "post": { + "tags": [ + "Devices" + ], + "summary": "Installs the updates on the Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_InstallUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully installed updates on the device." + }, + "202": { + "description": "Accepted the request to install updates on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "InstallUpdatesPost": { + "$ref": "./examples/InstallUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/jobs/{name}": { + "get": { + "tags": [ + "Jobs" + ], + "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.", + "operationId": "Jobs_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The job name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The job details.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "JobsGet": { + "$ref": "./examples/JobsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/networkSettings/default": { + "get": { + "tags": [ + "Devices" + ], + "description": "Gets the network settings of the specified Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_GetNetworkSettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The device network settings.", + "schema": { + "$ref": "#/definitions/NetworkSettings" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "NetworkSettingsGet": { + "$ref": "./examples/NetworkSettingsGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/nodes": { + "get": { + "tags": [ + "Nodes" + ], + "description": "Gets all the nodes currently configured under this Data Box Edge device", + "operationId": "Nodes_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all nodes on the device.", + "schema": { + "$ref": "#/definitions/NodeList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "NodesGetAllInDevice": { + "$ref": "./examples/NodeGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/operationsStatus/{name}": { + "get": { + "tags": [ + "OperationsStatus" + ], + "summary": "Gets the details of a specified job on a Data Box Edge/Data Box Gateway device.", + "operationId": "OperationsStatus_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The job name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The job details.", + "schema": { + "$ref": "#/definitions/Job" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "OperationsStatusGet": { + "$ref": "./examples/OperationsStatusGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders": { + "get": { + "tags": [ + "Orders" + ], + "summary": "Lists all the orders related to a Data Box Edge/Data Box Gateway device.", + "operationId": "Orders_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Lists all the orders for the Data Box Edge Device", + "schema": { + "$ref": "#/definitions/OrderList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "OrderGetAllInDevice": { + "$ref": "./examples/OrderGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/orders/default": { + "get": { + "tags": [ + "Orders" + ], + "summary": "Gets a specific order by name.", + "operationId": "Orders_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The order details of a device.", + "schema": { + "$ref": "#/definitions/Order" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "OrderGet": { + "$ref": "./examples/OrderGet.json" + } + } + }, + "put": { + "tags": [ + "Orders" + ], + "summary": "Creates or updates an order.", + "operationId": "Orders_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The order details of a device.", + "required": true, + "type": "string" + }, + { + "name": "order", + "in": "body", + "description": "The order to be created or updated.", + "required": true, + "schema": { + "$ref": "#/definitions/Order" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the order.", + "schema": { + "$ref": "#/definitions/Order" + } + }, + "202": { + "description": "Accepted the request to create or update the order." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "OrderPut": { + "$ref": "./examples/OrderPut.json" + } + } + }, + "delete": { + "tags": [ + "Orders" + ], + "summary": "Deletes the order related to the device.", + "operationId": "Orders_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the order." + }, + "202": { + "description": "Accepted the request to delete the order." + }, + "204": { + "description": "The order is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "OrderDelete": { + "$ref": "./examples/OrderDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles": { + "get": { + "tags": [ + "Roles" + ], + "description": "Lists all the roles configured in a Data Box Edge/Data Box Gateway device.", + "operationId": "Roles_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "List of all the roles configured in the device.", + "schema": { + "$ref": "#/definitions/RoleList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "RoleGetAllInDevice": { + "$ref": "./examples/RoleGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/roles/{name}": { + "get": { + "tags": [ + "Roles" + ], + "description": "Gets a specific role by name.", + "operationId": "Roles_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The role with the specified name in the given device.", + "schema": { + "$ref": "#/definitions/Role" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "RoleGet": { + "$ref": "./examples/RoleGet.json" + } + } + }, + "put": { + "tags": [ + "Roles" + ], + "description": "Create or update a role.", + "operationId": "Roles_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "name": "role", + "in": "body", + "description": "The role properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Role" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the role.", + "schema": { + "$ref": "#/definitions/Role" + } + }, + "202": { + "description": "Accepted the request to create or update the role." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RolePut": { + "$ref": "./examples/RolePut.json" + } + } + }, + "delete": { + "tags": [ + "Roles" + ], + "description": "Deletes the role on the device.", + "operationId": "Roles_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The role name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the role." + }, + "202": { + "description": "Accepted the request to delete the role." + }, + "204": { + "description": "The role is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "RoleDelete": { + "$ref": "./examples/RoleDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/scanForUpdates": { + "post": { + "tags": [ + "Devices" + ], + "summary": "Scans for updates on a Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_ScanForUpdates", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully scanned the device for updates." + }, + "202": { + "description": "Accepted the request to scan for updates on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ScanForUpdatesPost": { + "$ref": "./examples/ScanForUpdatesPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/securitySettings/default/update": { + "post": { + "tags": [ + "Devices" + ], + "description": "Updates the security settings on a Data Box Edge/Data Box Gateway device.", + "operationId": "Devices_CreateOrUpdateSecuritySettings", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "securitySettings", + "in": "body", + "description": "The security settings.", + "required": true, + "schema": { + "$ref": "#/definitions/SecuritySettings" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to update the security settings." + }, + "204": { + "description": "Updated the security settings." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "CreateOrUpdateSecuritySettings": { + "$ref": "./examples/SecuritySettingsUpdatePost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares": { + "get": { + "tags": [ + "Shares" + ], + "summary": "Lists all the shares in a Data Box Edge/Data Box Gateway device.", + "operationId": "Shares_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all the shares on the device.", + "schema": { + "$ref": "#/definitions/ShareList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ShareGetAllInDevice": { + "$ref": "./examples/ShareGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}": { + "get": { + "tags": [ + "Shares" + ], + "summary": "Gets a share by name.", + "operationId": "Shares_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The share details.", + "schema": { + "$ref": "#/definitions/Share" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ShareGet": { + "$ref": "./examples/ShareGet.json" + } + } + }, + "put": { + "tags": [ + "Shares" + ], + "summary": "Creates a new share or updates an existing share on the device.", + "operationId": "Shares_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "name": "share", + "in": "body", + "description": "The share properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Share" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the share.", + "schema": { + "$ref": "#/definitions/Share" + } + }, + "202": { + "description": "Accepted the request to create or update the share." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SharePut": { + "$ref": "./examples/SharePut.json" + } + } + }, + "delete": { + "tags": [ + "Shares" + ], + "description": "Deletes the share on the Data Box Edge/Data Box Gateway device.", + "operationId": "Shares_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the share." + }, + "202": { + "description": "Accepted the request to delete the share." + }, + "204": { + "description": "The share is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareDelete": { + "$ref": "./examples/ShareDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/shares/{name}/refresh": { + "post": { + "tags": [ + "Shares" + ], + "summary": "Refreshes the share metadata with the data from the cloud.", + "operationId": "Shares_Refresh", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The share name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully refreshed the share on the device." + }, + "202": { + "description": "Accepted the request to refresh the share on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ShareRefreshPost": { + "$ref": "./examples/ShareRefreshPost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials": { + "get": { + "tags": [ + "StorageAccountCredentials" + ], + "summary": "Gets all the storage account credentials in a Data Box Edge/Data Box Gateway device.", + "operationId": "StorageAccountCredentials_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of storage account credentials.", + "schema": { + "$ref": "#/definitions/StorageAccountCredentialList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SACGetAllInDevice": { + "$ref": "./examples/SACGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccountCredentials/{name}": { + "get": { + "tags": [ + "StorageAccountCredentials" + ], + "description": "Gets the properties of the specified storage account credential.", + "operationId": "StorageAccountCredentials_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The storage account credential properties.", + "schema": { + "$ref": "#/definitions/StorageAccountCredential" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "SACGet": { + "$ref": "./examples/SACGet.json" + } + } + }, + "put": { + "tags": [ + "StorageAccountCredentials" + ], + "description": "Creates or updates the storage account credential.", + "operationId": "StorageAccountCredentials_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountCredential", + "in": "body", + "description": "The storage account credential.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccountCredential" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the storage account credential.", + "schema": { + "$ref": "#/definitions/StorageAccountCredential" + } + }, + "202": { + "description": "Accepted the request to create or update the storage account credential." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SACPut": { + "$ref": "./examples/SACPut.json" + } + } + }, + "delete": { + "tags": [ + "StorageAccountCredentials" + ], + "description": "Deletes the storage account credential.", + "operationId": "StorageAccountCredentials_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The storage account credential name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the storage account credential." + }, + "202": { + "description": "Accepted the request to delete the storage account credential." + }, + "204": { + "description": "The storage account credential is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SACDelete": { + "$ref": "./examples/SACDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts": { + "get": { + "tags": [ + "StorageAccounts" + ], + "summary": "Lists all the storage accounts in a Data Box Edge/Data Box Gateway device.", + "operationId": "StorageAccounts_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all the StorageAccounts on the device.", + "schema": { + "$ref": "#/definitions/StorageAccountList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "StorageAccountGetAllInDevice": { + "$ref": "./examples/StorageAccountGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}": { + "get": { + "tags": [ + "StorageAccounts" + ], + "summary": "Gets a StorageAccount by name.", + "operationId": "StorageAccounts_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The storage account name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The storage account details.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "StorageAccountGet": { + "$ref": "./examples/StorageAccountGet.json" + } + } + }, + "put": { + "tags": [ + "StorageAccounts" + ], + "summary": "Creates a new StorageAccount or updates an existing StorageAccount on the device.", + "operationId": "StorageAccounts_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The StorageAccount name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccount", + "in": "body", + "description": "The StorageAccount properties.", + "required": true, + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the StorageAccount.", + "schema": { + "$ref": "#/definitions/StorageAccount" + } + }, + "202": { + "description": "Accepted the request to create or update the StorageAccount." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "StorageAccountPut": { + "$ref": "./examples/StorageAccountPut.json" + } + } + }, + "delete": { + "tags": [ + "StorageAccounts" + ], + "description": "Deletes the StorageAccount on the Data Box Edge/Data Box Gateway device.", + "operationId": "StorageAccounts_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The StorageAccount name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to delete the StorageAccount." + }, + "204": { + "description": "The StorageAccount is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "StorageAccountDelete": { + "$ref": "./examples/StorageAccountDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers": { + "get": { + "tags": [ + "Containers" + ], + "summary": "Lists all the containers of a storage Account in a Data Box Edge/Data Box Gateway device.", + "operationId": "Containers_ListByStorageAccount", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The storage Account name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The collection of all the containers on the device.", + "schema": { + "$ref": "#/definitions/ContainerList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "ContainerListAllInDevice": { + "$ref": "./examples/ContainerListAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}": { + "get": { + "tags": [ + "Containers" + ], + "summary": "Gets a container by name.", + "operationId": "Containers_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container Name", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The container details.", + "schema": { + "$ref": "#/definitions/Container" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "ContainerGet": { + "$ref": "./examples/ContainerGet.json" + } + } + }, + "put": { + "tags": [ + "Containers" + ], + "summary": "Creates a new container or updates an existing container on the device.", + "operationId": "Containers_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container name.", + "required": true, + "type": "string" + }, + { + "name": "container", + "in": "body", + "description": "The container properties.", + "required": true, + "schema": { + "$ref": "#/definitions/Container" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the container.", + "schema": { + "$ref": "#/definitions/Container" + } + }, + "202": { + "description": "Accepted the request to create or update the container." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerPut": { + "$ref": "./examples/ContainerPut.json" + } + } + }, + "delete": { + "tags": [ + "Containers" + ], + "description": "Deletes the container on the Data Box Edge/Data Box Gateway device.", + "operationId": "Containers_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "202": { + "description": "Accepted the request to delete the container." + }, + "204": { + "description": "The container is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerDelete": { + "$ref": "./examples/ContainerDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/storageAccounts/{storageAccountName}/containers/{containerName}/refresh": { + "post": { + "tags": [ + "Containers" + ], + "summary": "Refreshes the container metadata with the data from the cloud.", + "operationId": "Containers_Refresh", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "storageAccountName", + "in": "path", + "description": "The Storage Account Name", + "required": true, + "type": "string" + }, + { + "name": "containerName", + "in": "path", + "description": "The container name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully refreshed the container on the device." + }, + "202": { + "description": "Accepted the request to refresh the container on the device." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "ContainerRefresh": { + "$ref": "./examples/ContainerRefresh.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers": { + "get": { + "tags": [ + "Triggers" + ], + "description": "Lists all the triggers configured in the device.", + "operationId": "Triggers_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='CustomContextTag eq ' to filter on custom context tag property", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "List all the triggers configured in the device", + "schema": { + "$ref": "#/definitions/TriggerList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "TriggerGetAllInDevice": { + "$ref": "./examples/TriggerGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/triggers/{name}": { + "get": { + "tags": [ + "Triggers" + ], + "description": "Get a specific trigger by name.", + "operationId": "Triggers_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The trigger name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The trigger.", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "TriggerGet": { + "$ref": "./examples/TriggerGet.json" + } + } + }, + "put": { + "tags": [ + "Triggers" + ], + "description": "Creates or updates a trigger.", + "operationId": "Triggers_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "Creates or updates a trigger", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The trigger name.", + "required": true, + "type": "string" + }, + { + "name": "trigger", + "in": "body", + "description": "The trigger.", + "required": true, + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the trigger.", + "schema": { + "$ref": "#/definitions/Trigger" + } + }, + "202": { + "description": "Accepted the request to create or update the trigger." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerPut": { + "$ref": "./examples/TriggerPut.json" + } + } + }, + "delete": { + "tags": [ + "Triggers" + ], + "description": "Deletes the trigger on the gateway device.", + "operationId": "Triggers_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The trigger name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the trigger." + }, + "202": { + "description": "Accepted the request to delete the trigger." + }, + "204": { + "description": "The trigger is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "TriggerDelete": { + "$ref": "./examples/TriggerDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/updateSummary/default": { + "get": { + "tags": [ + "Devices" + ], + "summary": "Gets information about the availability of updates based on the last scan of the device. It also gets information about any ongoing download or install jobs on the device.", + "operationId": "Devices_GetUpdateSummary", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The update summary.", + "schema": { + "$ref": "#/definitions/UpdateSummary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UpdateSummaryGet": { + "$ref": "./examples/UpdateSummaryGet.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/uploadCertificate": { + "post": { + "tags": [ + "Devices" + ], + "description": "Uploads registration certificate for the device.", + "operationId": "Devices_UploadCertificate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The upload certificate request.", + "required": true, + "schema": { + "$ref": "#/definitions/UploadCertificateRequest" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully uploaded the registration certificate.", + "schema": { + "$ref": "#/definitions/UploadCertificateResponse" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UploadCertificatePost": { + "$ref": "./examples/UploadCertificatePost.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users": { + "get": { + "tags": [ + "Users" + ], + "description": "Gets all the users registered on a Data Box Edge/Data Box Gateway device.", + "operationId": "Users_ListByDataBoxEdgeDevice", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='UserType eq ' to filter on user type property", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "The collection of all users on the device.", + "schema": { + "$ref": "#/definitions/UserList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "UserGetAllInDevice": { + "$ref": "./examples/UserGetAllInDevice.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/{deviceName}/users/{name}": { + "get": { + "tags": [ + "Users" + ], + "description": "Gets the properties of the specified user.", + "operationId": "Users_Get", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The user name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The user details.", + "schema": { + "$ref": "#/definitions/User" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-examples": { + "UserGet": { + "$ref": "./examples/UserGet.json" + } + } + }, + "put": { + "tags": [ + "Users" + ], + "description": "Creates a new user or updates an existing user's information on a Data Box Edge/Data Box Gateway device.", + "operationId": "Users_CreateOrUpdate", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The user name.", + "required": true, + "type": "string" + }, + { + "name": "user", + "in": "body", + "description": "The user details.", + "required": true, + "schema": { + "$ref": "#/definitions/User" + } + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully created or updated the user.", + "schema": { + "$ref": "#/definitions/User" + } + }, + "202": { + "description": "Accepted the request to create or update the user." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UserPut": { + "$ref": "./examples/UserPut.json" + } + } + }, + "delete": { + "tags": [ + "Users" + ], + "description": "Deletes the user on a databox edge/gateway device.", + "operationId": "Users_Delete", + "parameters": [ + { + "name": "deviceName", + "in": "path", + "description": "The device name.", + "required": true, + "type": "string" + }, + { + "name": "name", + "in": "path", + "description": "The user name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/resourceGroupNameParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the user." + }, + "202": { + "description": "Accepted the request to delete the user." + }, + "204": { + "description": "The user is already deleted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "UserDelete": { + "$ref": "./examples/UserDelete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.DataBoxEdge/skus": { + "get": { + "tags": [ + "Skus" + ], + "summary": "List all the available Skus in the region and information related to them", + "operationId": "Skus_List", + "parameters": [ + { + "$ref": "#/parameters/subscriptionIdParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "in": "query", + "description": "Specify $filter='location eq ' to filter on location.", + "required": false, + "type": "string" + } + ], + "responses": { + "200": { + "description": "Lists the available Skus and information related to them.", + "schema": { + "$ref": "#/definitions/SkuInformationList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ListSkus": { + "$ref": "./examples/ListSkus.json" + } + } + } + } + }, + "definitions": { + "Address": { + "description": "The shipping address of the customer.", + "required": [ + "addressLine1", + "postalCode", + "city", + "state", + "country" + ], + "type": "object", + "properties": { + "addressLine1": { + "description": "The address line1.", + "type": "string" + }, + "addressLine2": { + "description": "The address line2.", + "type": "string" + }, + "addressLine3": { + "description": "The address line3.", + "type": "string" + }, + "postalCode": { + "description": "The postal code.", + "type": "string" + }, + "city": { + "description": "The city name.", + "type": "string" + }, + "state": { + "description": "The state name.", + "type": "string" + }, + "country": { + "description": "The country name.", + "type": "string" + } + } + }, + "Alert": { + "description": "Alert on the data box edge/gateway device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/AlertProperties", + "description": "Properties of alert.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "AlertErrorDetails": { + "description": "Error details for the alert.", + "type": "object", + "properties": { + "errorCode": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "errorMessage": { + "description": "Error Message.", + "type": "string", + "readOnly": true + }, + "occurrences": { + "format": "int32", + "description": "Number of occurrences.", + "type": "integer", + "readOnly": true + } + } + }, + "AlertList": { + "description": "Collection of alerts.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "array", + "items": { + "$ref": "#/definitions/Alert" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "AlertProperties": { + "description": "Properties of alert.", + "type": "object", + "properties": { + "title": { + "description": "Alert title.", + "type": "string", + "readOnly": true + }, + "alertType": { + "description": "Alert type.", + "type": "string", + "readOnly": true + }, + "appearedAtDateTime": { + "format": "date-time", + "description": "UTC time when the alert appeared.", + "type": "string", + "readOnly": true + }, + "recommendation": { + "description": "Alert recommendation.", + "type": "string", + "readOnly": true + }, + "severity": { + "description": "Severity of the alert.", + "enum": [ + "Informational", + "Warning", + "Critical" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "AlertSeverity", + "modelAsString": true + } + }, + "errorDetails": { + "$ref": "#/definitions/AlertErrorDetails", + "description": "Error details of the alert.", + "readOnly": true + }, + "detailedInformation": { + "description": "Alert details.", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "ARMBaseModel": { + "description": "Represents the base class for all object models.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "AsymmetricEncryptedSecret": { + "description": "Represent the secrets intended for encryption with asymmetric key pair.", + "required": [ + "value", + "encryptionAlgorithm" + ], + "type": "object", + "properties": { + "value": { + "description": "The value of the secret.", + "type": "string" + }, + "encryptionCertThumbprint": { + "description": "Thumbprint certificate used to encrypt \\\"Value\\\". If the value is unencrypted, it will be null.", + "type": "string" + }, + "encryptionAlgorithm": { + "description": "The algorithm used to encrypt \"Value\".", + "enum": [ + "None", + "AES256", + "RSAES_PKCS1_v_1_5" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionAlgorithm", + "modelAsString": true + } + } + } + }, + "Authentication": { + "description": "Authentication mechanism for IoT devices.", + "type": "object", + "properties": { + "symmetricKey": { + "$ref": "#/definitions/SymmetricKey", + "description": "Symmetric key for authentication." + } + } + }, + "AzureContainerInfo": { + "description": "Azure container mapping of the endpoint.", + "required": [ + "storageAccountCredentialId", + "containerName", + "dataFormat" + ], + "type": "object", + "properties": { + "storageAccountCredentialId": { + "description": "ID of the storage account credential used to access storage.", + "type": "string" + }, + "containerName": { + "description": "Container name (Based on the data format specified, this represents the name of Azure Files/Page blob/Block blob).", + "type": "string" + }, + "dataFormat": { + "description": "Storage format used for the file represented by the share.", + "enum": [ + "BlockBlob", + "PageBlob", + "AzureFile" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureContainerDataFormat", + "modelAsString": true + } + } + } + }, + "BandwidthSchedule": { + "description": "The bandwidth schedule details.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/BandwidthScheduleProperties", + "description": "The properties of the bandwidth schedule.", + "x-ms-client-flatten": true + } + } + }, + "BandwidthScheduleProperties": { + "description": "The properties of the bandwidth schedule.", + "required": [ + "start", + "stop", + "rateInMbps", + "days" + ], + "type": "object", + "properties": { + "start": { + "description": "The start time of the schedule in UTC.", + "type": "string" + }, + "stop": { + "description": "The stop time of the schedule in UTC.", + "type": "string" + }, + "rateInMbps": { + "format": "int32", + "description": "The bandwidth rate in Mbps.", + "type": "integer" + }, + "days": { + "description": "The days of the week when this schedule is applicable.", + "type": "array", + "items": { + "enum": [ + "Sunday", + "Monday", + "Tuesday", + "Wednesday", + "Thursday", + "Friday", + "Saturday" + ], + "type": "string", + "x-ms-enum": { + "name": "DayOfWeek", + "modelAsString": true + } + } + } + } + }, + "BandwidthSchedulesList": { + "description": "The collection of bandwidth schedules.", + "type": "object", + "properties": { + "value": { + "description": "The list of bandwidth schedules.", + "type": "array", + "items": { + "$ref": "#/definitions/BandwidthSchedule" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ClientAccessRight": { + "description": "The mapping between a particular client IP and the type of access client has on the NFS share.", + "required": [ + "client", + "accessPermission" + ], + "type": "object", + "properties": { + "client": { + "description": "IP of the client.", + "type": "string" + }, + "accessPermission": { + "description": "Type of access to be allowed for the client.", + "enum": [ + "NoAccess", + "ReadOnly", + "ReadWrite" + ], + "type": "string", + "x-ms-enum": { + "name": "ClientPermissionType", + "modelAsString": true + } + } + } + }, + "CloudError": { + "description": "An error response from the service.", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "The error details." + } + }, + "x-ms-external": true + }, + "CloudErrorBody": { + "description": "An error response from the service.", + "properties": { + "code": { + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically.", + "type": "string" + }, + "message": { + "description": "A message describing the error, intended to be suitable for display in a user interface.", + "type": "string" + }, + "details": { + "description": "A list of additional details about the error.", + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + } + } + }, + "x-ms-external": true + }, + "ContactDetails": { + "description": "Contains all the contact details of the customer.", + "required": [ + "contactPerson", + "companyName", + "phone", + "emailList" + ], + "type": "object", + "properties": { + "contactPerson": { + "description": "The contact person name.", + "type": "string" + }, + "companyName": { + "description": "The name of the company.", + "type": "string" + }, + "phone": { + "description": "The phone number.", + "type": "string" + }, + "emailList": { + "description": "The email list.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "Container": { + "description": "Represents a container on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ContainerProperties", + "description": "The container properties.", + "x-ms-client-flatten": true + } + } + }, + "ContainerList": { + "description": "Collection of all the containers on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of containers.", + "type": "array", + "items": { + "$ref": "#/definitions/Container" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ContainerProperties": { + "description": "The container properties.", + "required": [ + "dataFormat" + ], + "type": "object", + "properties": { + "containerStatus": { + "description": "Current status of the container.", + "enum": [ + "OK", + "Offline", + "Unknown", + "Updating", + "NeedsAttention" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ContainerStatus", + "modelAsString": true + } + }, + "dataFormat": { + "description": "DataFormat for Container", + "enum": [ + "BlockBlob", + "PageBlob", + "AzureFile" + ], + "type": "string", + "x-ms-enum": { + "name": "AzureContainerDataFormat", + "modelAsString": true + } + }, + "refreshDetails": { + "$ref": "#/definitions/RefreshDetails", + "description": "Details of the refresh job on this container.", + "readOnly": true + }, + "createdDateTime": { + "format": "date-time", + "description": "The UTC time when container got created.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDevice": { + "description": "The Data Box Edge/Gateway device.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "location": { + "description": "The location of the device. This is a supported and registered Azure geographical region (for example, West US, East US, or Southeast Asia). The geographical region of a device cannot be changed once it is created, but if an identical geographical region is specified on update, the request will succeed.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "The list of tags that describe the device. These tags can be used to view and group this device (across resource groups).", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The SKU type." + }, + "etag": { + "description": "The etag for the devices.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/DataBoxEdgeDeviceProperties", + "description": "The properties of the Data Box Edge/Gateway device.", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceExtendedInfo": { + "description": "The extended Info of the Data Box Edge/Gateway device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/DataBoxEdgeDeviceExtendedInfoProperties", + "description": "The extended info properties.", + "x-ms-client-flatten": true + } + } + }, + "DataBoxEdgeDeviceExtendedInfoProperties": { + "description": "The properties of the Data Box Edge/Gateway device extended info.", + "type": "object", + "properties": { + "encryptionKeyThumbprint": { + "description": "The digital signature of encrypted certificate.", + "type": "string" + }, + "encryptionKey": { + "description": "The public part of the encryption certificate. Client uses this to encrypt any secret.", + "type": "string" + }, + "resourceKey": { + "description": "The Resource ID of the Resource.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDeviceList": { + "description": "The collection of Data Box Edge/Gateway devices.", + "type": "object", + "properties": { + "value": { + "description": "The list of Data Box Edge/Gateway devices.", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxEdgeDevice" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "DataBoxEdgeDevicePatch": { + "description": "The Data Box Edge/Gateway device patch.", + "type": "object", + "properties": { + "tags": { + "description": "The tags attached to the Data Box Edge/Gateway resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "DataBoxEdgeDeviceProperties": { + "description": "The properties of the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "dataBoxEdgeDeviceStatus": { + "description": "The status of the Data Box Edge/Gateway device.", + "enum": [ + "ReadyToSetup", + "Online", + "Offline", + "NeedsAttention", + "Disconnected", + "PartiallyDisconnected", + "Maintenance" + ], + "type": "string", + "x-ms-enum": { + "name": "DataBoxEdgeDeviceStatus", + "modelAsString": true + } + }, + "serialNumber": { + "description": "The Serial Number of Data Box Edge/Gateway device.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The Description of the Data Box Edge/Gateway device.", + "type": "string" + }, + "modelDescription": { + "description": "The description of the Data Box Edge/Gateway device model.", + "type": "string" + }, + "deviceType": { + "description": "The type of the Data Box Edge/Gateway device.", + "enum": [ + "DataBoxEdgeDevice" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DeviceType", + "modelAsString": true + } + }, + "friendlyName": { + "description": "The Data Box Edge/Gateway device name.", + "type": "string" + }, + "culture": { + "description": "The Data Box Edge/Gateway device culture.", + "type": "string", + "readOnly": true + }, + "deviceModel": { + "description": "The Data Box Edge/Gateway device model.", + "type": "string", + "readOnly": true + }, + "deviceSoftwareVersion": { + "description": "The Data Box Edge/Gateway device software version.", + "type": "string", + "readOnly": true + }, + "deviceLocalCapacity": { + "format": "int64", + "description": "The Data Box Edge/Gateway device local capacity in MB.", + "type": "integer", + "readOnly": true + }, + "timeZone": { + "description": "The Data Box Edge/Gateway device timezone.", + "type": "string", + "readOnly": true + }, + "deviceHcsVersion": { + "description": "The device software version number of the device (eg: 1.2.18105.6).", + "type": "string", + "readOnly": true + }, + "configuredRoleTypes": { + "description": "Type of compute roles configured.", + "type": "array", + "items": { + "enum": [ + "IOT", + "ASA", + "Functions", + "Cognitive" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + }, + "readOnly": true + }, + "nodeCount": { + "format": "int32", + "description": "The number of nodes in the cluster.", + "type": "integer", + "readOnly": true + } + } + }, + "DataBoxEdgeSku": { + "description": "The Sku information.", + "type": "object", + "properties": { + "resourceType": { + "description": "The type of the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Sku name.", + "enum": [ + "Gateway", + "Edge", + "TEA_1Node", + "TEA_1Node_UPS", + "TEA_1Node_Heater", + "TEA_1Node_UPS_Heater", + "TEA_4Node_Heater", + "TEA_4Node_UPS_Heater", + "TMA", + "TDC", + "TCA_Large", + "TCA_Small", + "GPU" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "kind": { + "description": "The Sku kind.", + "type": "string", + "readOnly": true + }, + "tier": { + "description": "The Sku tier.", + "enum": [ + "Standard" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + }, + "size": { + "description": "The Sku kind.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "The Sku family.", + "type": "string", + "readOnly": true + }, + "locations": { + "description": "Availability of the Sku for the region.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "apiVersions": { + "description": "The API versions in which Sku is available.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "locationInfo": { + "description": "Availability of the Sku for the location/zone/site.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfo" + }, + "readOnly": true + }, + "costs": { + "description": "The pricing info of the Sku.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuCost" + }, + "readOnly": true + }, + "restrictions": { + "description": "Restriction info of the SKU.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuRestriction" + }, + "readOnly": true + }, + "signupOption": { + "description": "Can the SKU be signed up..", + "enum": [ + "None", + "Available" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuSignupOption", + "modelAsString": true + } + }, + "version": { + "description": "Sku version.", + "enum": [ + "Stable", + "Preview" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuVersion", + "modelAsString": true + } + }, + "availability": { + "description": "Is SKU available", + "enum": [ + "Available", + "Unavailable" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuAvailability", + "modelAsString": true + } + } + } + }, + "DataBoxEdgeSkuList": { + "description": "List of SKU Information objects.", + "type": "object", + "properties": { + "value": { + "description": "List of ResourceType Sku", + "type": "array", + "items": { + "$ref": "#/definitions/DataBoxEdgeSku" + }, + "readOnly": true + }, + "nextLink": { + "description": "Links to the next set of results", + "type": "string", + "readOnly": true + } + } + }, + "FileEventTrigger": { + "description": "Trigger details.", + "required": [ + "properties", + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/FileTriggerProperties", + "description": "File trigger properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "FileEvent" + }, + "FileSourceInfo": { + "description": "File source details.", + "required": [ + "shareId" + ], + "type": "object", + "properties": { + "shareId": { + "description": "File share ID.", + "type": "string" + } + } + }, + "FileTriggerProperties": { + "description": "File trigger properties.", + "required": [ + "sourceInfo", + "sinkInfo" + ], + "type": "object", + "properties": { + "sourceInfo": { + "$ref": "#/definitions/FileSourceInfo", + "description": "File event source details." + }, + "sinkInfo": { + "$ref": "#/definitions/RoleSinkInfo", + "description": "Role sink info." + }, + "customContextTag": { + "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.", + "type": "string" + } + } + }, + "ImageRepositoryCredential": { + "description": "Image repository credential.", + "required": [ + "imageRepositoryUrl", + "userName" + ], + "type": "object", + "properties": { + "imageRepositoryUrl": { + "description": "Image repository url (e.g.: mcr.microsoft.com).", + "type": "string" + }, + "userName": { + "description": "Repository user name.", + "type": "string" + }, + "password": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Repository user password." + } + } + }, + "IoTDeviceInfo": { + "description": "Metadata of IoT device/IoT Edge device to be configured.", + "required": [ + "deviceId", + "ioTHostHub" + ], + "type": "object", + "properties": { + "deviceId": { + "description": "ID of the IoT device/edge device.", + "type": "string" + }, + "ioTHostHub": { + "description": "Host name for the IoT hub associated to the device.", + "type": "string" + }, + "ioTHostHubId": { + "description": "Id for the IoT hub associated to the device.", + "type": "string" + }, + "authentication": { + "$ref": "#/definitions/Authentication", + "description": "Encrypted IoT device/IoT edge device connection string." + } + } + }, + "IoTEdgeAgentInfo": { + "description": "IoT edge agent details is optional, this will be used for download system Agent module while bootstrapping IoT Role if specified.", + "required": [ + "imageName", + "tag" + ], + "type": "object", + "properties": { + "imageName": { + "description": "Name of the IoT edge agent image.", + "type": "string" + }, + "tag": { + "description": "Image Tag.", + "type": "string" + }, + "imageRepository": { + "$ref": "#/definitions/ImageRepositoryCredential", + "description": "Image repository details." + } + } + }, + "IoTRole": { + "description": "Compute role.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Role" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/IoTRoleProperties", + "description": "Properties specific to IoT role.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "IOT" + }, + "IoTRoleProperties": { + "description": "IoT role properties.", + "required": [ + "hostPlatform", + "ioTDeviceDetails", + "ioTEdgeDeviceDetails", + "roleStatus" + ], + "type": "object", + "properties": { + "hostPlatform": { + "description": "Host OS supported by the IoT role.", + "enum": [ + "Windows", + "Linux" + ], + "type": "string", + "x-ms-enum": { + "name": "PlatformType", + "modelAsString": true + } + }, + "ioTDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT device metadata to which data box edge device needs to be connected." + }, + "ioTEdgeDeviceDetails": { + "$ref": "#/definitions/IoTDeviceInfo", + "description": "IoT edge device to which the IoT role needs to be configured." + }, + "shareMappings": { + "description": "Mount points of shares in role(s).", + "type": "array", + "items": { + "$ref": "#/definitions/MountPointMap" + } + }, + "ioTEdgeAgentInfo": { + "$ref": "#/definitions/IoTEdgeAgentInfo", + "description": "Iot edge agent details to download the agent and bootstrap iot runtime." + }, + "hostPlatformType": { + "description": "Platform where the Iot runtime is hosted.", + "enum": [ + "KubernetesCluster", + "LinuxVM" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "HostPlatformType", + "modelAsString": true + } + }, + "roleStatus": { + "description": "Role status.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleStatus", + "modelAsString": true + } + } + } + }, + "Ipv4Config": { + "description": "Details related to the IPv4 address configuration.", + "type": "object", + "properties": { + "ipAddress": { + "description": "The IPv4 address of the network adapter.", + "type": "string", + "readOnly": true + }, + "subnet": { + "description": "The IPv4 subnet of the network adapter.", + "type": "string", + "readOnly": true + }, + "gateway": { + "description": "The IPv4 gateway of the network adapter.", + "type": "string", + "readOnly": true + } + } + }, + "Ipv6Config": { + "description": "Details related to the IPv6 address configuration.", + "type": "object", + "properties": { + "ipAddress": { + "description": "The IPv6 address of the network adapter.", + "type": "string", + "readOnly": true + }, + "prefixLength": { + "format": "int32", + "description": "The IPv6 prefix of the network adapter.", + "type": "integer", + "readOnly": true + }, + "gateway": { + "description": "The IPv6 gateway of the network adapter.", + "type": "string", + "readOnly": true + } + } + }, + "Job": { + "description": "A device job.", + "type": "object", + "properties": { + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the object.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + }, + "status": { + "description": "The current status of the job.", + "enum": [ + "Invalid", + "Running", + "Succeeded", + "Failed", + "Canceled", + "Paused", + "Scheduled" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobStatus", + "modelAsString": true + } + }, + "startTime": { + "format": "date-time", + "description": "The UTC date and time at which the job started.", + "type": "string", + "readOnly": true + }, + "endTime": { + "format": "date-time", + "description": "The UTC date and time at which the job completed.", + "type": "string", + "readOnly": true + }, + "percentComplete": { + "format": "int32", + "description": "The percentage of the job that is complete.", + "type": "integer", + "readOnly": true + }, + "error": { + "$ref": "#/definitions/JobErrorDetails", + "description": "The error details.", + "readOnly": true + }, + "properties": { + "$ref": "#/definitions/JobProperties", + "description": "The properties of the job.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "JobErrorDetails": { + "description": "The job error information containing the list of job errors.", + "type": "object", + "properties": { + "errorDetails": { + "description": "The error details.", + "type": "array", + "items": { + "$ref": "#/definitions/JobErrorItem" + }, + "readOnly": true + }, + "code": { + "description": "The code intended for programmatic access.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message that describes the error in detail.", + "type": "string", + "readOnly": true + } + } + }, + "JobErrorItem": { + "description": "The job error items.", + "type": "object", + "properties": { + "recommendations": { + "description": "The recommended actions.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "code": { + "description": "The code intended for programmatic access.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "The message that describes the error in detail.", + "type": "string", + "readOnly": true + } + } + }, + "JobProperties": { + "description": "The properties for the job.", + "type": "object", + "properties": { + "jobType": { + "description": "The type of the job.", + "enum": [ + "Invalid", + "ScanForUpdates", + "DownloadUpdates", + "InstallUpdates", + "RefreshShare", + "RefreshContainer" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "JobType", + "modelAsString": true + } + }, + "currentStage": { + "description": "Current stage of the update operation.", + "enum": [ + "Unknown", + "Initial", + "ScanStarted", + "ScanComplete", + "ScanFailed", + "DownloadStarted", + "DownloadComplete", + "DownloadFailed", + "InstallStarted", + "InstallComplete", + "InstallFailed", + "RebootInitiated", + "Success", + "Failure", + "RescanStarted", + "RescanComplete", + "RescanFailed" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpdateOperationStage", + "modelAsString": true + } + }, + "downloadProgress": { + "$ref": "#/definitions/UpdateDownloadProgress", + "description": "The download progress.", + "readOnly": true + }, + "installProgress": { + "$ref": "#/definitions/UpdateInstallProgress", + "description": "The install progress.", + "readOnly": true + }, + "totalRefreshErrors": { + "format": "int32", + "description": "Total number of errors encountered during the refresh process.", + "type": "integer", + "readOnly": true + }, + "errorManifestFile": { + "description": "Local share/remote container relative path to the error manifest file of the refresh.", + "type": "string", + "readOnly": true + }, + "refreshedEntityId": { + "description": "ARM ID of the entity that was refreshed.", + "type": "string", + "readOnly": true + }, + "folder": { + "description": "If only subfolders need to be refreshed, then the subfolder path inside the share or container. (The path is empty if there are no subfolders.)", + "type": "string" + } + } + }, + "MetricDimension_V1": { + "description": "Metric Dimension v1.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metrics dimension.", + "type": "string" + }, + "displayName": { + "description": "Display name of the metrics dimension.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "To be exported to shoe box.", + "type": "boolean" + } + } + }, + "MetricSpecification_V1": { + "description": "Metric specification version 1.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Description of the metric to be displayed.", + "type": "string" + }, + "unit": { + "description": "Metric units.", + "enum": [ + "NotSpecified", + "Percent", + "Count", + "Seconds", + "Milliseconds", + "Bytes", + "BytesPerSecond", + "CountPerSecond" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricUnit", + "modelAsString": true + } + }, + "aggregationType": { + "description": "Metric aggregation type.", + "enum": [ + "NotSpecified", + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + }, + "dimensions": { + "description": "Metric dimensions, other than default dimension which is resource.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricDimension_V1" + } + }, + "fillGapWithZero": { + "description": "Set true to fill the gaps with zero.", + "type": "boolean" + }, + "category": { + "description": "Metric category.", + "enum": [ + "Capacity", + "Transaction" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricCategory", + "modelAsString": true + } + }, + "resourceIdDimensionNameOverride": { + "description": "Resource name override.", + "type": "string" + }, + "supportedTimeGrainTypes": { + "description": "Support granularity of metrics.", + "type": "array", + "items": { + "enum": [ + "PT1M", + "PT5M", + "PT15M", + "PT30M", + "PT1H", + "PT6H", + "PT12H", + "PT1D" + ], + "type": "string", + "x-ms-enum": { + "name": "TimeGrain", + "modelAsString": true + } + } + }, + "supportedAggregationTypes": { + "description": "Support metric aggregation type.", + "type": "array", + "items": { + "enum": [ + "NotSpecified", + "None", + "Average", + "Minimum", + "Maximum", + "Total", + "Count" + ], + "type": "string", + "x-ms-enum": { + "name": "MetricAggregationType", + "modelAsString": true + } + } + } + } + }, + "MountPointMap": { + "description": "The share mount point.", + "required": [ + "shareId" + ], + "type": "object", + "properties": { + "shareId": { + "description": "ID of the share mounted to the role VM.", + "type": "string" + }, + "roleId": { + "description": "ID of the role to which share is mounted.", + "type": "string", + "readOnly": true + }, + "mountPoint": { + "description": "Mount point for the share.", + "type": "string", + "readOnly": true + }, + "mountType": { + "description": "Mounting type.", + "enum": [ + "Volume", + "HostPath" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "MountType", + "modelAsString": true + } + }, + "roleType": { + "description": "Role type.", + "enum": [ + "IOT", + "ASA", + "Functions", + "Cognitive" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + } + } + }, + "NetworkAdapter": { + "description": "Represents the networkAdapter on a device.", + "type": "object", + "properties": { + "adapterId": { + "description": "Instance ID of network adapter.", + "type": "string", + "readOnly": true + }, + "adapterPosition": { + "$ref": "#/definitions/NetworkAdapterPosition", + "description": "Hardware position of network adapter.", + "readOnly": true + }, + "index": { + "format": "int32", + "description": "Logical index of the adapter.", + "type": "integer", + "readOnly": true + }, + "nodeId": { + "description": "Node ID of the network adapter.", + "type": "string", + "readOnly": true + }, + "networkAdapterName": { + "description": "Network adapter name.", + "type": "string", + "readOnly": true + }, + "label": { + "description": "Hardware label for the adapter.", + "type": "string", + "readOnly": true + }, + "macAddress": { + "description": "MAC address.", + "type": "string", + "readOnly": true + }, + "linkSpeed": { + "format": "int64", + "description": "Link speed.", + "type": "integer", + "readOnly": true + }, + "status": { + "description": "Value indicating whether this adapter is valid.", + "enum": [ + "Inactive", + "Active" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkAdapterStatus", + "modelAsString": true + } + }, + "rdmaStatus": { + "description": "Value indicating whether this adapter is RDMA capable.", + "enum": [ + "Incapable", + "Capable" + ], + "type": "string", + "x-ms-enum": { + "name": "NetworkAdapterRDMAStatus", + "modelAsString": true + } + }, + "dhcpStatus": { + "description": "Value indicating whether this adapter has DHCP enabled.", + "enum": [ + "Disabled", + "Enabled" + ], + "type": "string", + "x-ms-enum": { + "name": "NetworkAdapterDHCPStatus", + "modelAsString": true + } + }, + "ipv4Configuration": { + "$ref": "#/definitions/Ipv4Config", + "description": "The IPv4 configuration of the network adapter.", + "readOnly": true + }, + "ipv6Configuration": { + "$ref": "#/definitions/Ipv6Config", + "description": "The IPv6 configuration of the network adapter.", + "readOnly": true + }, + "ipv6LinkLocalAddress": { + "description": "The IPv6 local address.", + "type": "string", + "readOnly": true + }, + "dnsServers": { + "description": "The list of DNS Servers of the device.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "NetworkAdapterPosition": { + "description": "The network adapter position.", + "type": "object", + "properties": { + "networkGroup": { + "description": "The network group.", + "enum": [ + "None", + "NonRDMA", + "RDMA" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NetworkGroup", + "modelAsString": true + } + }, + "port": { + "format": "int32", + "description": "The port.", + "type": "integer", + "readOnly": true + } + } + }, + "NetworkSettings": { + "description": "The network settings of a device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NetworkSettingsProperties", + "description": "The properties of network settings of a device.", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "NetworkSettingsProperties": { + "description": "The properties of network settings.", + "type": "object", + "properties": { + "networkAdapters": { + "description": "The network adapter list on the device.", + "type": "array", + "items": { + "$ref": "#/definitions/NetworkAdapter" + }, + "readOnly": true + } + } + }, + "Node": { + "description": "Represents a single node in a Data box Edge/Gateway device\r\nGateway devices, standalone Edge devices and a single node cluster Edge device will all have 1 node\r\nMulti-node Edge devices will have more than 1 nodes", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/NodeProperties", + "description": "The properties of the node", + "readOnly": true, + "x-ms-client-flatten": true + } + } + }, + "NodeList": { + "description": "Collection of Nodes.", + "type": "object", + "properties": { + "value": { + "description": "The list of Nodes.", + "type": "array", + "items": { + "$ref": "#/definitions/Node" + }, + "readOnly": true + } + } + }, + "NodeProperties": { + "description": "This class represents the nodes in a highly available cluster", + "type": "object", + "properties": { + "nodeStatus": { + "description": "The current status of the individual node", + "enum": [ + "Unknown", + "Up", + "Down", + "Rebooting", + "ShuttingDown" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "NodeStatus", + "modelAsString": true + } + }, + "nodeChassisSerialNumber": { + "description": "Serial number of the Chassis", + "type": "string", + "readOnly": true + }, + "nodeSerialNumber": { + "description": "Serial number of the individual node", + "type": "string", + "readOnly": true + }, + "nodeDisplayName": { + "description": "Display Name of the individual node", + "type": "string", + "readOnly": true + }, + "nodeFriendlySoftwareVersion": { + "description": "Friendly software version name that is currently installed on the node", + "type": "string", + "readOnly": true + }, + "nodeHcsVersion": { + "description": "HCS version that is currently installed on the node", + "type": "string", + "readOnly": true + }, + "nodeInstanceId": { + "description": "Guid instance id of the node", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "Operations.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation.", + "type": "string" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "Properties displayed for the operation." + }, + "origin": { + "description": "Origin of the operation.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Operation properties.", + "x-ms-client-flatten": true + } + } + }, + "OperationDisplay": { + "description": "Operation display properties.", + "type": "object", + "properties": { + "provider": { + "description": "Provider name.", + "type": "string" + }, + "resource": { + "description": "The type of resource in which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "Operation to be performed on the resource.", + "type": "string" + }, + "description": { + "description": "Description of the operation to be performed.", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "Service specification." + } + } + }, + "OperationsList": { + "description": "The list of operations used for the discovery of available provider operations.", + "required": [ + "value" + ], + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string" + } + } + }, + "Order": { + "description": "The order details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/OrderProperties", + "description": "The order properties.", + "x-ms-client-flatten": true + } + } + }, + "OrderList": { + "description": "List of order entities.", + "type": "object", + "properties": { + "value": { + "description": "The list of orders.", + "type": "array", + "items": { + "$ref": "#/definitions/Order" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "OrderProperties": { + "description": "Order properties.", + "required": [ + "contactInformation", + "shippingAddress" + ], + "type": "object", + "properties": { + "contactInformation": { + "$ref": "#/definitions/ContactDetails", + "description": "The contact details." + }, + "shippingAddress": { + "$ref": "#/definitions/Address", + "description": "The shipping address." + }, + "currentStatus": { + "$ref": "#/definitions/OrderStatus", + "description": "Current status of the order." + }, + "orderHistory": { + "description": "List of status changes in the order.", + "type": "array", + "items": { + "$ref": "#/definitions/OrderStatus" + }, + "readOnly": true + }, + "serialNumber": { + "description": "Serial number of the device.", + "type": "string", + "readOnly": true + }, + "deliveryTrackingInfo": { + "description": "Tracking information for the package delivered to the customer whether it has an original or a replacement device.", + "type": "array", + "items": { + "$ref": "#/definitions/TrackingInfo" + }, + "readOnly": true + }, + "returnTrackingInfo": { + "description": "Tracking information for the package returned from the customer whether it has an original or a replacement device.", + "type": "array", + "items": { + "$ref": "#/definitions/TrackingInfo" + }, + "readOnly": true + } + } + }, + "OrderStatus": { + "description": "Represents a single status change.", + "required": [ + "status" + ], + "type": "object", + "properties": { + "status": { + "description": "Status of the order as per the allowed status types.", + "enum": [ + "Untracked", + "AwaitingFulfilment", + "AwaitingPreparation", + "AwaitingShipment", + "Shipped", + "Arriving", + "Delivered", + "ReplacementRequested", + "LostDevice", + "Declined", + "ReturnInitiated", + "AwaitingReturnShipment", + "ShippedBack", + "CollectedAtMicrosoft" + ], + "type": "string", + "x-ms-enum": { + "name": "OrderState", + "modelAsString": true + } + }, + "updateDateTime": { + "format": "date-time", + "description": "Time of status update.", + "type": "string", + "readOnly": true + }, + "comments": { + "description": "Comments related to this status change.", + "type": "string" + }, + "additionalOrderDetails": { + "description": "Dictionary to hold generic information which is not stored\r\nby the already existing properties", + "type": "object", + "additionalProperties": { + "type": "string" + }, + "readOnly": true + } + } + }, + "PeriodicTimerEventTrigger": { + "description": "Trigger details.", + "required": [ + "properties", + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Trigger" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PeriodicTimerProperties", + "description": "Periodic timer trigger properties.", + "x-ms-client-flatten": true + }, + "id": { + "description": "The path ID that uniquely identifies the object.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The object name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The hierarchical type of the object.", + "type": "string", + "readOnly": true + } + }, + "x-ms-discriminator-value": "PeriodicTimerEvent" + }, + "PeriodicTimerProperties": { + "description": "Periodic timer trigger properties.", + "required": [ + "sourceInfo", + "sinkInfo" + ], + "type": "object", + "properties": { + "sourceInfo": { + "$ref": "#/definitions/PeriodicTimerSourceInfo", + "description": "Periodic timer details." + }, + "sinkInfo": { + "$ref": "#/definitions/RoleSinkInfo", + "description": "Role Sink information." + }, + "customContextTag": { + "description": "A custom context tag typically used to correlate the trigger against its usage. For example, if a periodic timer trigger is intended for certain specific IoT modules in the device, the tag can be the name or the image URL of the module.", + "type": "string" + } + } + }, + "PeriodicTimerSourceInfo": { + "description": "Periodic timer event source.", + "required": [ + "startTime", + "schedule" + ], + "type": "object", + "properties": { + "startTime": { + "format": "date-time", + "description": "The time of the day that results in a valid trigger. Schedule is computed with reference to the time specified upto seconds. If timezone is not specified the time will considered to be in device timezone. The value will always be returned as UTC time.", + "type": "string" + }, + "schedule": { + "description": "Periodic frequency at which timer event needs to be raised. Supports daily, hourly, minutes, and seconds.", + "type": "string" + }, + "topic": { + "description": "Topic where periodic events are published to IoT device.", + "type": "string" + } + } + }, + "RawCertificateData": { + "description": "Raw Certificate Data.", + "required": [ + "certificate" + ], + "type": "object", + "properties": { + "authenticationType": { + "description": "The authentication type.", + "enum": [ + "Invalid", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "certificate": { + "description": "The base64 encoded certificate raw data.", + "type": "string" + } + } + }, + "RefreshDetails": { + "description": "Fields for tracking refresh job on the share or container.", + "type": "object", + "properties": { + "inProgressRefreshJobId": { + "description": "If a refresh job is currently in progress on this share or container, this field indicates the ARM resource ID of that job. The field is empty if no job is in progress.", + "type": "string" + }, + "lastCompletedRefreshJobTimeInUTC": { + "format": "date-time", + "description": "Indicates the completed time for the last refresh job on this particular share or container, if any.This could be a failed job or a successful job.", + "type": "string" + }, + "errorManifestFile": { + "description": "Indicates the relative path of the error xml for the last refresh job on this particular share or container, if any. This could be a failed job or a successful job.", + "type": "string" + }, + "lastJob": { + "description": "Indicates the id of the last refresh job on this particular share or container,if any. This could be a failed job or a successful job.", + "type": "string" + } + } + }, + "ResourceTypeSku": { + "description": "SkuInformation object", + "type": "object", + "properties": { + "resourceType": { + "description": "The type of the resource", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The Sku name", + "enum": [ + "Gateway", + "Edge", + "TEA_1Node", + "TEA_1Node_UPS", + "TEA_1Node_Heater", + "TEA_1Node_UPS_Heater", + "TEA_4Node_Heater", + "TEA_4Node_UPS_Heater", + "TMA", + "TDC", + "TCA_Large", + "TCA_Small", + "GPU" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "kind": { + "description": "The Sku kind", + "type": "string", + "readOnly": true + }, + "tier": { + "description": "The Sku tier", + "enum": [ + "Standard" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + }, + "family": { + "description": "The Sku family", + "type": "string", + "readOnly": true + }, + "locations": { + "description": "Availability of the SKU for the region", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "apiVersions": { + "description": "The API versions in which SKU is available", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "locationInfo": { + "description": "Availability of the SKU for the location/zone", + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfo" + }, + "readOnly": true + }, + "costs": { + "description": "The pricing info of the Sku.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuCost" + }, + "readOnly": true + }, + "restrictions": { + "description": "Restrictions of the SKU availability.", + "type": "array", + "items": { + "$ref": "#/definitions/SkuRestriction" + }, + "readOnly": true + } + } + }, + "Role": { + "description": "Compute role.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "kind": { + "description": "Role type.", + "enum": [ + "IOT", + "ASA", + "Functions", + "Cognitive" + ], + "type": "string", + "x-ms-enum": { + "name": "RoleTypes", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "RoleList": { + "description": "Collection of all the roles on the Data Box Edge device.", + "type": "object", + "properties": { + "value": { + "description": "The Value.", + "type": "array", + "items": { + "$ref": "#/definitions/Role" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "RoleSinkInfo": { + "description": "Compute role against which events will be raised.", + "required": [ + "roleId" + ], + "type": "object", + "properties": { + "roleId": { + "description": "Compute role ID.", + "type": "string" + } + } + }, + "SecuritySettings": { + "description": "The security settings of a device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecuritySettingsProperties", + "description": "Properties of the security settings.", + "x-ms-client-flatten": true + } + } + }, + "SecuritySettingsProperties": { + "description": "The properties of security settings.", + "required": [ + "deviceAdminPassword" + ], + "type": "object", + "properties": { + "deviceAdminPassword": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Device administrator password as an encrypted string (encrypted using RSA PKCS #1) is used to sign into the local web UI of the device. The Actual password should have at least 8 characters that are a combination of uppercase, lowercase, numeric, and special characters." + } + } + }, + "ServiceSpecification": { + "description": "Service specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Metric specification as defined by shoebox.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification_V1" + } + } + } + }, + "Share": { + "description": "Represents a share on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ShareProperties", + "description": "The share properties.", + "x-ms-client-flatten": true + } + } + }, + "ShareAccessRight": { + "description": "Specifies the mapping between this particular user and the type of access he has on shares on this device.", + "required": [ + "shareId", + "accessType" + ], + "type": "object", + "properties": { + "shareId": { + "description": "The share ID.", + "type": "string" + }, + "accessType": { + "description": "Type of access to be allowed on the share for this user.", + "enum": [ + "Change", + "Read", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessType", + "modelAsString": true + } + } + } + }, + "ShareList": { + "description": "Collection of all the shares on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of shares.", + "type": "array", + "items": { + "$ref": "#/definitions/Share" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "ShareProperties": { + "description": "The share properties.", + "required": [ + "shareStatus", + "monitoringStatus", + "accessProtocol" + ], + "type": "object", + "properties": { + "description": { + "description": "Description for the share.", + "type": "string" + }, + "shareStatus": { + "description": "Current status of the share.", + "enum": [ + "Offline", + "Unknown", + "OK", + "Updating", + "NeedsAttention" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareStatus", + "modelAsString": true + } + }, + "monitoringStatus": { + "description": "Current monitoring status of the share.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "MonitoringStatus", + "modelAsString": true + } + }, + "azureContainerInfo": { + "$ref": "#/definitions/AzureContainerInfo", + "description": "Azure container mapping for the share." + }, + "accessProtocol": { + "description": "Access protocol to be used by the share.", + "enum": [ + "SMB", + "NFS" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessProtocol", + "modelAsString": true + } + }, + "userAccessRights": { + "description": "Mapping of users and corresponding access rights on the share (required for SMB protocol).", + "type": "array", + "items": { + "$ref": "#/definitions/UserAccessRight" + } + }, + "clientAccessRights": { + "description": "List of IP addresses and corresponding access rights on the share(required for NFS protocol).", + "type": "array", + "items": { + "$ref": "#/definitions/ClientAccessRight" + } + }, + "refreshDetails": { + "$ref": "#/definitions/RefreshDetails", + "description": "Details of the refresh job on this share." + }, + "shareMappings": { + "description": "Share mount point to the role.", + "type": "array", + "items": { + "$ref": "#/definitions/MountPointMap" + }, + "readOnly": true + }, + "dataPolicy": { + "description": "Data policy of the share.", + "enum": [ + "Cloud", + "Local" + ], + "type": "string", + "x-ms-enum": { + "name": "DataPolicy", + "modelAsString": true + } + } + } + }, + "Sku": { + "description": "The SKU type.", + "type": "object", + "properties": { + "name": { + "description": "SKU name.", + "enum": [ + "Gateway", + "Edge", + "TEA_1Node", + "TEA_1Node_UPS", + "TEA_1Node_Heater", + "TEA_1Node_UPS_Heater", + "TEA_4Node_Heater", + "TEA_4Node_UPS_Heater", + "TMA", + "TDC", + "TCA_Large", + "TCA_Small", + "GPU" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "tier": { + "description": "The SKU tier. This is based on the SKU name.", + "enum": [ + "Standard" + ], + "type": "string", + "x-ms-enum": { + "name": "SkuTier", + "modelAsString": true + } + } + } + }, + "SKUCapability": { + "description": "The capabilities of the SKU", + "type": "object", + "properties": { + "name": { + "description": "The capability name", + "type": "string", + "readOnly": true + }, + "value": { + "description": "The capability value", + "type": "string", + "readOnly": true + } + } + }, + "SkuCost": { + "description": "The metadata for retrieving price info.", + "type": "object", + "properties": { + "meterId": { + "description": "Used for querying price from commerce.", + "type": "string", + "readOnly": true + }, + "quantity": { + "format": "int64", + "description": "The cost quantity.", + "type": "integer", + "readOnly": true + }, + "extendedUnit": { + "description": "The extended unit.", + "type": "string", + "readOnly": true + } + } + }, + "SKUCost": { + "description": "The cost of the SKU", + "type": "object", + "properties": { + "meterId": { + "description": "The meter id", + "type": "string", + "readOnly": true + }, + "quantity": { + "format": "int32", + "description": "The quantity", + "type": "integer", + "readOnly": true + }, + "extendedUnit": { + "description": "The extended unit", + "type": "string", + "readOnly": true + } + } + }, + "SkuInformation": { + "description": "Sku information", + "type": "object", + "properties": { + "resourceType": { + "description": "The resource type.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The sku name.", + "type": "string", + "readOnly": true + }, + "tier": { + "description": "The sku tier.", + "type": "string", + "readOnly": true + }, + "kind": { + "description": "The sku kind.", + "type": "string", + "readOnly": true + }, + "size": { + "description": "The sku size.", + "type": "string", + "readOnly": true + }, + "family": { + "description": "The sku family.", + "type": "string", + "readOnly": true + }, + "locations": { + "description": "The locations where Sku is available.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "locationInfo": { + "description": "The locations where Sku is available with zones and sites info", + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfo" + }, + "readOnly": true + }, + "requiredQuotaIds": { + "description": "The required quotaIds for the sku to be available.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredFeatures": { + "description": "The required features for the sku to be available.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "costs": { + "description": "The cost of the SKU", + "type": "array", + "items": { + "$ref": "#/definitions/SKUCost" + }, + "readOnly": true + }, + "capabilities": { + "description": "The capabilities of the SKU", + "type": "array", + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "readOnly": true + } + } + }, + "SkuInformationList": { + "description": "List of SKU Information objects", + "type": "object", + "properties": { + "value": { + "description": "List of ResourceType Sku", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceTypeSku" + }, + "readOnly": true + }, + "nextLink": { + "description": "Links to the next set of results", + "type": "string", + "readOnly": true + } + } + }, + "SkuLocationInfo": { + "description": "The location info.", + "type": "object", + "properties": { + "location": { + "description": "The location.", + "type": "string", + "readOnly": true + }, + "zones": { + "description": "The zones.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "sites": { + "description": "The sites.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "SkuRestriction": { + "description": "The restrictions because of which SKU cannot be used.", + "type": "object", + "properties": { + "type": { + "description": "The type of the restriction.", + "type": "string", + "readOnly": true + }, + "values": { + "description": "The locations where sku is restricted.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "reasonCode": { + "description": "The SKU restriction reason.", + "enum": [ + "NotAvailableForSubscription", + "QuotaId" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "SkuRestrictionReasonCode", + "modelAsString": true + } + }, + "restrictionInfo": { + "$ref": "#/definitions/SkuRestrictionInfo", + "description": "Restriction of the SKU for the location/zone", + "readOnly": true + } + } + }, + "SkuRestrictionInfo": { + "description": "The restriction info with locations and zones.", + "type": "object", + "properties": { + "locations": { + "description": "The locations.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "zones": { + "description": "The zones.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + } + } + }, + "StorageAccount": { + "description": "Represents a Storage Account on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageAccountProperties", + "description": "The Storage Account properties.", + "x-ms-client-flatten": true + } + } + }, + "StorageAccountCredential": { + "description": "The storage account credential.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/StorageAccountCredentialProperties", + "description": "The storage account credential properties.", + "x-ms-client-flatten": true + } + } + }, + "StorageAccountCredentialList": { + "description": "The collection of storage account credentials.", + "type": "object", + "properties": { + "value": { + "description": "The value.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccountCredential" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccountCredentialProperties": { + "description": "The storage account credential properties.", + "required": [ + "alias", + "sslStatus", + "accountType" + ], + "type": "object", + "properties": { + "alias": { + "description": "Alias for the storage account.", + "type": "string" + }, + "userName": { + "description": "Username for the storage account.", + "type": "string" + }, + "accountKey": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Encrypted storage key." + }, + "connectionString": { + "description": "Connection string for the storage account. Use this string if username and account key are not specified.", + "type": "string" + }, + "sslStatus": { + "description": "Signifies whether SSL needs to be enabled or not.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "SSLStatus", + "modelAsString": true + } + }, + "blobDomainName": { + "description": "Blob end point for private clouds.", + "type": "string" + }, + "accountType": { + "description": "Type of storage accessed on the storage account.", + "enum": [ + "GeneralPurposeStorage", + "BlobStorage" + ], + "type": "string", + "x-ms-enum": { + "name": "AccountType", + "modelAsString": true + } + }, + "storageAccountId": { + "description": "Id of the storage account.", + "type": "string" + } + } + }, + "StorageAccountList": { + "description": "Collection of all the Storage Accounts on the Data Box Edge/Gateway device.", + "type": "object", + "properties": { + "value": { + "description": "The list of storageAccounts.", + "type": "array", + "items": { + "$ref": "#/definitions/StorageAccount" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "StorageAccountProperties": { + "description": "The storage account properties.", + "type": "object", + "properties": { + "description": { + "description": "Description for the storage Account.", + "type": "string" + }, + "storageAccountStatus": { + "description": "Current status of the storage account", + "enum": [ + "OK", + "Offline", + "Unknown", + "Updating", + "NeedsAttention" + ], + "type": "string", + "x-ms-enum": { + "name": "StorageAccountStatus", + "modelAsString": true + } + }, + "dataPolicy": { + "description": "Data policy of the storage Account.", + "enum": [ + "Cloud", + "Local" + ], + "type": "string", + "x-ms-enum": { + "name": "DataPolicy", + "modelAsString": true + } + }, + "storageAccountCredentialId": { + "description": "Storage Account Credential Id", + "type": "string" + }, + "blobEndpoint": { + "description": "BlobEndpoint of Storage Account", + "type": "string", + "readOnly": true + }, + "containerCount": { + "format": "int32", + "description": "The Container Count. Present only for Storage Accounts with DataPolicy set to Cloud.", + "type": "integer", + "readOnly": true + } + } + }, + "SymmetricKey": { + "description": "Symmetric key for authentication.", + "type": "object", + "properties": { + "connectionString": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "Connection string based on the symmetric key." + } + } + }, + "TrackingInfo": { + "description": "Tracking courier information.", + "type": "object", + "properties": { + "serialNumber": { + "description": "Serial number of the device being tracked.", + "type": "string" + }, + "carrierName": { + "description": "Name of the carrier used in the delivery.", + "type": "string" + }, + "trackingId": { + "description": "Tracking ID of the shipment.", + "type": "string" + }, + "trackingUrl": { + "description": "Tracking URL of the shipment.", + "type": "string" + } + } + }, + "Trigger": { + "description": "Trigger details.", + "required": [ + "kind" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "kind": { + "description": "Trigger Kind.", + "enum": [ + "FileEvent", + "PeriodicTimerEvent" + ], + "type": "string", + "x-ms-enum": { + "name": "TriggerEventType", + "modelAsString": true + } + } + }, + "discriminator": "kind" + }, + "TriggerList": { + "description": "Collection of all trigger on the data box edge device.", + "type": "object", + "properties": { + "value": { + "description": "The list of triggers.", + "type": "array", + "items": { + "$ref": "#/definitions/Trigger" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UpdateDownloadProgress": { + "description": "Details about the download progress of update.", + "type": "object", + "properties": { + "downloadPhase": { + "description": "The download phase.", + "enum": [ + "Unknown", + "Initializing", + "Downloading", + "Verifying" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "DownloadPhase", + "modelAsString": true + } + }, + "percentComplete": { + "format": "int32", + "description": "Percentage of completion.", + "type": "integer", + "readOnly": true + }, + "totalBytesToDownload": { + "format": "double", + "description": "Total bytes to download.", + "type": "number", + "readOnly": true + }, + "totalBytesDownloaded": { + "format": "double", + "description": "Total bytes downloaded.", + "type": "number", + "readOnly": true + }, + "numberOfUpdatesToDownload": { + "format": "int32", + "description": "Number of updates to download.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesDownloaded": { + "format": "int32", + "description": "Number of updates downloaded.", + "type": "integer", + "readOnly": true + } + } + }, + "UpdateInstallProgress": { + "description": "Progress details during installation of updates.", + "type": "object", + "properties": { + "percentComplete": { + "format": "int32", + "description": "Percentage completed.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesToInstall": { + "format": "int32", + "description": "Number of updates to install.", + "type": "integer", + "readOnly": true + }, + "numberOfUpdatesInstalled": { + "format": "int32", + "description": "Number of updates installed.", + "type": "integer", + "readOnly": true + } + } + }, + "UpdateSummary": { + "description": "Details about ongoing updates and availability of updates on the device.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/UpdateSummaryProperties", + "description": "The device update information summary.", + "x-ms-client-flatten": true + } + } + }, + "UpdateSummaryProperties": { + "description": "The device update information summary.", + "type": "object", + "properties": { + "deviceVersionNumber": { + "description": "The current version of the device in format: 1.2.17312.13.\",", + "type": "string" + }, + "friendlyDeviceVersionName": { + "description": "The current version of the device in text format.", + "type": "string" + }, + "deviceLastScannedDateTime": { + "format": "date-time", + "description": "The last time when a scan was done on the device.", + "type": "string" + }, + "lastCompletedScanJobDateTime": { + "format": "date-time", + "description": "The time when the last scan job was completed (success/cancelled/failed) on the appliance.", + "type": "string" + }, + "lastCompletedDownloadJobDateTime": { + "format": "date-time", + "description": "The time when the last Download job was completed (success/cancelled/failed) on the appliance.", + "type": "string", + "readOnly": true + }, + "lastCompletedInstallJobDateTime": { + "format": "date-time", + "description": "The time when the last Install job was completed (success/cancelled/failed) on the appliance.", + "type": "string", + "readOnly": true + }, + "totalNumberOfUpdatesAvailable": { + "format": "int32", + "description": "The number of updates available for the current device version as per the last device scan.", + "type": "integer", + "readOnly": true + }, + "totalNumberOfUpdatesPendingDownload": { + "format": "int32", + "description": "The total number of items pending download.", + "type": "integer", + "readOnly": true + }, + "totalNumberOfUpdatesPendingInstall": { + "format": "int32", + "description": "The total number of items pending install.", + "type": "integer", + "readOnly": true + }, + "rebootBehavior": { + "description": "Indicates if updates are available and at least one of the updates needs a reboot.", + "enum": [ + "NeverReboots", + "RequiresReboot", + "RequestReboot" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "InstallRebootBehavior", + "modelAsString": true + } + }, + "ongoingUpdateOperation": { + "description": "The current update operation.", + "enum": [ + "None", + "Scan", + "Download", + "Install" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "UpdateOperation", + "modelAsString": true + } + }, + "inProgressDownloadJobId": { + "description": "The job ID of the download job in progress.", + "type": "string", + "readOnly": true + }, + "inProgressInstallJobId": { + "description": "The job ID of the install job in progress.", + "type": "string", + "readOnly": true + }, + "inProgressDownloadJobStartedDateTime": { + "format": "date-time", + "description": "The time when the currently running download (if any) started.", + "type": "string", + "readOnly": true + }, + "inProgressInstallJobStartedDateTime": { + "format": "date-time", + "description": "The time when the currently running install (if any) started.", + "type": "string", + "readOnly": true + }, + "updateTitles": { + "description": "The list of updates available for install.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "totalUpdateSizeInBytes": { + "format": "double", + "description": "The total size of updates available for download in bytes.", + "type": "number", + "readOnly": true + } + } + }, + "UploadCertificateRequest": { + "description": "The upload certificate request.", + "required": [ + "properties" + ], + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/RawCertificateData", + "description": "The Base 64 encoded certificate raw data.", + "x-ms-client-flatten": true + } + } + }, + "UploadCertificateResponse": { + "description": "The upload registration certificate response.", + "type": "object", + "properties": { + "authType": { + "description": "Specifies authentication type.", + "enum": [ + "Invalid", + "AzureActiveDirectory" + ], + "type": "string", + "x-ms-enum": { + "name": "AuthenticationType", + "modelAsString": true + } + }, + "resourceId": { + "description": "The resource ID of the Data Box Edge/Gateway device.", + "type": "string", + "readOnly": true + }, + "aadAuthority": { + "description": "Azure Active Directory tenant authority.", + "type": "string", + "readOnly": true + }, + "aadTenantId": { + "description": "Azure Active Directory tenant ID.", + "type": "string", + "readOnly": true + }, + "servicePrincipalClientId": { + "description": "Azure Active Directory service principal client ID.", + "type": "string", + "readOnly": true + }, + "servicePrincipalObjectId": { + "description": "Azure Active Directory service principal object ID.", + "type": "string", + "readOnly": true + }, + "azureManagementEndpointAudience": { + "description": "The azure management endpoint audience.", + "type": "string", + "readOnly": true + }, + "aadAudience": { + "description": "Identifier of the target resource that is the recipient of the requested token.", + "type": "string", + "readOnly": true + } + } + }, + "User": { + "description": "Represents a user who has access to one or more shares on the Data Box Edge/Gateway device.", + "required": [ + "properties" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ARMBaseModel" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/UserProperties", + "description": "The storage account credential properties.", + "x-ms-client-flatten": true + } + } + }, + "UserAccessRight": { + "description": "The mapping between a particular user and the access type on the SMB share.", + "required": [ + "userId", + "accessType" + ], + "type": "object", + "properties": { + "userId": { + "description": "User ID (already existing in the device).", + "type": "string" + }, + "accessType": { + "description": "Type of access to be allowed for the user.", + "enum": [ + "Change", + "Read", + "Custom" + ], + "type": "string", + "x-ms-enum": { + "name": "ShareAccessType", + "modelAsString": true + } + } + } + }, + "UserList": { + "description": "Collection of users.", + "type": "object", + "properties": { + "value": { + "description": "The list of users.", + "type": "array", + "items": { + "$ref": "#/definitions/User" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to the next set of results.", + "type": "string", + "readOnly": true + } + } + }, + "UserProperties": { + "description": "The user properties.", + "required": [ + "userType" + ], + "type": "object", + "properties": { + "encryptedPassword": { + "$ref": "#/definitions/AsymmetricEncryptedSecret", + "description": "The password details." + }, + "shareAccessRights": { + "description": "List of shares that the user has rights on. This field should not be specified during user creation.", + "type": "array", + "items": { + "$ref": "#/definitions/ShareAccessRight" + }, + "readOnly": true + }, + "userType": { + "description": "Type of the user.", + "enum": [ + "Share", + "LocalManagement", + "ARM" + ], + "type": "string", + "x-ms-enum": { + "name": "UserType", + "modelAsString": true + } + } + } + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "The API version.", + "required": true, + "type": "string" + }, + "locationParameter": { + "name": "location", + "in": "path", + "description": "The location of the resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "resourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The resource group name.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "subscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID.", + "required": true, + "type": "string" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow.", + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account." + } + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AlertGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AlertGet.json new file mode 100644 index 000000000000..e829777055ee --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AlertGet.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.", + "alertType": "UpdateScanFailedEvent", + "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", + "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", + "severity": "Critical", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 1 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "type": "dataBoxEdgeDevices/alerts" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AlertGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AlertGetAllInDevice.json new file mode 100644 index 000000000000..058be9650b25 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AlertGetAllInDevice.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "title": "Device password has changed", + "alertType": "PasswordChangedEvent", + "appearedAtDateTime": "2018-12-18T02:29:15.2325577Z", + "recommendation": "The device administrator password has changed. This is a required action as part of the first time device setup or regular password reset. No further action is required.", + "severity": "Informational", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 2 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/83eccd0b-134b-40b0-ad62-b5f124d03790", + "name": "83eccd0b-134b-40b0-ad62-b5f124d03790", + "type": "dataBoxEdgeDevices/alerts" + }, + { + "properties": { + "title": "Could not scan for updates. Error message : 'An internal error has occurred. Please contact Microsoft Support.'.", + "alertType": "UpdateScanFailedEvent", + "appearedAtDateTime": "2018-12-18T02:18:51.4270267Z", + "recommendation": "Resolve the error : An internal error has occurred. Please contact Microsoft Support.", + "severity": "Critical", + "errorDetails": { + "errorCode": "", + "errorMessage": "", + "occurrences": 1 + }, + "detailedInformation": {} + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/alerts/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "type": "dataBoxEdgeDevices/alerts" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AvailableSkusList.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AvailableSkusList.json new file mode 100644 index 000000000000..100be9b2ed41 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/AvailableSkusList.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "location": "westus", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "dataBoxEdeDevices", + "name": "Gateway", + "availability": "Available", + "tier": "Standard", + "kind": "AzureDataBoxGateway", + "version": "Stable", + "signupOption": "Available", + "locations": [ + "West US" + ], + "locationInfo": [ + { + "location": "West US" + } + ], + "restrictions": [ + { + "type": "location", + "values": [ + "East US" + ], + "restrictionInfo": { + "locations": [ + "East US" + ] + }, + "reasonCode": "NotAvailableForSubscription" + } + ] + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleDelete.json new file mode 100644 index 000000000000..b46c16246344 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleGet.json new file mode 100644 index 000000000000..6c5a7052d395 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleGetAllInDevice.json new file mode 100644 index 000000000000..d952c9942888 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthScheduleGetAllInDevice.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthSchedulePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthSchedulePut.json new file mode 100644 index 000000000000..6a192fe36044 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/BandwidthSchedulePut.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "bandwidth-1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "start": "0:0:0", + "stop": "13:59:0", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "start": "00:00:00", + "stop": "13:59:00", + "rateInMbps": 100, + "days": [ + "Sunday", + "Monday" + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/bandwidthSchedules/bandwidth-1", + "name": "bandwidth-1", + "type": "dataBoxEdgeDevices/bandwidthSchedules" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerDelete.json new file mode 100644 index 000000000000..e69cb3ffc99a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerGet.json new file mode 100644 index 000000000000..f777a5c71568 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:13:27.8545799Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1", + "name": "blobcontainer1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerListAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerListAllInDevice.json new file mode 100644 index 000000000000..9e68fda234f4 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerListAllInDevice.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:14:32.3016929Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer1", + "name": "blobcontainer1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + }, + { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:15:38.0077675Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer2", + "name": "blobcontainer2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + }, + { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:13:27.8545799Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/EAuToWIN-6LJVNIFFB411021190437191/storageAccounts/storageaccount1/containers/blobcontainer3", + "name": "blobcontainer3", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerPut.json new file mode 100644 index 000000000000..c2917e20dc77 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerPut.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "container": { + "properties": { + "dataFormat": "BlockBlob" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "containerStatus": "OK", + "dataFormat": "BlockBlob", + "refreshDetails": {}, + "createdDateTime": "2019-10-20T23:13:27.8545799Z" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/storageaccount1/containers/blobcontainer1", + "name": "blobcontainer-5e155efe", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts/containers" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerRefresh.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerRefresh.json new file mode 100644 index 000000000000..8a72270e6f5a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ContainerRefresh.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "containerName": "blobcontainer1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceDelete.json new file mode 100644 index 000000000000..df86d5121027 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetByName.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetByName.json new file mode 100644 index 000000000000..529220678891 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetByName.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-16T08%3A03%3A27.61Z'\"_W/\"datetime'2018-12-16T08%3A03%3A27.653Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetByResourceGroup.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetByResourceGroup.json new file mode 100644 index 000000000000..77fb3d576d8d --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetByResourceGroup.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A06.493Z'\"_W/\"datetime'2018-12-17T10%3A31%3A06.597Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-09-27T09%3A45%3A09.15Z'\"_W/\"datetime'2018-09-27T09%3A45%3A09.177Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice2", + "name": "testedgedevice2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A00.293Z'\"_W/\"datetime'2018-12-17T10%3A31%3A00.34Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice3", + "name": "testedgedevice3", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetBySubscription.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetBySubscription.json new file mode 100644 index 000000000000..24d19bbe4731 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDeviceGetBySubscription.json @@ -0,0 +1,71 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A06.493Z'\"_W/\"datetime'2018-12-17T10%3A31%3A06.597Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-09-27T09%3A45%3A09.15Z'\"_W/\"datetime'2018-09-27T09%3A45%3A09.177Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice2", + "name": "testedgedevice2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + }, + { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "\"W/\"datetime'2018-12-17T10%3A31%3A00.293Z'\"_W/\"datetime'2018-12-17T10%3A31%3A00.34Z'\"\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice3", + "name": "testedgedevice3", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDevicePatch.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDevicePatch.json new file mode 100644 index 000000000000..197f56975010 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDevicePatch.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "tags": { + "Key1": "value1", + "Key2": "value2" + } + } + }, + "responses": { + "200": { + "body": { + "location": "WUS", + "tags": { + "Key1": "value1", + "Key2": "value2" + }, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "etag": "W/\"datetime'2018-12-19T06%3A33%3A24.983Z'\"_W/\"datetime'2018-12-19T06%3A33%3A25.013Z'\"", + "properties": { + "dataBoxEdgeDeviceStatus": "ReadyToSetup", + "deviceType": "DataBoxEdgeDevice", + "deviceLocalCapacity": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDevicePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDevicePut.json new file mode 100644 index 000000000000..d77a070a559a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DataBoxEdgeDevicePut.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "DataBoxEdgeDevice": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + } + } + }, + "responses": { + "200": { + "body": { + "location": "WUS", + "tags": {}, + "sku": { + "name": "Edge", + "tier": "Standard" + }, + "name": "testedgedevice" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DownloadUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DownloadUpdatesPost.json new file mode 100644 index 000000000000..edf388b1856a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/DownloadUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ExtendedInfoPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ExtendedInfoPost.json new file mode 100644 index 000000000000..32e39f14ff95 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ExtendedInfoPost.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "resourceKey": "3482840729935603111", + "encryptionKeyThumbprint": "", + "encryptionKey": "" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice", + "name": "testedgedevice", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/InstallUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/InstallUpdatesPost.json new file mode 100644 index 000000000000..edf388b1856a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/InstallUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/JobsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/JobsGet.json new file mode 100644 index 000000000000..d87d0e7c7994 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/JobsGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/jobs/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "status": "Succeeded", + "startTime": "2018-12-18T02:18:51.4270267Z", + "endTime": "2018-12-18T03:18:51.4270267Z", + "percentComplete": 100, + "properties": { + "jobType": "DownloadUpdates", + "currentStage": "Success" + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ListSkus.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ListSkus.json new file mode 100644 index 000000000000..63d53d236863 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ListSkus.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "location": "westus", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "dataBoxEdeDevices", + "name": "Gateway", + "tier": "Standard", + "locations": [ + "West US" + ], + "locationInfo": [ + { + "location": "West US" + } + ], + "apiVersions": [ + "2020-05-01-preview" + ], + "restrictions": [ + { + "type": "location", + "values": [ + "East US" + ], + "restrictionInfo": { + "locations": [ + "East US" + ] + }, + "reasonCode": "NotAvailableForSubscription" + } + ] + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/NetworkSettingsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/NetworkSettingsGet.json new file mode 100644 index 000000000000..8167b0879c6f --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/NetworkSettingsGet.json @@ -0,0 +1,58 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "networkAdapters": [ + { + "adapterId": "{47D0D0EC-AA8A-4221-AA2A-355B58082BA5}", + "adapterPosition": { + "networkGroup": "NonRDMA", + "port": 0 + }, + "index": 1, + "nodeId": "3fd54d9e-f7a0-45bf-bdf1-39b0977d1984", + "networkAdapterName": "DATA1", + "label": "DATA1", + "macAddress": "00155D4E265B", + "linkSpeed": 10000000000, + "status": "Inactive", + "rdmaStatus": "Incapable", + "dhcpStatus": "Disabled", + "ipv4Configuration": { + "ipAddress": "10.150.78.56", + "subnet": "255.255.252.0", + "gateway": "10.150.76.1" + }, + "ipv6Configuration": { + "ipAddress": "2404:f801:4800:1e:d5c6:50a1:465b:1bbf", + "prefixLength": 64, + "gateway": "fe80::12f3:11ff:fe36:994b%5" + }, + "ipv6LinkLocalAddress": "fe80::d5c6:50a1:465b:1bbf%5", + "dnsServers": [ + "10.50.50.50", + "10.50.10.50" + ] + } + ] + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/networkSettings/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/NodeGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/NodeGetAllInDevice.json new file mode 100644 index 000000000000..9930117b2223 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/NodeGetAllInDevice.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "nodeStatus": "Unknown", + "nodeChassisSerialNumber": "1D6QHQ2", + "nodeSerialNumber": "1D6QHQ2", + "nodeDisplayName": "Controller 1", + "nodeFriendlySoftwareVersion": "Data Box Edge 1908", + "nodeHcsVersion": "1.6.961.8307", + "nodeInstanceId": "ad051874-7d27-4ac4-a7b1-b6f231d8a035" + }, + "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1D6QHQ2", + "name": "1D6QHQ2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes" + }, + { + "properties": { + "nodeStatus": "Unknown", + "nodeChassisSerialNumber": "1D6QHQ2", + "nodeSerialNumber": "1DCNHQ2", + "nodeDisplayName": "Controller 1", + "nodeFriendlySoftwareVersion": "Data Box Edge 1908", + "nodeHcsVersion": "1.6.961.8307", + "nodeInstanceId": "ddf3a76d-ada4-44af-99c6-a69a0e21bcb6" + }, + "id": "/subscriptions/db4e2fdb-6d80-4e6e-b7cd-736098270664/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/DataBoxEdgeDevices/testedgedevice/nodes/1DCNHQ2", + "name": "1DCNHQ2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/nodes" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OperationsGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OperationsGet.json new file mode 100644 index 000000000000..bf014355f7f8 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OperationsGet.json @@ -0,0 +1,675 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "List share users", + "description": "Lists or gets the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "List share users", + "description": "Lists or gets the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "Creates or updates share users", + "description": "Creates or updates the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "share users", + "operation": "Delete share users", + "description": "Deletes the share users" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "List bandwidth schedules", + "description": "Lists or gets the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "List bandwidth schedules", + "description": "Lists or gets the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "Creates or updates bandwidth schedules", + "description": "Creates or updates the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/bandwidthSchedules/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "bandwidth schedules", + "operation": "Delete bandwidth schedules", + "description": "Deletes the bandwidth schedules" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "List ArmApiRes_roles", + "description": "Lists or gets the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "List ArmApiRes_roles", + "description": "Lists or gets the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "Creates or updates ArmApiRes_roles", + "description": "Creates or updates the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/roles/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "ArmApiRes_roles", + "operation": "Delete ArmApiRes_roles", + "description": "Deletes the ArmApiRes_roles" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "List shares", + "description": "Lists or gets the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "List shares", + "description": "Lists or gets the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "Creates or updates shares", + "description": "Creates or updates the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/refresh/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "ArmApiOp_action_refresh_shares", + "description": "ArmApiDesc_action_refresh_shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/shares/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "shares", + "operation": "Delete shares", + "description": "Deletes the shares" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/uploadCertificate/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Upload certificates", + "description": "Upload certificate for device registration" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Creates or updates Data Box Edge devices", + "description": "Creates or updates the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Delete Data Box Edge devices", + "description": "Deletes the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "List Data Box Edge devices", + "description": "Lists or gets the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Creates or updates Data Box Edge devices", + "description": "Creates or updates the Data Box Edge devices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/getExtendedInformation/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "ArmApiOp_action_getExtendedInformation_dataBoxEdgeDevices", + "description": "ArmApiDesc_action_getExtendedInformation_dataBoxEdgeDevices" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/extendedInformation/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Gets resource extended information", + "description": "Retrieves resource extended information" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/networkSettings/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Device network settings", + "operation": "List Device network settings", + "description": "Lists or gets the Device network settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/securitySettings/update/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Device security settings", + "operation": "Update security settings", + "description": "Update security settings" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "update summary", + "operation": "List update summary", + "description": "Lists or gets the update summary" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/scanForUpdates/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Scan for updates", + "description": "Scan for updates" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/downloadUpdates/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Download Updates", + "description": "Download Updates in device" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/installUpdates/action", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge devices", + "operation": "Install Updates", + "description": "Install Updates on device" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/jobs/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "jobs", + "operation": "List jobs", + "description": "Lists or gets the jobs" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "Creates or updates storage account credentials", + "description": "Creates or updates the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "List storage account credentials", + "description": "Lists or gets the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "List storage account credentials", + "description": "Lists or gets the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials/delete", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "storage account credentials", + "operation": "Delete storage account credentials", + "description": "Deletes the storage account credentials" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "alerts", + "operation": "List alerts", + "description": "Lists or gets the alerts" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/alerts/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "alerts", + "operation": "List alerts", + "description": "Lists or gets the alerts" + }, + "origin": "user" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/metricDefinitions/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Read Data Box Edge device metric definition", + "description": "Gets the available Data Box Edge device level metrics" + }, + "origin": "system", + "properties": { + "serviceSpecification": { + "metricSpecifications": [ + { + "name": "NICReadThroughput", + "displayName": "Read Throughput (Network)", + "displayDescription": "The read throughput of the network interface on the device in the reporting period for all volumes in the gateway.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "InstanceName", + "displayName": "Name", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "NICWriteThroughput", + "displayName": "Write Throughput (Network)", + "displayDescription": "The write throughput of the network interface on the device in the reporting period for all volumes in the gateway.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "InstanceName", + "displayName": "Name", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudReadThroughputPerShare", + "displayName": "Cloud Download Throughput (Share)", + "displayDescription": "The download throughput to Azure from a share during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudUploadThroughputPerShare", + "displayName": "Cloud Upload Throughput (Share)", + "displayDescription": "The upload throughput to Azure from a share during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "BytesUploadedToCloudPerShare", + "displayName": "Cloud Bytes Uploaded (Share)", + "displayDescription": "The total number of bytes that is uploaded to Azure from a share during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [ + { + "name": "Share", + "displayName": "Share", + "toBeExportedForShoebox": true + } + ], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT1M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "TotalCapacity", + "displayName": "Total Capacity", + "displayDescription": "Total Capacity", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Capacity", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "AvailableCapacity", + "displayName": "Available Capacity", + "displayDescription": "The available capacity in bytes during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Capacity", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudUploadThroughput", + "displayName": "Cloud Upload Throughput", + "displayDescription": "The cloud upload throughput during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "CloudReadThroughput", + "displayName": "Cloud Read Throughput", + "displayDescription": "The cloud download throughput during the reporting period.", + "unit": "BytesPerSecond", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + }, + { + "name": "BytesUploadedToCloud", + "displayName": "Cloud Bytes Uploaded (Device)", + "displayDescription": "The total number of bytes that is uploaded to Azure from a device during the reporting period.", + "unit": "Bytes", + "aggregationType": "Average", + "dimensions": [], + "fillGapWithZero": false, + "category": "Transaction", + "supportedTimeGrainTypes": [ + "PT5M", + "PT15M", + "PT1H" + ], + "supportedAggregationTypes": [ + "Average", + "Minimum", + "Maximum" + ] + } + ] + } + } + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/write", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Write diagnostics setting", + "description": "Creates or updates the diagnostics setting for the resource" + }, + "origin": "system" + }, + { + "name": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/providers/Microsoft.Insights/diagnosticSettings/read", + "display": { + "provider": "Microsoft.DataBoxEdge", + "resource": "Data Box Edge device", + "operation": "Read diagnostics setting", + "description": "Gets the diagnostic setting for the resource" + }, + "origin": "system" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OperationsStatusGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OperationsStatusGet.json new file mode 100644 index 000000000000..8fd09a4313e9 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OperationsStatusGet.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/id/locations/westus/operationsStatus/159a00c7-8543-4343-9435-263ac87df3bb", + "name": "159a00c7-8543-4343-9435-263ac87df3bb", + "status": "Succeeded", + "startTime": "2018-12-18T02:18:51.4270267Z", + "endTime": "2018-12-18T03:18:51.4270267Z", + "percentComplete": 100, + "properties": { + "jobType": "DownloadUpdates", + "currentStage": "Success" + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderDelete.json new file mode 100644 index 000000000000..df86d5121027 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderGet.json new file mode 100644 index 000000000000..7393c1e6588f --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderGet.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "currentStatus": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [], + "returnTrackingInfo": [] + } + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderGetAllInDevice.json new file mode 100644 index 000000000000..128e6415ccbb --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderGetAllInDevice.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "api-version": "2019-03-01", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "currentStatus": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [], + "returnTrackingInfo": [] + } + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderPut.json new file mode 100644 index 000000000000..9d3506275641 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/OrderPut.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "order": { + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/orders/default", + "name": "default", + "type": "dataBoxEdgeDevices/orders", + "properties": { + "contactInformation": { + "contactPerson": "John Mcclane", + "companyName": "Microsoft", + "phone": "(800) 426-9400", + "emailList": [ + "john@microsoft.com" + ] + }, + "shippingAddress": { + "addressLine1": "Microsoft Corporation", + "addressLine2": "One Microsoft Way", + "addressLine3": "Redmond", + "postalCode": "98052", + "city": "WA", + "state": "WA", + "country": "USA" + }, + "currentStatus": { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "" + }, + "orderHistory": [ + { + "status": "Untracked", + "updateDateTime": "2018-12-10T07:59:05.847Z", + "comments": "lorem ipsum" + } + ], + "serialNumber": "UDS123NSDA123", + "deliveryTrackingInfo": [], + "returnTrackingInfo": [] + } + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleDelete.json new file mode 100644 index 000000000000..a5b6b867ef4a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleDelete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleGet.json new file mode 100644 index 000000000000..826a9f8c4367 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleGet.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "kind": "IOT", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleGetAllInDevice.json new file mode 100644 index 000000000000..32f8594d7a14 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RoleGetAllInDevice.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "kind": "IOT", + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RolePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RolePut.json new file mode 100644 index 000000000000..d093b26030fa --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/RolePut.json @@ -0,0 +1,85 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "IoTRole1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "role": { + "kind": "IOT", + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": { + "connectionString": { + "value": "Encrypted<>", + "encryptionCertThumbprint": "348586569999244", + "encryptionAlgorithm": "AES256" + } + } + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": { + "connectionString": { + "value": "Encrypted<>", + "encryptionCertThumbprint": "1245475856069999244", + "encryptionAlgorithm": "AES256" + } + } + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "kind": "IOT", + "properties": { + "hostPlatform": "Linux", + "ioTDeviceDetails": { + "deviceId": "iotdevice", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "ioTEdgeDeviceDetails": { + "deviceId": "iotEdge", + "ioTHostHub": "iothub.azure-devices.net", + "authentication": { + "symmetricKey": {} + } + }, + "shareMappings": [], + "roleStatus": "Enabled" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/IoTRole1", + "name": "IoTRole1", + "type": "dataBoxEdgeDevices/roles" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACDelete.json new file mode 100644 index 000000000000..01a649f80024 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACGet.json new file mode 100644 index 000000000000..c117fb14cf3c --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "name": "sac1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACGetAllInDevice.json new file mode 100644 index 000000000000..de2303075043 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACGetAllInDevice.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "alias": "sac1128180128323", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "GeneralPurposeStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128323", + "name": "sac1128180128323", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + }, + { + "properties": { + "alias": "sac1128180128312", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1128180128312", + "name": "sac1128180128312", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACPut.json new file mode 100644 index 000000000000..ae4c2bb51f57 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SACPut.json @@ -0,0 +1,50 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "sac1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "storageAccountCredential": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "accountKey": { + "value": "lAeZEYi6rNP1/EyNaVUYmTSZEYyaIaWmwUsGwek0+xiZj54GM9Ue9/UA2ed/ClC03wuSit2XzM/cLRU5eYiFBwks23rGwiQOr3sruEL2a74EjPD050xYjA6M1I2hu/w2yjVHhn5j+DbXS4Xzi+rHHNZK3DgfDO3PkbECjPck+PbpSBjy9+6Mrjcld5DIZhUAeMlMHrFlg+WKRKB14o/og56u5/xX6WKlrMLEQ+y6E18dUwvWs2elTNoVO8PBE8SM/CfooX4AMNvaNdSObNBPdP+F6Lzc556nFNWXrBLRt0vC7s9qTiVRO4x/qCNaK/B4y7IqXMllwQFf4Np9UQ2ECA==", + "encryptionCertThumbprint": "2A9D8D6BE51574B5461230AEF02F162C5F01AD31", + "encryptionAlgorithm": "AES256" + }, + "sslStatus": "Disabled", + "accountType": "BlobStorage" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "alias": "sac1", + "userName": "cisbvt", + "sslStatus": "Disabled", + "accountType": "BlobStorage" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "name": "sac1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccountCredentials" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ScanForUpdatesPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ScanForUpdatesPost.json new file mode 100644 index 000000000000..edf388b1856a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ScanForUpdatesPost.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SecuritySettingsUpdatePost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SecuritySettingsUpdatePost.json new file mode 100644 index 000000000000..511f01e39772 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SecuritySettingsUpdatePost.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "AzureVM", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "securitySettings": { + "properties": { + "deviceAdminPassword": { + "value": "jJ5MvXa/AEWvwxviS92uCjatCXeyLYTy8jx/k105MjQRXT7i6Do8qpEcQ8d+OBbwmQTnwKW0CYyzzVRCc0uZcPCf6PsWtP4l6wvcKGAP66PwK68eEkTUOmp+wUHc4hk02kWmTWeAjBZkuDBP3xK1RnZo95g2RE4i1UgKNP5BEKCLd71O104DW3AWW41mh9XLWNOaxw+VjQY7wmvlE6XkvpkMhcGuha2u7lx8zi9ZkcMvJVYDYK36Fb/K3KhBAmDjjDmVq04jtBlcSTXQObt0nlj4BwGGtdrpeIpr67zqr5i3cPm6e6AleIaIhp6sI/uyGSMiT3oev2eg49u2ii7kVA==", + "encryptionAlgorithm": "AES256", + "encryptionCertThumbprint": "7DCBDFC44ED968D232C9A998FC105B5C70E84BE0" + } + } + } + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareDelete.json new file mode 100644 index 000000000000..026fcf9d2017 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareGet.json new file mode 100644 index 000000000000..0524743d0b98 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareGet.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", + "name": "smbshare", + "type": "dataBoxEdgeDevices/shares" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareGetAllInDevice.json new file mode 100644 index 000000000000..78f3c8136562 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareGetAllInDevice.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", + "name": "smbshare", + "type": "dataBoxEdgeDevices/shares" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SharePut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SharePut.json new file mode 100644 index 000000000000..5cca883119c0 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/SharePut.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "share": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Enabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "dataPolicy": "Cloud" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "", + "shareStatus": "Online", + "monitoringStatus": "Disabled", + "azureContainerInfo": { + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/sac1", + "containerName": "testContainerSMB", + "dataFormat": "BlockBlob" + }, + "accessProtocol": "SMB", + "userAccessRights": [ + { + "userId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "accessType": "Change" + } + ], + "clientAccessRights": [], + "refreshDetails": {}, + "shareMappings": [], + "dataPolicy": "Cloud" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/smbshare", + "name": "smbshare", + "type": "dataBoxEdgeDevices/shares" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareRefreshPost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareRefreshPost.json new file mode 100644 index 000000000000..a4efecfd7b1c --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/ShareRefreshPost.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "smbshare", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountDelete.json new file mode 100644 index 000000000000..73e2c40793a3 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountDelete.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "storageaccount1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountGet.json new file mode 100644 index 000000000000..33d1d4a34592 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "blobstorageaccount1", + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt", + "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/", + "containerCount": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1", + "name": "blobstorageaccount1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountGetAllInDevice.json new file mode 100644 index 000000000000..ed122e0b409c --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountGetAllInDevice.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt", + "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/", + "containerCount": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1", + "name": "blobstorageaccount1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountPut.json new file mode 100644 index 000000000000..4a37b3854833 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/StorageAccountPut.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "storageAccountName": "blobstorageaccount1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "storageAccount": { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "description": "It's an awesome storage account", + "storageAccountStatus": "OK", + "dataPolicy": "Cloud", + "storageAccountCredentialId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccountCredentials/cisbvt", + "blobEndpoint": "https://blobstorageaccount1.blob.testedge.microsoftdatabox.com/", + "containerCount": 0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForDataBoxEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/storageAccounts/blobstorageaccount1", + "name": "blobstorageaccount1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/storageAccounts" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerDelete.json new file mode 100644 index 000000000000..f46231018958 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerDelete.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerGet.json new file mode 100644 index 000000000000..382d547534a2 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerGetAllInDevice.json new file mode 100644 index 000000000000..902b6d4bc29d --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerGetAllInDevice.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerPut.json new file mode 100644 index 000000000000..e1e12efbc7c6 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/TriggerPut.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "trigger1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "trigger": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "kind": "FileEvent" + } + }, + "responses": { + "200": { + "body": { + "properties": { + "customContextTag": "CustomContextTags-1235346475", + "sourceInfo": { + "shareId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/shares/share1" + }, + "sinkInfo": { + "roleId": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/roles/role1" + } + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/triggers/trigger1", + "name": "trigger1", + "type": "dataBoxEdgeDevices/triggers", + "kind": "FileEvent" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UpdateSummaryGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UpdateSummaryGet.json new file mode 100644 index 000000000000..7ae88078f54c --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UpdateSummaryGet.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "deviceVersionNumber": "1.2.18183.2", + "friendlyDeviceVersionName": "Data Box Edge Virtual Device Preview Version 1.1", + "totalNumberOfUpdatesAvailable": 0, + "totalNumberOfUpdatesPendingDownload": 0, + "totalNumberOfUpdatesPendingInstall": 0, + "rebootBehavior": "NeverReboots", + "ongoingUpdateOperation": "None", + "totalUpdateSizeInBytes": 0.0 + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/updateSummary/default", + "name": "default", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/updateSummary" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UploadCertificatePost.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UploadCertificatePost.json new file mode 100644 index 000000000000..3d2b1e9c83dc --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UploadCertificatePost.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "parameters": { + "properties": { + "certificate": "MIIC9DCCAdygAwIBAgIQWJae7GNjiI9Mcv/gJyrOPTANBgkqhkiG9w0BAQUFADASMRAwDgYDVQQDDAdXaW5kb3dzMB4XDTE4MTEyNzAwMTA0NVoXDTIxMTEyODAwMTA0NVowEjEQMA4GA1UEAwwHV2luZG93czCCASIwDQYJKoZIhvcNAQEBBQADggEPADCCAQoCggEBAKxkRExqxf0qH1avnyORptIbRC2yQwqe3EIbJ2FPKr5jtAppGeX/dGKrFSnX+7/0HFr77aJHafdpEAtOiLyJ4zCAVs0obZCCIq4qJdmjYUTU0UXH/w/YzXfQA0d9Zh9AN+NJBX9xj05NzgsT24fkgsK2v6mWJQXT7YcWAsl5sEYPnx1e+MrupNyVSL/RUJmrS+etJSysHtFeWRhsUhVAs1DD5ExJvBLU3WH0IsojEvpXcjrutB5/MDQNrd/StGI6WovoSSPH7FyT9tgERx+q+Yg3YUGzfaIPCctlrRGehcdtzdNoKd0rsX62yCq0U6POoSfwe22NJu41oAUMd7e6R8cCAwEAAaNGMEQwEwYDVR0lBAwwCgYIKwYBBQUHAwIwHQYDVR0OBBYEFDd0VxnS3LnMIfwc7xW4b4IZWG5GMA4GA1UdDwEB/wQEAwIFIDANBgkqhkiG9w0BAQUFAAOCAQEAPQRby2u9celvtvL/DLEb5Vt3/tPStRQC5MyTD62L5RT/q8E6EMCXVZNkXF5WlWucLJi/18tY+9PNgP9xWLJh7kpSWlWdi9KPtwMqKDlEH8L2TnQdjimt9XuiCrTnoFy/1X2BGLY/rCaUJNSd15QCkz2xeW+Z+YSk2GwAc/A/4YfNpqSIMfNuPrT76o02VdD9WmJUA3fS/HY0sU9qgQRS/3F5/0EPS+HYQ0SvXCK9tggcCd4O050ytNBMJC9qMOJ7yE0iOrFfOJSCfDAuPhn/rHFh79Kn1moF+/CE+nc0/2RPiLC8r54/rt5dYyyxJDfXg0a3VrrX39W69WZGW5OXiw==" + } + } + }, + "responses": { + "200": { + "body": { + "authType": "AzureActiveDirectory", + "resourceId": "392799901267771", + "aadAuthority": "https://login.windows.net", + "aadTenantId": "100b019d-4626-4a9e-a83c-9cff8fe41909", + "servicePrincipalClientId": "ffd8a688-82b1-4e5a-a4c1-7ede8c928e68", + "servicePrincipalObjectId": "cef6d40c-24e6-4a6f-bb9e-3ec60b4adec4", + "azureManagementEndpointAudience": "https://wus-bvtgateway.ext.trafficmanager.net/" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserDelete.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserDelete.json new file mode 100644 index 000000000000..bd146196546a --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserDelete.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserGet.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserGet.json new file mode 100644 index 000000000000..2745ecccea79 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserGet.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + "202": { + "body": "" + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserGetAllInDevice.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserGetAllInDevice.json new file mode 100644 index 000000000000..f3e7d42ccd19 --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserGetAllInDevice.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ] + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user2", + "name": "user2", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + }, + { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + ] + } + } + } +} diff --git a/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserPut.json b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserPut.json new file mode 100644 index 000000000000..ce1e4f0392cc --- /dev/null +++ b/specification/databoxedge/resource-manager/Microsoft.DataBoxEdge/preview/2020-05-01-preview/examples/UserPut.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "api-version": "2020-05-01-preview", + "subscriptionId": "4385cf00-2d3a-425a-832f-f4285b1c9dce", + "resourceGroupName": "GroupForEdgeAutomation", + "deviceName": "testedgedevice", + "name": "user1", + "Content-Type": [ + "application/json; charset=utf-8" + ], + "Content-Length": [ + "200" + ], + "x-ms-client-request-id": [ + "a93b39a3-1ff4-42b8-a56f-43368d47e37a" + ], + "accept-language": [ + "en-US" + ], + "user": { + "properties": { + "encryptedPassword": { + "value": "Password@1", + "encryptionAlgorithm": "None", + "encryptionCertThumbprint": "blah" + }, + "userType": "Share" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "userType": "Share" + }, + "id": "/subscriptions/4385cf00-2d3a-425a-832f-f4285b1c9dce/resourceGroups/GroupForEdgeAutomation/providers/Microsoft.DataBoxEdge/dataBoxEdgeDevices/testedgedevice/users/user1", + "name": "user1", + "type": "Microsoft.DataBoxEdge/dataBoxEdgeDevices/users" + } + }, + "202": {} + } +} diff --git a/specification/databoxedge/resource-manager/readme.cli.md b/specification/databoxedge/resource-manager/readme.cli.md index 5716aafd4672..a98fad99fa79 100644 --- a/specification/databoxedge/resource-manager/readme.cli.md +++ b/specification/databoxedge/resource-manager/readme.cli.md @@ -47,6 +47,7 @@ cli: - name: DataBoxEdgeDeviceGetByResourceGroup - name: DataBoxEdgeDeviceGetBySubscription - name: ListSkus + - name: ListAvailableSkus - name: OperationsGet - name: ContainerRefresh - name: CreateOrUpdateSecuritySettings diff --git a/specification/databoxedge/resource-manager/readme.md b/specification/databoxedge/resource-manager/readme.md index 455345faee18..beec4161964b 100644 --- a/specification/databoxedge/resource-manager/readme.md +++ b/specification/databoxedge/resource-manager/readme.md @@ -29,6 +29,15 @@ openapi-type: arm tag: package-2019-08 ``` +### Tag: package-2020-05-preview + +These settings apply only when `--tag=package-2020-05-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-05-preview' +input-file: +- Microsoft.DataBoxEdge/preview/2020-05-01-preview/databoxedge.json +``` + ### Tag: package-2019-08 These settings apply only when `--tag=package-2019-08` is specified on the command line. @@ -128,6 +137,20 @@ batch: - tag: package-2019-03 - tag: package-2019-07 - tag: package-2019-08 + - tag: package-2020-05-preview +``` + +### Tag: package-2020-05-preview and java + +These settings apply only when `--tag=package-2020-05-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-05-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.databoxedge.v2020_05_01_preview + output-folder: $(azure-libraries-for-java-folder)/databoxedge/resource-manager/v2020_05_01_preview +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2019-08 and java @@ -181,10 +204,10 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.DataBoxEdge/preview/2020-05-01-preview/databoxedge.json - $(this-folder)/Microsoft.DataBoxEdge/stable/2019-08-01/databoxedge.json - $(this-folder)/Microsoft.DataBoxEdge/stable/2019-07-01/databoxedge.json - $(this-folder)/Microsoft.DataBoxEdge/stable/2019-03-01/databoxedge.json - ``` If there are files that should not be in the `all-api-versions` set, diff --git a/specification/databoxedge/resource-manager/readme.python.md b/specification/databoxedge/resource-manager/readme.python.md index b7c6cd2ccae4..6016f29d1038 100644 --- a/specification/databoxedge/resource-manager/readme.python.md +++ b/specification/databoxedge/resource-manager/readme.python.md @@ -23,10 +23,34 @@ Generate all API versions currently shipped for this package ```yaml $(python) && $(multiapi) batch: + - tag: package-2020-05-preview + - tag: package-2019-08 - tag: package-2019-07 - tag: package-2019-03 ``` +### Tag: package-2020-05-preview and python + +These settings apply only when `--tag=package-2020-05-preview --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-05-preview' && $(python) +python: + namespace: azure.mgmt.databoxedge.v2020_05_01_preview + output-folder: $(python-sdks-folder)/databoxedge/azure-mgmt-databoxedge/azure/mgmt/databoxedge/v2020_05_01_preview +``` + +### Tag: package-2019-08 and python + +These settings apply only when `--tag=package-2019-08 --python` is specified on the command line. +Please also specify `--python-sdks-folder=`. + +``` yaml $(tag) == 'package-2019-08' && $(python) +python: + namespace: azure.mgmt.databoxedge.v2019_08_01 + output-folder: $(python-sdks-folder)/databoxedge/azure-mgmt-databoxedge/azure/mgmt/databoxedge/v2019_08_01 +``` + ### Tag: package-2019-07 and python These settings apply only when `--tag=package-2019-07 --python` is specified on the command line. diff --git a/specification/databoxedge/resource-manager/readme.ruby.md b/specification/databoxedge/resource-manager/readme.ruby.md index c8c6afca17b3..5d72f44737e7 100644 --- a/specification/databoxedge/resource-manager/readme.ruby.md +++ b/specification/databoxedge/resource-manager/readme.ruby.md @@ -12,11 +12,22 @@ azure-arm: true ``` yaml $(ruby) && $(multiapi) batch: + - tag: package-2020-05-preview - tag: package-2019-08 - tag: package-2019-07 - tag: package-2019-03 ``` +### Tag: package-2020-05-preview and ruby + +These settings apply only when `--tag=package-2020-05-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-05-preview' && $(ruby) +namespace: "Azure::DataBoxEdge::Mgmt::V2020_05_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_databoxedge/lib +``` + ### Tag: package-2019-08 and ruby These settings apply only when `--tag=package-2019-08 --ruby` is specified on the command line. From a31c416da18a1e94868316b90f54e2b6d823ab2b Mon Sep 17 00:00:00 2001 From: wenbof <61670890+wenbof@users.noreply.github.com> Date: Mon, 6 Jul 2020 16:52:13 +0800 Subject: [PATCH 262/318] SAP Open Hub - Support Message Server (#10029) --- .../2018-06-01/entityTypes/LinkedService.json | 23 ++++++++++++++----- 1 file changed, 17 insertions(+), 6 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 4b63d84add83..317fec827901 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -2473,6 +2473,10 @@ "type": "object", "description": "Language of the BW system where the open hub destination is located. The default value is EN. Type: string (or Expression with resultType string)." }, + "systemId": { + "type": "object", + "description": "SystemID of the SAP system where the table is located. Type: string (or Expression with resultType string)." + }, "userName": { "type": "object", "description": "Username to access the SAP BW server where the open hub destination is located. Type: string (or Expression with resultType string)." @@ -2481,16 +2485,23 @@ "description": "Password to access the SAP BW server where the open hub destination is located.", "$ref": "../datafactory.json#/definitions/SecretBase" }, + "messageServer": { + "type": "object", + "description": "The hostname of the SAP Message Server. Type: string (or Expression with resultType string)." + }, + "messageServerService": { + "type": "object", + "description": "The service name or port number of the Message Server. Type: string (or Expression with resultType string)." + }, + "logonGroup": { + "type": "object", + "description": "The Logon Group for the SAP System. Type: string (or Expression with resultType string)." + }, "encryptedCredential": { "type": "object", "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string)." } - }, - "required": [ - "server", - "systemNumber", - "clientId" - ] + } }, "RestServiceLinkedService": { "x-ms-discriminator-value": "RestService", From 361fc54279ae803b91a2dc06d9fe8cda17fc14e2 Mon Sep 17 00:00:00 2001 From: Milan Brkic Date: Mon, 6 Jul 2020 12:13:44 +0200 Subject: [PATCH 263/318] Added auto complete restore option in managed databases (#9911) * Added auto complete restore option * Revert "Added auto complete restore option" This reverts commit bd72f9b2e3addb4ba66f90a9a369d393ba6dec66. * New version 2020-02-02-preview Microsoft.Sql * Fixes * Fix prettier * fix encoding for problematic files * included change into package-composite-v3 * Scope to common-types, fix build * fixing the paths Co-authored-by: Milan Brkic --- ...eManagedDatabaseListByManagedInstance.json | 40 + ...anagedDatabaseCompleteExternalRestore.json | 16 + .../examples/ManagedDatabaseCreateMax.json | 52 ++ .../examples/ManagedDatabaseCreateMin.json | 43 + ...nagedDatabaseCreatePointInTimeRestore.json | 54 ++ .../ManagedDatabaseCreateRecovery.json | 51 ++ ...edDatabaseCreateRestoreExternalBackup.json | 57 ++ ...ManagedDatabaseCreateRestoreLtrBackup.json | 55 ++ .../examples/ManagedDatabaseDelete.json | 14 + .../examples/ManagedDatabaseGet.json | 25 + .../ManagedDatabaseListByManagedInstance.json | 41 + .../ManagedDatabaseRestoreDetails.json | 33 + .../examples/ManagedDatabaseUpdateMax.json | 34 + .../examples/ManagedDatabaseUpdateMin.json | 34 + .../2020-02-02-preview/managedDatabases.json | 835 ++++++++++++++++++ specification/sql/resource-manager/readme.md | 9 +- 16 files changed, 1389 insertions(+), 4 deletions(-) create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/InaccessibleManagedDatabaseListByManagedInstance.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCompleteExternalRestore.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateMax.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateMin.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRecovery.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRestoreLtrBackup.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseDelete.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseGet.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseListByManagedInstance.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseRestoreDetails.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseUpdateMax.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseUpdateMin.json create mode 100644 specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/InaccessibleManagedDatabaseListByManagedInstance.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/InaccessibleManagedDatabaseListByManagedInstance.json new file mode 100644 index 000000000000..7aed6c957168 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/InaccessibleManagedDatabaseListByManagedInstance.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "testrg", + "managedInstanceName": "testcl", + "api-version": "2020-02-02-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb1", + "location": "southeastasia", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "creationDate": "2017-08-04T15:00:17.73Z", + "defaultSecondaryLocation": "North Europe", + "status": "Inaccessible" + }, + "type": "Microsoft.Sql/managedInstances/databases" + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb2", + "location": "southeastasia", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "creationDate": "2017-08-04T15:00:17.73Z", + "defaultSecondaryLocation": "North Europe", + "status": "Inaccessible" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + ] + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCompleteExternalRestore.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCompleteExternalRestore.json new file mode 100644 index 000000000000..1bea25f89b65 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCompleteExternalRestore.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "myRG", + "managedInstanceName": "myManagedInstanceName", + "databaseName": "myDatabase", + "api-version": "2020-02-02-preview", + "parameters": { + "lastBackupName": "testdb1_log4" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateMax.json new file mode 100644 index 000000000000..0d08f3a0026f --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateMax.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2017-03-01-preview", + "parameters": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb1", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "201": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb2", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateMin.json new file mode 100644 index 000000000000..9a38d0f50043 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateMin.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb1", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "201": { + "body": { + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb2", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json new file mode 100644 index 000000000000..d4fba534959b --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreatePointInTimeRestore.json @@ -0,0 +1,54 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "properties": { + "createMode": "PointInTimeRestore", + "sourceDatabaseId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb", + "restorePointInTime": "2017-07-14T05:35:31.503Z" + } + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb1", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "201": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb2", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRecovery.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRecovery.json new file mode 100644 index 000000000000..49764695d1bb --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRecovery.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "server1", + "databaseName": "testdb_recovered", + "api-version": "2017-03-01-preview", + "parameters": { + "location": "southeastasia", + "properties": { + "createMode": "Recovery", + "recoverableDatabaseId": "/subscriptions/11111111-2222-3333-4444-555555555555/resourceGroups/Default-SQL-WestEurope/providers/Microsoft.Sql/managedInstances/testsvr/recoverableDatabases/testdb" + } + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/server1/recoverableDatabases/testdb_recovered", + "name": "testdb_recovered", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2018-11-07T04:41:33.937Z" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "201": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/recoverableDatabases/testdb_recovered", + "name": "testdb_recovered", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2018-11-07T04:41:33.937Z" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json new file mode 100644 index 000000000000..a3023c7173fb --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRestoreExternalBackup.json @@ -0,0 +1,57 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "createMode": "RestoreExternalBackup", + "storageContainerUri": "https://myaccountname.blob.core.windows.net/backups", + "storageContainerSasToken": "sv=2015-12-11&sr=c&sp=rl&sig=1234", + "collation": "SQL_Latin1_General_CP1_CI_AS", + "autoCompleteRestore": true, + "lastBackupName": "last_backup_name" + }, + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb1", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "201": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb2", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRestoreLtrBackup.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRestoreLtrBackup.json new file mode 100644 index 000000000000..854fa11ccb3c --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseCreateRestoreLtrBackup.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2018-06-01-preview", + "parameters": { + "properties": { + "createMode": "RestoreExternalBackup", + "storageContainerUri": "https://myaccountname.blob.core.windows.net/backups", + "storageContainerSasToken": "sv=2015-12-11&sr=c&sp=rl&sig=1234", + "collation": "SQL_Latin1_General_CP1_CI_AS" + }, + "location": "southeastasia" + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb1", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "201": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/testsvr/databases/testdb2", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseDelete.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseDelete.json new file mode 100644 index 000000000000..cab3ff43e7ab --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "testdb", + "api-version": "2017-03-01-preview" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseGet.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseGet.json new file mode 100644 index 000000000000..96645d91a368 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Test1", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2015-05-01-preview" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb1", + "location": "southeastasia", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "creationDate": "2017-08-04T15:00:17.73Z", + "defaultSecondaryLocation": "North Europe", + "status": "Online" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseListByManagedInstance.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseListByManagedInstance.json new file mode 100644 index 000000000000..4ff33c21639e --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseListByManagedInstance.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Test1", + "managedInstanceName": "managedInstance", + "databaseName": "managedDatabase", + "api-version": "2015-05-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb1", + "location": "southeastasia", + "name": "testdb1", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "creationDate": "2017-08-04T15:00:17.73Z", + "defaultSecondaryLocation": "North Europe", + "status": "Online" + }, + "type": "Microsoft.Sql/managedInstances/databases" + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.Sql/managedInstances/testcl/databases/testdb2", + "location": "southeastasia", + "name": "testdb2", + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "creationDate": "2017-08-04T15:00:17.73Z", + "defaultSecondaryLocation": "North Europe", + "status": "Online" + }, + "type": "Microsoft.Sql/managedInstances/databases" + } + ] + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseRestoreDetails.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseRestoreDetails.json new file mode 100644 index 000000000000..8ab9dbfc1f8c --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseRestoreDetails.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "testdb", + "restoreDetailsName": "Default", + "api-version": "2020-02-02-preview", + "parameters": { + "tags": { + "tagKey1": "TagValue1" + } + } + }, + "responses": { + "200": { + "body": { + "properties": { + "status": "Restoring", + "currentRestoringFileName": "full_0", + "percentCompleted": 0.0, + "unrestorableFiles": [], + "numberOfFilesDetected": 26, + "lastUploadedFileName": "log2_3", + "lastUploadedFileTime": "2018-06-15T11:38:33Z" + }, + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/managedInstances/managedInstance/databases/testdb/restoreDetails/current", + "name": "current", + "type": "Microsoft.Sql/managedInstances/databases/restoreDetails" + } + } + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseUpdateMax.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseUpdateMax.json new file mode 100644 index 000000000000..342311fd20a0 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseUpdateMax.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "testdb", + "api-version": "2017-03-01-preview", + "parameters": { + "tags": { + "tagKey1": "TagValue1" + } + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb" + }, + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseUpdateMin.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseUpdateMin.json new file mode 100644 index 000000000000..342311fd20a0 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/examples/ManagedDatabaseUpdateMin.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "Default-SQL-SouthEastAsia", + "managedInstanceName": "managedInstance", + "databaseName": "testdb", + "api-version": "2017-03-01-preview", + "parameters": { + "tags": { + "tagKey1": "TagValue1" + } + } + }, + "responses": { + "200": { + "body": { + "tags": { + "tagKey1": "TagValue1" + }, + "location": "southeastasia", + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/Default-SQL-SouthEastAsia/providers/Microsoft.Sql/servers/testsvr/databases/testdb", + "name": "testdb" + }, + "properties": { + "collation": "SQL_Latin1_General_CP1_CI_AS", + "status": "Online", + "creationDate": "2017-06-07T04:41:33.937Z", + "defaultSecondaryLocation": "North Europe", + "type": "Microsoft.Sql/servers/databases" + } + }, + "202": {} + } +} diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json new file mode 100644 index 000000000000..d1ce85ccd7f7 --- /dev/null +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json @@ -0,0 +1,835 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-02-02-preview", + "title": "SqlManagementClient", + "description": "The Azure SQL Database management API provides a RESTful set of web APIs that interact with Azure SQL Database services to manage your databases. The API enables users to create, retrieve, update, and delete databases, servers, and other entities." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/restoreDetails/{restoreDetailsName}": { + "get": { + "tags": [ + "ManagedDatabaseRestoreDetails" + ], + "description": "Gets managed database restore details.", + "operationId": "ManagedDatabaseRestoreDetails_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "restoreDetailsName", + "in": "path", + "description": "The name of the restore details to retrieve.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "RestoreDetailsName", + "modelAsString": true + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved restore details.", + "schema": { + "$ref": "#/definitions/ManagedDatabaseRestoreDetailsResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 MissingThumbprint - Can not find server certificate.\n\n * 400 PartiallyContainedDatabaseUnsupported - \"Backup for a partially contained database is not supported.\"\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 BackupSetNotFound - \"No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 ExternalBackupAlreadySignaledToComplete - The restore request has already been signaled to complete.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 ExternalBackupRestoreHasNotBeenStarted - The restore request can only be completed once the restore has started.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 XtpInitializedDuringRestore - Memory-optimized filegroup must be empty in order to be restored on General Purpose tier of SQL Database Managed Instance.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit.\n\n * 400 ManagedDatabaseNotInRestoringState - Managed database is not in Restoring state." + } + }, + "x-ms-examples": { + "Managed database restore details.": { + "$ref": "./examples/ManagedDatabaseRestoreDetails.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases": { + "get": { + "tags": [ + "ManagedDatabases" + ], + "description": "Gets a list of managed databases.", + "operationId": "ManagedDatabases_ListByInstance", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of databases.", + "schema": { + "$ref": "#/definitions/ManagedDatabaseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List databases by managed instances": { + "$ref": "./examples/ManagedDatabaseListByManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}": { + "get": { + "tags": [ + "ManagedDatabases" + ], + "description": "Gets a managed database.", + "operationId": "ManagedDatabases_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified managed database.", + "schema": { + "$ref": "#/definitions/ManagedDatabase" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found." + } + }, + "x-ms-examples": { + "Gets a managed database": { + "$ref": "./examples/ManagedDatabaseGet.json" + } + } + }, + "put": { + "tags": [ + "ManagedDatabases" + ], + "description": "Creates a new database or updates an existing database.", + "operationId": "ManagedDatabases_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested database resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedDatabase" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/ManagedDatabase" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 InvalidLongTermRetentionManagedInstanceBackupId - Invalid long term retention backup identifier for Managed Instances.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Accepted" + }, + "201": { + "description": "Successfully created the database.", + "schema": { + "$ref": "#/definitions/ManagedDatabase" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Creates a new managed database with minimal properties": { + "$ref": "./examples/ManagedDatabaseCreateMin.json" + }, + "Creates a new managed database with maximal properties": { + "$ref": "./examples/ManagedDatabaseCreateMax.json" + }, + "Creates a new managed database using point in time restore": { + "$ref": "./examples/ManagedDatabaseCreatePointInTimeRestore.json" + }, + "Creates a new managed database by restoring from an external backup": { + "$ref": "./examples/ManagedDatabaseCreateRestoreExternalBackup.json" + }, + "Creates a new managed database from restoring a geo-replicated backup": { + "$ref": "./examples/ManagedDatabaseCreateRecovery.json" + }, + "Creates a new managed database from restoring a long term retention backup": { + "$ref": "./examples/ManagedDatabaseCreateRestoreLtrBackup.json" + } + } + }, + "delete": { + "tags": [ + "ManagedDatabases" + ], + "description": "Deletes a managed database.", + "operationId": "ManagedDatabases_Delete", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the managed database." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 CannotMoveOrDropJobAccountDatabase - Cannot drop database associated with job account.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 CannotMoveOrDropSyncMetadataDatabase - Cannot drop database used as sync metadata database.\n\n * 400 GeoReplicationDatabaseNotPrimary - The operation cannot be performed since the database '{0}' is a replication target.\n\n * 400 GeoReplicationDatabaseNotSecondary - The operation expects the database to be a replication target.\n\n * 400 DropDisallowedDuringFailover - Can not drop database because a failover operation is in progress on the failover group.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 404 OperationIdNotFound - The operation with Id does not exist.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 409 OperationCancelled - The operation has been cancelled by user.\n\n * 409 OperationInterrupted - The operation on the resource could not be completed because it was interrupted by another operation on the same resource.\n\n * 409 ServerDisabled - Server is disabled.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 OperationTimedOut - The operation timed out and automatically rolled back. Please retry the operation.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Deleting the managed database is in progress." + }, + "204": { + "description": "The specified managed database does not exist." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete managed database": { + "$ref": "./examples/ManagedDatabaseDelete.json" + } + } + }, + "patch": { + "tags": [ + "ManagedDatabases" + ], + "description": "Updates an existing database.", + "operationId": "ManagedDatabases_Update", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The requested database resource state.", + "required": true, + "schema": { + "$ref": "#/definitions/ManagedDatabaseUpdate" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/ManagedDatabase" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerName - Invalid server name specified.\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 ManagedInstanceUpdateSloInProgress - \"The operation could not be completed because a service tier change is in progress for managed instance '{0}.' Please wait for the operation in progress to complete and try again.\"\n\n * 400 DatabaseNumberLimitReached - Maximum number of databases for SQL Database Managed Instance reached.\n\n * 400 CurrentDatabaseSizeExceedsMaxSize - User attempted to reduce the max size for a database to a size smaller than the current usage.\n\n * 400 InvalidCollation - Collation is not recognized by the server.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 PitrPointInTimeInvalid - The point in time {0} is not valid. Valid point in time range from {1} days early to now and not before source server creation time.\n\n * 400 PasswordNotComplex - The provided password is not complex enough.\n\n * 400 ManagedDatabaseNameInUse - Database '{0}' already exists. Choose a different database name.\n\n * 400 CannotUseTrailingWhitespacesInDatabaseName - The database name validation failed.\n\n * 400 NoMoreSpaceInManagedInstance - The managed instance has reached its storage limit. The storage usage for the managed instance cannot exceed (%d) MBs.\n\n * 400 InvalidBackupRetentionPeriod - The retention days of {0} is not a valid configuration. Valid backup retention in days must be between {1} and {2}\n\n * 400 RegionDoesNotSupportVersion - A user attempted to create a server of a specified version in a location where that server version isn't supported.\n\n * 400 SourceServerNotFound - The server part of a source database id provided in a CreateDatabaseAsCopy API call doesn't map to an existing server.\n\n * 400 ServerNotFound - The requested server was not found.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 400 SubscriptionNotFound - The requested subscription was not found.\n\n * 400 CurrentDatabaseLogSizeExceedsMaxSize - User attempted to change the database to a sku with lower max log size than the current usage.\n\n * 400 InvalidDatabaseCreateOrUpdateRequest - The request body for the create or update database operation is invalid.\n\n * 400 InvalidResourceId - Invalid resource identifier.\n\n * 400 InvalidSourceDatabaseId - Invalid source database identifier.\n\n * 400 InvalidRestorableDroppedDatabaseId - Invalid restorable dropped database identifier\n\n * 400 MismatchingResourceGroupNameWithUrl - The provided resource group name did not match the name in the Url.\n\n * 400 MismatchingServerNameWithUrl - The provided server name did not match the name in the Url.\n\n * 400 MismatchingSubscriptionWithUrl - The provided subscription did not match the subscription in the Url.\n\n * 400 MissingCollation - Collation is required.\n\n * 400 MissingSourceDatabaseId - Missing source database identifier.\n\n * 400 MissingRestorePointInTime - Missing restore point in time\n\n * 400 MissingStorageContainerSasToken - Missing storage container SAS token\n\n * 400 MissingStorageContainerUri - Missing storage container URI\n\n * 400 RestorableDroppedDatabaseIdGivenForRestoreWithSourceDatabaseId - Cannot specify restorableDroppedDatabaseId when sourceDatabaseId is already given in restore create mode\n\n * 400 CannotUseReservedDatabaseName - Cannot use reserved database name in this operation.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 ResourceNotFound - The requested resource was not found.\n\n * 404 ServerNotInSubscription - Specified server does not exist on the specified subscription.\n\n * 404 RestoreSourceDatabaseNotFound - Could not find database '{0}' at time '{1}' that can be restored.\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 CannotFindServerCertificateWithThumbprint - Cannot find server certificate with thumbprint '{0}'. Please use PowerShell Cmdlet 'Add-AzureRmSqlManagedInstanceTransparentDataEncryptionCertificate' to create the certificate.\n\n * 404 DatabaseDoesNotExist - User has specified a database name that does not exist on this server instance.\n\n * 404 CannotFindObject - Cannot find the object because it does not exist or you do not have permissions\n\n * 409 RemoteDatabaseExists - The destination database name already exists on the destination server.\n\n * 409 SubscriptionDisabled - Subscription is disabled.\n\n * 409 ManagementServiceDatabaseBusy - Database '{0}' is busy with another operation. Please try your operation later.\n\n * 409 ConflictingDatabaseOperation - There is already some operation on the database and the current operation should wait till it is done.\n\n * 409 ConflictingSystemOperationInProgress - A system maintenance operation is in progress on the database and further operations need to wait until it is completed.\n\n * 429 SubscriptionTooManyCreateUpdateRequests - Requests beyond max requests that can be processed by available resources.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 500 ActivateOrDeactivateWorkflowThrottling - Activation or deactivation workflow failed because there are too many concurrent workflows\n\n * 503 TooManyRequests - Requests beyond max requests that can be processed by available resources.\n\n * 503 DatabaseUnavailable - The operation failed because the database is unavailable.\n\n * 504 RequestTimeout - Service request exceeded the allowed timeout." + }, + "202": { + "description": "Updating the managed database is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Updates a managed database with minimal properties": { + "$ref": "./examples/ManagedDatabaseUpdateMin.json" + }, + "Updates a managed database with maximal properties": { + "$ref": "./examples/ManagedDatabaseUpdateMax.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/inaccessibleManagedDatabases": { + "get": { + "tags": [ + "ManagedDatabases" + ], + "description": "Gets a list of inaccessible managed databases in a managed instance", + "operationId": "ManagedDatabases_ListInaccessibleByInstance", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of inaccessible managed databases in a managed instance.", + "schema": { + "$ref": "#/definitions/ManagedDatabaseListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 404 ServerNotInSubscriptionResourceGroup - Specified server does not exist in the specified resource group and subscription.\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List inaccessible managed databases by managed instances": { + "$ref": "./examples/InaccessibleManagedDatabaseListByManagedInstance.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Sql/managedInstances/{managedInstanceName}/databases/{databaseName}/completeRestore": { + "post": { + "tags": [ + "ManagedDatabases" + ], + "description": "Completes the restore operation on a managed database.", + "operationId": "ManagedDatabases_CompleteRestore", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ManagedInstanceNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The definition for completing the restore of this managed database.", + "required": true, + "schema": { + "$ref": "#/definitions/CompleteDatabaseRestoreDefinition" + } + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully completed restore request." + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidDatabaseCompleteRestoreRequest - The complete database restore request is invalid\n\n * 400 InvalidDatabaseCompleteRestoreRequestLastBackupName - The last backup name is invalid\n\n * 400 TokenTooLong - The provided token is too long.\n\n * 400 UnsupportedServiceName - The specified name is an invalid name because it contains one or more unsupported unicode characters.\n\n * 400 SourceDatabaseNotFound - The source database does not exist.\n\n * 400 InvalidIdentifier - The identifier contains NULL or an invalid unicode character.\n\n * 400 ManagedInstanceStorageLimitHit - The managed instance has reached its storage limit.\n\n * 400 BackupSetNotFound - \"No backups were found to restore the database. Please contact support to restore the database.\n\n * 400 FullBackupNotFound - Full backup can not be found.\n\n * 400 RestoreFromStripedBackupsNotEnabled - Restoring from striped backups is not supported.\n\n * 400 BrokenRestorePlanNoFullBackup - The restore plan is broken because there is no full backup.\n\n * 400 BrokenRestorePlanWrongLogBackupLSN - The restore plan is broken because firstLsn of current log backup is not <= lastLsn of next log backup.\n\n * 400 BrokenRestorePlanWrongDiffBackupLSN - The restore plan is broken because firstLsn of diff backup is not >= firstLsn of full backup.\n\n * 400 BrokenRestorePlanGapInLogBackups - The restore plan is broken because firstLsn of current log backup is not equal to lastLsn of prev log backup.\n\n * 400 XtpInitializedDuringRestore - Memory-optimized filegroup must be empty in order to be restored on General Purpose tier of SQL Database Managed Instance.\n\n * 400 FullBackupMissingChecksum - Provided full backup is missing checksum.\n\n * 400 FullBackupDamaged - Provided full backup is damaged.\n\n * 400 PartiallyContainedDatabaseUnsupported - \"Backup for a partially contained database is not supported.\"\n\n * 400 RequiredBackupIsNotLastRestored - Migration cannot be completed because provided backup file name is not the name of the last backup file that is restored.\n\n * 400 IncompatiblePhysicalLayoutTooFewDataFiles - Database backup contains incompatible physical layout. No data files are found in the backup.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineDataFilesExist - Database backup contains incompatible physical layout. Non-online data files exist.\n\n * 400 IncompatiblePhysicalLayoutWrongNumberOfLogFiles - Database backup contains incompatible physical layout. Multiple log files are not supported.\n\n * 400 IncompatiblePhysicalLayoutNonOnlineLogFilesExist - Database backup contains incompatible physical layout. Non-online log files exist.\n\n * 400 IncompatiblePhysicalLayoutTooManyNonDataLogFiles - Database backup contains incompatible physical layout. Too many non-data/log files.\n\n * 400 ExternalBackupAlreadySignaledToComplete - The restore request has already been signaled to complete.\n\n * 400 ExternalBackupRestoreHasNotBeenStarted - The restore request can only be completed once the restore has started.\n\n * 400 ExternalBackupUpgradeInProgress - The restore request cannot be completed, since upgrade is in progress.\n\n * 400 IncompatiblePhysicalLayoutTooManyXTPFiles - Database backup contains incompatible physical layout. Multiple files found in the filegroup that contains MEMORY_OPTIMIZED_DATA.\n\n * 400 BlobStorageFailure - Blob storage failure has occurred.\n\n * 400 MissingThumbprint - Can not find server certificate.\n\n * 404 ResourceDoesNotExist - Resource with the name '{0}' does not exist. To continue, specify a valid resource name.\n\n * 429 SubscriptionTooManyRequests - Requests beyond max requests that can be processed by available resources." + }, + "202": { + "description": "Completing restore request is in progress." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Completes a managed database external backup restore.": { + "$ref": "./examples/ManagedDatabaseCompleteExternalRestore.json" + } + } + } + } + }, + "definitions": { + "ManagedDatabaseRestoreDetailsProperties": { + "description": "The managed database's restore details properties.", + "type": "object", + "properties": { + "status": { + "description": "Restore status.", + "type": "string", + "readOnly": true + }, + "currentRestoringFileName": { + "description": "Current restoring file name.", + "type": "string", + "readOnly": true + }, + "lastRestoredFileName": { + "description": "Last restored file name.", + "type": "string", + "readOnly": true + }, + "lastRestoredFileTime": { + "format": "date-time", + "description": "Last restored file time.", + "type": "string", + "readOnly": true + }, + "percentCompleted": { + "format": "double", + "description": "Percent completed.", + "type": "number", + "readOnly": true + }, + "unrestorableFiles": { + "description": "List of unrestorable files.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "numberOfFilesDetected": { + "format": "int64", + "description": "Number of files detected.", + "type": "integer", + "readOnly": true + }, + "lastUploadedFileName": { + "description": "Last uploaded file name.", + "type": "string", + "readOnly": true + }, + "lastUploadedFileTime": { + "format": "date-time", + "description": "Last uploaded file time.", + "type": "string", + "readOnly": true + }, + "blockReason": { + "description": "The reason why restore is in Blocked state.", + "type": "string", + "readOnly": true + } + } + }, + "ProxyResource": { + "description": "ARM proxy resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "ManagedDatabaseRestoreDetailsResult": { + "description": "A managed database restore details.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ManagedDatabaseRestoreDetailsProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ManagedDatabaseListResult": { + "description": "A list of managed databases.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ManagedDatabase" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "ManagedDatabaseProperties": { + "description": "The managed database's properties.", + "type": "object", + "properties": { + "collation": { + "description": "Collation of the managed database.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "status": { + "description": "Status of the database.", + "enum": [ + "Online", + "Offline", + "Shutdown", + "Creating", + "Inaccessible", + "Restoring", + "Updating" + ], + "type": "string", + "readOnly": true, + "x-ms-enum": { + "name": "ManagedDatabaseStatus", + "modelAsString": true + } + }, + "creationDate": { + "format": "date-time", + "description": "Creation date of the database.", + "type": "string", + "readOnly": true + }, + "earliestRestorePoint": { + "format": "date-time", + "description": "Earliest restore point in time for point in time restore.", + "type": "string", + "readOnly": true + }, + "restorePointInTime": { + "format": "date-time", + "description": "Conditional. If createMode is PointInTimeRestore, this value is required. Specifies the point in time (ISO8601 format) of the source database that will be restored to create the new database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "defaultSecondaryLocation": { + "description": "Geo paired region.", + "type": "string", + "readOnly": true + }, + "catalogCollation": { + "description": "Collation of the metadata catalog.", + "enum": [ + "DATABASE_DEFAULT", + "SQL_Latin1_General_CP1_CI_AS" + ], + "type": "string", + "x-ms-enum": { + "name": "CatalogCollationType", + "modelAsString": true + }, + "x-ms-mutability": [ + "read", + "create" + ] + }, + "createMode": { + "description": "Managed database create mode. PointInTimeRestore: Create a database by restoring a point in time backup of an existing database. SourceDatabaseName, SourceManagedInstanceName and PointInTime must be specified. RestoreExternalBackup: Create a database by restoring from external backup files. Collation, StorageContainerUri and StorageContainerSasToken must be specified. Recovery: Creates a database by restoring a geo-replicated backup. RecoverableDatabaseId must be specified as the recoverable database resource ID to restore. RestoreLongTermRetentionBackup: Create a database by restoring from a long term retention backup (longTermRetentionBackupResourceId required).", + "enum": [ + "Default", + "RestoreExternalBackup", + "PointInTimeRestore", + "Recovery", + "RestoreLongTermRetentionBackup" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedDatabaseCreateMode", + "modelAsString": true + }, + "x-ms-mutability": [ + "create" + ] + }, + "storageContainerUri": { + "description": "Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the uri of the storage container where backups for this restore are stored.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "sourceDatabaseId": { + "description": "The resource identifier of the source database associated with create operation of this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "restorableDroppedDatabaseId": { + "description": "The restorable dropped database resource id to restore when creating this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "storageContainerSasToken": { + "description": "Conditional. If createMode is RestoreExternalBackup, this value is required. Specifies the storage container sas token.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "failoverGroupId": { + "description": "Instance Failover Group resource identifier that this managed database belongs to.", + "type": "string", + "readOnly": true + }, + "recoverableDatabaseId": { + "description": "The resource identifier of the recoverable database associated with create operation of this database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "longTermRetentionBackupResourceId": { + "description": "The name of the Long Term Retention backup to be used for restore of this managed database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + }, + "autoCompleteRestore": { + "description": "Whether to auto complete restore of this managed database.", + "type": "boolean", + "x-ms-mutability": [ + "create" + ] + }, + "lastBackupName": { + "description": "Last backup file name for restore of this managed database.", + "type": "string", + "x-ms-mutability": [ + "create" + ] + } + } + }, + "Resource": { + "description": "ARM resource.", + "type": "object", + "properties": { + "id": { + "description": "Resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Resource name.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Resource type.", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "TrackedResource": { + "description": "ARM tracked top level resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "Resource location.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "ManagedDatabase": { + "description": "A managed database resource.", + "required": [ + "location" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/ManagedDatabaseProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + }, + "ManagedDatabaseUpdate": { + "description": "An managed database update.", + "type": "object", + "properties": { + "properties": { + "$ref": "#/definitions/ManagedDatabaseProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "tags": { + "description": "Resource tags.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "CompleteDatabaseRestoreDefinition": { + "description": "Contains the information necessary to perform a complete database restore operation.", + "required": [ + "lastBackupName" + ], + "type": "object", + "properties": { + "lastBackupName": { + "description": "The last backup name to apply", + "type": "string" + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "The subscription ID that identifies an Azure subscription.", + "required": true, + "type": "string", + "x-ms-parameter-location": "client" + }, + "ManagedInstanceNameParameter": { + "name": "managedInstanceName", + "in": "path", + "description": "The name of the managed instance.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 7af58229e572..135eea154e63 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -490,10 +490,11 @@ These can be regenerated by running the following PowerShell script from this re ``` yaml $(tag) == 'package-pure-2020-02-preview' input-file: -- Microsoft.Sql/preview/2020-02-02-preview/DatabaseSecurityAlertPolicies.json -- Microsoft.Sql/preview/2020-02-02-preview/ManagedServerSecurityAlertPolicies.json -- Microsoft.Sql/preview/2020-02-02-preview/ServerSecurityAlertPolicies.json -- Microsoft.Sql/preview/2020-02-02-preview/operations.json +- ./Microsoft.Sql/preview/2020-02-02-preview/DatabaseSecurityAlertPolicies.json +- ./Microsoft.Sql/preview/2020-02-02-preview/ManagedServerSecurityAlertPolicies.json +- ./Microsoft.Sql/preview/2020-02-02-preview/ServerSecurityAlertPolicies.json +- ./Microsoft.Sql/preview/2020-02-02-preview/operations.json +- ./Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json # Needed when there is more than one input file override-info: From 16178fee3c9288bd43fd4db804e4b010257f1414 Mon Sep 17 00:00:00 2001 From: ariklin Date: Mon, 6 Jul 2020 13:16:24 +0300 Subject: [PATCH 264/318] Azure rest api specs security solutions (#9913) * Copy solutions files from 2015-06-01-preview * update API version * update readme * Add required to ExternalSecuritySolution * add new swagger files * fix errors1 * fix2 * fix 3 * fix 4 * fix4 * fix4 * fix conflict * fix conflict2 * fix conflict4 * fix conflict 6 * fix conflict 7 * ttt * rrr * aaa * bbb * fix 10 * Prettier check * update readme * fix reference error * fix comment * fix conflict * fic conflict2 * fix conflict3 * fix conflict4 * remove files * delete externalSecuritySolutions * add assessments.json * fix readme.md * Fix validation errors 1 * Fix validation errors 2 * merge * Fix validation errors 3 * Fix validation errors 4 * Fix validation errors 5 * Fix validation errors 5 * Fix validation errors 5 * Fix validation errors 6 * Fix validation errors 4 * Fix validation errors 7 * Fix validation errors 8 * Fix validation errors 9 * Fix validation errors 10 * fix validation errors 11 * fix validation errors 11 * ix validation errors 12 * ix validation errors 13 * fix validation errors 14 * Fix validation errors 15 * Fix validation errors 16 * run prettier Co-authored-by: Arik Riklin --- .../stable/2020-01-01/SecuritySolutions.json | 238 ++++++++++++++++++ ...olutionsResourceGroupLocation_example.json | 25 ++ ...SecuritySolutionsSubscription_example.json | 38 +++ ...renceDataSubscriptionLocation_example.json | 43 ++++ ...ionsReferenceDataSubscription_example.json | 42 ++++ .../securitySolutionsReferenceData.json | 212 ++++++++++++++++ .../security/resource-manager/readme.md | 8 +- 7 files changed, 605 insertions(+), 1 deletion(-) create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/SecuritySolutions.json create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutions/GetSecuritySolutionsResourceGroupLocation_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutions/GetSecuritySolutionsSubscription_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutionsReferenceData/GetSecuritySolutionsReferenceDataSubscriptionLocation_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutionsReferenceData/GetSecuritySolutionsReferenceDataSubscription_example.json create mode 100644 specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/securitySolutionsReferenceData.json diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/SecuritySolutions.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/SecuritySolutions.json new file mode 100644 index 000000000000..0c1bbb667ab3 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/SecuritySolutions.json @@ -0,0 +1,238 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2020-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securitySolutions": { + "get": { + "x-ms-examples": { + "Get security solutions": { + "$ref": "./examples/SecuritySolutions/GetSecuritySolutionsSubscription_example.json" + } + }, + "tags": [ + "SecuritySolutions" + ], + "description": "Gets a list of Security Solutions for the subscription.", + "operationId": "SecuritySolutions_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecuritySolutionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Security/locations/{ascLocation}/securitySolutions/{securitySolutionName}": { + "get": { + "x-ms-examples": { + "Get a security solution from a security data location": { + "$ref": "./examples/SecuritySolutions/GetSecuritySolutionsResourceGroupLocation_example.json" + } + }, + "tags": [ + "SecuritySolutions" + ], + "description": "Gets a specific Security Solution.", + "operationId": "SecuritySolutions_Get", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ResourceGroupName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "#/parameters/SecuritySolutionName" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/SecuritySolution" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "SecuritySolutionList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/SecuritySolution" + } + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page." + } + } + }, + "SecuritySolution": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/SecuritySolutionProperties" + } + }, + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + }, + { + "$ref": "../../../common/v1/types.json#/definitions/Location" + } + ] + }, + "SecuritySolutionProperties": { + "type": "object", + "properties": { + "securityFamily": { + "type": "string", + "description": "The security family of the security solution", + "enum": [ + "Waf", + "Ngfw", + "SaasWaf", + "Va" + ], + "x-ms-enum": { + "name": "securityFamily", + "modelAsString": true, + "values": [ + { + "value": "Waf" + }, + { + "value": "Ngfw" + }, + { + "value": "SaasWaf" + }, + { + "value": "Va" + } + ] + } + }, + "provisioningState": { + "type": "string", + "description": "The security family provisioning State", + "enum": [ + "Succeeded", + "Failed", + "Updating" + ], + "x-ms-enum": { + "name": "provisioningState", + "modelAsString": true, + "values": [ + { + "value": "Succeeded" + }, + { + "value": "Failed" + }, + { + "value": "Updating" + } + ] + } + }, + "template": { + "type": "string", + "description": "The security solutions' template" + }, + "protectionStatus": { + "type": "string", + "description": "The security solutions' status" + } + }, + "required": [ + "securityFamily", + "provisioningState", + "template", + "protectionStatus" + ] + } + }, + "parameters": { + "SecuritySolutionName": { + "name": "securitySolutionName", + "type": "string", + "in": "path", + "required": true, + "description": "Name of security solution.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutions/GetSecuritySolutionsResourceGroupLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutions/GetSecuritySolutionsResourceGroupLocation_example.json new file mode 100644 index 000000000000..6c0bd6832ccd --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutions/GetSecuritySolutionsResourceGroupLocation_example.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "resourceGroupName": "myRg2", + "ascLocation": "centralus", + "securitySolutionName": "paloalto7" + }, + "responses": { + "200": { + "body": { + "properties": { + "securityFamily": "Ngfw", + "protectionStatus": "Good", + "template": "paloalto.paloaltofw", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/securitySolutions/paloalto7", + "name": "MyVA", + "type": "Microsoft.Security/locations/securitySolutions", + "location": "eastus2" + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutions/GetSecuritySolutionsSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutions/GetSecuritySolutionsSubscription_example.json new file mode 100644 index 000000000000..e255b72c1293 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutions/GetSecuritySolutionsSubscription_example.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "securityFamily": "SaasWaf", + "protectionStatus": "Good", + "template": "microsoft/ApplicationGateway-ARM", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg1/providers/Microsoft.Security/locations/centralus/securitySolutions/SaasWaf", + "name": "MySaasWaf", + "type": "Microsoft.Security/locations/securitySolutions", + "location": "eastus" + }, + { + "properties": { + "securityFamily": "Va", + "protectionStatus": "Good", + "template": "qualys.qualysAgent", + "provisioningState": "Succeeded" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/resourceGroups/myRg2/providers/Microsoft.Security/locations/centralus/securitySolutions/MyVA", + "name": "MyVA", + "type": "Microsoft.Security/locations/securitySolutions", + "location": "eastus2" + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutionsReferenceData/GetSecuritySolutionsReferenceDataSubscriptionLocation_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutionsReferenceData/GetSecuritySolutionsReferenceDataSubscriptionLocation_example.json new file mode 100644 index 000000000000..1f8b43f377f2 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutionsReferenceData/GetSecuritySolutionsReferenceDataSubscriptionLocation_example.json @@ -0,0 +1,43 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23", + "ascLocation": "westcentralus" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "alertVendorName": "Microsoft", + "securityFamily": "SaasWaf", + "packageInfoUrl": "www.azure.com", + "productName": "Web Application Firewall", + "publisher": "microsoft", + "publisherDisplayName": "Microsoft Inc.", + "template": "microsoft/ApplicationGateway-ARM" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westcentralus/securitySolutionsReferenceData/microsoft.ApplicationGateway-ARM", + "name": "microsoft.ApplicationGateway-ARM", + "type": "Microsoft.Security/locations/securitySolutionsReferenceData" + }, + { + "properties": { + "alertVendorName": "Qualys VA", + "securityFamily": "Va", + "packageInfoUrl": "http://www.qualys.com/", + "productName": "Vulnerability Assessment", + "publisher": "qualys", + "publisherDisplayName": "Qualys, Inc.", + "template": "qualys/qualysAgent" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westcentralus/securitySolutionsReferenceData/qualys.qualysAgent", + "name": "qualys.qualysAgent", + "type": "Microsoft.Security/locations/SecuritySolutions" + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutionsReferenceData/GetSecuritySolutionsReferenceDataSubscription_example.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutionsReferenceData/GetSecuritySolutionsReferenceDataSubscription_example.json new file mode 100644 index 000000000000..ee3c112ca4cd --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/examples/SecuritySolutionsReferenceData/GetSecuritySolutionsReferenceDataSubscription_example.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "api-version": "2020-01-01", + "subscriptionId": "20ff7fc3-e762-44dd-bd96-b71116dcdc23" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "alertVendorName": "Microsoft", + "securityFamily": "SaasWaf", + "packageInfoUrl": "www.azure.com", + "productName": "Web Application Firewall", + "publisher": "microsoft", + "publisherDisplayName": "Microsoft Inc.", + "template": "microsoft/ApplicationGateway-ARM" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westcentralus/securitySolutionsReferenceData/microsoft.ApplicationGateway-ARM", + "name": "microsoft.ApplicationGateway-ARM", + "type": "Microsoft.Security/locations/securitySolutionsReferenceData" + }, + { + "properties": { + "alertVendorName": "Qualys VA", + "securityFamily": "Va", + "packageInfoUrl": "http://www.qualys.com/", + "productName": "Vulnerability Assessment", + "publisher": "qualys", + "publisherDisplayName": "Qualys, Inc.", + "template": "qualys/qualysAgent" + }, + "id": "/subscriptions/20ff7fc3-e762-44dd-bd96-b71116dcdc23/providers/Microsoft.Security/locations/westcentralus/securitySolutionsReferenceData/qualys.qualysAgent", + "name": "qualys.qualysAgent", + "type": "Microsoft.Security/locations/SecuritySolutions" + } + ] + } + } + } +} diff --git a/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/securitySolutionsReferenceData.json b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/securitySolutionsReferenceData.json new file mode 100644 index 000000000000..92b203a528f5 --- /dev/null +++ b/specification/security/resource-manager/Microsoft.Security/stable/2020-01-01/securitySolutionsReferenceData.json @@ -0,0 +1,212 @@ +{ + "swagger": "2.0", + "info": { + "title": "Security Center", + "description": "API spec for Microsoft.Security (Azure Security Center) resource provider", + "version": "2020-01-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/securitySolutionsReferenceData": { + "get": { + "x-ms-examples": { + "Get security solutions": { + "$ref": "./examples/SecuritySolutionsReferenceData/GetSecuritySolutionsReferenceDataSubscription_example.json" + } + }, + "tags": [ + "securitySolutionsReferenceData" + ], + "description": "Gets a list of all supported Security Solutions for the subscription.", + "operationId": "securitySolutionsReferenceData_List", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/securitySolutionsReferenceDataList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Security/locations/{ascLocation}/securitySolutionsReferenceData": { + "get": { + "x-ms-examples": { + "Get security solutions from a security data location": { + "$ref": "./examples/SecuritySolutionsReferenceData/GetSecuritySolutionsReferenceDataSubscriptionLocation_example.json" + } + }, + "tags": [ + "SecuritySolutionsReferenceData" + ], + "description": "Gets list of all supported Security Solutions for subscription and location.", + "operationId": "SecuritySolutionsReferenceData_ListByHomeRegion", + "parameters": [ + { + "$ref": "../../../common/v1/types.json#/parameters/SubscriptionId" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/AscLocation" + }, + { + "$ref": "../../../common/v1/types.json#/parameters/ApiVersion" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/securitySolutionsReferenceDataList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "../../../common/v1/types.json#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "securitySolutionsReferenceDataList": { + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/securitySolutionsReferenceData" + } + } + } + }, + "securitySolutionsReferenceData": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/securitySolutionsReferenceDataProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "../../../common/v1/types.json#/definitions/Resource" + }, + { + "$ref": "../../../common/v1/types.json#/definitions/Location" + } + ] + }, + "securitySolutionsReferenceDataProperties": { + "type": "object", + "properties": { + "securityFamily": { + "type": "string", + "description": "The security family of the security solution", + "enum": [ + "Waf", + "Ngfw", + "SaasWaf", + "Va" + ], + "x-ms-enum": { + "name": "securityFamily", + "modelAsString": true, + "values": [ + { + "value": "Waf" + }, + { + "value": "Ngfw" + }, + { + "value": "SaasWaf" + }, + { + "value": "Va" + } + ] + } + }, + "alertVendorName": { + "type": "string", + "description": "The security solutions' vendor name" + }, + "packageInfoUrl": { + "type": "string", + "description": "The security solutions' package info url" + }, + "productName": { + "type": "string", + "description": "The security solutions' product name" + }, + "publisher": { + "type": "string", + "description": "The security solutions' publisher" + }, + "publisherDisplayName": { + "type": "string", + "description": "The security solutions' publisher display name" + }, + "template": { + "type": "string", + "description": "The security solutions' template" + } + }, + "required": [ + "securityFamily", + "alertVendorName", + "packageInfoUrl", + "productName", + "publisher", + "publisherDisplayName", + "template" + ] + } + } +} diff --git a/specification/security/resource-manager/readme.md b/specification/security/resource-manager/readme.md index 14664abb714f..36a913eb2b79 100644 --- a/specification/security/resource-manager/readme.md +++ b/specification/security/resource-manager/readme.md @@ -173,8 +173,10 @@ input-file: - Microsoft.Security/stable/2020-01-01/topologies.json - Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json - Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json +- Microsoft.Security/stable/2020-01-01/securitySolutionsReferenceData.json - Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json - Microsoft.Security/preview/2020-01-01-preview/secureScore.json +- Microsoft.Security/stable/2020-01-01/SecuritySolutions.json - Microsoft.Security/preview/2020-01-01-preview/connectors.json # Needed when there is more than one input file @@ -339,6 +341,8 @@ input-file: - Microsoft.Security/stable/2020-01-01/assessmentMetadata.json - Microsoft.Security/stable/2020-01-01/assessments.json - Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json +- Microsoft.Security/stable/2020-01-01/SecuritySolutions.json +- Microsoft.Security/stable/2020-01-01/securitySolutionsReferenceData.json - Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json - Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json - Microsoft.Security/stable/2020-01-01/serverVulnerabilityAssessments.json @@ -451,6 +455,8 @@ input-file: - $(this-folder)/Microsoft.Security/stable/2020-01-01/topologies.json - $(this-folder)/Microsoft.Security/stable/2020-01-01/jitNetworkAccessPolicies.json - $(this-folder)/Microsoft.Security/stable/2020-01-01/discoveredSecuritySolutions.json + - $(this-folder)/Microsoft.Security/stable/2020-01-01/securitySolutionsReferenceData.json + - $(this-folder)/Microsoft.Security/stable/2020-01-01/SecuritySolutions.json - $(this-folder)/Microsoft.Security/stable/2020-01-01/externalSecuritySolutions.json - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/assessmentMetadata.json - $(this-folder)/Microsoft.Security/preview/2019-01-01-preview/assessments.json @@ -463,4 +469,4 @@ uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json -``` +``` \ No newline at end of file From ab2787e3978ac30bc5330d4e7c5833500c4db88a Mon Sep 17 00:00:00 2001 From: chjaress <35044424+chjaress@users.noreply.github.com> Date: Mon, 6 Jul 2020 16:49:13 -0700 Subject: [PATCH 265/318] Add vmHealth status in the VirtualMachineInstanceView (#10013) --- .../Microsoft.Compute/stable/2020-06-01/compute.json | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json index 560d81fea158..bf776693fce8 100644 --- a/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json +++ b/specification/compute/resource-manager/Microsoft.Compute/stable/2020-06-01/compute.json @@ -8864,6 +8864,11 @@ }, "description": "The extensions information." }, + "vmHealth": { + "readOnly": true, + "$ref": "#/definitions/VirtualMachineHealthStatus", + "description": "The health status for the VM." + }, "bootDiagnostics": { "$ref": "#/definitions/BootDiagnosticsInstanceView", "description": "Boot Diagnostics is a debugging feature which allows you to view Console Output and Screenshot to diagnose VM status.

    You can easily view the output of your console log.

    Azure also enables you to see a screenshot of the VM from the hypervisor." From f9c879be3a5358f0200876f8621bb49ab7050482 Mon Sep 17 00:00:00 2001 From: gubalasu <59630928+gubalasu@users.noreply.github.com> Date: Mon, 6 Jul 2020 19:22:59 -0700 Subject: [PATCH 266/318] Add odatatype for Url Signing Action (#10017) * Add odatatype for Url Signing Action * Fix typo --- .../Microsoft.Cdn/stable/2020-03-31/cdn.json | 6 ++++++ .../Microsoft.Cdn/stable/2020-04-15/cdn.json | 6 ++++++ 2 files changed, 12 insertions(+) diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json index 7b052709cb5f..3e36e1fb1fa3 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json @@ -3868,6 +3868,12 @@ "keyId" ], "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters" + ] + }, "keyId": { "description": "Id reference of the key to be used to verify the hash and should be defined in UrlSigningKeys", "type": "string" diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json index 5d621303e558..3c18bca376e4 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json @@ -3868,6 +3868,12 @@ "keyId" ], "properties": { + "@odata.type": { + "type": "string", + "enum": [ + "#Microsoft.Azure.Cdn.Models.DeliveryRuleUrlSigningActionParameters" + ] + }, "keyId": { "description": "Id reference of the key to be used to verify the hash and should be defined in UrlSigningKeys", "type": "string" From cf34791021c7d8f2d988fc94a9306f29f4f66617 Mon Sep 17 00:00:00 2001 From: toki95 <35834415+toki95@users.noreply.github.com> Date: Tue, 7 Jul 2020 04:30:04 +0200 Subject: [PATCH 267/318] Updating MI operations swagger (#9691) * Create GetManagedInstanceOperation.json * Create CancelManagedInstanceOperation.json * Added Ger example * Add files via upload * Added changes to readme file * Removing not needed files * Changed operationId to operationName * Removed seconbd managedInstanceOperations * Removerting not needed changes * Updating managed instance operaitons api * Adding spacing * Run prettier check Co-authored-by: Jovana Toroman --- .../examples/GetManagedInstanceOperation.json | 33 ++++++- .../ListManagedInstanceOperations.json | 52 ++++++++++- .../managedInstanceOperations.json | 93 +++++++++++++++++++ .../examples/GetManagedInstanceOperation.json | 33 ++++++- .../ListManagedInstanceOperations.json | 50 +++++++++- .../managedInstanceOperations.json | 93 +++++++++++++++++++ 6 files changed, 347 insertions(+), 7 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/GetManagedInstanceOperation.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/GetManagedInstanceOperation.json index 9f390521b5cb..66d9bac2032c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/GetManagedInstanceOperation.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/GetManagedInstanceOperation.json @@ -16,7 +16,38 @@ "percentComplete": 100, "startTime": "2019-12-06T11:08:44.49Z", "state": "Cancelled", - "isCancellable": false + "isCancellable": false, + "operationSteps": { + "totalSteps": "5", + "currentStep": 2, + "stepsList": [ + { + "order": 1, + "name": "Request validation", + "status": "Completed" + }, + { + "order": 2, + "name": "New SQL Instance Startup", + "status": "Canceled" + }, + { + "order": 3, + "name": "Seeding database files", + "status": "NotStarted" + }, + { + "order": 4, + "name": "Preparing Failover and Failover", + "status": "NotStarted" + }, + { + "order": 5, + "name": "Old SQL Instance cleanup", + "status": "NotStarted" + } + ] + } }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/operations/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ListManagedInstanceOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ListManagedInstanceOperations.json index 00d4517c0859..ec27fdcbbeab 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ListManagedInstanceOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/examples/ListManagedInstanceOperations.json @@ -28,10 +28,45 @@ "managedInstanceName": "sqlcrudtest-4645", "operation": "UpsertManagedServer", "operationFriendlyName": "UPDATE MANAGED SERVER", - "percentComplete": 0, + "percentComplete": 50, "startTime": "2019-12-06T11:08:44.49Z", "state": "InProgress", - "isCancellable": true + "isCancellable": true, + "operationParameters": { + "currentParameters": { + "family": "Gen4", + "tier": "GeneralPurpose", + "vCores": 8, + "storageSizeInGB": 32 + }, + "requestedParameters": { + "family": "Gen4", + "tier": "BusinessCritical", + "vCores": 8, + "storageSizeInGB": 128 + } + }, + "operationSteps": { + "totalSteps": "3", + "currentStep": 3, + "stepsList": [ + { + "order": 1, + "name": "Request validation", + "status": "Completed" + }, + { + "order": 2, + "name": "Virtual Cluster resize/creation", + "status": "Completed" + }, + { + "order": 3, + "name": "New SQL Instance Startup", + "status": "InProgress" + } + ] + } }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/operations/22222222-2222-2222-2222-222222222222", "name": "22222222-2222-2222-2222-222222222222", @@ -62,7 +97,18 @@ "operationFriendlyName": "MAKE ALL MANAGED DBS ACCESSIBLE", "percentComplete": 100, "startTime": "2017-06-01T09:00:08.10Z", - "state": "Succeeded" + "state": "Succeeded", + "operationSteps": { + "totalSteps": "1", + "currentStep": 1, + "stepsList": [ + { + "order": 1, + "name": "Request validation", + "status": "Failed" + } + ] + } }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/operations/44444444-4444-4444-4444-444444444444", "name": "44444444-4444-4444-4444-444444444444", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedInstanceOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedInstanceOperations.json index 261d8aad543f..fb5c48b9f9d7 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedInstanceOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2018-06-01-preview/managedInstanceOperations.json @@ -210,6 +210,57 @@ "description": "Whether the operation can be cancelled.", "type": "boolean", "readOnly": true + }, + "operationParameters": { + "$ref": "#/definitions/ManagedInstanceOperationParametersPair", + "description": "The operation parameters.", + "readOnly": true + }, + "operationSteps": { + "$ref": "#/definitions/ManagedInstanceOperationSteps", + "description": "The operation steps.", + "readOnly": true + } + } + }, + "ManagedInstanceOperationParametersPair": { + "description": "The parameters of a managed instance operation.", + "type": "object", + "properties": { + "currentParameters": { + "$ref": "#/definitions/UpsertManagedServerOperationParameters", + "description": "The current parameters.", + "readOnly": true + }, + "requestedParameters": { + "$ref": "#/definitions/UpsertManagedServerOperationParameters", + "description": "The requested parameters.", + "readOnly": true + } + } + }, + "ManagedInstanceOperationSteps": { + "description": "The steps of a managed instance operation.", + "type": "object", + "properties": { + "totalSteps": { + "description": "The total number of operation steps.", + "type": "string", + "readOnly": true + }, + "currentStep": { + "format": "int32", + "description": "The number of current operation steps.", + "type": "integer", + "readOnly": true + }, + "stepsList": { + "description": "The operation steps list.", + "type": "array", + "items": { + "$ref": "#/definitions/UpsertManagedServerOperationStep" + }, + "readOnly": true } } }, @@ -235,6 +286,48 @@ }, "x-ms-azure-resource": true }, + "UpsertManagedServerOperationParameters": { + "type": "object", + "properties": { + "family": { + "type": "string" + }, + "tier": { + "type": "string" + }, + "vCores": { + "format": "int32", + "type": "integer" + }, + "storageSizeInGB": { + "format": "int32", + "type": "integer" + } + } + }, + "UpsertManagedServerOperationStep": { + "type": "object", + "properties": { + "order": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + }, + "status": { + "enum": [ + "NotStarted", + "InProgress", + "SlowedDown", + "Completed", + "Failed", + "Canceled" + ], + "type": "string" + } + } + }, "ProxyResource": { "description": "ARM proxy resource.", "type": "object", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/GetManagedInstanceOperation.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/GetManagedInstanceOperation.json index 9f390521b5cb..66d9bac2032c 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/GetManagedInstanceOperation.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/GetManagedInstanceOperation.json @@ -16,7 +16,38 @@ "percentComplete": 100, "startTime": "2019-12-06T11:08:44.49Z", "state": "Cancelled", - "isCancellable": false + "isCancellable": false, + "operationSteps": { + "totalSteps": "5", + "currentStep": 2, + "stepsList": [ + { + "order": 1, + "name": "Request validation", + "status": "Completed" + }, + { + "order": 2, + "name": "New SQL Instance Startup", + "status": "Canceled" + }, + { + "order": 3, + "name": "Seeding database files", + "status": "NotStarted" + }, + { + "order": 4, + "name": "Preparing Failover and Failover", + "status": "NotStarted" + }, + { + "order": 5, + "name": "Old SQL Instance cleanup", + "status": "NotStarted" + } + ] + } }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/operations/11111111-1111-1111-1111-111111111111", "name": "11111111-1111-1111-1111-111111111111", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/ListManagedInstanceOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/ListManagedInstanceOperations.json index 82409de378c6..ec27fdcbbeab 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/ListManagedInstanceOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/examples/ListManagedInstanceOperations.json @@ -31,7 +31,42 @@ "percentComplete": 50, "startTime": "2019-12-06T11:08:44.49Z", "state": "InProgress", - "isCancellable": true + "isCancellable": true, + "operationParameters": { + "currentParameters": { + "family": "Gen4", + "tier": "GeneralPurpose", + "vCores": 8, + "storageSizeInGB": 32 + }, + "requestedParameters": { + "family": "Gen4", + "tier": "BusinessCritical", + "vCores": 8, + "storageSizeInGB": 128 + } + }, + "operationSteps": { + "totalSteps": "3", + "currentStep": 3, + "stepsList": [ + { + "order": 1, + "name": "Request validation", + "status": "Completed" + }, + { + "order": 2, + "name": "Virtual Cluster resize/creation", + "status": "Completed" + }, + { + "order": 3, + "name": "New SQL Instance Startup", + "status": "InProgress" + } + ] + } }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/operations/22222222-2222-2222-2222-222222222222", "name": "22222222-2222-2222-2222-222222222222", @@ -62,7 +97,18 @@ "operationFriendlyName": "MAKE ALL MANAGED DBS ACCESSIBLE", "percentComplete": 100, "startTime": "2017-06-01T09:00:08.10Z", - "state": "Succeeded" + "state": "Succeeded", + "operationSteps": { + "totalSteps": "1", + "currentStep": 1, + "stepsList": [ + { + "order": 1, + "name": "Request validation", + "status": "Failed" + } + ] + } }, "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/sqlcrudtest-7398/providers/Microsoft.Sql/managedInstances/sqlcrudtest-4645/operations/44444444-4444-4444-4444-444444444444", "name": "44444444-4444-4444-4444-444444444444", diff --git a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json index 7b425988000e..e7d461236c33 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json +++ b/specification/sql/resource-manager/Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json @@ -253,6 +253,57 @@ "description": "Whether the operation can be cancelled.", "type": "boolean", "readOnly": true + }, + "operationParameters": { + "$ref": "#/definitions/ManagedInstanceOperationParametersPair", + "description": "The operation parameters.", + "readOnly": true + }, + "operationSteps": { + "$ref": "#/definitions/ManagedInstanceOperationSteps", + "description": "The operation steps.", + "readOnly": true + } + } + }, + "ManagedInstanceOperationParametersPair": { + "description": "The parameters of a managed instance operation.", + "type": "object", + "properties": { + "currentParameters": { + "$ref": "#/definitions/UpsertManagedServerOperationParameters", + "description": "The current parameters.", + "readOnly": true + }, + "requestedParameters": { + "$ref": "#/definitions/UpsertManagedServerOperationParameters", + "description": "The requested parameters.", + "readOnly": true + } + } + }, + "ManagedInstanceOperationSteps": { + "description": "The steps of a managed instance operation.", + "type": "object", + "properties": { + "totalSteps": { + "description": "The total number of operation steps.", + "type": "string", + "readOnly": true + }, + "currentStep": { + "format": "int32", + "description": "The number of current operation steps.", + "type": "integer", + "readOnly": true + }, + "stepsList": { + "description": "The operation steps list.", + "type": "array", + "items": { + "$ref": "#/definitions/UpsertManagedServerOperationStep" + }, + "readOnly": true } } }, @@ -278,6 +329,48 @@ }, "x-ms-azure-resource": true }, + "UpsertManagedServerOperationParameters": { + "type": "object", + "properties": { + "family": { + "type": "string" + }, + "tier": { + "type": "string" + }, + "vCores": { + "format": "int32", + "type": "integer" + }, + "storageSizeInGB": { + "format": "int32", + "type": "integer" + } + } + }, + "UpsertManagedServerOperationStep": { + "type": "object", + "properties": { + "order": { + "format": "int32", + "type": "integer" + }, + "name": { + "type": "string" + }, + "status": { + "enum": [ + "NotStarted", + "InProgress", + "SlowedDown", + "Completed", + "Failed", + "Canceled" + ], + "type": "string" + } + } + }, "ProxyResource": { "description": "ARM proxy resource.", "type": "object", From 3774a2c2f9b847a7695c4f857a5634ed5663d2c7 Mon Sep 17 00:00:00 2001 From: Don Date: Mon, 6 Jul 2020 20:39:03 -0700 Subject: [PATCH 268/318] update MLC swagger json (#9919) * update MLC swagger json * Update machineLearningServices.json * Update machineLearningServices.json Clean up pretty layout * Update machineLearningServices.json Co-authored-by: Don Reamey --- .../2020-04-01/machineLearningServices.json | 20 ++++++++++++++++++- 1 file changed, 19 insertions(+), 1 deletion(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json index 094ed64eef22..7bd035bdff35 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json @@ -2329,6 +2329,14 @@ "aksNetworkingConfiguration": { "description": "AKS networking configuration for vnet", "$ref": "#/definitions/AksNetworkingConfiguration" + }, + "clusterPurpose": { + "type": "string", + "enum": [ + "FastProd", + "DenseProd", + "DevTest" + ] } } } @@ -2621,7 +2629,8 @@ "type": "string", "enum": [ "Disabled", - "Enabled" + "Enabled", + "Auto" ] }, "cert": { @@ -2635,6 +2644,15 @@ "cname": { "description": "CNAME of the cert", "type": "string" + }, + "leafDomainLabel": { + "description": "The leaf domain label name", + "type": "string" + }, + "overwriteExistingDomain": { + "description": "Boolean value for overwriting the domain", + "type": "boolean", + "default": false } } }, From 608316dce1249a0b3fc54cd60d82c70bd72cce96 Mon Sep 17 00:00:00 2001 From: Landon Smith Date: Mon, 6 Jul 2020 22:34:44 -0700 Subject: [PATCH 269/318] Fix urlSigingKeys array type ref in CDN versions 2020-03-31 and 2020-04-15 (#9997) --- .../resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json | 4 +++- .../resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json | 4 +++- 2 files changed, 6 insertions(+), 2 deletions(-) diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json index 3e36e1fb1fa3..6c41c103a962 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json @@ -2697,7 +2697,9 @@ "urlSigningKeys": { "description": "List of keys used to validate the signed URL hashes.", "type": "array", - "$ref": "#/definitions/UrlSigningKey" + "items": { + "$ref": "#/definitions/UrlSigningKey" + } }, "deliveryPolicy": { "description": "A policy that specifies the delivery rules to be used for an endpoint.", diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json index 3c18bca376e4..5e9ebacd260b 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json @@ -2697,7 +2697,9 @@ "urlSigningKeys": { "description": "List of keys used to validate the signed URL hashes.", "type": "array", - "$ref": "#/definitions/UrlSigningKey" + "items": { + "$ref": "#/definitions/UrlSigningKey" + } }, "deliveryPolicy": { "description": "A policy that specifies the delivery rules to be used for an endpoint.", From be85a7207da4ed237eef38a945c4b4a6da3b97b0 Mon Sep 17 00:00:00 2001 From: Zach Rathbun Date: Mon, 6 Jul 2020 22:39:56 -0700 Subject: [PATCH 270/318] [Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 (#9958) * RI documentation updates * Parameter location * Missed a parameter * Fix enum formatting * remove new params to get healthy version * Add basic parameters * fix parameter format * Update examples * Fix trailing comma * Only simple parameters * Fix parameter declaration * Fix casing * trailing comma * Use parameters correctly * Fix input parameter * Update examples for fixed format * Remove unused definition * Fix parameter naming * Fix path template * Fix descriptions * Test resorting * Remove 5 year * Prettier fixes --- .../stable/2019-10-01/consumption.json | 123 +++++++++++++++++- ...RecommendationDetailsByBillingAccount.json | 7 +- ...RecommendationDetailsByBillingProfile.json | 7 +- ...nRecommendationDetailsByResourceGroup.json | 76 +++++++++++ ...onRecommendationDetailsBySubscription.json | 7 +- ...rvationRecommendationsByResourceGroup.json | 53 ++++++++ 6 files changed, 266 insertions(+), 7 deletions(-) create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByResourceGroup.json create mode 100644 specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationsByResourceGroup.json diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json index 214e42d27d1a..7a1a4c264a8e 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json @@ -1030,6 +1030,9 @@ "ReservationRecommendationsBySubscription-Legacy": { "$ref": "./examples/ReservationRecommendationsBySubscription.json" }, + "ReservationRecommendationsByResourceGroup-Legacy": { + "$ref": "./examples/ReservationRecommendationsByResourceGroup.json" + }, "ReservationRecommendationsFilterBySubscriptionForScopeLookBackPeriod-Legacy": { "$ref": "./examples/ReservationRecommendationsFilterBySubscriptionForScopeLookBackPeriod.json" }, @@ -1070,7 +1073,7 @@ } } }, - "/{scope}/providers/Microsoft.Consumption/reservationRecommendationDetails": { + "/{billingScope}/providers/Microsoft.Consumption/reservationRecommendationDetails": { "get": { "tags": [ "ReservationRecommendationDetails" @@ -1084,6 +1087,9 @@ "ReservationRecommendationsBySubscription-Legacy": { "$ref": "./examples/ReservationRecommendationDetailsBySubscription.json" }, + "ReservationRecommendationsByResourceGroup-Legacy": { + "$ref": "./examples/ReservationRecommendationDetailsByResourceGroup.json" + }, "ReservationRecommendationsByBillingAccount-Legacy": { "$ref": "./examples/ReservationRecommendationDetailsByBillingAccount.json" }, @@ -1097,6 +1103,21 @@ }, { "$ref": "#/parameters/scopeReservationRecommendationDetailsParameter" + }, + { + "$ref": "#/parameters/scopeParameter" + }, + { + "$ref": "#/parameters/regionParameter" + }, + { + "$ref": "#/parameters/termParameter" + }, + { + "$ref": "#/parameters/lookBackPeriodParameter" + }, + { + "$ref": "#/parameters/productParameter" } ], "responses": { @@ -4944,16 +4965,16 @@ "in": "path", "required": true, "type": "string", - "description": "The scope associated with reservation recommendations operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope", + "description": "The scope associated with reservation recommendations operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope", "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true }, "scopeReservationRecommendationDetailsParameter": { - "name": "scope", + "name": "billingScope", "in": "path", "required": true, "type": "string", - "description": "The scope associated with reservation recommendation details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroup}', /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope", + "description": "The scope associated with reservation recommendation details operations. This includes '/subscriptions/{subscriptionId}/' for subscription scope, '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}' for resource group scope, /providers/Microsoft.Billing/billingAccounts/{billingAccountId}' for BillingAccount scope, and '/providers/Microsoft.Billing/billingAccounts/{billingAccountId}/billingProfiles/{billingProfileId}' for billingProfile scope", "x-ms-parameter-location": "method", "x-ms-skip-url-encoding": true }, @@ -5153,6 +5174,100 @@ "required": false, "type": "string", "x-ms-parameter-location": "method" + }, + "termParameter": { + "description": "Specify length of reservation recommendation term.", + "type": "string", + "in": "query", + "required": true, + "name": "term", + "x-ms-parameter-location": "method", + "enum": [ + "P1Y", + "P3Y" + ], + "x-ms-enum": { + "name": "term", + "modelAsString": true, + "values": [ + { + "value": "P1Y", + "description": "1 year reservation term", + "name": "P1Y" + }, + { + "value": "P3Y", + "description": "3 year reservation term", + "name": "P3Y" + } + ] + } + }, + "regionParameter": { + "name": "region", + "in": "query", + "description": "Used to select the region the recommendation should be generated for.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "lookBackPeriodParameter": { + "name": "lookBackPeriod", + "in": "query", + "description": "Filter the time period on which reservation recommendation results are based.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "enum": [ + "Last7Days", + "Last30Days", + "Last60Days" + ], + "x-ms-enum": { + "name": "lookBackPeriod", + "modelAsString": true, + "values": [ + { + "value": "Last7Days", + "description": "Use 7 days of data for recommendations", + "name": "Last07Days" + }, + { + "value": "Last30Days", + "description": "Use 30 days of data for recommendations", + "name": "Last30Days" + }, + { + "value": "Last60Days", + "description": "Use 60 days of data for recommendations", + "name": "Last60Days" + } + ] + } + }, + "productParameter": { + "name": "product", + "in": "query", + "description": "Filter the products for which reservation recommendation results are generated. Examples: Standard_DS1_v2 (for VM), Premium_SSD_Managed_Disks_P30 (for Managed Disks)", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "scopeParameter": { + "description": "Scope of the reservation.", + "type": "string", + "name": "scope", + "in": "query", + "required": true, + "x-ms-parameter-location": "method", + "enum": [ + "Single", + "Shared" + ], + "x-ms-enum": { + "name": "scope", + "modelAsString": true + } } } } diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByBillingAccount.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByBillingAccount.json index 3349a95990bd..64132bae1ed3 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByBillingAccount.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByBillingAccount.json @@ -1,7 +1,12 @@ { "parameters": { "api-version": "2019-10-01", - "scope": "providers/Microsoft.Billing/billingAccounts/000000" + "billingScope": "providers/Microsoft.Billing/billingAccounts/000000", + "lookBackPeriod": "Last60Days", + "product": "Standard_DS14_v2", + "region": "eastus", + "scope": "Shared", + "term": "P1Y" }, "responses": { "200": { diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByBillingProfile.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByBillingProfile.json index 235b489b818b..2e26e8ae8e3e 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByBillingProfile.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByBillingProfile.json @@ -1,7 +1,12 @@ { "parameters": { "api-version": "2019-10-01", - "scope": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-00000000:00000000-0000-0000-0000-00000000/billingProfiles/00000000-0000-0000-0000-00000000" + "billingScope": "providers/Microsoft.Billing/billingAccounts/00000000-0000-0000-0000-00000000:00000000-0000-0000-0000-00000000/billingProfiles/00000000-0000-0000-0000-00000000", + "lookBackPeriod": "Last7Days", + "product": "Standard_B2s", + "region": "australiaeast", + "scope": "Shared", + "term": "P1Y" }, "responses": { "200": { diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByResourceGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByResourceGroup.json new file mode 100644 index 000000000000..41488fe63828 --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsByResourceGroup.json @@ -0,0 +1,76 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "billingScope": "subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testGroup", + "lookBackPeriod": "Last30Days", + "product": "Standard_DS13_v2", + "region": "westus", + "scope": "Single", + "term": "P3Y" + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/00000000-0000-0000-0000-00000000/resourceGroups/testGroup/providers/microsoft.consumption/reservationrecommendationdetails", + "name": "reservationRecommendationDetails", + "type": "Microsoft.Consumption/ReservationRecommendationDetails", + "properties": { + "currency": "USD", + "resource": { + "appliedScopes": [ + "00000000-0000-0000-0000-00000000", + "testGroup" + ], + "onDemandRate": 0.519, + "product": "Standard_DS13_v2", + "region": "westus", + "reservationRate": 0.302549467275493, + "resourceType": "virtualmachines" + }, + "resourceGroup": "testGroup", + "savings": { + "calculatedSavings": [ + { + "onDemandCost": 368.4813602070006, + "overageCost": 0.0, + "quantity": 2, + "reservationCost": 429.01514459665, + "totalReservationCost": 429.01514459665, + "savings": -60.5337843896494 + }, + { + "onDemandCost": 368.481360207000, + "overageCost": 1.557, + "quantity": 1, + "reservationCost": 214.507572298325, + "totalReservationCost": 216.064572298325, + "savings": 152.416787908675 + } + ], + "lookBackPeriod": 30, + "recommendedQuantity": 1.0, + "reservationOrderTerm": "P3Y", + "savingsType": "instance", + "unitOfMeasure": "hour" + }, + "scope": "Single", + "usage": { + "firstConsumptionDate": "2020-02-03T00:00:00", + "lastConsumptionDate": "2020-03-03T13:00:00", + "lookBackUnitType": "virtualMachine quantity", + "usageData": [ + 1.0, + 1.0, + 1.0, + 1.0, + 1.0, + 1.0 + ], + "usageGrain": "hourly" + } + } + } + }, + "204": {} + } +} diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsBySubscription.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsBySubscription.json index 81401cfe5622..8edeecfad5e8 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsBySubscription.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationDetailsBySubscription.json @@ -1,7 +1,12 @@ { "parameters": { "api-version": "2019-10-01", - "scope": "subscriptions/00000000-0000-0000-0000-00000000" + "billingScope": "subscriptions/00000000-0000-0000-0000-00000000", + "lookBackPeriod": "Last30Days", + "product": "Standard_DS13_v2", + "region": "westus", + "scope": "Single", + "term": "P3Y" }, "responses": { "200": { diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationsByResourceGroup.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationsByResourceGroup.json new file mode 100644 index 000000000000..e5176552a10c --- /dev/null +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/examples/ReservationRecommendationsByResourceGroup.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "api-version": "2019-10-01", + "scope": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGrouups/testGroup/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations1", + "name": "reservationRecommendations1", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "kind": "legacy", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P1Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 4.634521202630137, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single" + } + }, + { + "id": "subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup/providers/Microsoft.Consumption/reservationRecommendations/reservationRecommendations2", + "name": "reservationRecommendations2", + "type": "Microsoft.Consumption/reservationRecommendations", + "sku": "Standard_DS1_v2", + "location": "northeurope", + "kind": "legacy", + "properties": { + "lookBackPeriod": "Last7Days", + "meterId": "00000000-0000-0000-0000-000000000000", + "term": "P3Y", + "costWithNoReservedInstances": 0.0, + "recommendedQuantity": 1, + "totalCostWithReservedInstances": 0.0, + "netSavings": 7.2893157231780812, + "firstUsageDate": "2018-03-06T00:00:00Z", + "scope": "Single" + } + } + ], + "nextLink": "https://management.azure.com/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/testGroup/providers/Microsoft.Consumption/reservationRecommendations?api-version=2019-10-01&$skiptoken=AQAAAA%3D%3D&" + } + } + } +} From bfd326ea58084517f8e9cb2e6bdbcb0c400f6370 Mon Sep 17 00:00:00 2001 From: Anirban Sarkar <33848291+asarkar84@users.noreply.github.com> Date: Tue, 7 Jul 2020 00:15:30 -0700 Subject: [PATCH 271/318] Added preview BillingV2 with limited APIs for Backward compatibility of SDKs (#10048) * Correcting the swagger to accept downloadToken similar to other download operations Correcting the swagger to accept downloadToken similar to other download operations * Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. Adding the missing api-version parameter for move and validate move apis. IT is already part of the examples. * Removing reonly property to allow update operations Removing reonly property to allow update operations * Fixed the bad output-folder Fixed the bad output-folder * Added preview BillingV2 for limited version of APIs Added preview BillingV2 for limited version of APIs * Updated readme file * Fixed build errors * Fixed build errors Co-authored-by: Anirban Sarkar --- .../preview/2018-03-01-preview/billingV2.json | 394 ++++++++++++++++++ .../billing/resource-manager/readme.md | 1 + 2 files changed, 395 insertions(+) create mode 100644 specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json diff --git a/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json new file mode 100644 index 000000000000..94e961a7fdee --- /dev/null +++ b/specification/billing/resource-manager/Microsoft.Billing/preview/2018-03-01-preview/billingV2.json @@ -0,0 +1,394 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-03-01-preview", + "title": "BillingManagementClient", + "description": "Billing client provides access to billing resources for Azure subscriptions." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.Billing/enrollmentAccounts": { + "get": { + "tags": [ + "EnrollmentAccounts" + ], + "x-ms-examples": { + "EnrollmentAccountsList": { + "$ref": "./examples/EnrollmentAccountsList.json" + } + }, + "operationId": "EnrollmentAccounts_List", + "description": "Lists the enrollment accounts the caller has access to.", + "parameters": [ + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnrollmentAccountListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/providers/Microsoft.Billing/enrollmentAccounts/{name}": { + "get": { + "tags": [ + "EnrollmentAccounts" + ], + "x-ms-examples": { + "EnrollmentAccountsGet": { + "$ref": "./examples/EnrollmentAccountsGet.json" + } + }, + "operationId": "EnrollmentAccounts_Get", + "description": "Gets a enrollment account by name.", + "parameters": [ + { + "name": "name", + "in": "path", + "description": "Enrollment Account name.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/apiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/EnrollmentAccountSummary" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods": { + "get": { + "tags": [ + "BillingPeriods" + ], + "operationId": "BillingPeriods_List", + "description": "Lists the available billing periods for a subscription in reverse chronological order. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "externalDocs": { + "url": "https://go.microsoft.com/fwlink/?linkid=844490" + }, + "x-ms-examples": { + "BillingPeriodsList": { + "$ref": "./examples/BillingPeriodsList.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionGuidParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "$filter", + "description": "May be used to filter billing periods by billingPeriodEndDate. The filter supports 'eq', 'lt', 'gt', 'le', 'ge', and 'and'. It does not currently support 'ne', 'or', or 'not'.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$skiptoken", + "description": "Skiptoken is only used if a previous operation returned a partial result. If a previous response contains a nextLink element, the value of the nextLink element will include a skiptoken parameter that specifies a starting point to use for subsequent calls.", + "in": "query", + "required": false, + "type": "string" + }, + { + "name": "$top", + "description": "May be used to limit the number of results to the most recent N billing periods.", + "in": "query", + "required": false, + "type": "integer", + "minimum": 1, + "maximum": 100 + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPeriodsListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Billing/billingPeriods/{billingPeriodName}": { + "get": { + "tags": [ + "BillingPeriods" + ], + "operationId": "BillingPeriods_Get", + "description": "Gets a named billing period. This is only supported for Azure Web-Direct subscriptions. Other subscription types which were not purchased directly through the Azure web portal are not supported through this preview API.", + "x-ms-examples": { + "BillingPeriodsGet": { + "$ref": "./examples/BillingPeriodsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/subscriptionGuidParameter" + }, + { + "$ref": "#/parameters/apiVersionParameter" + }, + { + "name": "billingPeriodName", + "description": "The name of a BillingPeriod resource.", + "in": "path", + "required": true, + "type": "string" + } + ], + "responses": { + "200": { + "description": "OK. The request has succeeded.", + "schema": { + "$ref": "#/definitions/BillingPeriod" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + } + }, + "definitions": { + "EnrollmentAccountSummary": { + "description": "An enrollment account resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "An enrollment account.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/EnrollmentAccountSummaryProperties" + } + } + }, + "EnrollmentAccountListResult": { + "description": "Result of listing enrollment accounts.", + "properties": { + "value": { + "description": "The list of enrollment accounts.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/EnrollmentAccountSummary" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "EnrollmentAccountSummaryProperties": { + "description": "The properties of the enrollment account.", + "properties": { + "principalName": { + "description": "The account owner's principal name.", + "type": "string", + "readOnly": true + } + } + }, + "BillingPeriod": { + "description": "A billing period resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "description": "A billing period.", + "x-ms-client-flatten": true, + "$ref": "#/definitions/BillingPeriodProperties" + } + } + }, + "BillingPeriodsListResult": { + "description": "Result of listing billing periods. It contains a list of available billing periods in reverse chronological order.", + "properties": { + "value": { + "description": "The list of billing periods.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/BillingPeriod" + } + }, + "nextLink": { + "description": "The link (url) to the next page of results.", + "type": "string", + "readOnly": true + } + } + }, + "BillingPeriodProperties": { + "description": "The properties of the billing period.", + "properties": { + "billingPeriodStartDate": { + "description": "The start of the date range covered by the billing period.", + "type": "string", + "format": "date", + "readOnly": true + }, + "billingPeriodEndDate": { + "description": "The end of the date range covered by the billing period.", + "type": "string", + "format": "date", + "readOnly": true + }, + "invoiceIds": { + "description": "Array of invoice ids that associated with.", + "type": "array", + "readOnly": true, + "items": { + "type": "string" + } + } + } + }, + "ErrorDetails": { + "description": "The details of the error.", + "properties": { + "code": { + "description": "Error code.", + "type": "string", + "readOnly": true + }, + "message": { + "description": "Error message indicating why the operation failed.", + "type": "string", + "readOnly": true + }, + "target": { + "description": "The target of the particular error.", + "type": "string", + "readOnly": true + } + } + }, + "ErrorResponse": { + "description": "Error response indicates that the service is not able to process the incoming request. The reason is provided in the error message.", + "type": "object", + "properties": { + "error": { + "description": "The details of the error.", + "$ref": "#/definitions/ErrorDetails" + } + } + }, + "Resource": { + "description": "The Resource model definition.", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type." + } + }, + "x-ms-azure-resource": true + } + }, + "parameters": { + "apiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request. The current version is 2018-03-01-preview." + }, + "subscriptionGuidParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/billing/resource-manager/readme.md b/specification/billing/resource-manager/readme.md index 31988a610128..d7dd48f19501 100644 --- a/specification/billing/resource-manager/readme.md +++ b/specification/billing/resource-manager/readme.md @@ -36,6 +36,7 @@ These settings apply only when `--tag=package-2020-05` is specified on the comma ``` yaml $(tag) == 'package-2020-05' input-file: - Microsoft.Billing/stable/2020-05-01/billing.json +- Microsoft.Billing/preview/2018-03-01-preview/billingV2.json ``` ### Tag: package-2019-10-preview From 3657724ee90a43591a904c208f835f8d51a66b07 Mon Sep 17 00:00:00 2001 From: Saif Kayani Date: Tue, 7 Jul 2020 02:45:45 -0700 Subject: [PATCH 272/318] Managed Services General API Fixes (#9886) * -For stable/2019-09-01 and preview/2020-02-01, added MarketplaceRegistration property and use it in place of RegistrationDefinition for MarketplaceRegistrationDefinitionsList -For preview/2020-02-01, added eligibleAuthorizations to GetMarketplaceRegistrationDefinition and GetMarketplaceRegistrationDefinitionsList examples * Removed extraneous spacing * Fixed get marketplace reg def examples to reference MarketplaceRegDef property * Added name property to marketplace reg def + fixed examples --- .../GetMarketplaceRegistrationDefinition.json | 15 ++-- ...GetMarketplaceRegistrationDefinitions.json | 15 ++-- .../2020-02-01-preview/managedservices.json | 73 ++++++++++++++++++- .../GetMarketplaceRegistrationDefinition.json | 15 ++-- ...GetMarketplaceRegistrationDefinitions.json | 15 ++-- .../stable/2019-09-01/managedservices.json | 66 ++++++++++++++++- 6 files changed, 163 insertions(+), 36 deletions(-) diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinition.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinition.json index d85e52a4f545..be0edc4cc58e 100644 --- a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinition.json +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinition.json @@ -8,27 +8,26 @@ "200": { "body": { "properties": { - "description": "Test", "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc", - "registrationDefinitionName": "DefinitionName", "authorizations": [ { "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc", "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" } ], - "provisioningState": "Succeeded", - "managedByTenantName": "Test Tenant" + "offerDisplayName": "Marketplace Test Offer", + "publisherDisplayName": "Marketplace Test Publisher", + "planDisplayName": "Test Plan" }, "plan": { - "name": "addesai-plan", + "name": "test-plan", "product": "test", "publisher": "marketplace-test", "version": "1.0.0" }, - "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2", - "type": "Microsoft.ManagedServices/registrationDefinitions", - "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2" + "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/marketplace-test.test.test-plan.1.0.0", + "type": "Microsoft.ManagedServices/marketplaceRegistrationDefinitions", + "name": "marketplace-test.test.test-plan.1.0.0" } } } diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinitions.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinitions.json index 59623715d529..b511ed1128fd 100644 --- a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinitions.json +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/examples/GetMarketplaceRegistrationDefinitions.json @@ -10,27 +10,26 @@ "value": [ { "properties": { - "description": "Test", "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc", - "registrationDefinitionName": "DefinitionName", "authorizations": [ { "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc", "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" } ], - "provisioningState": "Succeeded", - "managedByTenantName": "Test Tenant" + "offerDisplayName": "Marketplace Test Offer", + "publisherDisplayName": "Marketplace Test Publisher", + "planDisplayName": "Test Plan" }, "plan": { - "name": "addesai-plan", + "name": "test-plan", "product": "test", "publisher": "marketplace-test", "version": "1.0.0" }, - "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2", - "type": "Microsoft.ManagedServices/registrationDefinitions", - "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2" + "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/marketplace-test.test.test-plan.1.0.0", + "type": "Microsoft.ManagedServices/marketplaceRegistrationDefinitions", + "name": "marketplace-test.test.test-plan.1.0.0" } ] } diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json index b3a19710450b..4c0da88970ae 100644 --- a/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/preview/2020-02-01-preview/managedservices.json @@ -444,7 +444,7 @@ "200": { "description": "OK - Returns the details of the marketplace registration definition.", "schema": { - "$ref": "#/definitions/RegistrationDefinition" + "$ref": "#/definitions/MarketplaceRegistrationDefinition" } }, "default": { @@ -779,13 +779,82 @@ }, "description": "List of registration assignments." }, + "MarketplaceRegistrationDefinition": { + "properties": { + "properties": { + "description": "Properties of a marketplace registration definition.", + "$ref": "#/definitions/MarketplaceRegistrationDefinitionProperties" + }, + "plan": { + "description": "Plan details for the managed services.", + "$ref": "#/definitions/Plan" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified path of the marketplace registration definition." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the marketplace registration definition." + } + }, + "x-ms-azure-resource": true, + "type": "object" + }, + "MarketplaceRegistrationDefinitionProperties": { + "properties": { + "managedByTenantId": { + "type": "string", + "description": "Id of the managedBy tenant." + }, + "authorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/Authorization" + }, + "description": "Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role." + }, + "eligibleAuthorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/EligibleAuthorization" + }, + "description": "Eligible PIM authorization tuple containing principal id of the user/security group or service principal, id of the built-in role, and just-in-time access policy setting" + }, + "offerDisplayName": { + "type": "string", + "description": "The marketplace offer display name." + }, + "publisherDisplayName": { + "type": "string", + "description": "The marketplace publisher display name." + }, + "planDisplayName": { + "type": "string", + "description": "The marketplace plan display name." + } + }, + "required": [ + "managedByTenantId", + "authorizations" + ], + "type": "object", + "description": "Properties of a marketplace registration definition." + }, "MarketplaceRegistrationDefinitionList": { "properties": { "value": { "type": "array", "readOnly": true, "items": { - "$ref": "#/definitions/RegistrationDefinition" + "$ref": "#/definitions/MarketplaceRegistrationDefinition" }, "description": "List of marketplace registration definitions." }, diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/examples/GetMarketplaceRegistrationDefinition.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/examples/GetMarketplaceRegistrationDefinition.json index a8d48818f2a0..7d81dfc342fb 100644 --- a/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/examples/GetMarketplaceRegistrationDefinition.json +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/examples/GetMarketplaceRegistrationDefinition.json @@ -8,27 +8,26 @@ "200": { "body": { "properties": { - "description": "Test", "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc", - "registrationDefinitionName": "DefinitionName", "authorizations": [ { "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc", "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" } ], - "provisioningState": "Succeeded", - "managedByTenantName": "Test Tenant" + "offerDisplayName": "Marketplace Test Offer", + "publisherDisplayName": "Marketplace Test Publisher", + "planDisplayName": "Test Plan" }, "plan": { - "name": "addesai-plan", + "name": "test-plan", "product": "test", "publisher": "marketplace-test", "version": "1.0.0" }, - "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2", - "type": "Microsoft.ManagedServices/registrationDefinitions", - "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2" + "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/marketplace-test.test.test-plan.1.0.0", + "type": "Microsoft.ManagedServices/marketplaceRegistrationDefinitions", + "name": "marketplace-test.test.test-plan.1.0.0" } } } diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/examples/GetMarketplaceRegistrationDefinitions.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/examples/GetMarketplaceRegistrationDefinitions.json index 39127fd4a5d3..bd2d422e11eb 100644 --- a/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/examples/GetMarketplaceRegistrationDefinitions.json +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/examples/GetMarketplaceRegistrationDefinitions.json @@ -10,27 +10,26 @@ "value": [ { "properties": { - "description": "Test", "managedByTenantId": "83ace5cd-bcc3-441a-hd86-e6a75360cecc", - "registrationDefinitionName": "DefinitionName", "authorizations": [ { "principalId": "f98g86a2-4cc4-4e6d-ad47-b3e80a1bcdfc", "roleDefinitionId": "acdd72a7-3385-48ef-bd42-f606fba81ae7" } ], - "provisioningState": "Succeeded", - "managedByTenantName": "Test Tenant" + "offerDisplayName": "Marketplace Test Offer", + "publisherDisplayName": "Marketplace Test Publisher", + "planDisplayName": "Test Plan" }, "plan": { - "name": "addesai-plan", + "name": "test-plan", "product": "test", "publisher": "marketplace-test", "version": "1.0.0" }, - "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/registrationDefinitions/26c128c2-fefa-4340-9bb1-6e081c90ada2", - "type": "Microsoft.ManagedServices/registrationDefinitions", - "name": "26c128c2-fefa-4340-9bb1-6e081c90ada2" + "id": "/subscriptions/0afefe50-734e-4610-8a82-a144ahf49dea/providers/Microsoft.ManagedServices/marketplaceRegistrationDefinitions/marketplace-test.test.test-plan.1.0.0", + "type": "Microsoft.ManagedServices/marketplaceRegistrationDefinitions", + "name": "marketplace-test.test.test-plan.1.0.0" } ] } diff --git a/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/managedservices.json b/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/managedservices.json index e51fa6947178..308312c1b835 100644 --- a/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/managedservices.json +++ b/specification/managedservices/resource-manager/Microsoft.ManagedServices/stable/2019-09-01/managedservices.json @@ -444,7 +444,7 @@ "200": { "description": "OK - Returns the details of the marketplace registration definition.", "schema": { - "$ref": "#/definitions/RegistrationDefinition" + "$ref": "#/definitions/MarketplaceRegistrationDefinition" } }, "default": { @@ -765,13 +765,75 @@ }, "description": "List of registration assignments." }, + "MarketplaceRegistrationDefinition": { + "properties": { + "properties": { + "description": "Properties of a marketplace registration definition.", + "$ref": "#/definitions/MarketplaceRegistrationDefinitionProperties" + }, + "plan": { + "description": "Plan details for the managed services.", + "$ref": "#/definitions/Plan" + }, + "id": { + "readOnly": true, + "type": "string", + "description": "Fully qualified path of the marketplace registration definition." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Type of the resource." + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Name of the marketplace registration definition." + } + }, + "x-ms-azure-resource": true, + "type": "object" + }, + "MarketplaceRegistrationDefinitionProperties": { + "properties": { + "managedByTenantId": { + "type": "string", + "description": "Id of the managedBy tenant." + }, + "authorizations": { + "type": "array", + "items": { + "$ref": "#/definitions/Authorization" + }, + "description": "Authorization tuple containing principal id of the user/security group or service principal and id of the build-in role." + }, + "offerDisplayName": { + "type": "string", + "description": "The marketplace offer display name." + }, + "publisherDisplayName": { + "type": "string", + "description": "The marketplace publisher display name." + }, + "planDisplayName": { + "type": "string", + "description": "The marketplace plan display name." + } + }, + "required": [ + "managedByTenantId", + "authorizations" + ], + "type": "object", + "description": "Properties of a marketplace registration definition." + }, "MarketplaceRegistrationDefinitionList": { "properties": { "value": { "type": "array", "readOnly": true, "items": { - "$ref": "#/definitions/RegistrationDefinition" + "$ref": "#/definitions/MarketplaceRegistrationDefinition" }, "description": "List of marketplace registration definitions." }, From 2839dc759b61945e0785cb403f7f381ef9caca06 Mon Sep 17 00:00:00 2001 From: JianyeXi <59603451+jianyexi@users.noreply.github.com> Date: Tue, 7 Jul 2020 17:48:44 +0800 Subject: [PATCH 273/318] fix linter doc errors (#10039) Co-authored-by: jianyexi --- documentation/openapi-authoring-automated-guidelines.md | 5 ++--- 1 file changed, 2 insertions(+), 3 deletions(-) diff --git a/documentation/openapi-authoring-automated-guidelines.md b/documentation/openapi-authoring-automated-guidelines.md index 848f8f89f120..1202a11e02d0 100644 --- a/documentation/openapi-authoring-automated-guidelines.md +++ b/documentation/openapi-authoring-automated-guidelines.md @@ -1132,7 +1132,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Description**: Per [ARM guidelines](https://github.com/Azure/azure-resource-manager-rpc/blob/master/v1.0/resource-api-reference.md), a `Resource` model must have the `name`, `id` and `type` properties defined as `readOnly` in its hierarchy. -**Why the rule is important**: `name`, `type` and `id` are readonly properties set on the service end. Also, per ARM guidelines each `Resource` type model must have these properties defined in its hierarchy. An example `Resource` definition can be found [here](https://github.com/Azure/azure-rest-api-specs-pr/blob/master/common-types/resource-management/v1/types.json#L3). +**Why the rule is important**: `name`, `type` and `id` are readonly properties set on the service end. Also, per ARM guidelines each `Resource` type model must have these properties defined in its hierarchy. An example `Resource` definition can be found [here](https://github.com/Azure/azure-rest-api-specs/blob/master/specification/common-types/resource-management/v1/types.json#L9). **How to fix the violation**: Ensure the `Resource` type model has the properties `name`, `type` and `id` and they are marked as `readOnly:true`. @@ -1927,7 +1927,7 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul ### R3020 PathResourceProviderNamePascalCase -**Category** : ARM Warning +**Category** : ARM Error **Applies to** : ARM and Data Plane OpenAPI(swagger) specs @@ -2410,7 +2410,6 @@ Links: [Index](#index) | [Error vs. Warning](#error-vs-warning) | [Automated Rul **Output Message** : The response of operation '{operation name }' is defined without 'systemData'. Consider adding the systemData to the response. **Description** : The responses of GET, PUT and PATCH in new API versions should contain the `systemData` object.The version after 2020-05-01 consider as a new API version. -For more information, see: [AzureRPCSystemData-RP_Copy.docx](https://microsoft.sharepoint.com/:w:/t/Operations_Management_Suite/EZP2GBYnvsRKnSmJ_FXV4jkBUz6xG_glzG3KVnmHN9Q0qA?e=99dfOo). **CreatedAt**: May 21, 2020 From 4e59cc44f2e5a24a7fc55eca2a92a803b5386864 Mon Sep 17 00:00:00 2001 From: lapradh <66009265+lapradh@users.noreply.github.com> Date: Tue, 7 Jul 2020 18:30:27 +0530 Subject: [PATCH 274/318] Update bms.json (#10030) * Update bms.json * added back enum for health status with description to deprecate later * Update bms.json removed unused enums --- .../stable/2019-06-15/bms.json | 63 +------------------ 1 file changed, 3 insertions(+), 60 deletions(-) diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json index d9b32439141c..e097d62a7f07 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json @@ -1302,32 +1302,6 @@ "modelAsString": true } }, - "healthStatus": { - "description": "Health status of protected item.", - "enum": [ - "Passed", - "ActionRequired", - "ActionSuggested", - "Healthy", - "TransientDegraded", - "PersistentDegraded", - "TransientUnhealthy", - "PersistentUnhealthy", - "Invalid" - ], - "type": "string", - "x-ms-enum": { - "name": "HealthStatus", - "modelAsString": true - } - }, - "healthDetails": { - "description": "Health details on this backup item.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthDetails" - } - }, "lastBackupStatus": { "description": "Last backup operation status. Possible values: Healthy, Unhealthy.", "type": "string" @@ -1630,7 +1604,7 @@ } } }, - "HealthDetails": { + "ResourceHealthDetails": { "description": "Health Details for backup items.", "type": "object", "properties": { @@ -1665,7 +1639,7 @@ "type": "object", "allOf": [ { - "$ref": "#/definitions/HealthDetails" + "$ref": "#/definitions/ResourceHealthDetails" } ] }, @@ -1837,16 +1811,11 @@ } }, "healthStatus": { - "description": "Health status of protected item", + "description": "Health status of protected item.", "enum": [ "Passed", "ActionRequired", "ActionSuggested", - "Healthy", - "TransientDegraded", - "PersistentDegraded", - "TransientUnhealthy", - "PersistentUnhealthy", "Invalid" ], "type": "string", @@ -2208,32 +2177,6 @@ "modelAsString": true } }, - "healthStatus": { - "description": "Health status of protected item.", - "enum": [ - "Passed", - "ActionRequired", - "ActionSuggested", - "Healthy", - "TransientDegraded", - "PersistentDegraded", - "TransientUnhealthy", - "PersistentUnhealthy", - "Invalid" - ], - "type": "string", - "x-ms-enum": { - "name": "HealthStatus", - "modelAsString": true - } - }, - "healthDetails": { - "description": "Health details on this backup item.", - "type": "array", - "items": { - "$ref": "#/definitions/HealthDetails" - } - }, "extendedInfo": { "$ref": "#/definitions/AzureVmWorkloadProtectedItemExtendedInfo", "description": "Additional information for this backup item." From 452b7b6e0a6cba884e9e45872a7f7043b51c2b3b Mon Sep 17 00:00:00 2001 From: Vivian Liu Date: Tue, 7 Jul 2020 09:42:04 -0700 Subject: [PATCH 275/318] IoT Central API user changes (#10014) * user changes * Ran prettier * Spell check fix * Removed format email --- custom-words.txt | 1 + .../examples/apitoken_create.json | 8 +- .../examples/apitoken_get.json | 8 +- .../examples/apitoken_list.json | 4 +- .../examples/users_delete.json | 12 + .../examples/users_get.json | 23 ++ .../examples/users_list.json | 37 +++ .../examples/users_set.json | 31 +++ .../examples/users_set_serviceprincipal.json | 34 +++ .../2019-10-28-preview/iotcentral.json | 225 ++++++++++++++++-- .../2019-10-28-preview/iotcentralapps.json | 11 +- 11 files changed, 363 insertions(+), 31 deletions(-) create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_delete.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_get.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_list.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_set.json create mode 100644 specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_set_serviceprincipal.json diff --git a/custom-words.txt b/custom-words.txt index c59d6461e5d1..ec49c03b070a 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -1380,6 +1380,7 @@ servicefabricmesh servicefabrics servicemap servicemembers +serviceprincipal servicerunners servicestats servicetopology diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_create.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_create.json index 5d6311ea78f5..a55322ee1034 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_create.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_create.json @@ -7,7 +7,9 @@ "token_id": "testtoken", "body": { "roles": [ - "c7be2c6b-797e-4551-bb24-33709f6b2e20" + { + "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + } ] } }, @@ -16,7 +18,9 @@ "body": { "id": "testtoken", "roles": [ - "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + { + "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + } ], "expiry": "2020-10-18T18:30:40.227Z", "token": "SharedAccessSignature sr=..." diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_get.json index 007cec68ff29..5fe99dd8058e 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_get.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_get.json @@ -1,6 +1,6 @@ { - "title": "Get API tokens in your application", - "description": "Get a list of API tokens in your application.", + "title": "Get an API token in your application", + "description": "Get an API token by Id in your application.", "parameters": { "centralDnsSuffixInPath": "azureiotcentral.com", "subdomain": "appsubdomain", @@ -11,7 +11,9 @@ "body": { "id": "testtoken", "roles": [ - "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + { + "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + } ], "expiry": "2020-10-18T18:30:40.227Z" } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_list.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_list.json index f7a1c35aeeda..5dde63f15be0 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_list.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/apitoken_list.json @@ -12,7 +12,9 @@ { "id": "testtoken", "roles": [ - "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + { + "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + } ], "expiry": "2020-10-18T18:30:40.227Z" } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_delete.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_delete.json new file mode 100644 index 000000000000..c0219a703918 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_delete.json @@ -0,0 +1,12 @@ +{ + "title": "Remove a user", + "description": "Remove a user from the application by Id.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain", + "user_id": "abc" + }, + "responses": { + "204": {} + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_get.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_get.json new file mode 100644 index 000000000000..be97832401c6 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_get.json @@ -0,0 +1,23 @@ +{ + "title": "Get a user in your application", + "description": "Get a user by Id in your application.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain", + "user_id": "abc" + }, + "responses": { + "200": { + "body": { + "id": "abc", + "type": "EmailUser", + "roles": [ + { + "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + } + ], + "email": "alice@contoso.com" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_list.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_list.json new file mode 100644 index 000000000000..d9f0290c760a --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_list.json @@ -0,0 +1,37 @@ +{ + "title": "List users in your application", + "description": "Get a list of users in your application.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "af0d5b8f-7a69-4521-868e-19745fae353f", + "type": "EmailUser", + "roles": [ + { + "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + } + ], + "email": "alice@contoso.com" + }, + { + "id": "123", + "type": "ServicePrincipalUser", + "roles": [ + { + "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + } + ], + "tenantId": "72f988bf-86f1-41af-91ab-2d7cd011db47", + "objectId": "9071c899-bce0-4862-b208-75dabae226a9" + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_set.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_set.json new file mode 100644 index 000000000000..98466284fe66 --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_set.json @@ -0,0 +1,31 @@ +{ + "title": "Add or update an email user in your application", + "description": "Add or update an email user in your application.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain", + "user_id": "123", + "body": { + "type": "EmailUser", + "roles": [ + { + "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + } + ], + "email": "bob@contoso.com" + } + }, + "responses": { + "200": { + "body": { + "type": "EmailUser", + "roles": [ + { + "role": "ca310b8d-2f4a-44e0-a36e-957c202cd8d4" + } + ], + "email": "bob@contoso.com" + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_set_serviceprincipal.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_set_serviceprincipal.json new file mode 100644 index 000000000000..0f7a29c171fc --- /dev/null +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/examples/users_set_serviceprincipal.json @@ -0,0 +1,34 @@ +{ + "title": "Add or update a service principal in your application", + "description": "Add or update an AAD service principal in your application.", + "parameters": { + "centralDnsSuffixInPath": "azureiotcentral.com", + "subdomain": "appsubdomain", + "user_id": "123", + "body": { + "type": "ServicePrincipalUser", + "tenantId": "027fdad7-cf0f-470a-a26a-272197813322", + "objectId": "65e13aac-1443-4c49-9d49-57b87197cfff", + "roles": [ + { + "role": "c7be2c6b-797e-4551-bb24-33709f6b2e20" + } + ] + } + }, + "responses": { + "200": { + "body": { + "id": "123", + "type": "ServicePrincipalUser", + "tenantId": "027fdad7-cf0f-470a-a26a-272197813322", + "objectId": "65e13aac-1443-4c49-9d49-57b87197cfff", + "roles": [ + { + "role": "c7be2c6b-797e-4551-bb24-33709f6b2e20" + } + ] + } + } + } +} diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json index e6db1b5e77a2..0d512680cfed 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentral.json @@ -494,6 +494,25 @@ "value" ] }, + "EmailUser": { + "allOf": [ + { + "$ref": "#/definitions/User" + }, + { + "type": "object", + "properties": { + "email": { + "description": "Email address of the user.", + "type": "string" + } + }, + "required": [ + "email" + ] + } + ] + }, "Endpoint": { "type": "object", "properties": { @@ -766,10 +785,19 @@ "type": "object", "properties": { "roles": { - "description": "List of role IDs that specify the permissions to access the application.", + "description": "List of roles that specify the permissions to access the application.", "type": "array", "items": { - "type": "string" + "type": "object", + "properties": { + "role": { + "description": "ID that specifies the role assignment for this role.", + "type": "string" + } + }, + "required": [ + "role" + ] }, "minItems": 1 } @@ -851,6 +879,30 @@ } ] }, + "ServicePrincipalUser": { + "allOf": [ + { + "$ref": "#/definitions/User" + }, + { + "type": "object", + "properties": { + "tenantId": { + "description": "The AAD tenant ID of the service principal.", + "type": "string" + }, + "objectId": { + "description": "The AAD object ID of the service principal.", + "type": "string" + } + }, + "required": [ + "tenantId", + "objectId" + ] + } + ] + }, "SolutionModel": { "allOf": [ { @@ -909,7 +961,6 @@ ] }, "SymmetricKeyAttestation": { - "x-ms-discriminator-value": "SymmetricKeyAttestation", "allOf": [ { "$ref": "#/definitions/Attestation" @@ -941,7 +992,6 @@ ] }, "TpmAttestation": { - "x-ms-discriminator-value": "TpmAttestation", "allOf": [ { "$ref": "#/definitions/Attestation" @@ -960,6 +1010,50 @@ } ] }, + "User": { + "allOf": [ + { + "$ref": "#/definitions/Permission" + }, + { + "type": "object", + "properties": { + "id": { + "description": "Unique ID of the user.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "Type of the user.", + "type": "string" + } + }, + "required": [ + "type" + ], + "discriminator": "type" + } + ] + }, + "UserCollection": { + "type": "object", + "properties": { + "value": { + "description": "The collection of users.", + "type": "array", + "items": { + "$ref": "#/definitions/User" + } + }, + "nextLink": { + "description": "URL to get the next page of users.", + "type": "string" + } + }, + "required": [ + "value" + ] + }, "ValueDetail": { "allOf": [ { @@ -1027,7 +1121,6 @@ } }, "X509Attestation": { - "x-ms-discriminator-value": "X509Attestation", "allOf": [ { "$ref": "#/definitions/Attestation" @@ -2297,6 +2390,117 @@ } } } + }, + "/users": { + "get": { + "operationId": "Users_List", + "summary": "Get the list of users in an application", + "x-ms-examples": { + "List users": { + "$ref": "./examples/users_list.json" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/UserCollection" + } + } + } + } + }, + "/users/{user_id}": { + "get": { + "operationId": "Users_Get", + "summary": "Get a user by ID", + "x-ms-examples": { + "Get a user by ID": { + "$ref": "./examples/users_get.json" + } + }, + "parameters": [ + { + "in": "path", + "name": "user_id", + "description": "Unique ID of the user.", + "type": "string", + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/User" + } + } + } + }, + "put": { + "operationId": "Users_Set", + "summary": "Create or update a user in the application", + "x-ms-examples": { + "Add or update a service principal user": { + "$ref": "./examples/users_set_serviceprincipal.json" + }, + "Add or update an email user": { + "$ref": "./examples/users_set.json" + } + }, + "parameters": [ + { + "in": "path", + "name": "user_id", + "description": "Unique ID of the user.", + "type": "string", + "required": true + }, + { + "in": "body", + "name": "body", + "description": "User body.", + "schema": { + "$ref": "#/definitions/User" + }, + "required": true + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/User" + } + } + } + }, + "delete": { + "operationId": "Users_Remove", + "summary": "Delete a user", + "x-ms-examples": { + "Delete a user": { + "$ref": "./examples/users_delete.json" + } + }, + "parameters": [ + { + "in": "path", + "name": "user_id", + "description": "Unique ID of the user.", + "type": "string", + "required": true + } + ], + "responses": { + "204": { + "description": "Success" + } + } + } } }, "parameters": { @@ -2368,11 +2572,6 @@ } }, "securityDefinitions": { - "APIKeyHeader": { - "type": "apiKey", - "in": "header", - "name": "Authorization" - }, "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", @@ -2383,9 +2582,5 @@ } } }, - "security": [ - { - "APIKeyHeader": [] - } - ] + "security": [] } diff --git a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json index f8ad6cee92c4..6745556b6fee 100644 --- a/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json +++ b/specification/iotcentral/data-plane/Microsoft.IoTCentral/preview/2019-10-28-preview/iotcentralapps.json @@ -128,11 +128,6 @@ } }, "securityDefinitions": { - "APIKeyHeader": { - "type": "apiKey", - "in": "header", - "name": "Authorization" - }, "azure_auth": { "type": "oauth2", "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", @@ -143,9 +138,5 @@ } } }, - "security": [ - { - "APIKeyHeader": [] - } - ] + "security": [] } From 7388ad664b13b1d77bc2ec5a40d588b839e5d246 Mon Sep 17 00:00:00 2001 From: Laurent Mazuel Date: Tue, 7 Jul 2020 09:46:58 -0700 Subject: [PATCH 276/318] Split Synapse into three distributions packages for Python (#10011) --- specification/synapse/data-plane/readme.python.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/synapse/data-plane/readme.python.md b/specification/synapse/data-plane/readme.python.md index 30169a5bf708..0ea1d2fe60b5 100644 --- a/specification/synapse/data-plane/readme.python.md +++ b/specification/synapse/data-plane/readme.python.md @@ -20,15 +20,15 @@ batch: ``` yaml $(package-spark) no-namespace-folders: true namespace: azure.synapse.spark -output-folder: $(python-sdks-folder)/synapse/azure-synapse/azure/synapse/spark +output-folder: $(python-sdks-folder)/synapse/azure-synapse-spark/azure/synapse/spark ``` ``` yaml $(package-artifacts) no-namespace-folders: true namespace: azure.synapse.artifacts -output-folder: $(python-sdks-folder)/synapse/azure-synapse/azure/synapse/artifacts +output-folder: $(python-sdks-folder)/synapse/azure-synapse-artifacts/azure/synapse/artifacts ``` ``` yaml $(package-access-control) no-namespace-folders: true namespace: azure.synapse.accesscontrol -output-folder: $(python-sdks-folder)/synapse/azure-synapse/azure/synapse/accesscontrol +output-folder: $(python-sdks-folder)/synapse/azure-synapse-accesscontrol/azure/synapse/accesscontrol ``` From 5a73005b3cdbcadbc6d210de0b21e9ed6ba17c2b Mon Sep 17 00:00:00 2001 From: giakas Date: Tue, 7 Jul 2020 09:47:49 -0700 Subject: [PATCH 277/318] LVA update tagname, C# namespace and few properties (#10027) * update the lva version and few C# autorest parameters * LVA Update C# namespace and some properties * update tag --- specification/mediaservices/data-plane/readme.md | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/specification/mediaservices/data-plane/readme.md b/specification/mediaservices/data-plane/readme.md index 47663592b1e0..a43ff67118e7 100644 --- a/specification/mediaservices/data-plane/readme.md +++ b/specification/mediaservices/data-plane/readme.md @@ -26,15 +26,14 @@ These are the global settings for the Live video analytics API. ``` yaml openapi-type: data-plane -tag: package-lva-1-0-0-preview -opt-in-extensible-enums: true +tag: package-lva-1-0-preview ``` ### Tag: package-2018-07 -These settings apply only when `--tag=package-lva-1-0-0-preview` is specified on the command line. +These settings apply only when `--tag=package-lva-1-0-preview` is specified on the command line. -``` yaml $(tag) == 'package-lva-1-0-0-preview' +``` yaml $(tag) == 'package-lva-1-0-preview' input-file: - LiveVideoAnalytics.Edge/preview/1.0/LiveVideoAnalytics.json ``` @@ -65,8 +64,8 @@ csharp: azure-arm: false payload-flattening-threshold: 2 license-header: MICROSOFT_MIT_NO_VERSION - namespace: Azure.Media.LiveVideoAnalytics.Edge - output-folder: $(csharp-sdks-folder)/mediaservices/Azure.Media.LiveVideoAnalytics.Edge/src/Generated + namespace: Microsoft.Azure.Media.LiveVideoAnalytics.Edge + output-folder: $(csharp-sdks-folder)/mediaservices/Microsoft.Azure.Media.LiveVideoAnalytics.Edge/src/Generated clear-output-folder: true use-internal-constructors: true override-client-name: LiveVideoAnalyticsEdgeClient From e60f1b4f483841b9c812a9a0f8dd37e9896a6d54 Mon Sep 17 00:00:00 2001 From: Lei Ni <7233663+leni-msft@users.noreply.github.com> Date: Wed, 8 Jul 2020 10:23:20 +0800 Subject: [PATCH 278/318] fix schema generation failure for securityinsights (#10038) --- .../stable/2020-01-01/SecurityInsights.json | 6 +----- 1 file changed, 1 insertion(+), 5 deletions(-) diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json index c6cc554ad423..daac982bd922 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/stable/2020-01-01/SecurityInsights.json @@ -1702,11 +1702,7 @@ "description": "Alerts data type for data connectors.", "properties": { "alerts": { - "allOf": [ - { - "$ref": "#/definitions/DataConnectorDataTypeCommon" - } - ], + "$ref": "#/definitions/DataConnectorDataTypeCommon", "description": "Alerts data type connection.", "type": "object" } From 19a2cf7a64fc5b221ee3e73a6811ddaba3866da9 Mon Sep 17 00:00:00 2001 From: Daniel Orozco <64658732+dagoroz@users.noreply.github.com> Date: Tue, 7 Jul 2020 20:51:22 -0700 Subject: [PATCH 279/318] [Hub Generated] Review request for Microsoft.Authorization to add version preview/2020-04-01-preview (#9971) --- .../authorization-RoleAssignmentsCalls.json | 687 ++++++++++++++++++ .../examples/DeleteRoleAssignmentById.json | 26 + .../examples/DeleteRoleAssignmentByName.json | 26 + .../examples/GetAllRoleAssignments.json | 29 + .../examples/GetRoleAssignmentById.json | 25 + .../examples/GetRoleAssignmentByName.json | 27 + .../examples/GetRoleAssignmentByScope.json | 29 + .../GetRoleAssignmentsForResource.json | 34 + .../GetRoleAssignmentsForResourceGroup.json | 30 + .../examples/PutRoleAssignment.json | 37 + .../examples/PutRoleAssignmentById.json | 37 + .../authorization/resource-manager/readme.md | 65 +- 12 files changed, 1041 insertions(+), 11 deletions(-) create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/authorization-RoleAssignmentsCalls.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/DeleteRoleAssignmentById.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/DeleteRoleAssignmentByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetAllRoleAssignments.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentById.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentByName.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentByScope.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentsForResource.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentsForResourceGroup.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/PutRoleAssignment.json create mode 100644 specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/PutRoleAssignmentById.json diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/authorization-RoleAssignmentsCalls.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/authorization-RoleAssignmentsCalls.json new file mode 100644 index 000000000000..c6733a4380c0 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/authorization-RoleAssignmentsCalls.json @@ -0,0 +1,687 @@ +{ + "swagger": "2.0", + "info": { + "title": "AuthorizationManagementClient", + "version": "2020-04-01-preview", + "description": "Role based access control provides you a way to apply granular level policy administration down to individual resources or resource groups. These operations enable you to manage role assignments. A role assignment grants access to Azure Active Directory users." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/subscriptions/{subscriptionId}/resourcegroups/{resourceGroupName}/providers/{resourceProviderNamespace}/{parentResourcePath}/{resourceType}/{resourceName}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListForResource", + "description": "Gets role assignments for a resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ResourceProviderNamespaceParameter" + }, + { + "name": "parentResourcePath", + "in": "path", + "required": true, + "type": "string", + "description": "The parent resource identity.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceType", + "in": "path", + "required": true, + "type": "string", + "description": "The resource type of the resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "resourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource to get role assignments for." + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentsForResource.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListForResourceGroup", + "description": "Gets role assignments for a resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentsForResourceGroup.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignments/{roleAssignmentName}": { + "delete": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Delete", + "description": "Deletes a role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment to delete.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to delete." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/DeleteRoleAssignmentByName.json" + } + } + }, + "put": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Create", + "description": "Creates a role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment to create. The scope can be any REST resource instance. For example, use '/subscriptions/{subscription-id}/' for a subscription, '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}' for a resource group, and '/subscriptions/{subscription-id}/resourceGroups/{resource-group-name}/providers/{resource-provider}/{resource-type}/{resource-name}' for a resource.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to create. It can be any valid GUID." + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentCreateParameters" + }, + "description": "Parameters for the role assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/PutRoleAssignment.json" + } + } + }, + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_Get", + "description": "Get the specified role assignment.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignment.", + "x-ms-skip-url-encoding": true + }, + { + "name": "roleAssignmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the role assignment to get." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentByName.json" + } + } + } + }, + "/{roleId}": { + "delete": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_DeleteById", + "description": "Deletes a role assignment.", + "parameters": [ + { + "name": "roleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role assignment to delete.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns information about the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/DeleteRoleAssignmentById.json" + } + } + }, + "put": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_CreateById", + "description": "Creates a role assignment by ID.", + "parameters": [ + { + "name": "roleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role assignment to create.", + "x-ms-skip-url-encoding": true + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/RoleAssignmentCreateParameters" + }, + "description": "Parameters for the role assignment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "201": { + "description": "Created - Returns the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/PutRoleAssignmentById.json" + } + } + }, + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_GetById", + "description": "Gets a role assignment by ID.", + "parameters": [ + { + "name": "roleId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the role assignment to get.", + "x-ms-skip-url-encoding": true + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns the role assignment.", + "schema": { + "$ref": "#/definitions/RoleAssignment" + } + } + }, + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentById.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_List", + "description": "Gets all role assignments for the subscription.", + "parameters": [ + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetAllRoleAssignments.json" + } + } + } + }, + "/{scope}/providers/Microsoft.Authorization/roleAssignments": { + "get": { + "tags": [ + "RoleAssignments" + ], + "operationId": "RoleAssignments_ListForScope", + "description": "Gets role assignments for a scope.", + "parameters": [ + { + "name": "scope", + "in": "path", + "required": true, + "type": "string", + "description": "The scope of the role assignments.", + "x-ms-skip-url-encoding": true + }, + { + "name": "$filter", + "in": "query", + "required": false, + "type": "string", + "description": "The filter to apply on the operation. Use $filter=atScope() to return all role assignments at or above the scope. Use $filter=principalId eq {id} to return all role assignments at, above or below the scope for the specified principal." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns an array of role assignments.", + "schema": { + "$ref": "#/definitions/RoleAssignmentListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-odata": "#/definitions/RoleAssignmentFilter", + "x-ms-examples": { + "GetConfigurations": { + "$ref": "./examples/GetRoleAssignmentByScope.json" + } + } + } + } + }, + "definitions": { + "RoleAssignmentFilter": { + "properties": { + "principalId": { + "type": "string", + "description": "Returns role assignment of the specific principal." + }, + "canDelegate": { + "type": "boolean", + "description": "The Delegation flag for the role assignment" + } + }, + "description": "Role Assignments filter" + }, + "RoleAssignmentPropertiesWithScope": { + "properties": { + "scope": { + "type": "string", + "description": "The role assignment scope." + }, + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID." + }, + "principalId": { + "type": "string", + "description": "The principal ID." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "Unknown", + "DirectoryRoleTemplate", + "ForeignGroup", + "Application", + "MSI", + "DirectoryObjectOrGroup", + "Everyone" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + } + }, + "canDelegate": { + "type": "boolean", + "description": "The Delegation flag for the role assignment" + }, + "description": { + "type": "string", + "description": "Description of role assignment" + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment. This limits the resources it can be assigned to. e.g.: @Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition. Currently accepted values are '1.0' or '2.0'" + } + }, + "description": "Role assignment properties with scope." + }, + "RoleAssignment": { + "properties": { + "id": { + "type": "string", + "readOnly": true, + "description": "The role assignment ID." + }, + "name": { + "type": "string", + "readOnly": true, + "description": "The role assignment name." + }, + "type": { + "type": "string", + "readOnly": true, + "description": "The role assignment type." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentPropertiesWithScope", + "description": "Role assignment properties." + } + }, + "description": "Role Assignments" + }, + "RoleAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/RoleAssignment" + }, + "description": "Role assignment list." + }, + "nextLink": { + "type": "string", + "description": "The URL to use for getting the next set of results." + } + }, + "description": "Role assignment list operation result." + }, + "RoleAssignmentProperties": { + "properties": { + "roleDefinitionId": { + "type": "string", + "description": "The role definition ID used in the role assignment." + }, + "principalId": { + "type": "string", + "description": "The principal ID assigned to the role. This maps to the ID inside the Active Directory. It can point to a user, service principal, or security group." + }, + "principalType": { + "type": "string", + "description": "The principal type of the assigned principal ID.", + "enum": [ + "User", + "Group", + "ServicePrincipal", + "Unknown", + "DirectoryRoleTemplate", + "ForeignGroup", + "Application", + "MSI", + "DirectoryObjectOrGroup", + "Everyone" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + } + }, + "canDelegate": { + "type": "boolean", + "description": "The delegation flag used for creating a role assignment" + }, + "description": { + "type": "string", + "description": "Description of role assignment" + }, + "condition": { + "type": "string", + "description": "The conditions on the role assignment" + }, + "conditionVersion": { + "type": "string", + "description": "Version of the condition" + } + }, + "required": [ + "roleDefinitionId", + "principalId" + ], + "description": "Role assignment properties." + }, + "RoleAssignmentCreateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/RoleAssignmentProperties", + "description": "Role assignment properties." + } + }, + "required": [ + "properties" + ], + "description": "Role assignment create parameters." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "The ID of the target subscription." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "The API version to use for this operation." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the resource group.", + "x-ms-parameter-location": "method" + }, + "ResourceProviderNamespaceParameter": { + "name": "resourceProviderNamespace", + "in": "path", + "required": true, + "type": "string", + "description": "The namespace of the resource provider.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/DeleteRoleAssignmentById.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/DeleteRoleAssignmentById.json new file mode 100644 index 000000000000..79a4930d5d95 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/DeleteRoleAssignmentById.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "scope": "scope", + "roleId": "roleAssignmentId", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", + "principalId": "Pid", + "principalType": "Ptype", + "scope": "/subscriptions/subId/resourcegroups/rgname", + "canDelegate": false + }, + "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "roleassignmentId" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/DeleteRoleAssignmentByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/DeleteRoleAssignmentByName.json new file mode 100644 index 000000000000..bf403661e286 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/DeleteRoleAssignmentByName.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "scope": "scope", + "roleAssignmentName": "roleAssignmentName", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", + "principalId": "Pid", + "principalType": "Ptype", + "scope": "/subscriptions/subId/resourcegroups/rgname", + "canDelegate": false + }, + "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "roleassignmentId" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetAllRoleAssignments.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetAllRoleAssignments.json new file mode 100644 index 000000000000..f2f280fce64a --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetAllRoleAssignments.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "subId", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", + "principalId": "Pid", + "principalType": "Ptype", + "scope": "/subscriptions/subId/resourcegroups/rgname", + "canDelegate": false + }, + "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "raId" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentById.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentById.json new file mode 100644 index 000000000000..ecbaeb7de321 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentById.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "roleId": "roleassignmentId", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", + "principalId": "Pid", + "principalType": "Ptype", + "scope": "/subscriptions/subId/resourcegroups/rgname", + "canDelegate": false + }, + "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "roleassignmentId" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentByName.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentByName.json new file mode 100644 index 000000000000..202df15a909d --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentByName.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "scope": "scope", + "roleAssignmentName": "roleAssignmentName", + "subscriptionId": "subId", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", + "principalId": "Pid", + "principalType": "Ptype", + "scope": "/subscriptions/subId/resourcegroups/rgname", + "canDelegate": false + }, + "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "raId" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentByScope.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentByScope.json new file mode 100644 index 000000000000..5fe6140ed25c --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentByScope.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "scope": "scope", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", + "principalId": "Pid", + "principalType": "Ptype", + "scope": "/subscriptions/subId/resourcegroups/rgname", + "canDelegate": false + }, + "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "raId" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentsForResource.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentsForResource.json new file mode 100644 index 000000000000..350bd409baf2 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentsForResource.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "resourceGroupName": "rgname", + "resourceProviderNamespace": "resourceProviderNamespace", + "parentResourcePath": "parentResourcePath", + "resourceType": "resourceType", + "resourceName": "resourceName", + "subscriptionId": "subId", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", + "principalId": "Pid", + "principalType": "Ptype", + "scope": "/subscriptions/subId/resourcegroups/rgname", + "canDelegate": false + }, + "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "raId" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentsForResourceGroup.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentsForResourceGroup.json new file mode 100644 index 000000000000..df3eb34a02cb --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/GetRoleAssignmentsForResourceGroup.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "resourceGroupName": "rgname", + "subscriptionId": "subId", + "api-version": "2020-04-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", + "principalId": "Pid", + "principalType": "Ptype", + "scope": "/subscriptions/subId/resourcegroups/rgname", + "canDelegate": false + }, + "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "raId" + } + ] + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/PutRoleAssignment.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/PutRoleAssignment.json new file mode 100644 index 000000000000..c87cfe4307e7 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/PutRoleAssignment.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "scope": "scope", + "roleAssignmentName": "roleAssignmentName", + "parameters": { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/providers/Microsoft.Authorization/roleDefinitions/de139f84-1756-47ae-9be6-808fbbe84772", + "principalId": "d93a38bc-d029-4160-bfb0-fbda779ac214", + "principalType": "User", + "canDelegate": false + } + }, + "api-version": "2020-04-01-preview" + }, + "responses": { + "201": { + "body": { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", + "principalId": "Pid", + "principalType": "Ptype", + "scope": "/subscriptions/subId/resourcegroups/rgname", + "canDelegate": false + }, + "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "roleassignmentId" + } + } + } +} diff --git a/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/PutRoleAssignmentById.json b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/PutRoleAssignmentById.json new file mode 100644 index 000000000000..965fb76e36b5 --- /dev/null +++ b/specification/authorization/resource-manager/Microsoft.Authorization/preview/2020-04-01-preview/examples/PutRoleAssignmentById.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "scope": "scope", + "roleId": "roleAssignmentId", + "parameters": { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/4004a9fd-d58e-48dc-aeb2-4a4aec58606f/providers/Microsoft.Authorization/roleDefinitions/de139f84-1756-47ae-9be6-808fbbe84772", + "principalId": "d93a38bc-d029-4160-bfb0-fbda779ac214", + "principalType": "User", + "canDelegate": false + } + }, + "api-version": "2020-04-01-preview" + }, + "responses": { + "201": { + "body": { + "properties": { + "condition": "@Resource[Microsoft.Storage/storageAccounts/blobServices/containers:ContainerName] StringEqualsIgnoreCase 'foo_storage_container'", + "conditionVersion": "1.0", + "description": "Grants UserFoo role assignment bar in scope baz", + "roleDefinitionId": "/subscriptions/subId/providers/Microsoft.Authorization/roleDefinitions/roledefinitionId", + "principalId": "Pid", + "principalType": "Ptype", + "scope": "/subscriptions/subId/resourcegroups/rgname", + "canDelegate": false + }, + "id": "/subscriptions/subId/resourcegroups/rgname/providers/Microsoft.Authorization/roleAssignments/roleassignmentId", + "type": "Microsoft.Authorization/roleAssignments", + "name": "roleassignmentId" + } + } + } +} diff --git a/specification/authorization/resource-manager/readme.md b/specification/authorization/resource-manager/readme.md index 88cac5ab776c..f87f85d6af53 100644 --- a/specification/authorization/resource-manager/readme.md +++ b/specification/authorization/resource-manager/readme.md @@ -4,10 +4,10 @@ This is the AutoRest configuration file for Authorization. - - --- + ## Getting Started + To build the SDK for Authorization, simply [Install AutoRest](https://aka.ms/autorest/install) and in this folder, run: > `autorest` @@ -15,28 +15,72 @@ To build the SDK for Authorization, simply [Install AutoRest](https://aka.ms/aut To see additional help and options, run: > `autorest --help` + --- ## Configuration - - ### Basic Information + These are the global settings for the Authorization API. ``` yaml openapi-type: arm -tag: package-2018-09-01-preview +tag: package-2020-04-preview ``` ## Suppression + ``` yaml directive: - suppress: OperationsAPIImplementation reason: we do have a operations api as "/providers/Microsoft.Authorization/operations" - #where: - # - $.paths["/providers/Microsoft.Authorization/operations"] + - suppress: OperationIdNounConflictingModelNames + where: '$.paths["/providers/Microsoft.Authorization/providerOperations/{resourceProviderNamespace}"].get.operationId' + from: authorization-ProviderOperationsCalls.json + reason: the full operationId value is "ProviderOperationsMetadata_Get" the linter does not seem to be picking what's after the '_' + - suppress: OperationIdNounConflictingModelNames + where: '$.paths["/providers/Microsoft.Authorization/providerOperations"].get.operationId' + from: authorization-ProviderOperationsCalls.json + reason: the full operationId value is "ProviderOperationsMetadata_List" the linter does not seem to be picking what's after the '_' + - suppress: EnumInsteadOfBoolean + where: $.definitions.RoleAssignmentFilter.properties.canDelegate + from: authorization-RoleAssignmentsCalls.json + reason: for this case the result of the proposed change would resemble a boolean anyways + - suppress: EnumInsteadOfBoolean + where: $.definitions.RoleAssignmentPropertiesWithScope.properties.canDelegate + from: authorization-RoleAssignmentsCalls.json + reason: for this case the result of the proposed change would resemble a boolean anyways + - suppress: EnumInsteadOfBoolean + where: $.definitions.RoleAssignmentProperties.properties.canDelegate + from: authorization-RoleAssignmentsCalls.json + reason: for this case the result of the proposed change would resemble a boolean anyways + - suppress: EnumInsteadOfBoolean + where: $.definitions.ProviderOperation.properties.isDataAction + from: authorization-ProviderOperationsCalls.json + reason: for this case the result of the proposed change would resemble a boolean anyways + - suppress: EnumInsteadOfBoolean + where: $.definitions.DenyAssignmentProperties.properties.doNotApplyToChildScopes + from: authorization-DenyAssignmentGetCalls.json + reason: for this case the result of the proposed change would resemble a boolean anyways + - suppress: EnumInsteadOfBoolean + where: $.definitions.DenyAssignmentProperties.properties.isSystemProtected + from: authorization-DenyAssignmentGetCalls.json + reason: for this case the result of the proposed change would resemble a boolean anyways +``` + +### Tag: package-2020-04-preview +These settings apply only when `--tag=package-2020-04-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-04-preview' +input-file: +- Microsoft.Authorization/preview/2015-06-01/authorization-ClassicAdminCalls.json +- Microsoft.Authorization/stable/2015-07-01/authorization-ElevateAccessCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-ProviderOperationsCalls.json +- Microsoft.Authorization/preview/2018-01-01-preview/authorization-RoleDefinitionsCalls.json +- Microsoft.Authorization/preview/2018-07-01-preview/authorization-DenyAssignmentGetCalls.json +- Microsoft.Authorization/preview/2020-04-01-preview/authorization-RoleAssignmentsCalls.json ``` ### Tag: package-2015-07-01 @@ -167,8 +211,8 @@ input-file: ``` --- -# Code Generation +# Code Generation ## Swagger to SDK @@ -198,7 +242,7 @@ See configuration in [readme.go.md](./readme.go.md) See configuration in [readme.java.md](./readme.java.md) -## Multi-API/Profile support for AutoRest v3 generators +## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -225,11 +269,10 @@ input-file: ``` -If there are files that should not be in the `all-api-versions` set, +If there are files that should not be in the `all-api-versions` set, uncomment the `exclude-file` section below and add the file paths. ``` yaml $(tag) == 'all-api-versions' #exclude-file: # - $(this-folder)/Microsoft.Example/stable/2010-01-01/somefile.json ``` - From 06ce7423b08a00357250daa5065f22691248aa7a Mon Sep 17 00:00:00 2001 From: Junbo Wang Date: Wed, 8 Jul 2020 15:39:17 +0800 Subject: [PATCH 280/318] MSI/ClientCert support in SignalR service (#9987) --- .../examples/Operations_List.json | 25 + ...nalRPrivateEndpointConnections_Delete.json | 18 + ...SignalRPrivateEndpointConnections_Get.json | 29 + ...nalRPrivateEndpointConnections_Update.json | 45 + .../SignalRPrivateLinkResources_List.json | 31 + .../SignalR_CheckNameAvailability.json | 20 + .../examples/SignalR_CreateOrUpdate.json | 305 +++ .../examples/SignalR_Delete.json | 17 + .../examples/SignalR_Get.json | 114 + .../examples/SignalR_ListByResourceGroup.json | 117 ++ .../examples/SignalR_ListBySubscription.json | 116 ++ .../examples/SignalR_ListKeys.json | 18 + .../examples/SignalR_RegenerateKey.json | 25 + .../examples/SignalR_Restart.json | 17 + .../examples/SignalR_Update.json | 197 ++ .../examples/Usages_List.json | 36 + .../preview/2020-07-01-preview/signalr.json | 1851 +++++++++++++++++ .../signalr/resource-manager/readme.go.md | 10 + .../signalr/resource-manager/readme.java.md | 14 + .../signalr/resource-manager/readme.md | 11 +- .../signalr/resource-manager/readme.ruby.md | 11 + 21 files changed, 3026 insertions(+), 1 deletion(-) create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/Operations_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateLinkResources_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_CheckNameAvailability.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_CreateOrUpdate.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Delete.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Get.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListByResourceGroup.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListBySubscription.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListKeys.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_RegenerateKey.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Restart.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Update.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/Usages_List.json create mode 100644 specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/Operations_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/Operations_List.json new file mode 100644 index 000000000000..dcac0aba2178 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/Operations_List.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.SignalRService/SignalR/read", + "isDataAction": false, + "display": { + "provider": "Microsoft.SignalRService", + "resource": "SignalR", + "operation": "Manage SignalR (read-only)", + "description": "View the SignalR's settings and configurations in the management portal or through API" + }, + "properties": {} + } + ], + "nextLink": "providers/Microsoft.SignalRService?$skipToken={opaqueString}" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json new file mode 100644 index 000000000000..b2f4b2f2825d --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Delete.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Get.json new file mode 100644 index 000000000000..8136bd3efc51 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Get.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Update.json new file mode 100644 index 000000000000..f7574dea5e33 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateEndpointConnections_Update.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "parameters": { + "properties": { + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + } + }, + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService", + "privateEndpointConnectionName": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e" + }, + "responses": { + "200": { + "body": { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateLinkResources_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateLinkResources_List.json new file mode 100644 index 000000000000..4f15af187f25 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalRPrivateLinkResources_List.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "properties": { + "groupId": "signalr", + "requiredMembers": [ + "signalr" + ], + "requiredZoneNames": [ + "privatelink.service.signalr.net" + ] + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/privateLinkResources", + "name": "signalr", + "type": "privateLinkResources" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_CheckNameAvailability.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_CheckNameAvailability.json new file mode 100644 index 000000000000..b2b0abfc74ba --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_CheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "location": "eastus", + "parameters": { + "type": "Microsoft.SignalRService/SignalR", + "name": "my-signalr-service" + }, + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "nameAvailable": false, + "reason": "AlreadyExists", + "message": "The leaf is already used by other people" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_CreateOrUpdate.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_CreateOrUpdate.json new file mode 100644 index 000000000000..9efeefa6cfa6 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_CreateOrUpdate.json @@ -0,0 +1,305 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": "*", + "eventPattern": "connect,disconnect", + "categoryPattern": "*", + "urlTemplate": "https://example.com/chat/api/connect", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "api://example" + } + } + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com", + "auth": null + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + }, + "201": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com", + "auth": null + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Delete.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Delete.json new file mode 100644 index 000000000000..8a29508741c7 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Delete.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Get.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Get.json new file mode 100644 index 000000000000..75691a753f3b --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Get.json @@ -0,0 +1,114 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com", + "auth": null + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListByResourceGroup.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListByResourceGroup.json new file mode 100644 index 000000000000..2736c7564cab --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListByResourceGroup.json @@ -0,0 +1,117 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com", + "auth": null + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListBySubscription.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListBySubscription.json new file mode 100644 index 000000000000..d31abbcd6567 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListBySubscription.json @@ -0,0 +1,116 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com", + "auth": null + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + ] + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListKeys.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListKeys.json new file mode 100644 index 000000000000..cf251e27a32a --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_ListKeys.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "primaryKey": "primaryAccessKey", + "secondaryKey": "secondaryAccessKey", + "primaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;Version=1.0", + "secondaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;Version=1.0" + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_RegenerateKey.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_RegenerateKey.json new file mode 100644 index 000000000000..b247d4659746 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_RegenerateKey.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "parameters": { + "keyType": "Primary" + }, + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "201": { + "body": { + "primaryKey": "primaryAccessKey", + "secondaryKey": "secondaryAccessKey", + "primaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=primaryAccessKey;Version=1.0;", + "secondaryConnectionString": "Endpoint=https://yourServiceName.service.signalr.net;AccessKey=secondaryAccessKey;Version=1.0;" + }, + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Restart.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Restart.json new file mode 100644 index 000000000000..8a29508741c7 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Restart.json @@ -0,0 +1,17 @@ +{ + "parameters": { + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + }, + "204": {} + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Update.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Update.json new file mode 100644 index 000000000000..6cbf5f9d3f87 --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/SignalR_Update.json @@ -0,0 +1,197 @@ +{ + "parameters": { + "parameters": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "capacity": 1 + }, + "properties": { + "tls": { + "clientCertEnabled": false + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": "*", + "eventPattern": "connect,disconnect", + "categoryPattern": "*", + "urlTemplate": "https://example.com/chat/api/connect", + "auth": { + "type": "ManagedIdentity", + "managedIdentity": { + "resource": "api://example" + } + } + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned" + }, + "location": "eastus", + "tags": { + "key1": "value1" + } + }, + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "resourceName": "mySignalRService" + }, + "responses": { + "200": { + "body": { + "sku": { + "name": "Standard_S1", + "tier": "Standard", + "size": "S1", + "capacity": 1 + }, + "properties": { + "provisioningState": "Succeeded", + "externalIP": "10.0.0.1", + "hostName": "mysignalrservice.service.signalr.net", + "publicPort": 443, + "serverPort": 443, + "version": "1.0", + "privateEndpointConnections": [ + { + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.Network/privateEndpoints/myPrivateEndpoint" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": null, + "actionsRequired": "None" + } + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService/privateEndpointConnections/mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "type": "Microsoft.SignalRService/SignalR/privateEndpointConnections" + } + ], + "tls": { + "clientCertEnabled": true + }, + "features": [ + { + "flag": "ServiceMode", + "value": "Serverless", + "properties": {} + }, + { + "flag": "EnableConnectivityLogs", + "value": "True", + "properties": {} + }, + { + "flag": "EnableMessagingLogs", + "value": "False", + "properties": {} + } + ], + "cors": { + "allowedOrigins": [ + "https://foo.com", + "https://bar.com" + ] + }, + "upstream": { + "templates": [ + { + "hubPattern": null, + "eventPattern": null, + "categoryPattern": null, + "urlTemplate": "http://foo.com", + "auth": null + } + ] + }, + "networkACLs": { + "defaultAction": "Deny", + "publicNetwork": { + "allow": [ + "ClientConnection" + ], + "deny": null + }, + "privateEndpoints": [ + { + "name": "mySignalRService.1fa229cd-bf3f-47f0-8c49-afb36723997e", + "allow": [ + "ServerConnection" + ], + "deny": null + } + ] + } + }, + "kind": "SignalR", + "identity": { + "type": "SystemAssigned", + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000" + }, + "location": "eastus", + "tags": { + "key1": "value1" + }, + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourcegroups/myResourceGroup/providers/Microsoft.SignalRService/SignalR/mySignalRService", + "name": "mySignalRService", + "type": "Microsoft.SignalRService/SignalR" + } + }, + "202": { + "headers": { + "Location": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationResult...", + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/Usages_List.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/Usages_List.json new file mode 100644 index 000000000000..4646d1b4660e --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/examples/Usages_List.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "location": "eastus", + "api-version": "2020-07-01-preview", + "subscriptionId": "00000000-0000-0000-0000-000000000000" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage1", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage1", + "localizedValue": "Usage1" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/providers/Microsoft.SignalRService/locations/eastus/usages/Usage2", + "currentValue": 0, + "limit": 100, + "name": { + "value": "Usage2", + "localizedValue": "Usage2" + }, + "unit": "Count" + } + ], + "nextLink": "https://management.azure.com/subscriptions/subid/providers/Microsoft.SignalRService/...pathToMoreResults..." + } + } + } +} diff --git a/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json new file mode 100644 index 000000000000..39a47b3a804b --- /dev/null +++ b/specification/signalr/resource-manager/Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json @@ -0,0 +1,1851 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-07-01-preview", + "title": "SignalRManagementClient", + "description": "REST API for Azure SignalR Service" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/providers/Microsoft.SignalRService/operations": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Lists all of the available REST API operations of the Microsoft.SignalRService provider.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of operations.", + "schema": { + "$ref": "#/definitions/OperationList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Operations_List": { + "$ref": "./examples/Operations_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Checks that the SignalR name is valid and is not already in use.", + "operationId": "SignalR_CheckNameAvailability", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the region", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "Parameters supplied to the operation.", + "required": false, + "schema": { + "$ref": "#/definitions/NameAvailabilityParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the name availability.", + "schema": { + "$ref": "#/definitions/NameAvailability" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_CheckNameAvailability": { + "$ref": "./examples/SignalR_CheckNameAvailability.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/signalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a subscription.", + "operationId": "SignalR_ListBySubscription", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SignalR services in the subscription.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalR_ListBySubscription": { + "$ref": "./examples/SignalR_ListBySubscription.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Handles requests to list all resources in a resource group.", + "operationId": "SignalR_ListByResourceGroup", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the list of SignalR services in a resourceGroup.", + "schema": { + "$ref": "#/definitions/SignalRResourceList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalR_ListByResourceGroup": { + "$ref": "./examples/SignalR_ListByResourceGroup.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the specified private endpoint connection associated with a SignalR resource.", + "operationId": "SignalRPrivateEndpointConnections_Get", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the SignalR resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Get": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Update the state of specified private endpoint connection associated with a SignalR resource.", + "operationId": "SignalRPrivateEndpointConnections_Update", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the SignalR resource.", + "required": true, + "type": "string" + }, + { + "name": "parameters", + "in": "body", + "description": "The resource of private endpoint and its properties.", + "required": false, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "OK. The response indicates the private endpoint connection is updated successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Update": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Update.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Delete the specified private endpoint connection associated with a SignalR resource.", + "operationId": "SignalRPrivateEndpointConnections_Delete", + "parameters": [ + { + "name": "privateEndpointConnectionName", + "in": "path", + "description": "The name of the private endpoint connection associated with the SignalR resource.", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "202": { + "description": "Success" + }, + "204": { + "description": "Success. The response indicates the private endpoint connection is already deleted." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalRPrivateEndpointConnections_Delete": { + "$ref": "./examples/SignalRPrivateEndpointConnections_Delete.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/privateLinkResources": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the private link resources that need to be created for a SignalR resource.", + "operationId": "SignalRPrivateLinkResources_List", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a list of private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "SignalRPrivateLinkResources_List": { + "$ref": "./examples/SignalRPrivateLinkResources_List.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/listKeys": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Get the access keys of the SignalR resource.", + "operationId": "SignalR_ListKeys", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes SignalR service access keys.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_ListKeys": { + "$ref": "./examples/SignalR_ListKeys.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/regenerateKey": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Regenerate SignalR service access key. PrimaryKey and SecondaryKey cannot be regenerated at the same time.", + "operationId": "SignalR_RegenerateKey", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameter that describes the Regenerate Key Operation.", + "required": false, + "schema": { + "$ref": "#/definitions/RegenerateKeyParameters" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "201": { + "description": "Created and an async operation is executing in background to make the new key to take effect. The response contains new keys and a Location header to query the async operation result.", + "schema": { + "$ref": "#/definitions/SignalRKeys" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalR_RegenerateKey": { + "$ref": "./examples/SignalR_RegenerateKey.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}": { + "get": { + "tags": [ + "SignalR" + ], + "description": "Get the SignalR service and its properties.", + "operationId": "SignalR_Get", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes the corresponding SignalR service.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "SignalR_Get": { + "$ref": "./examples/SignalR_Get.json" + } + } + }, + "put": { + "tags": [ + "SignalR" + ], + "description": "Create a new SignalR service and update an exiting SignalR service.", + "operationId": "SignalR_CreateOrUpdate", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the create or update operation", + "required": false, + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a SignalR service.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "201": { + "description": "Created. The response describes the new service and contains a Location header to query the operation result.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalR_CreateOrUpdate": { + "$ref": "./examples/SignalR_CreateOrUpdate.json" + } + } + }, + "delete": { + "tags": [ + "SignalR" + ], + "description": "Operation to delete a SignalR service.", + "operationId": "SignalR_Delete", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the delete operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the resource is already deleted." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalR_Delete": { + "$ref": "./examples/SignalR_Delete.json" + } + } + }, + "patch": { + "tags": [ + "SignalR" + ], + "description": "Operation to update an exiting SignalR service.", + "operationId": "SignalR_Update", + "parameters": [ + { + "name": "parameters", + "in": "body", + "description": "Parameters for the update operation", + "required": false, + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "200": { + "description": "Success. The response describes a SignalR service.", + "schema": { + "$ref": "#/definitions/SignalRResource" + } + }, + "202": { + "description": "Accepted. The response indicates the exiting SignalR service is now updating and contains a Location header to query the operation result.." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "SignalR_Update": { + "$ref": "./examples/SignalR_Update.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.SignalRService/signalR/{resourceName}/restart": { + "post": { + "tags": [ + "SignalR" + ], + "description": "Operation to restart a SignalR service.", + "operationId": "SignalR_Restart", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SignalRServiceName" + } + ], + "responses": { + "202": { + "description": "Accepted. The response indicates the restart operation is performed in the background." + }, + "204": { + "description": "Success. The response indicates the operation is successful and no content will be returned." + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "azure-async-operation" + }, + "x-ms-examples": { + "SignalR_Restart": { + "$ref": "./examples/SignalR_Restart.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.SignalRService/locations/{location}/usages": { + "get": { + "tags": [ + "SignalR" + ], + "description": "List usage quotas for Azure SignalR service by location.", + "operationId": "Usages_List", + "parameters": [ + { + "name": "location", + "in": "path", + "description": "the location like \"eastus\"", + "required": true, + "type": "string" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "Success. The response describe the usage quotas of a subscription in specified region.", + "schema": { + "$ref": "#/definitions/SignalRUsageList" + } + }, + "default": { + "description": "An unexpected error occurred during the operation.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "Usages_List": { + "$ref": "./examples/Usages_List.json" + } + } + } + } + }, + "definitions": { + "OperationList": { + "description": "Result of the request to list REST API operations. It contains a list of operations.", + "type": "object", + "properties": { + "value": { + "description": "List of operations supported by the resource provider.", + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "Operation": { + "description": "REST API operation supported by SignalR resource provider.", + "type": "object", + "properties": { + "name": { + "description": "Name of the operation with format: {provider}/{resource}/{operation}", + "type": "string" + }, + "isDataAction": { + "description": "If the operation is a data action. (for data plane rbac)", + "type": "boolean" + }, + "display": { + "$ref": "#/definitions/OperationDisplay", + "description": "The object that describes the operation." + }, + "origin": { + "description": "Optional. The intended executor of the operation; governs the display of the operation in the RBAC UX and the audit logs UX.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/OperationProperties", + "description": "Extra properties for the operation.", + "x-ms-client-flatten": false + } + } + }, + "OperationDisplay": { + "description": "The object that describes a operation.", + "type": "object", + "properties": { + "provider": { + "description": "Friendly name of the resource provider", + "type": "string" + }, + "resource": { + "description": "Resource type on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string" + }, + "description": { + "description": "The localized friendly description for the operation", + "type": "string" + } + } + }, + "OperationProperties": { + "description": "Extra Operation properties.", + "type": "object", + "properties": { + "serviceSpecification": { + "$ref": "#/definitions/ServiceSpecification", + "description": "The service specifications." + } + } + }, + "ServiceSpecification": { + "description": "An object that describes a specification.", + "type": "object", + "properties": { + "metricSpecifications": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/MetricSpecification" + } + }, + "logSpecifications": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "array", + "items": { + "$ref": "#/definitions/LogSpecification" + } + } + } + }, + "MetricSpecification": { + "description": "Specifications of the Metrics for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the metric.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the metric.", + "type": "string" + }, + "displayDescription": { + "description": "Localized friendly description of the metric.", + "type": "string" + }, + "unit": { + "description": "The unit that makes sense for the metric.", + "type": "string" + }, + "aggregationType": { + "description": "Only provide one value for this field. Valid values: Average, Minimum, Maximum, Total, Count.", + "type": "string" + }, + "fillGapWithZero": { + "description": "Optional. If set to true, then zero will be returned for time duration where no metric is emitted/published. \r\nEx. a metric that returns the number of times a particular error code was emitted. The error code may not appear \r\noften, instead of the RP publishing 0, Shoebox can auto fill in 0s for time periods where nothing was emitted.", + "type": "string" + }, + "category": { + "description": "The name of the metric category that the metric belongs to. A metric can only belong to a single category.", + "type": "string" + }, + "dimensions": { + "description": "The dimensions of the metrics.", + "type": "array", + "items": { + "$ref": "#/definitions/Dimension" + } + } + } + }, + "LogSpecification": { + "description": "Specifications of the Logs for Azure Monitoring.", + "type": "object", + "properties": { + "name": { + "description": "Name of the log.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the log.", + "type": "string" + } + } + }, + "Dimension": { + "description": "Specifications of the Dimension of metrics.", + "type": "object", + "properties": { + "name": { + "description": "The public facing name of the dimension.", + "type": "string" + }, + "displayName": { + "description": "Localized friendly display name of the dimension.", + "type": "string" + }, + "internalName": { + "description": "Name of the dimension as it appears in MDM.", + "type": "string" + }, + "toBeExportedForShoebox": { + "description": "A Boolean flag indicating whether this dimension should be included for the shoebox export scenario.", + "type": "boolean" + } + } + }, + "ErrorResponse": { + "description": "Contains information about an API error.", + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/ErrorResponseBody", + "description": "Describes a particular API error with an error code and a message." + } + } + }, + "ErrorResponseBody": { + "description": "Describes a particular API error with an error code and a message.", + "required": [ + "code", + "message" + ], + "type": "object", + "properties": { + "code": { + "description": "An error code that describes the error condition more precisely than an HTTP status code. \r\nCan be used to programmatically handle specific error cases.", + "type": "string" + }, + "message": { + "description": "A message that describes the error in detail and provides debugging information.", + "type": "string" + }, + "target": { + "description": "The target of the particular error (for example, the name of the property in error).", + "type": "string" + }, + "details": { + "description": "Contains nested errors that are related to this error.", + "type": "array", + "items": { + "$ref": "#/definitions/ErrorResponseBody" + } + } + } + }, + "NameAvailabilityParameters": { + "description": "Data POST-ed to the nameAvailability action", + "required": [ + "type", + "name" + ], + "type": "object", + "properties": { + "type": { + "description": "The resource type. Should be always \"Microsoft.SignalRService/SignalR\".", + "type": "string" + }, + "name": { + "description": "The SignalR service name to validate. e.g.\"my-signalR-name-here\"", + "type": "string" + } + } + }, + "NameAvailability": { + "description": "Result of the request to check name availability. It contains a flag and possible reason of failure.", + "type": "object", + "properties": { + "nameAvailable": { + "description": "Indicates whether the name is available or not.", + "type": "boolean" + }, + "reason": { + "description": "The reason of the availability. Required if name is not available.", + "type": "string" + }, + "message": { + "description": "The message of the operation.", + "type": "string" + } + } + }, + "SignalRResourceList": { + "description": "Object that includes an array of SignalR services and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of SignalR services", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRResource": { + "description": "A class represent a SignalR service resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "properties": { + "sku": { + "$ref": "#/definitions/ResourceSku", + "description": "The billing information of the resource.(e.g. Free, Standard)" + }, + "properties": { + "$ref": "#/definitions/SignalRProperties", + "description": "Settings used to provision or configure the resource", + "x-ms-client-flatten": true + }, + "kind": { + "$ref": "#/definitions/ServiceKind", + "description": "The kind of the service - e.g. \"SignalR\", or \"RawWebSockets\" for \"Microsoft.SignalRService/SignalR\"", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "identity": { + "$ref": "#/definitions/ManagedIdentity", + "description": "The managed identity response" + } + } + }, + "ServiceKind": { + "description": "The kind of the service - e.g. \"SignalR\", or \"RawWebSockets\" for \"Microsoft.SignalRService/SignalR\"", + "enum": [ + "SignalR", + "RawWebSockets" + ], + "type": "string", + "x-ms-enum": { + "name": "ServiceKind", + "modelAsString": true + } + }, + "TrackedResource": { + "description": "The resource model definition for a ARM tracked top level resource.", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "location": { + "description": "The GEO location of the SignalR service. e.g. West US | East US | North Central US | South Central US.", + "type": "string", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "description": "Tags of the service which is a list of key value pairs that describe the resource.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "Resource": { + "description": "The core properties of ARM resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified resource Id for the resource.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the resource.", + "type": "string", + "readOnly": true + }, + "type": { + "description": "The type of the resource - e.g. \"Microsoft.SignalRService/SignalR\"", + "type": "string", + "readOnly": true + } + }, + "x-ms-azure-resource": true + }, + "ResourceSku": { + "description": "The billing information of the SignalR resource.", + "required": [ + "name" + ], + "type": "object", + "properties": { + "name": { + "description": "The name of the SKU. Required.\r\n\r\nAllowed values: Standard_S1, Free_F1", + "type": "string" + }, + "tier": { + "$ref": "#/definitions/SignalRSkuTier", + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead." + }, + "size": { + "description": "Optional string. For future use.", + "type": "string" + }, + "family": { + "description": "Optional string. For future use.", + "type": "string" + }, + "capacity": { + "format": "int32", + "description": "Optional, integer. The unit count of SignalR resource. 1 by default.\r\n\r\nIf present, following values are allowed:\r\n Free: 1\r\n Standard: 1,2,5,10,20,50,100", + "type": "integer" + } + } + }, + "SignalRSkuTier": { + "description": "Optional tier of this particular SKU. 'Standard' or 'Free'. \r\n\r\n`Basic` is deprecated, use `Standard` instead.", + "enum": [ + "Free", + "Basic", + "Standard", + "Premium" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRSkuTier", + "modelAsString": true + } + }, + "SignalRProperties": { + "description": "A class that describes the properties of the SignalR service that should contain more read-only properties than AzSignalR.Models.SignalRCreateOrUpdateProperties", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/SignalRCreateOrUpdateProperties" + } + ], + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource.", + "readOnly": true + }, + "externalIP": { + "description": "The publicly accessible IP of the SignalR service.", + "type": "string", + "readOnly": true + }, + "hostName": { + "description": "FQDN of the SignalR service instance. Format: xxx.service.signalr.net", + "type": "string", + "readOnly": true + }, + "publicPort": { + "format": "int32", + "description": "The publicly accessible port of the SignalR service which is designed for browser/client side usage.", + "type": "integer", + "readOnly": true + }, + "serverPort": { + "format": "int32", + "description": "The publicly accessible port of the SignalR service which is designed for customer server side usage.", + "type": "integer", + "readOnly": true + }, + "version": { + "description": "Version of the SignalR resource. Probably you need the same or higher version of client SDKs.", + "type": "string", + "readOnly": true + }, + "privateEndpointConnections": { + "description": "Private endpoint connections to the SignalR resource.", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "readOnly": true + }, + "tls": { + "$ref": "#/definitions/SignalRTlsSettings", + "description": "TLS settings." + } + } + }, + "ProvisioningState": { + "description": "Provisioning state of the resource.", + "enum": [ + "Unknown", + "Succeeded", + "Failed", + "Canceled", + "Running", + "Creating", + "Updating", + "Deleting", + "Moving" + ], + "type": "string", + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "SignalRCreateOrUpdateProperties": { + "description": "Settings used to provision or configure the resource.", + "type": "object", + "properties": { + "features": { + "description": "List of SignalR featureFlags. e.g. ServiceMode.\r\n\r\nFeatureFlags that are not included in the parameters for the update operation will not be modified.\r\nAnd the response will only include featureFlags that are explicitly set. \r\nWhen a featureFlag is not explicitly set, SignalR service will use its globally default value. \r\nBut keep in mind, the default value doesn't mean \"false\". It varies in terms of different FeatureFlags.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRFeature" + } + }, + "cors": { + "$ref": "#/definitions/SignalRCorsSettings", + "description": "Cross-Origin Resource Sharing (CORS) settings." + }, + "upstream": { + "$ref": "#/definitions/ServerlessUpstreamSettings", + "description": "Upstream settings when the Azure SignalR is in server-less mode." + }, + "networkACLs": { + "$ref": "#/definitions/SignalRNetworkACLs", + "description": "Network ACLs" + } + } + }, + "SignalRFeature": { + "description": "Feature of a SignalR resource, which controls the SignalR runtime behavior.", + "required": [ + "flag", + "value" + ], + "type": "object", + "properties": { + "flag": { + "$ref": "#/definitions/FeatureFlags", + "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively." + }, + "value": { + "description": "Value of the feature flag. See Azure SignalR service document https://docs.microsoft.com/azure/azure-signalr/ for allowed values.", + "maxLength": 128, + "minLength": 1, + "type": "string" + }, + "properties": { + "description": "Optional properties related to this feature.", + "type": "object", + "additionalProperties": { + "type": "string" + } + } + } + }, + "FeatureFlags": { + "description": "FeatureFlags is the supported features of Azure SignalR service.\r\n- ServiceMode: Flag for backend server for SignalR service. Values allowed: \"Default\": have your own backend server; \"Serverless\": your application doesn't have a backend server; \"Classic\": for backward compatibility. Support both Default and Serverless mode but not recommended; \"PredefinedOnly\": for future use.\r\n- EnableConnectivityLogs: \"true\"/\"false\", to enable/disable the connectivity log category respectively.", + "enum": [ + "ServiceMode", + "EnableConnectivityLogs", + "EnableMessagingLogs" + ], + "type": "string", + "x-ms-enum": { + "name": "FeatureFlags", + "modelAsString": true + } + }, + "SignalRCorsSettings": { + "description": "Cross-Origin Resource Sharing (CORS) settings.", + "type": "object", + "properties": { + "allowedOrigins": { + "description": "Gets or sets the list of origins that should be allowed to make cross-origin calls (for example: http://example.com:12345). Use \"*\" to allow all. If omitted, allow all by default.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "ServerlessUpstreamSettings": { + "description": "The settings for the Upstream when the Azure SignalR is in server-less mode.", + "type": "object", + "properties": { + "templates": { + "description": "Gets or sets the list of Upstream URL templates. Order matters, and the first matching template takes effects.", + "type": "array", + "items": { + "$ref": "#/definitions/UpstreamTemplate" + } + } + } + }, + "SignalRNetworkACLs": { + "description": "Network ACLs for SignalR", + "type": "object", + "properties": { + "defaultAction": { + "$ref": "#/definitions/ACLAction", + "description": "Default action when no other rule matches" + }, + "publicNetwork": { + "$ref": "#/definitions/NetworkACL", + "description": "ACL for requests from public network" + }, + "privateEndpoints": { + "description": "ACLs for requests from private endpoints", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointACL" + } + } + } + }, + "ACLAction": { + "description": "Default action when no other rule matches", + "enum": [ + "Allow", + "Deny" + ], + "type": "string", + "x-ms-enum": { + "name": "ACLAction", + "modelAsString": true + } + }, + "UpstreamTemplate": { + "description": "Upstream template item settings. It defines the Upstream URL of the incoming requests.\r\nThe template defines the pattern of the event, the hub or the category of the incoming request that matches current URL template.", + "required": [ + "urlTemplate" + ], + "type": "object", + "properties": { + "hubPattern": { + "description": "Gets or sets the matching pattern for hub names. If not set, it matches any hub.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any hub name\r\n 2. Combine multiple hubs with \",\", for example \"hub1,hub2\", it matches \"hub1\" and \"hub2\"\r\n 3. The single hub name, for example, \"hub1\", it matches \"hub1\"", + "type": "string" + }, + "eventPattern": { + "description": "Gets or sets the matching pattern for event names. If not set, it matches any event.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any event name\r\n 2. Combine multiple events with \",\", for example \"connect,disconnect\", it matches event \"connect\" and \"disconnect\"\r\n 3. The single event name, for example, \"connect\", it matches \"connect\"", + "type": "string" + }, + "categoryPattern": { + "description": "Gets or sets the matching pattern for category names. If not set, it matches any category.\r\nThere are 3 kind of patterns supported:\r\n 1. \"*\", it to matches any category name\r\n 2. Combine multiple categories with \",\", for example \"connections,messages\", it matches category \"connections\" and \"messages\"\r\n 3. The single category name, for example, \"connections\", it matches the category \"connections\"", + "type": "string" + }, + "urlTemplate": { + "description": "Gets or sets the Upstream URL template. You can use 3 predefined parameters {hub}, {category} {event} inside the template, the value of the Upstream URL is dynamically calculated when the client request comes in.\r\nFor example, if the urlTemplate is `http://example.com/{hub}/api/{event}`, with a client request from hub `chat` connects, it will first POST to this URL: `http://example.com/chat/api/connect`.", + "type": "string" + }, + "auth": { + "$ref": "#/definitions/UpstreamAuthSettings", + "description": "Gets or sets the auth settings for an upstream. If not set, no auth is used for upstream messages." + } + } + }, + "NetworkACL": { + "description": "Network ACL", + "type": "object", + "properties": { + "allow": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + } + }, + "deny": { + "description": "Denied request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRRequestType" + } + } + } + }, + "SignalRRequestType": { + "description": "Allowed request types. The value can be one or more of: ClientConnection, ServerConnection, RESTAPI.", + "enum": [ + "ClientConnection", + "ServerConnection", + "RESTAPI" + ], + "type": "string", + "x-ms-enum": { + "name": "SignalRRequestType", + "modelAsString": true + } + }, + "PrivateEndpointACL": { + "description": "ACL for a private endpoint", + "required": [ + "name" + ], + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/NetworkACL" + } + ], + "properties": { + "name": { + "description": "Name of the private endpoint connection", + "type": "string" + } + } + }, + "UpstreamAuthSettings": { + "description": "Upstream auth settings.", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/UpstreamAuthType", + "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now." + }, + "managedIdentity": { + "$ref": "#/definitions/ManagedIdentitySettings", + "description": "Gets or sets the managed identity settings. It's required if the auth type is set to ManagedIdentity." + } + } + }, + "UpstreamAuthType": { + "description": "Gets or sets the type of auth. None or ManagedIdentity is supported now.", + "enum": [ + "None", + "ManagedIdentity" + ], + "type": "string", + "x-ms-enum": { + "name": "UpstreamAuthType", + "modelAsString": true + } + }, + "ManagedIdentitySettings": { + "description": "Managed identity settings for upstream.", + "type": "object", + "properties": { + "resource": { + "description": "The Resource indicating the App ID URI of the target resource.\r\nIt also appears in the aud (audience) claim of the issued token.", + "type": "string" + } + } + }, + "ManagedIdentity": { + "description": "A class represent managed identities used for request and response", + "type": "object", + "properties": { + "type": { + "$ref": "#/definitions/ManagedIdentityType", + "description": "Represent the identity type: systemAssigned, userAssigned, None" + }, + "userAssignedIdentities": { + "description": "Get or set the user assigned identities", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/UserAssignedIdentityProperty" + } + }, + "principalId": { + "description": "Get the principal id for the system assigned identity.\r\nOnly be used in response.", + "type": "string", + "readOnly": true + }, + "tenantId": { + "description": "Get the tenant id for the system assigned identity.\r\nOnly be used in response", + "type": "string", + "readOnly": true + } + } + }, + "ManagedIdentityType": { + "description": "Represent the identity type: systemAssigned, userAssigned, None", + "enum": [ + "None", + "SystemAssigned", + "UserAssigned" + ], + "type": "string", + "x-ms-enum": { + "name": "ManagedIdentityType", + "modelAsString": true + } + }, + "PrivateEndpointConnection": { + "description": "A private endpoint connection to SignalR resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "description": "Properties of the private endpoint connection", + "x-ms-client-flatten": true + } + } + }, + "ProxyResource": { + "description": "The resource model definition for a ARM proxy resource. It will have everything other than required location and tags", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": {} + }, + "SignalRTlsSettings": { + "description": "TLS settings for SignalR", + "type": "object", + "properties": { + "clientCertEnabled": { + "description": "Request client certificate during TLS handshake if enabled", + "type": "boolean" + } + } + }, + "UserAssignedIdentityProperty": { + "description": "Properties of user assigned identity.", + "type": "object", + "properties": { + "principalId": { + "description": "Get the principal id for the user assigned identity", + "type": "string", + "readOnly": true + }, + "clientId": { + "description": "Get the client id for the user assigned identity", + "type": "string", + "readOnly": true + } + } + }, + "PrivateEndpointConnectionProperties": { + "description": "Private endpoint connection properties", + "type": "object", + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the private endpoint connection", + "readOnly": true + }, + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "Private endpoint associated with the private endpoint connection" + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "Connection state" + } + } + }, + "PrivateEndpoint": { + "description": "Private endpoint", + "type": "object", + "properties": { + "id": { + "description": "Full qualified Id of the private endpoint", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionState": { + "description": "Connection state of the private endpoint connection", + "type": "object", + "properties": { + "status": { + "$ref": "#/definitions/PrivateLinkServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "description": "The reason for approval/rejection of the connection.", + "type": "string" + }, + "actionsRequired": { + "description": "A message indicating if changes on the service provider require any updates on the consumer.", + "type": "string" + } + } + }, + "PrivateLinkServiceConnectionStatus": { + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected" + ], + "type": "string", + "x-ms-enum": { + "name": "PrivateLinkServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateLinkResourceList": { + "description": "Contains a list of AzSignalR.Models.Response.PrivateLink.PrivateLinkResource and a possible link to query more results", + "type": "object", + "properties": { + "value": { + "description": "List of PrivateLinkResource", + "type": "array", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "PrivateLinkResource": { + "description": "Private link resource", + "type": "object", + "allOf": [ + { + "$ref": "#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Properties of a private link resource", + "x-ms-client-flatten": true + } + } + }, + "PrivateLinkResourceProperties": { + "description": "Private link resource properties", + "type": "object", + "properties": { + "groupId": { + "description": "Group Id of the private link resource", + "type": "string" + }, + "requiredMembers": { + "description": "Required members of the private link resource", + "type": "array", + "items": { + "type": "string" + } + }, + "requiredZoneNames": { + "description": "Required private DNS zone names", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "SignalRKeys": { + "description": "A class represents the access keys of SignalR service.", + "type": "object", + "properties": { + "primaryKey": { + "description": "The primary access key.", + "type": "string" + }, + "secondaryKey": { + "description": "The secondary access key.", + "type": "string" + }, + "primaryConnectionString": { + "description": "SignalR connection string constructed via the primaryKey", + "type": "string" + }, + "secondaryConnectionString": { + "description": "SignalR connection string constructed via the secondaryKey", + "type": "string" + } + } + }, + "RegenerateKeyParameters": { + "description": "Parameters describes the request to regenerate access keys", + "type": "object", + "properties": { + "keyType": { + "$ref": "#/definitions/KeyType", + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive)." + } + } + }, + "KeyType": { + "description": "The keyType to regenerate. Must be either 'primary' or 'secondary'(case-insensitive).", + "enum": [ + "Primary", + "Secondary" + ], + "type": "string", + "x-ms-enum": { + "name": "KeyType", + "modelAsString": true + } + }, + "SignalRUsageList": { + "description": "Object that includes an array of SignalR resource usages and a possible link for next set.", + "type": "object", + "properties": { + "value": { + "description": "List of SignalR usages", + "type": "array", + "items": { + "$ref": "#/definitions/SignalRUsage" + } + }, + "nextLink": { + "description": "The URL the client should use to fetch the next page (per server side paging).\r\nIt's null for now, added for future use.", + "type": "string" + } + } + }, + "SignalRUsage": { + "description": "Object that describes a specific usage of SignalR resources.", + "type": "object", + "properties": { + "id": { + "description": "Fully qualified ARM resource id", + "type": "string" + }, + "currentValue": { + "format": "int64", + "description": "Current value for the usage quota.", + "type": "integer" + }, + "limit": { + "format": "int64", + "description": "The maximum permitted value for the usage quota. If there is no limit, this value will be -1.", + "type": "integer" + }, + "name": { + "$ref": "#/definitions/SignalRUsageName", + "description": "Localizable String object containing the name and a localized value." + }, + "unit": { + "description": "Representing the units of the usage quota. Possible values are: Count, Bytes, Seconds, Percent, CountPerSecond, BytesPerSecond.", + "type": "string" + } + } + }, + "SignalRUsageName": { + "description": "Localizable String object containing the name and a localized value.", + "type": "object", + "properties": { + "value": { + "description": "The identifier of the usage.", + "type": "string" + }, + "localizedValue": { + "description": "Localized name of the usage.", + "type": "string" + } + } + } + }, + "parameters": { + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "description": "Client Api Version.", + "required": true, + "type": "string" + }, + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Gets subscription Id which uniquely identify the Microsoft Azure subscription. The subscription ID forms part of the URI for every service call.", + "required": true, + "type": "string" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group that contains the resource. You can obtain this value from the Azure Resource Manager API or the portal.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "SignalRServiceName": { + "name": "resourceName", + "in": "path", + "description": "The name of the SignalR resource.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "flow": "implicit", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "scopes": { + "user_impersonation": "impersonate your user account" + }, + "type": "oauth2", + "description": "Azure Active Directory OAuth2 Flow" + } + }, + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ] +} diff --git a/specification/signalr/resource-manager/readme.go.md b/specification/signalr/resource-manager/readme.go.md index c7fed8130266..99af62cf41d4 100644 --- a/specification/signalr/resource-manager/readme.go.md +++ b/specification/signalr/resource-manager/readme.go.md @@ -16,6 +16,7 @@ batch: - tag: package-2018-03-01-preview - tag: package-2018-10-01 - tag: package-2020-05-01 + - tag: package-2020-07-01-preview ``` ### Tag: package-2018-03-01-preview and go @@ -44,3 +45,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-07-01-preview' && $(go) +output-folder: $(go-sdk-folder)/services/preview/$(namespace)/mgmt/2020-07-01-preview/$(namespace) +``` diff --git a/specification/signalr/resource-manager/readme.java.md b/specification/signalr/resource-manager/readme.java.md index 332c4a397833..783271a172f2 100644 --- a/specification/signalr/resource-manager/readme.java.md +++ b/specification/signalr/resource-manager/readme.java.md @@ -19,6 +19,20 @@ batch: - tag: package-2018-03-01-preview - tag: package-2018-10-01 - tag: package-2020-05-01 + - tag: package-2020-07-01-preview +``` + +### Tag: package-2020-07-01-preview and java + +These settings apply only when `--tag=package-2020-07-01-preview --java` is specified on the command line. +Please also specify `--azure-libraries-for-java-folder=`. + +``` yaml $(tag) == 'package-2020-07-01-preview' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.signalr.v2020_07_01_preview + output-folder: $(azure-libraries-for-java-folder)/sdk/signalr/mgmt-v2020_07_01_preview +regenerate-manager: true +generate-interface: true ``` ### Tag: package-2020-05-01 and java diff --git a/specification/signalr/resource-manager/readme.md b/specification/signalr/resource-manager/readme.md index 807ff01765c9..2f52d708922d 100644 --- a/specification/signalr/resource-manager/readme.md +++ b/specification/signalr/resource-manager/readme.md @@ -26,7 +26,7 @@ These are the global settings for the SignalR API. ``` yaml openapi-type: arm -tag: package-2020-05-01 +tag: package-2020-07-01-preview ``` ### Suppression @@ -55,6 +55,15 @@ directive: reason: The 'properties' is a user-defined dictionary, cannot be flattened. ``` +### Tag: package-2020-07-01-preview + +These settings apply only when `--tag=package-2020-07-01-preview` is specified on the command line. + +``` yaml $(tag) == 'package-2020-07-01-preview' +input-file: +- Microsoft.SignalRService/preview/2020-07-01-preview/signalr.json +``` + ### Tag: package-2020-05-01 These settings apply only when `--tag=package-2020-05-01` is specified on the command line. diff --git a/specification/signalr/resource-manager/readme.ruby.md b/specification/signalr/resource-manager/readme.ruby.md index b10560ba58b6..9688e52abf65 100644 --- a/specification/signalr/resource-manager/readme.ruby.md +++ b/specification/signalr/resource-manager/readme.ruby.md @@ -15,6 +15,17 @@ batch: - tag: package-2018-03-01-preview - tag: package-2018-10-01 - tag: package-2020-05-01 + - tag: package-2020-07-01-preview +``` + +### Tag: package-2020-07-01-preview and ruby + +These settings apply only when `--tag=package-2020-07-01-preview --ruby` is specified on the command line. +Please also specify `--ruby-sdks-folder=`. + +``` yaml $(tag) == 'package-2020-07-01-preview' && $(ruby) +namespace: "Azure::Signalr::Mgmt::V2020_07_01_preview" +output-folder: $(ruby-sdks-folder)/management/azure_mgmt_signalr/lib ``` ### Tag: package-2020-05-01 and ruby From 2533303aef8b82fc4afbbd45292678e70a67a658 Mon Sep 17 00:00:00 2001 From: Zhe Li Date: Wed, 8 Jul 2020 18:25:23 +0800 Subject: [PATCH 281/318] Auto scale dimension (#9945) --- .../stable/2015-04-01/autoscale_API.json | 44 +++++++++++++++++++ 1 file changed, 44 insertions(+) diff --git a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json index 857de7aa263c..2acae879f903 100644 --- a/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json +++ b/specification/monitor/resource-manager/Microsoft.Insights/stable/2015-04-01/autoscale_API.json @@ -378,6 +378,10 @@ "type": "string", "description": "the name of the metric that defines what the rule monitors." }, + "metricNamespace": { + "type": "string", + "description": "the namespace of the metric that defines what the rule monitors." + }, "metricResourceUri": { "type": "string", "description": "the resource identifier of the resource the rule monitors." @@ -442,6 +446,13 @@ "type": "number", "format": "double", "description": "the threshold of the metric that triggers the scale action." + }, + "dimensions": { + "type": "array", + "items": { + "$ref": "#/definitions/ScaleRuleMetricDimension" + }, + "description": "List of dimension conditions. For example: [{\"DimensionName\":\"AppName\",\"Operator\":\"Equals\",\"Values\":[\"App1\"]},{\"DimensionName\":\"Deployment\",\"Operator\":\"Equals\",\"Values\":[\"default\"]}]." } }, "description": "The trigger that results in a scaling action." @@ -803,6 +814,39 @@ "type": "string" } } + }, + "ScaleRuleMetricDimension": { + "required": [ + "DimensionName", + "Operator", + "Values" + ], + "properties": { + "DimensionName": { + "type": "string", + "description": "Name of the dimension." + }, + "Operator": { + "type": "string", + "description": "the dimension operator. Only 'Equals' and 'NotEquals' are supported. 'Equals' being equal to any of the values. 'NotEquals' being not equal to all of the values", + "enum": [ + "Equals", + "NotEquals" + ], + "x-ms-enum": { + "name": "ScaleRuleMetricDimensionOperationType", + "modelAsString": true + } + }, + "Values": { + "type": "array", + "items": { + "type": "string" + }, + "description": "list of dimension values. For example: [\"App1\",\"App2\"]." + } + }, + "description": "Specifies an auto scale rule metric dimension." } }, "parameters": { From fc171fd67338e735c61af592946e3e729a9b89cf Mon Sep 17 00:00:00 2001 From: Shangwei Sun <63389531+sunsw1994@users.noreply.github.com> Date: Wed, 8 Jul 2020 23:42:11 +0800 Subject: [PATCH 282/318] [Synapse]-Update autorest configuration for vnet and monitoring go sdk (#10058) * Update autorest configuration for vnet and monitoring go sdk * Update vnet namespace to managedVirtualNetwork * Fix tag vaule --- specification/synapse/data-plane/readme.go.md | 24 +++++++++++++++++++ specification/synapse/data-plane/readme.md | 1 + 2 files changed, 25 insertions(+) diff --git a/specification/synapse/data-plane/readme.go.md b/specification/synapse/data-plane/readme.go.md index 3b24071d4596..d15ac8b61eba 100644 --- a/specification/synapse/data-plane/readme.go.md +++ b/specification/synapse/data-plane/readme.go.md @@ -15,6 +15,8 @@ batch: - tag: package-spark-2019-11-01-preview - tag: package-artifacts-2019-06-01-preview - tag: package-access-control-2020-02-01-preview + - tag: package-monitoring-2019-11-01-preview + - tag: package-vnet-2019-06-01-preview ``` ### Tag: package-spark-2019-11-01-preview and go @@ -48,4 +50,26 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-monitoring-2019-11-01-preview' && $(go) +go: + namespace: monitoring +output-folder: $(go-sdk-folder)/services/preview/synapse/2019-11-01-preview/$(namespace) +``` + +### Tag: package-vnet-2019-06-01-preview and go + +These settings apply only when `--tag=package-vnet-2019-06-01-preview --go` is specified on the command line. +Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-vnet-2019-06-01-preview' && $(go) +go: + namespace: managedVirtualNetwork +output-folder: $(go-sdk-folder)/services/preview/synapse/2019-06-01-preview/$(namespace) ``` \ No newline at end of file diff --git a/specification/synapse/data-plane/readme.md b/specification/synapse/data-plane/readme.md index 21d88e28aa0c..bbc3bb50a0ed 100644 --- a/specification/synapse/data-plane/readme.md +++ b/specification/synapse/data-plane/readme.md @@ -162,6 +162,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/artifacts.json + - $(this-folder)/Microsoft.Synapse/preview/2019-06-01-preview/managedPrivateEndpoints.json - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/sparkJob.json - $(this-folder)/Microsoft.Synapse/preview/2019-11-01-preview/monitoring.json - $(this-folder)/Microsoft.Synapse/preview/2020-02-01-preview/roles.json From d9b359e55efe12792d86807a8dfe924a0427b6a8 Mon Sep 17 00:00:00 2001 From: Shenglong Li Date: Wed, 8 Jul 2020 17:20:02 -0700 Subject: [PATCH 283/318] Fix tenant leve What-If examples (#10062) --- .../PostDeploymentWhatIfOnTenant.json | 56 ++----------------- .../PostDeploymentWhatIfOnTenant.json | 56 ++----------------- 2 files changed, 10 insertions(+), 102 deletions(-) diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnTenant.json index 0bec2f85bc53..f206f7a77c56 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnTenant.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-10-01/examples/PostDeploymentWhatIfOnTenant.json @@ -18,59 +18,13 @@ "properties": { "changes": [ { - "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", - "changeType": "Modify", - "before": { - "apiVersion": "2019-06-01", - "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", - "type": "Microsoft.Authorization/policyAssignments", - "name": "myPolicyAssignment", - "location": "westus2", - "properties": { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", - "enforcementMode": "Default" - } - }, - "after": { - "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", - "changeType": "Modify", - "before": { - "apiVersion": "2019-06-01", - "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", - "type": "Microsoft.Authorization/policyAssignments", - "name": "myPolicyAssignment", - "location": "westus2", - "properties": { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", - "enforcementMode": "DoNotEnforce" - } - }, - "delta": [ - { - "path": "properties.enforcementMode", - "propertyChangeType": "Modify", - "before": "Default", - "after": "DoNotEnforce" - } - ] - } - }, - { - "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup", "changeType": "Create", "after": { - "apiVersion": "2019-06-01", - "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", - "type": "Microsoft.Authorization/policyAssignments", - "name": "myPolicyAssignment2", - "location": "westus2", - "properties": { - "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000002", - "enforcementMode": "Default" - } + "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "apiVersion": "2019-11-01", + "type": "Microsoft.Management/managementGroups", + "name": "myManagementGroup" } } ] diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnTenant.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnTenant.json index 7fefa1ffb815..789cd5a733e0 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnTenant.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-06-01/examples/PostDeploymentWhatIfOnTenant.json @@ -18,59 +18,13 @@ "properties": { "changes": [ { - "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", - "changeType": "Modify", - "before": { - "apiVersion": "2019-06-01", - "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", - "type": "Microsoft.Authorization/policyAssignments", - "name": "myPolicyAssignment", - "location": "westus2", - "properties": { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", - "enforcementMode": "Default" - } - }, - "after": { - "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", - "changeType": "Modify", - "before": { - "apiVersion": "2019-06-01", - "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment", - "type": "Microsoft.Authorization/policyAssignments", - "name": "myPolicyAssignment", - "location": "westus2", - "properties": { - "policyDefinitionId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000001", - "enforcementMode": "DoNotEnforce" - } - }, - "delta": [ - { - "path": "properties.enforcementMode", - "propertyChangeType": "Modify", - "before": "Default", - "after": "DoNotEnforce" - } - ] - } - }, - { - "resourceId": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", + "resourceId": "/providers/Microsoft.Management/managementGroups/myManagementGroup", "changeType": "Create", "after": { - "apiVersion": "2019-06-01", - "id": "/providers/Microsoft.Authorization/policyAssignments/myPolicyAssignment2", - "type": "Microsoft.Authorization/policyAssignments", - "name": "myPolicyAssignment2", - "location": "westus2", - "properties": { - "policyDefinitionId": "/providers/Microsoft.Management/managementGroups/myManagementGroup/providers/Microsoft.Authorization/policyAssignments/myPolicyDefinition", - "scope": "/subscriptions/00000000-0000-0000-0000-000000000002", - "enforcementMode": "Default" - } + "id": "/providers/Microsoft.Management/managementGroups/myManagementGroup", + "apiVersion": "2019-11-01", + "type": "Microsoft.Management/managementGroups", + "name": "myManagementGroup" } } ] From 8f534d9104c2b2fedb6593b2956bbff1b2011227 Mon Sep 17 00:00:00 2001 From: Dennis Benzinger | SAP Hybris Date: Thu, 9 Jul 2020 07:15:58 +0200 Subject: [PATCH 284/318] Fix description of public IP address name (#10070) --- .../Microsoft.Network/stable/2020-05-01/publicIpAddress.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpAddress.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpAddress.json index 6759277f77a5..6785b25ddc02 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpAddress.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/publicIpAddress.json @@ -54,7 +54,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the subnet." + "description": "The name of the public IP address." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" @@ -109,7 +109,7 @@ "in": "path", "required": true, "type": "string", - "description": "The name of the subnet." + "description": "The name of the public IP address." }, { "$ref": "./network.json#/parameters/ApiVersionParameter" From c0fbec001a82075a7244e94e4a33e391a49f2128 Mon Sep 17 00:00:00 2001 From: zhaomuzhi Date: Wed, 8 Jul 2020 22:28:22 -0700 Subject: [PATCH 285/318] [Ready For Review]a new version with CRUD operations on workspaces/connections (#9799) * Add Identity to createWorkpace example * move missing apis to version 2020-04-01 * add new version 2020-06-01 * change delete to async * fix up * fix up * add two optional parameters * fix url * modify readme.md * fix LintDiff errors * Adding ComputeInstance operations from 2020-02-18-preview to 2020-06-01 stable Adding ComputeInstance operations from 2020-02-18-preview to 2020-06-01 stable * Adding missing braces * make connection paginated * fix up Co-authored-by: Ramakrishna Gottimukkula --- .../stable/2020-06-01/examples/ListSkus.json | 79 + .../2020-06-01/examples/ListUsages.json | 400 ++ .../examples/ListVMSizesResult.json | 455 ++ .../examples/ListWorkspaceFeatures.json | 26 + .../ListWorkspaceQuotasByVMFamily.json | 415 ++ .../examples/amlComputeListNodes.json | 34 + .../examples/createBasicAKSCompute.json | 44 + .../examples/createBasicAmlCompute.json | 60 + .../createBasicDataFactoryCompute.json | 44 + .../examples/createComputeInstance.json | 52 + .../createComputeInstanceMinimal.json | 47 + .../2020-06-01/examples/createWorkspace.json | 148 + .../examples/createWorkspaceConnection.json | 33 + .../2020-06-01/examples/deleteCompute.json | 19 + .../2020-06-01/examples/deleteWorkspace.json | 13 + .../examples/deleteWorkspaceConnection.json | 13 + .../2020-06-01/examples/getAKSCompute.json | 25 + .../2020-06-01/examples/getAmlCompute.json | 60 + .../examples/getComputeInstance.json | 52 + .../2020-06-01/examples/getComputes.json | 41 + .../2020-06-01/examples/getWorkspace.json | 82 + .../examples/getWorkspaceConnection.json | 24 + .../getWorkspacesByResourceGroup.json | 56 + .../examples/getWorkspacesBySubscription.json | 55 + .../examples/listKeysAKSCompute.json | 19 + .../examples/listWorkspaceConnections.json | 40 + .../examples/listWorkspaceKeys.json | 35 + .../2020-06-01/examples/patchAmlCompute.json | 36 + .../examples/restartComputeInstance.json | 12 + .../examples/resyncWorkspaceKeys.json | 11 + .../examples/startComputeInstance.json | 12 + .../examples/stopComputeInstance.json | 12 + .../2020-06-01/examples/updateAKSCompute.json | 53 + .../2020-06-01/examples/updateAmlCompute.json | 59 + .../2020-06-01/examples/updateQuota.json | 45 + .../2020-06-01/examples/updateWorkspace.json | 42 + ...kspaceDeletePrivateEndpointConnection.json | 14 + ...workspaceGetPrivateEndpointConnection.json | 30 + .../workspaceListPrivateLinkResources.json | 28 + .../examples/workspacePrepareNotebook.json | 21 + ...workspacePutPrivateEndpointConnection.json | 38 + .../2020-06-01/machineLearningServices.json | 4070 +++++++++++++++++ .../resource-manager/readme.md | 26 +- 43 files changed, 6879 insertions(+), 1 deletion(-) create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListSkus.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListUsages.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListVMSizesResult.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListWorkspaceFeatures.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListWorkspaceQuotasByVMFamily.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/amlComputeListNodes.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicDataFactoryCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createComputeInstanceMinimal.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createWorkspaceConnection.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteWorkspaceConnection.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getComputes.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspaceConnection.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspacesByResourceGroup.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspacesBySubscription.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listKeysAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listWorkspaceConnections.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listWorkspaceKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/patchAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/restartComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/resyncWorkspaceKeys.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/startComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/stopComputeInstance.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateAKSCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateAmlCompute.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateQuota.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateWorkspace.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceDeletePrivateEndpointConnection.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceGetPrivateEndpointConnection.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceListPrivateLinkResources.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspacePrepareNotebook.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspacePutPrivateEndpointConnection.json create mode 100644 specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListSkus.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListSkus.json new file mode 100644 index 000000000000..7f3f77cc768a --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListSkus.json @@ -0,0 +1,79 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "{subscription-id}" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "workspaces", + "name": "Basic", + "tier": "Basic", + "locations": [ + "westus" + ], + "locationInfo": [ + { + "location": "westus", + "zones": [ + "westus-AZ02", + "westus-AZ01" + ] + } + ], + "capabilities": [ + { + "name": "automatedml_readhyperdrivesdk", + "value": "{\n \"id\": \"automatedml_ readhyperdrivesdk\",\n \"name\": \"Read hyperdrive SDK\",\n \"description\": \"Read only access to Hyperdrive in the SDK\"\n}" + }, + { + "name": "workspace_upgradeworkspacesdk", + "value": "{\n \"id\": \"workspace_upgradeworkspacesdk\",\n \"name\": \"Upgrade workspace SDK\",\n \"description\": \"Upgrade workspace from Basic to enterprise from the SDK\"\n}" + } + ], + "restrictions": [] + }, + { + "resourceType": "workspaces", + "name": "Enterprise", + "tier": "Enterprise", + "locations": [ + "westus" + ], + "locationInfo": [ + { + "location": "westus", + "zones": [ + "westus-AZ01" + ], + "zoneDetails": [ + { + "name": [ + "westus-AZ01" + ], + "capabilities": [ + { + "name": "automatedml_createeditexperimentssdk", + "value": "{\n \"id\": \"automatedml_createeditexperimentssdk\",\n \"name\": \"Create edit experiments SDK\",\n \"description\": \"Create, edit or delete AutoML experiments in the SDK\"\n}" + } + ] + } + ] + } + ], + "capabilities": [ + { + "name": "automatedml_createeditexperimentssdk", + "value": "{\n \"id\": \"automatedml_createeditexperimentssdk\",\n \"name\": \"Create edit experiments SDK\",\n \"description\": \"Create, edit or delete AutoML experiments in the SDK\"\n}" + } + ], + "restrictions": [] + } + ], + "nextLink": null + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListUsages.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListUsages.json new file mode 100644 index 000000000000..8527c93e5796 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListUsages.json @@ -0,0 +1,400 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000", + "type": "Microsoft.MachineLearningServices/totalCores/usages", + "currentValue": 7, + "limit": 100, + "name": { + "localizedValue": "Total Cluster vCPUs", + "value": "TotalCores" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000", + "type": "Microsoft.MachineLearningServices/totalDedicatedCores/usages", + "currentValue": 14, + "limit": 24, + "name": { + "localizedValue": "Total Cluster Dedicated Regional vCPUs", + "value": "TotalDedicatedCores" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages", + "currentValue": 0, + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "StandardDFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "StandardDSv2Family", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "StandardDSv2Family", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_dsv2/usages/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/computes/dedicatedCores/usages", + "currentValue": 2, + "limit": 24, + "name": { + "value": "StandardDSv2Family", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster2_dsv2/usages/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/computes/dedicatedCores/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "StandardDSv2Family", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "StandardDv2Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardFSv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages", + "currentValue": 0, + "limit": 24, + "name": { + "value": "StandardFSv2Family", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages", + "currentValue": 12, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "StandardNCFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspace/dedicatedCores/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "StandardNCFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_nc/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspace/computes/dedicatedCores/usages", + "currentValue": 6, + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "StandardNCFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "StandardNCFamily", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluser1_nc/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspaces/computes/dedicatedCores/usages", + "currentValue": 6, + "limit": 24, + "name": { + "value": "StandardNCFamily", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "StandardNCv2Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCv3Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "StandardNCv3Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNDFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages", + "currentValue": 0, + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "StandardNDFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNDv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages", + "currentValue": 0, + "limit": 0, + "name": { + "value": "StandardNDv2Family", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNVFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/usages", + "currentValue": 0, + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "StandardNVFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000", + "type": "Microsoft.MachineLearningServices/totalLowPriorityCores/usages", + "currentValue": 18, + "limit": 50, + "name": { + "localizedValue": "Total Cluster LowPriority Regional vCPUs", + "value": "TotalLowPriorityCores" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages", + "currentValue": 0, + "limit": -1, + "name": { + "value": "StandardDFamily", + "localizedValue": "Standard D Family Cluster LowPriority vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard DSv2 Family Cluster LowPriority vCPUs", + "value": "StandardDSv2Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardDv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard Dv2 Family Cluster LowPriority vCPUs", + "value": "StandardDv2Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardFSv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard FSv2 Family Cluster LowPriority vCPUs", + "value": "StandardFSv2Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages", + "currentValue": 18, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "StandardNCFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspace/lowPriorityCores/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "StandardNCFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/computes/demo_cluster1_lowPriority_nc/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspace/computes/lowPriorityCores/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "StandardNCFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspace/lowPriorityCores/usages", + "currentValue": 12, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "StandardNCFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster2_lowPriority_nc/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspace/computes/lowPriorityCores/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "StandardNCFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/computes/demo_cluster3_lowPriority_nc/usages/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspace/computes/lowPriorityCores/usages", + "currentValue": 6, + "limit": -1, + "name": { + "localizedValue": "Standard NC Family Cluster LowPriority vCPUs", + "value": "StandardNCFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv2 Family Cluster LowPriority vCPUs", + "value": "StandardNCv2Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNCv3Family", + "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NCv3 Family Cluster LowPriority vCPUs", + "value": "StandardNCv3Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNDFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard ND Family Cluster LowPriority vCPUs", + "value": "StandardNDFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNDv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NDv2 Family Cluster LowPriority vCPUs", + "value": "StandardNDv2Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/usages/StandardNVFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/lowPriorityCores/usages", + "currentValue": 0, + "limit": -1, + "name": { + "localizedValue": "Standard NV Family Cluster LowPriority vCPUs", + "value": "StandardNVFamily" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListVMSizesResult.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListVMSizesResult.json new file mode 100644 index 000000000000..b7c658842ef7 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListVMSizesResult.json @@ -0,0 +1,455 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "api-version": "2020-06-01", + "location": "eastus" + }, + "responses": { + "200": { + "body": { + "amlCompute": [ + { + "name": "Standard_F2s_v2", + "family": "standardFSv2Family", + "vCPUs": 2, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 16384, + "memoryGB": 4.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F4s_v2", + "family": "standardFSv2Family", + "vCPUs": 4, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 32768, + "memoryGB": 8.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F8s_v2", + "family": "standardFSv2Family", + "vCPUs": 8, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 65536, + "memoryGB": 16.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F16s_v2", + "family": "standardFSv2Family", + "vCPUs": 16, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 131072, + "memoryGB": 32.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F32s_v2", + "family": "standardFSv2Family", + "vCPUs": 32, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 262144, + "memoryGB": 64.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F64s_v2", + "family": "standardFSv2Family", + "vCPUs": 64, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 524288, + "memoryGB": 128.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_F72s_v2", + "family": "standardFSv2Family", + "vCPUs": 72, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 589824, + "memoryGB": 144.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_D1_v2", + "family": "standardDv2Family", + "vCPUs": 1, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 51200, + "memoryGB": 3.5, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D2_v2", + "family": "standardDv2Family", + "vCPUs": 2, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 102400, + "memoryGB": 7.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D3_v2", + "family": "standardDv2Family", + "vCPUs": 4, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 204800, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D4_v2", + "family": "standardDv2Family", + "vCPUs": 8, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 409600, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D11_v2", + "family": "standardDv2Family", + "vCPUs": 2, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 102400, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D12_v2", + "family": "standardDv2Family", + "vCPUs": 4, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 204800, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D13_v2", + "family": "standardDv2Family", + "vCPUs": 8, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 409600, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_D14_v2", + "family": "standardDv2Family", + "vCPUs": 16, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 819200, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_DS1_v2", + "family": "standardDSv2Family", + "vCPUs": 1, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 7168, + "memoryGB": 3.5, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS2_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 14336, + "memoryGB": 7.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS3_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS4_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS5_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS11_v2", + "family": "standardDSv2Family", + "vCPUs": 2, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 28672, + "memoryGB": 14.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS12_v2", + "family": "standardDSv2Family", + "vCPUs": 4, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 57344, + "memoryGB": 28.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS13_v2", + "family": "standardDSv2Family", + "vCPUs": 8, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 114688, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS14_v2", + "family": "standardDSv2Family", + "vCPUs": 16, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 229376, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_DS15_v2", + "family": "standardDSv2Family", + "vCPUs": 20, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 286720, + "memoryGB": 140.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC6s_v2", + "family": "standardNCSv2Family", + "vCPUs": 6, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 344064, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC12s_v2", + "family": "standardNCSv2Family", + "vCPUs": 12, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 688128, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC24rs_v2", + "family": "standardNCSv2Family", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC24s_v2", + "family": "standardNCSv2Family", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC6s_v3", + "family": "standardNCSv3Family", + "vCPUs": 6, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 344064, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC12s_v3", + "family": "standardNCSv3Family", + "vCPUs": 12, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 688128, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC24rs_v3", + "family": "standardNCSv3Family", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC24s_v3", + "family": "standardNCSv3Family", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_NC6", + "family": "standardNCFamily", + "vCPUs": 6, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 389120, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NC12", + "family": "standardNCFamily", + "vCPUs": 12, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 696320, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NC24", + "family": "standardNCFamily", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1474560, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NC24r", + "family": "standardNCFamily", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1474560, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NV6", + "family": "standardNVFamily", + "vCPUs": 6, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 389120, + "memoryGB": 56.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NV12", + "family": "standardNVFamily", + "vCPUs": 12, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 696320, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_NV24", + "family": "standardNVFamily", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1474560, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": false + }, + { + "name": "Standard_ND6s", + "family": "standardNDSFamily", + "vCPUs": 6, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 344064, + "memoryGB": 112.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_ND12s", + "family": "standardNDSFamily", + "vCPUs": 12, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 688128, + "memoryGB": 224.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_ND24rs", + "family": "standardNDSFamily", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + }, + { + "name": "Standard_ND24s", + "family": "standardNDSFamily", + "vCPUs": 24, + "osVhdSizeMB": 1047552, + "maxResourceVolumeMB": 1376256, + "memoryGB": 448.0, + "lowPriorityCapable": true, + "premiumIO": true + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListWorkspaceFeatures.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListWorkspaceFeatures.json new file mode 100644 index 000000000000..6ab06854f3bd --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListWorkspaceFeatures.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "api-version": "2020-06-01", + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "resourceGroupName": "myResourceGroup", + "workspaceName": "testworkspace" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "automatedml_createeditexperimentsui", + "displayName": "Create edit experiments UI", + "description": "Create, edit or delete AutoML experiments in the SDK" + }, + { + "id": "workspace_upgradeworkspaceui", + "displayName": "Upgrade workspace UI", + "description": "Upgrade workspace from Basic to enterprise from the UI" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListWorkspaceQuotasByVMFamily.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListWorkspaceQuotasByVMFamily.json new file mode 100644 index 000000000000..a81090adc166 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/ListWorkspaceQuotasByVMFamily.json @@ -0,0 +1,415 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardDFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas", + "limit": 48, + "name": { + "localizedValue": "Standard D Family Cluster Dedicated vCPUs", + "value": "StandardDFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardDFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 12, + "name": { + "value": "StandardDFamily", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardDFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 12, + "name": { + "value": "StandardDFamily", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/StandardDFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardDFamily", + "localizedValue": "Standard D Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardDSv2Family", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardDSv2Family", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 12, + "name": { + "value": "StandardDSv2Family", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 12, + "name": { + "value": "StandardDSv2Family", + "localizedValue": "Standard DSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardDv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs", + "value": "StandardDv2Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardDv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardDv2Family", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardDv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardDv2Family", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/StandardDv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardDv2Family", + "localizedValue": "Standard Dv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardFSv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardFSv2Family", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardFSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardFSv2Family", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardFSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardFSv2Family", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/StandardFSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 12, + "name": { + "value": "StandardFSv2Family", + "localizedValue": "Standard FSv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs", + "value": "StandardNCFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardNCFamily", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardNCFamily", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/StandardNCFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardNCFamily", + "localizedValue": "Standard NC Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNCv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs", + "value": "StandardNCv2Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNCv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNCv2Family", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardNCv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNCv2Family", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/StandardNCv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNCv2Family", + "localizedValue": "Standard NCv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNCv3Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs", + "value": "StandardNCv3Family" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNCv3Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNCv3Family", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardNCv3Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNCv3Family", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/StandardNCv3Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNCv3Family", + "localizedValue": "Standard NCv3 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNDFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas", + "limit": 0, + "name": { + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs", + "value": "StandardNDFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNDFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNDFamily", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardNDFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNDFamily", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/StandardNDFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNDFamily", + "localizedValue": "Standard ND Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNDv2Family", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNDv2Family", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNDv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNDv2Family", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardNDv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNDv2Family", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/StandardNDv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 0, + "name": { + "value": "StandardNDv2Family", + "localizedValue": "Standard NDv2 Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/quotas/StandardNVFamily", + "type": "Microsoft.MachineLearningServices/vmFamily/dedicatedCores/quotas", + "limit": 24, + "name": { + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs", + "value": "StandardNVFamily" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardNVFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardNVFamily", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardNVFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardNVFamily", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace3/quotas/StandardNVFamily", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 24, + "name": { + "value": "StandardNVFamily", + "localizedValue": "Standard NV Family Cluster Dedicated vCPUs" + }, + "unit": "Count" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/amlComputeListNodes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/amlComputeListNodes.json new file mode 100644 index 000000000000..a36d2da3aaad --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/amlComputeListNodes.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "computeType": "AmlCompute", + "nodes": [ + { + "nodeId": "tvm-3601533753_1-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50000, + "nodeState": "running", + "runId": "2f378a44-38f2-443a-9f0d-9909d0b47890" + }, + { + "nodeId": "tvm-3601533753_2-20170719t162906z", + "privateIpAddress": "13.84.190.124", + "publicIpAddress": "13.84.190.134", + "port": 50001, + "nodeState": "idle" + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicAKSCompute.json new file mode 100644 index 000000000000..db401df9d57d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicAKSCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AKS" + } + } + }, + "responses": { + "200": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AKS", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicAmlCompute.json new file mode 100644 index 000000000000..f9420e79b013 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicAmlCompute.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "NotSpecified" + } + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicDataFactoryCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicDataFactoryCompute.json new file mode 100644 index 000000000000..f3a2a07f91e5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createBasicDataFactoryCompute.json @@ -0,0 +1,44 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "DataFactory" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "DataFactory", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createComputeInstance.json new file mode 100644 index 000000000000..5379775c2b89 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createComputeInstance.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": "test-subnet-resource-id", + "applicationSharingPolicy": "Personal", + "sshSettings": { + "sshPublicAccess": "Disabled" + } + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createComputeInstanceMinimal.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createComputeInstanceMinimal.json new file mode 100644 index 000000000000..5cd739c27b81 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createComputeInstanceMinimal.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "properties": { + "vmSize": "STANDARD_NC6" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "computeType": "ComputeInstance", + "provisioningState": "Creating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createWorkspace.json new file mode 100644 index 000000000000..14b0251270ee --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createWorkspace.json @@ -0,0 +1,148 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus2euap", + "sku": { + "name": "Basic", + "tier": "Basic" + }, + "properties": { + "friendlyName": "HelloName", + "description": "test description", + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "encryption": { + "status": "Enabled", + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ] + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Basic", + "tier": "Basic" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "allowPublicAccessWhenBehindVnet": false, + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ], + "notebookInfo": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } + } + } + }, + "201": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Basic", + "tier": "Basic" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "allowPublicAccessWhenBehindVnet": false, + "sharedPrivateLinkResources": [ + { + "name": "testdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ], + "notebookInfo": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } + } + } + }, + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createWorkspaceConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createWorkspaceConnection.json new file mode 100644 index 000000000000..521acd0c4494 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/createWorkspaceConnection.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2020-06-01", + "parameters": { + "name": "connection-1", + "properties": { + "category": "ACR", + "target": "www.facebook.com", + "authType": "PAT", + "value": "secrets" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ACR", + "target": "www.facebook.com", + "authType": "PAT", + "value": "secrets" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteCompute.json new file mode 100644 index 000000000000..ab1edfae7e82 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteCompute.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01", + "underlyingResourceAction": "Delete" + }, + "responses": { + "200": {}, + "202": { + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus...", + "Location": "https://management.azure.com/subscriptions/...pathToOperationResult..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteWorkspace.json new file mode 100644 index 000000000000..c0425965629d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteWorkspace.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-06-01" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteWorkspaceConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteWorkspaceConnection.json new file mode 100644 index 000000000000..e1aafd381e53 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/deleteWorkspaceConnection.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2020-06-01" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getAKSCompute.json new file mode 100644 index 000000000000..c337b0d23372 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getAKSCompute.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getAmlCompute.json new file mode 100644 index 000000000000..692799eaac79 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getAmlCompute.json @@ -0,0 +1,60 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "createdOn": "2017-09-26T22:28:08.327Z", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "vmPriority": "Dedicated", + "subnet": "test-subnet-resource-id", + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + }, + "remoteLoginPortPublicAccess": "Enabled", + "allocationState": "Resizing", + "allocationStateTransitionTime": "2017-09-27T22:28:08.998Z", + "errors": null, + "currentNodeCount": 0, + "targetNodeCount": 1, + "nodeStateCounts": { + "preparingNodeCount": 0, + "runningNodeCount": 0, + "idleNodeCount": 0, + "unusableNodeCount": 0, + "leavingNodeCount": 0, + "preemptedNodeCount": 0 + } + } + }, + "identity": { + "principalId": "00000000-0000-0000-0000-000000000000", + "tenantId": "00000000-0000-0000-0000-000000000000", + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/f9d7ebed-adbd-4cb4-b973-aaf82c136138/resourcegroups/myResourceGroup1/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity2": { + "clientId": "00000000-0000-0000-0000-000000000000", + "principalId": "00000000-0000-0000-0000-000000000000" + } + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getComputeInstance.json new file mode 100644 index 000000000000..c00d60feb202 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getComputeInstance.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "ComputeInstance", + "createdOn": "2017-09-26T22:28:08.327Z", + "provisioningState": "Succeeded", + "properties": { + "vmSize": "STANDARD_NC6", + "subnet": "test-subnet-resource-id", + "applicationSharingPolicy": "Shared", + "sshSettings": { + "sshPublicAccess": "Enabled", + "adminUserName": "azureuser", + "sshPort": 22 + }, + "createdBy": { + "userName": "foobar@microsoft.com", + "userOrgId": "00000000-0000-0000-0000-000000000000", + "userId": "00000000-0000-0000-0000-000000000000" + }, + "connectivityEndpoints": { + "publicIpAddress": "10.0.0.1", + "privateIpAddress": "10.0.0.1" + }, + "applications": [ + { + "displayName": "Jupyter", + "endpointUri": "https://compute123.eastus2.azureml.net/jupyter" + } + ], + "errors": null, + "state": "Running" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getComputes.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getComputes.json new file mode 100644 index 000000000000..b4c4fa9882ac --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getComputes.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute1234", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute1234", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute1234-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Succeeded" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspace.json new file mode 100644 index 000000000000..25abf40c63df --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspace.json @@ -0,0 +1,82 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Enterprise", + "tier": "Enterprise" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description", + "encryption": { + "status": "Enabled", + "keyVaultProperties": { + "keyVaultArmId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "keyIdentifier": "https://testkv.vault.azure.net/keys/testkey/aabbccddee112233445566778899aabb", + "identityClientId": "" + } + }, + "hbiWorkspace": false, + "serviceProvisionedResourceGroup": "testworkspace_0000111122223333", + "privateLinkCount": 0, + "allowPublicAccessWhenBehindVnet": false, + "imageBuildCompute": "testcompute", + "privateEndpointConnections": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/testprivatelinkconnection", + "name": "testprivatelinkconnection", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + ], + "sharedPrivateLinkResources": [ + { + "name": "testcosmosdbresource", + "properties": { + "privateLinkResourceId": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.DocumentDB/databaseAccounts/testcosmosdbresource/privateLinkResources/Sql", + "groupId": "Sql", + "requestMessage": "Please approve", + "status": "Approved" + } + } + ], + "notebookInfo": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspaceConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspaceConnection.json new file mode 100644 index 000000000000..159d811c43b8 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspaceConnection.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "connectionName": "connection-1", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/connections/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ACR", + "target": "www.facebook.com", + "authType": "PAT", + "value": "secrets" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspacesByResourceGroup.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspacesByResourceGroup.json new file mode 100644 index 000000000000..de21ed344abe --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspacesByResourceGroup.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Basic", + "tier": "Basic" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace1", + "name": "testworkspace1", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Basic", + "tier": "Basic" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName 1", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspacesBySubscription.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspacesBySubscription.json new file mode 100644 index 000000000000..a06cd53137bb --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/getWorkspacesBySubscription.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Enterprise", + "tier": "Enterprise" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-5678/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Enterprise", + "tier": "Enterprise" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistryNew", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkvNew", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccountOld", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "HelloName", + "description": "test description" + } + } + ], + "nextLink": "nextLink" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listKeysAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listKeysAKSCompute.json new file mode 100644 index 000000000000..94b43cb7163d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listKeysAKSCompute.json @@ -0,0 +1,19 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "computeType": "AKS", + "userKubeConfig": "user kube config...", + "adminKubeConfig": "admin kube config...", + "imagePullSecretName": "the image pull secret name" + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listWorkspaceConnections.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listWorkspaceConnections.json new file mode 100644 index 000000000000..3cf89397b61e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listWorkspaceConnections.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "resourceGroup-1", + "workspaceName": "workspace-1", + "api-version": "2020-06-01", + "target": "www.facebook.com", + "category": "ACR" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-1", + "name": "connection-1", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ACR", + "target": "www.facebook.com", + "authType": "PAT", + "value": "secrets" + } + }, + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/resourceGroup-1/providers/Microsoft.MachineLearningServices/workspaces/workspace-1/linkedWorkspaces/connection-2", + "name": "connection-2", + "type": "Microsoft.MachineLearningServices/workspaces/connections", + "properties": { + "category": "ACR", + "target": "www.facebook.com", + "authType": "PAT", + "value": "secrets" + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listWorkspaceKeys.json new file mode 100644 index 000000000000..be0190b71d69 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/listWorkspaceKeys.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "userStorageKey": "r5rKCJ018TLk+bdAi/9YaVzgcQ0nkLsUqGyUN03KsdCFtqG0SjFGPV8+vT1frWqkvBL0bGoPpLc1BlZSSaZmOA==", + "userStorageResourceId": "/subscriptions/aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee/resourceGroups/ragargeastus2euap/providers/Microsoft.Storage/storageAccounts/testdemoworkazashomr", + "appInsightsInstrumentationKey": null, + "containerRegistryCredentials": { + "location": null, + "username": "testdemoworkjmjmeykp", + "passwords": [ + { + "name": "password", + "value": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw" + }, + { + "name": "password2", + "value": "0KARRQoQHSUq1yViPWg7YFernOS=Ic/t" + } + ] + }, + "notebookAccessKeys": { + "primaryAccessKey": "vBvVhYgAGtUSewVCUv3w95p4/q5Yrsnw", + "secondaryAccessKey": "0KARRQoQHSUq1yViPWg7YFernOS" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/patchAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/patchAmlCompute.json new file mode 100644 index 000000000000..88f65f776d80 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/patchAmlCompute.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01", + "parameters": { + "properties": { + "scaleSettings": { + "maxNodeCount": 4, + "minNodeCount": 4, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/restartComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/restartComputeInstance.json new file mode 100644 index 000000000000..71e86d428edc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/restartComputeInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/resyncWorkspaceKeys.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/resyncWorkspaceKeys.json new file mode 100644 index 000000000000..7494624f6c74 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/resyncWorkspaceKeys.json @@ -0,0 +1,11 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-06-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/startComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/startComputeInstance.json new file mode 100644 index 000000000000..71e86d428edc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/startComputeInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/stopComputeInstance.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/stopComputeInstance.json new file mode 100644 index 000000000000..71e86d428edc --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/stopComputeInstance.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01" + }, + "responses": { + "200": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateAKSCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateAKSCompute.json new file mode 100644 index 000000000000..7c1f3d13d84d --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateAKSCompute.json @@ -0,0 +1,53 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "properties": { + "agentCount": 4 + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus", + "properties": { + "description": "some compute", + "resourceId": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourcegroups/testrg123/providers/Microsoft.ContainerService/managedClusters/compute123-56826-c9b00420020b2", + "computeType": "AKS", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateAmlCompute.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateAmlCompute.json new file mode 100644 index 000000000000..98d7470237bf --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateAmlCompute.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "34adfa4f-cedf-4dc0-ba29-b6d1a69ab345", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "computeName": "compute123", + "api-version": "2020-06-01", + "parameters": { + "location": "eastus", + "properties": { + "computeType": "AmlCompute", + "properties": { + "scaleSettings": { + "maxNodeCount": 1, + "minNodeCount": 0, + "nodeIdleTimeBeforeScaleDown": "PT5M" + } + } + }, + "identity": { + "type": "SystemAssigned, UserAssigned", + "userAssignedIdentities": { + "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/myResourceGroup/providers/Microsoft.ManagedIdentity/userAssignedIdentities/identity-name": {} + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/34adfa4f-cedf-4dc0-ba29-b6d1a69ab345/resourceGroups/testrg123/providers/Microsoft.MachineLearningServices/workspaces/workspaces123/computes/compute123", + "type": "Microsoft.MachineLearningServices/workspaces/computes", + "name": "compute123", + "location": "eastus2", + "properties": { + "description": "some compute", + "computeType": "AmlCompute", + "provisioningState": "Updating" + } + }, + "headers": { + "Azure-AsyncOperation": "https://management.azure.com/subscriptions/...pathToOperationStatus..." + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateQuota.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateQuota.json new file mode 100644 index 000000000000..12ccc2bb1cb5 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateQuota.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "00000000-0000-0000-0000-000000000000", + "location": "eastus", + "api-version": "2020-06-01", + "parameters": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 100, + "unit": "Count" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 200, + "unit": "Count" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace1/quotas/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 100, + "unit": "Count", + "status": "Success" + }, + { + "id": "/subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/rg/providers/Microsoft.MachineLearningServices/workspaces/demo_workspace2/quotas/StandardDSv2Family", + "type": "Microsoft.MachineLearningServices/workspaces/dedicatedCores/quotas", + "limit": 200, + "unit": "Count", + "status": "Success" + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateWorkspace.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateWorkspace.json new file mode 100644 index 000000000000..a6166e476d50 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/updateWorkspace.json @@ -0,0 +1,42 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "workspace-1234", + "workspaceName": "testworkspace", + "api-version": "2020-06-01", + "parameters": { + "sku": { + "name": "Enterprise", + "tier": "Enterprise" + }, + "properties": { + "friendlyName": "New friendly name", + "description": "new description" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace", + "name": "testworkspace", + "type": "Microsoft.MachineLearningServices/workspaces", + "location": "eastus2euap", + "sku": { + "name": "Enterprise", + "tier": "Enterprise" + }, + "properties": { + "containerRegistry": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.ContainerRegistry/registries/testRegistry", + "keyVault": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/Microsoft.KeyVault/vaults/testkv", + "applicationInsights": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/workspace-1234/providers/microsoft.insights/components/testinsights", + "storageAccount": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/accountcrud-1234/providers/Microsoft.Storage/storageAccounts/testStorageAccount", + "discoveryUrl": "http://example.com", + "creationTime": "2017-03-01T23:14:37.0707808Z", + "friendlyName": "New friendly name", + "description": "new description" + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceDeletePrivateEndpointConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceDeletePrivateEndpointConnection.json new file mode 100644 index 000000000000..d6cddc4a0c2c --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceDeletePrivateEndpointConnection.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-06-01", + "monitor": "true" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceGetPrivateEndpointConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceGetPrivateEndpointConnection.json new file mode 100644 index 000000000000..82af3249a962 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceGetPrivateEndpointConnection.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-06-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceListPrivateLinkResources.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceListPrivateLinkResources.json new file mode 100644 index 000000000000..2757062dd036 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspaceListPrivateLinkResources.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "api-version": "2020-06-01", + "monitor": "true" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateLinkResources/amlworkspace", + "name": "amlworkspace", + "type": "Microsoft.Storage/workspaces/privateLinkResources", + "properties": { + "groupId": "amlworkspace", + "requiredMembers": [ + "default" + ] + } + } + ] + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspacePrepareNotebook.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspacePrepareNotebook.json new file mode 100644 index 000000000000..93f38156f95e --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspacePrepareNotebook.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "aaaaaaaa-bbbb-cccc-dddd-eeeeeeeeeeee", + "resourceGroupName": "testrg123", + "workspaceName": "workspaces123", + "api-version": "2020-06-01" + }, + "responses": { + "200": { + "body": { + "resourceId": "aabbccddee112233445566778899", + "fqdn": "testnotebook.notebooks.azure.com", + "notebookPreparationError": { + "statusCode": 500, + "errorMessage": "general error" + } + } + }, + "202": {} + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspacePutPrivateEndpointConnection.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspacePutPrivateEndpointConnection.json new file mode 100644 index 000000000000..8521b3e53ab9 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/examples/workspacePutPrivateEndpointConnection.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "rg-1234", + "workspaceName": "testworkspace", + "privateEndpointConnectionName": "{privateEndpointConnectionName}", + "api-version": "2020-06-01", + "monitor": "true", + "properties": { + "properties": { + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved" + } + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.MachineLearningServices/workspaces/testworkspace/privateEndpointConnections/{privateEndpointConnectionName}", + "name": "{privateEndpointConnectionName}", + "type": "Microsoft.MachineLearningServices/workspaces/privateEndpointConnections", + "properties": { + "provisioningState": "Succeeded", + "privateEndpoint": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/rg-1234/providers/Microsoft.Network/privateEndpoints/petest01" + }, + "privateLinkServiceConnectionState": { + "status": "Approved", + "description": "Auto-Approved", + "actionsRequired": "None" + } + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json new file mode 100644 index 000000000000..03cb6e43b145 --- /dev/null +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json @@ -0,0 +1,4070 @@ +{ + "swagger": "2.0", + "info": { + "title": "Azure Machine Learning Workspaces", + "description": "These APIs allow end users to operate on Azure Machine Learning Workspace resources.", + "version": "2020-06-01" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow.", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.MachineLearningServices/operations": { + "get": { + "tags": [ + "Operation" + ], + "description": "Lists all of the available Azure Machine Learning Workspaces REST API operations.", + "operationId": "Operations_List", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Gets the properties of the specified machine learning workspace.", + "operationId": "Workspaces_Get", + "x-ms-examples": { + "Get Workspace": { + "$ref": "./examples/getWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "Workspaces" + ], + "description": "Creates or updates a workspace with the specified parameters.", + "operationId": "Workspaces_CreateOrUpdate", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create Workspace": { + "$ref": "./examples/createWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for creating or updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/Workspace" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "201": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "202": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "Workspaces" + ], + "description": "Deletes a machine learning workspace.", + "operationId": "Workspaces_Delete", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Workspace": { + "$ref": "./examples/deleteWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "204": { + "description": "The machine learning workspace does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "patch": { + "tags": [ + "Workspaces" + ], + "description": "Updates a machine learning workspace with the specified parameters.", + "operationId": "Workspaces_Update", + "x-ms-examples": { + "Update Workspace": { + "$ref": "./examples/updateWorkspace.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The parameters for updating a machine learning workspace.", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceUpdateParameters" + } + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/Workspace" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/features": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all enabled features for a workspace", + "operationId": "WorkspaceFeatures_List", + "x-ms-examples": { + "List Workspace features": { + "$ref": "./examples/ListWorkspaceFeatures.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListAmlUserFeatureResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/prepareNotebook": { + "post": { + "tags": [ + "ProxyOperations" + ], + "operationId": "Notebooks_Prepare", + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "x-ms-examples": { + "Prepare Notebook": { + "$ref": "./examples/workspacePrepareNotebook.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "Success", + "schema": { + "$ref": "#/definitions/NotebookResourceInfo" + } + }, + "202": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified resource group.", + "operationId": "Workspaces_ListByResourceGroup", + "x-ms-examples": { + "Get Workspaces by Resource Group": { + "$ref": "./examples/getWorkspacesByResourceGroup.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/listKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ListKeys", + "x-ms-examples": { + "List Workspace Keys": { + "$ref": "./examples/listWorkspaceKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/ListWorkspaceKeysResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/resyncKeys": { + "post": { + "tags": [ + "Workspaces" + ], + "description": "Resync all the keys associated with this workspace. This includes keys for the storage account, app insights and password for container registry", + "operationId": "Workspaces_ResyncKeys", + "x-ms-examples": { + "Resync Workspace Keys": { + "$ref": "./examples/resyncWorkspaceKeys.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/usages": { + "get": { + "tags": [ + "Usage" + ], + "operationId": "Usages_List", + "description": "Gets the current usage information as well as limits for AML resources for given subscription and location.", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListUsagesResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List Usages": { + "$ref": "./examples/ListUsages.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/vmSizes": { + "get": { + "tags": [ + "VirtualMachineSizes" + ], + "operationId": "VirtualMachineSizes_List", + "description": "Returns supported VM Sizes in a location", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location upon which virtual-machine-sizes is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/VirtualMachineSizeListResult" + } + } + }, + "x-ms-examples": { + "List VM Sizes": { + "$ref": "./examples/ListVMSizesResult.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/updateQuotas": { + "post": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_Update", + "description": "Update quota for each VM family in workspace.", + "parameters": [ + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for update quota is queried.", + "pattern": "^[-\\w\\._]+$" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/QuotaUpdateParameters" + }, + "description": "Quota update parameters." + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful.", + "schema": { + "$ref": "#/definitions/UpdateWorkspaceQuotasResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-examples": { + "update quotas": { + "$ref": "./examples/updateQuota.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/locations/{location}/Quotas": { + "get": { + "tags": [ + "Quota" + ], + "operationId": "Quotas_List", + "description": "Gets the currently assigned Workspace Quotas based on VMFamily.", + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "required": true, + "type": "string", + "description": "The location for which resource usage is queried.", + "pattern": "^[-\\w\\._]+$" + } + ], + "responses": { + "200": { + "description": "OK", + "schema": { + "$ref": "#/definitions/ListWorkspaceQuotas" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List workspace quotas by VMFamily": { + "$ref": "./examples/ListWorkspaceQuotasByVMFamily.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces": { + "get": { + "tags": [ + "Workspaces" + ], + "description": "Lists all the available machine learning workspaces under the specified subscription.", + "operationId": "Workspaces_ListBySubscription", + "x-ms-examples": { + "Get Workspaces by subscription": { + "$ref": "./examples/getWorkspacesBySubscription.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/WorkspaceListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections": { + "get": { + "tags": [ + "WorkspaceConnections" + ], + "x-ms-pageable": { + "nextLinkName": null + }, + "x-ms-examples": { + "ListWorkspaceConnections": { + "$ref": "./examples/listWorkspaceConnections.json" + } + }, + "operationId": "WorkspaceConnections_List", + "description": "List all connections under a AML workspace.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/TargetParameter" + }, + { + "$ref": "#/parameters/CategoryParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Workspace connections and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedWorkspaceConnectionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/connections/{connectionName}": { + "put": { + "tags": [ + "WorkspaceConnections" + ], + "operationId": "WorkspaceConnections_Create", + "description": "Add a new workspace connection.", + "x-ms-examples": { + "CreateWorkspaceConnection": { + "$ref": "./examples/createWorkspaceConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "description": "The object for creating or updating a new workspace connection", + "required": true, + "schema": { + "$ref": "#/definitions/WorkspaceConnectionDto" + } + } + ], + "responses": { + "200": { + "description": "Successfully created the workspace connection.", + "schema": { + "$ref": "#/definitions/WorkspaceConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "get": { + "tags": [ + "WorkspaceConnections" + ], + "operationId": "WorkspaceConnections_Get", + "description": "Get the detail of a workspace connection.", + "x-ms-examples": { + "GetWorkspaceConnection": { + "$ref": "./examples/getWorkspaceConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the detail of the linked workspace.", + "schema": { + "$ref": "#/definitions/WorkspaceConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "WorkspaceConnections" + ], + "operationId": "WorkspaceConnections_Delete", + "description": "Delete a workspace connection.", + "x-ms-examples": { + "DeleteWorkspaceConnection": { + "$ref": "./examples/deleteWorkspaceConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ConnectionName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the workspace connection." + }, + "204": { + "description": "Specific workspace connection not found." + }, + "default": { + "description": "Error response describing why the operation failed", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "operationId": "MachineLearningCompute_ListByWorkspace", + "description": "Gets computes in specified workspace.", + "x-ms-examples": { + "Get Computes": { + "$ref": "./examples/getComputes.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/PaginationParameter" + } + ], + "responses": { + "200": { + "description": "The response includes a paginated array of Machine Learning computes and a URI to the next set of results, if any. For the more information the limits of the number of items in a resource group, see https://azure.microsoft.com/en-us/documentation/articles/azure-subscription-service-limits/.", + "schema": { + "$ref": "#/definitions/PaginatedComputeResourcesList" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}": { + "get": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Get", + "description": "Gets compute definition by its name. Any secrets (storage keys, service credentials, etc) are not returned - use 'keys' nested resource to get them.", + "x-ms-examples": { + "Get a AKS Compute": { + "$ref": "./examples/getAKSCompute.json" + }, + "Get a AML Compute": { + "$ref": "./examples/getAmlCompute.json" + }, + "Get a ComputeInstance": { + "$ref": "./examples/getComputeInstance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "put": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_CreateOrUpdate", + "description": "Creates or updates compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation. If your intent is to create a new compute, do a GET first to verify that it does not exist yet.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Create a AML Compute": { + "$ref": "./examples/createBasicAmlCompute.json" + }, + "Create a ComputeInstance Compute with minimal inputs": { + "$ref": "./examples/createComputeInstanceMinimal.json" + }, + "Create a ComputeInstance Compute": { + "$ref": "./examples/createComputeInstance.json" + }, + "Create AKS Compute": { + "$ref": "./examples/createBasicAKSCompute.json" + }, + "Create a DataFactory Compute": { + "$ref": "./examples/createBasicDataFactoryCompute.json" + }, + "Update a AML Compute": { + "$ref": "./examples/updateAmlCompute.json" + }, + "Update a AKS Compute": { + "$ref": "./examples/updateAKSCompute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/ComputeDefinitionParameter" + } + ], + "responses": { + "200": { + "description": "Compute creation or update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "201": { + "description": "Compute creation or update initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + } + }, + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "patch": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Update", + "description": "Updates properties of a compute. This call will overwrite a compute if it exists. This is a nonrecoverable operation.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a AmlCompute Compute": { + "$ref": "./examples/patchAmlCompute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdateParameters" + }, + "description": "Additional parameters for cluster update." + } + ], + "responses": { + "200": { + "description": "Compute update initiated.", + "schema": { + "$ref": "#/definitions/ComputeResource" + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + }, + "delete": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Delete", + "description": "Deletes specified Machine Learning compute.", + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Delete Compute": { + "$ref": "./examples/deleteCompute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/UnderlyingResourceActionParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly." + }, + "202": { + "description": "Compute deletion initiated.", + "headers": { + "Azure-AsyncOperation": { + "description": "URI to poll for asynchronous operation status.", + "type": "string" + }, + "Location": { + "description": "URI to poll for asynchronous operation result.", + "type": "string" + } + } + }, + "default": { + "description": "Error response describing why the request failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listNodes": { + "post": { + "tags": [ + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_ListNodes", + "description": "Get the details (e.g IP address, port etc) of all the compute nodes in the compute.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of IP addresses.", + "schema": { + "$ref": "#/definitions/AmlComputeNodesInformation" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-examples": { + "Get compute nodes information for a compute": { + "$ref": "./examples/amlComputeListNodes.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/listKeys": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_ListKeys", + "description": "Gets secrets related to Machine Learning compute (storage keys, service credentials, etc).", + "x-ms-examples": { + "List AKS Compute Keys": { + "$ref": "./examples/listKeysAKSCompute.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success.", + "schema": { + "$ref": "#/definitions/ComputeSecrets" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.MachineLearningServices/workspaces/skus": { + "get": { + "tags": [ + "WorkspaceSkus" + ], + "description": "Lists all skus with associated features", + "operationId": "ListSkus", + "x-ms-examples": { + "List Skus": { + "$ref": "./examples/ListSkus.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "The request was successful; the request was well-formed and received properly.", + "schema": { + "$ref": "#/definitions/SkuListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateEndpointConnections/{privateEndpointConnectionName}": { + "get": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Get", + "description": "Gets the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceGetPrivateEndpointConnection": { + "$ref": "./examples/workspaceGetPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Get the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "put": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Put", + "description": "Update the state of specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspacePutPrivateEndpointConnection": { + "$ref": "./examples/workspacePutPrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + }, + { + "name": "properties", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The private endpoint connection properties." + } + ], + "responses": { + "200": { + "description": "OK -- Update the private endpoint connection properties successfully.", + "schema": { + "$ref": "#/definitions/PrivateEndpointConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + }, + "delete": { + "tags": [ + "WorkspacePrivateEndpointConnections" + ], + "operationId": "PrivateEndpointConnections_Delete", + "description": "Deletes the specified private endpoint connection associated with the workspace.", + "x-ms-examples": { + "WorkspaceDeletePrivateEndpointConnection": { + "$ref": "./examples/workspaceDeletePrivateEndpointConnection.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/PrivateEndpointConnectionName" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- Delete the private endpoint connection successfully." + }, + "204": { + "description": "No Content -- The private endpoint connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/privateLinkResources": { + "get": { + "tags": [ + "WorkspacePrivateLinkResources" + ], + "operationId": "PrivateLinkResources_ListByWorkspace", + "description": "Gets the private link resources that need to be created for a workspace.", + "x-ms-examples": { + "WorkspaceListPrivateLinkResources": { + "$ref": "./examples/workspaceListPrivateLinkResources.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved private link resources.", + "schema": { + "$ref": "#/definitions/PrivateLinkResourceListResult" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/start": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Start", + "description": "Posts a start action to a compute instance", + "x-ms-examples": { + "Start ComputeInstance Compute": { + "$ref": "./examples/startComputeInstance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/stop": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Stop", + "description": "Posts a stop action to a compute instance", + "x-ms-examples": { + "Stop ComputeInstance Compute": { + "$ref": "./examples/stopComputeInstance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.MachineLearningServices/workspaces/{workspaceName}/computes/{computeName}/restart": { + "post": { + "tags": [ + "OperationalizationClusters", + "MachineLearningComputes" + ], + "operationId": "MachineLearningCompute_Restart", + "description": "Posts a restart action to a compute instance", + "x-ms-examples": { + "Restart ComputeInstance Compute": { + "$ref": "./examples/restartComputeInstance.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/WorkspaceNameParameter" + }, + { + "$ref": "#/parameters/ComputeNameParameter" + }, + { + "$ref": "#/parameters/APIVersionParameter" + } + ], + "responses": { + "200": { + "description": "Success." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/MachineLearningServiceError" + } + } + } + } + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "description": "Azure subscription identifier.", + "in": "path", + "type": "string", + "required": true + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "description": "Name of the resource group in which workspace is located.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "WorkspaceNameParameter": { + "name": "workspaceName", + "description": "Name of Azure Machine Learning workspace.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "ComputeNameParameter": { + "name": "computeName", + "description": "Name of the Azure Machine Learning compute.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "AsyncOperationIdParameter": { + "name": "asyncOperationId", + "description": "Identifier of an asynchronous Azure Machine Learning compute operation.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "LocationParameter": { + "name": "location", + "description": "The name of the Azure location/region.", + "in": "path", + "type": "string", + "required": true, + "x-ms-parameter-location": "method" + }, + "APIVersionParameter": { + "in": "query", + "name": "api-version", + "type": "string", + "description": "Version of Azure Machine Learning resource provider API.", + "required": true + }, + "PaginationParameter": { + "in": "query", + "name": "$skiptoken", + "type": "string", + "description": "Continuation token for pagination.", + "required": false, + "x-ms-parameter-location": "method" + }, + "ComputeDefinitionParameter": { + "in": "body", + "name": "parameters", + "description": "Payload with Machine Learning compute definition.", + "required": true, + "schema": { + "$ref": "#/definitions/ComputeResource" + }, + "x-ms-parameter-location": "method" + }, + "ComputeTypeParameter": { + "in": "query", + "name": "compute-type", + "type": "string", + "description": "Type of compute to filter by.", + "required": false, + "x-ms-parameter-location": "method" + }, + "UnderlyingResourceActionParameter": { + "in": "query", + "name": "underlyingResourceAction", + "type": "string", + "description": "Delete the underlying compute if 'Delete', or detach the underlying compute from workspace if 'Detach'.", + "required": true, + "enum": [ + "Delete", + "Detach" + ], + "x-ms-enum": { + "name": "UnderlyingResourceAction", + "modelAsString": true + }, + "x-ms-parameter-location": "method" + }, + "PrivateEndpointConnectionName": { + "name": "privateEndpointConnectionName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the private endpoint connection associated with the workspace", + "x-ms-parameter-location": "method" + }, + "ConnectionName": { + "name": "connectionName", + "in": "path", + "required": true, + "type": "string", + "description": "Friendly name of the workspace connection", + "x-ms-parameter-location": "method" + }, + "TargetParameter": { + "in": "query", + "name": "target", + "type": "string", + "description": "Target of the workspace connection.", + "required": false, + "x-ms-parameter-location": "method" + }, + "CategoryParameter": { + "in": "query", + "name": "category", + "type": "string", + "description": "Category of the workspace connection.", + "required": false, + "x-ms-parameter-location": "method" + } + }, + "definitions": { + "Operation": { + "description": "Azure Machine Learning workspace REST API operation", + "type": "object", + "properties": { + "name": { + "description": "Operation name: {provider}/{resource}/{operation}", + "type": "string" + }, + "display": { + "description": "Display name of operation", + "properties": { + "provider": { + "description": "The resource provider name: Microsoft.MachineLearningExperimentation", + "type": "string" + }, + "resource": { + "description": "The resource on which the operation is performed.", + "type": "string" + }, + "operation": { + "description": "The operation that users can perform.", + "type": "string" + }, + "description": { + "description": "The description for the operation.", + "type": "string" + } + } + } + } + }, + "NotebookListCredentialsResult": { + "type": "object", + "properties": { + "primaryAccessKey": { + "type": "string" + }, + "secondaryAccessKey": { + "type": "string" + } + } + }, + "NotebookResourceInfo": { + "type": "object", + "properties": { + "fqdn": { + "type": "string" + }, + "resourceId": { + "type": "string", + "description": "the data plane resourceId that used to initialize notebook component" + }, + "notebookPreparationError": { + "$ref": "#/definitions/NotebookPreparationError", + "description": "The error that occurs when preparing notebook." + } + } + }, + "NotebookPreparationError": { + "type": "object", + "properties": { + "errorMessage": { + "type": "string" + }, + "statusCode": { + "format": "int32", + "type": "integer" + } + } + }, + "OperationListResult": { + "description": "An array of operations supported by the resource provider.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "description": "List of AML workspace operations supported by the AML workspace resource provider." + } + } + }, + "Workspace": { + "type": "object", + "description": "An object that represents a machine learning workspace.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/WorkspaceProperties", + "description": "The properties of the machine learning workspace.", + "x-ms-client-flatten": true + } + } + }, + "WorkspaceProperties": { + "type": "object", + "description": "The properties of a machine learning workspace.", + "properties": { + "workspaceId": { + "description": "The immutable id associated with this workspace.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace. This name in mutable", + "type": "string" + }, + "creationTime": { + "format": "date-time", + "description": "The creation time of the machine learning workspace in ISO8601 format.", + "type": "string", + "readOnly": true + }, + "keyVault": { + "description": "ARM id of the key vault associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "applicationInsights": { + "description": "ARM id of the application insights associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "containerRegistry": { + "description": "ARM id of the container registry associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "storageAccount": { + "description": "ARM id of the storage account associated with this workspace. This cannot be changed once the workspace has been created", + "type": "string" + }, + "discoveryUrl": { + "description": "Url for the discovery service to identify regional endpoints for machine learning experimentation services", + "type": "string" + }, + "provisioningState": { + "type": "string", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true, + "description": "The current deployment state of workspace resource. The provisioningState is to indicate states for resource provisioning." + }, + "encryption": { + "$ref": "#/definitions/EncryptionProperty", + "description": "The encryption settings of Azure ML workspace." + }, + "hbiWorkspace": { + "type": "boolean", + "description": "The flag to signal HBI data in the workspace and reduce diagnostic data collected by the service", + "default": false + }, + "serviceProvisionedResourceGroup": { + "type": "string", + "description": "The name of the managed resource group created by workspace RP in customer subscription if the workspace is CMK workspace", + "readOnly": true + }, + "privateLinkCount": { + "type": "integer", + "format": "int32", + "description": "Count of private connections in the workspace", + "readOnly": true + }, + "imageBuildCompute": { + "description": "The compute name for image build", + "type": "string" + }, + "allowPublicAccessWhenBehindVnet": { + "type": "boolean", + "description": "The flag to indicate whether to allow public access when behind VNet.", + "default": false + }, + "privateEndpointConnections": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/PrivateEndpointConnection" + }, + "description": "The list of private endpoint connections in the workspace." + }, + "sharedPrivateLinkResources": { + "type": "array", + "items": { + "$ref": "#/definitions/SharedPrivateLinkResource" + }, + "description": "The list of shared private link resources in this workspace." + }, + "notebookInfo": { + "readOnly": true, + "$ref": "#/definitions/NotebookResourceInfo", + "description": "The notebook info of Azure ML workspace." + } + } + }, + "WorkspaceUpdateParameters": { + "description": "The parameters for updating a machine learning workspace.", + "properties": { + "tags": { + "description": "The resource tags for the machine learning workspace.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." + }, + "properties": { + "$ref": "#/definitions/WorkspacePropertiesUpdateParameters", + "description": "The properties that the machine learning workspace will be updated with.", + "x-ms-client-flatten": true + } + } + }, + "WorkspacePropertiesUpdateParameters": { + "description": "The parameters for updating the properties of a machine learning workspace.", + "properties": { + "description": { + "description": "The description of this workspace.", + "type": "string" + }, + "friendlyName": { + "description": "The friendly name for this workspace.", + "type": "string" + } + } + }, + "AmlUserFeature": { + "description": "Features enabled for a workspace", + "type": "object", + "properties": { + "id": { + "description": "Specifies the feature ID", + "type": "string" + }, + "displayName": { + "description": "Specifies the feature name ", + "type": "string" + }, + "description": { + "description": "Describes the feature for user experience", + "type": "string" + } + } + }, + "ListAmlUserFeatureResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlUserFeature" + }, + "description": "The list of AML user facing features." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML user features information. Call ListNext() with this to fetch the next page of AML user features information." + } + }, + "description": "The List Aml user feature operation response." + }, + "UsageName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Usage Names." + }, + "Usage": { + "type": "object", + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of usage measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "UsageUnit", + "modelAsString": true + } + }, + "currentValue": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The current usage of the resource." + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "description": "The maximum permitted usage of the resource." + }, + "name": { + "readOnly": true, + "$ref": "#/definitions/UsageName", + "description": "The name of the type of usage." + } + }, + "description": "Describes AML Resource Usage." + }, + "ListUsagesResult": { + "properties": { + "value": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/Usage" + }, + "description": "The list of AML resource usages." + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The URI to fetch the next page of AML resource usage information. Call ListNext() with this to fetch the next page of AML resource usage information." + } + }, + "description": "The List Usages operation response." + }, + "VirtualMachineSize": { + "properties": { + "name": { + "type": "string", + "title": "Virtual Machine size name", + "description": "The name of the virtual machine size.", + "readOnly": true + }, + "family": { + "type": "string", + "title": "Virtual Machine family name", + "description": "The family name of the virtual machine size.", + "readOnly": true + }, + "vCPUs": { + "type": "integer", + "format": "int32", + "title": "Number of vPUs", + "description": "The number of vCPUs supported by the virtual machine size.", + "readOnly": true + }, + "gpus": { + "type": "integer", + "format": "int32", + "title": "Number of gPUs", + "description": "The number of gPUs supported by the virtual machine size.", + "readOnly": true + }, + "osVhdSizeMB": { + "type": "integer", + "format": "int32", + "title": "OS VHD Disk size", + "description": "The OS VHD disk size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "maxResourceVolumeMB": { + "type": "integer", + "format": "int32", + "title": "Resource volume size", + "description": "The resource volume size, in MB, allowed by the virtual machine size.", + "readOnly": true + }, + "memoryGB": { + "type": "number", + "format": "double", + "title": "Memory size", + "description": "The amount of memory, in GB, supported by the virtual machine size.", + "readOnly": true + }, + "lowPriorityCapable": { + "type": "boolean", + "title": "Low priority capable", + "description": "Specifies if the virtual machine size supports low priority VMs.", + "readOnly": true + }, + "premiumIO": { + "type": "boolean", + "title": "Premium IO supported", + "description": "Specifies if the virtual machine size supports premium IO.", + "readOnly": true + } + }, + "description": "Describes the properties of a VM size." + }, + "VirtualMachineSizeListResult": { + "properties": { + "amlCompute": { + "type": "array", + "items": { + "$ref": "#/definitions/VirtualMachineSize" + }, + "description": "The list of virtual machine sizes supported by AmlCompute." + } + }, + "description": "The List Virtual Machine size operation response." + }, + "WorkspaceListResult": { + "description": "The result of a request to list machine learning workspaces.", + "properties": { + "value": { + "description": "The list of machine learning workspaces. Since this list may be incomplete, the nextLink field should be used to request the next list of machine learning workspaces.", + "type": "array", + "items": { + "$ref": "#/definitions/Workspace" + } + }, + "nextLink": { + "description": "The URI that can be used to request the next list of machine learning workspaces.", + "type": "string" + } + } + }, + "QuotaBaseProperties": { + "properties": { + "id": { + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The properties for Quota update or retrieval." + }, + "QuotaUpdateParameters": { + "properties": { + "value": { + "description": "The list for update quota.", + "type": "array", + "items": { + "$ref": "#/definitions/QuotaBaseProperties" + } + } + }, + "description": "Quota update parameters." + }, + "UpdateWorkspaceQuotasResult": { + "properties": { + "value": { + "description": "The list of workspace quota update result.", + "items": { + "$ref": "#/definitions/UpdateWorkspaceQuotas" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota update result. Call ListNext() with this to fetch the next page of Workspace Quota update result.", + "readOnly": true, + "type": "string" + } + }, + "description": "The result of update workspace quota." + }, + "UpdateWorkspaceQuotas": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "limit": { + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + }, + "status": { + "type": "string", + "readOnly": false, + "title": "Update Workspace Quota Status.", + "description": "Status of update workspace quota.", + "enum": [ + "Undefined", + "Success", + "Failure", + "InvalidQuotaBelowClusterMinimum", + "InvalidQuotaExceedsSubscriptionLimit", + "InvalidVMFamilyName", + "OperationNotSupportedForSku", + "OperationNotEnabledForRegion" + ], + "x-ms-enum": { + "name": "status", + "modelAsString": true + } + } + }, + "description": "The properties for update Quota response." + }, + "ResourceName": { + "properties": { + "value": { + "readOnly": true, + "type": "string", + "description": "The name of the resource." + }, + "localizedValue": { + "readOnly": true, + "type": "string", + "description": "The localized name of the resource." + } + }, + "description": "The Resource Name." + }, + "ResourceQuota": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource ID." + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Specifies the resource type." + }, + "name": { + "$ref": "#/definitions/ResourceName", + "description": "Name of the resource.", + "readOnly": true + }, + "limit": { + "readOnly": true, + "type": "integer", + "format": "int64", + "title": "Limit.", + "description": "The maximum permitted quota of the resource." + }, + "unit": { + "readOnly": true, + "type": "string", + "description": "An enum describing the unit of quota measurement.", + "enum": [ + "Count" + ], + "x-ms-enum": { + "name": "QuotaUnit", + "modelAsString": true + } + } + }, + "description": "The quota assigned to a resource." + }, + "ListWorkspaceQuotas": { + "properties": { + "value": { + "description": "The list of Workspace Quotas by VM Family", + "items": { + "$ref": "#/definitions/ResourceQuota" + }, + "readOnly": true, + "type": "array" + }, + "nextLink": { + "description": "The URI to fetch the next page of workspace quota information by VM Family. Call ListNext() with this to fetch the next page of Workspace Quota information.", + "readOnly": true, + "type": "string" + } + }, + "description": "The List WorkspaceQuotasByVMFamily operation response." + }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "SystemAssigned", + "UserAssigned", + "SystemAssigned, UserAssigned", + "None" + ], + "x-ms-enum": { + "name": "ResourceIdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with resource. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "description": "Identity for the resource.", + "required": [ + "type" + ] + }, + "Resource": { + "description": "Azure Resource Manager resource envelope.", + "x-ms-azure-resource": true, + "properties": { + "id": { + "description": "Specifies the resource ID.", + "type": "string", + "readOnly": true + }, + "name": { + "description": "Specifies the name of the resource.", + "type": "string", + "readOnly": true + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the resource." + }, + "location": { + "description": "Specifies the location of the resource.", + "type": "string" + }, + "type": { + "description": "Specifies the type of the resource.", + "type": "string", + "readOnly": true + }, + "tags": { + "description": "Contains resource tags defined as key/value pairs.", + "type": "object", + "additionalProperties": { + "type": "string" + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the workspace." + } + } + }, + "ResourceId": { + "properties": { + "id": { + "type": "string", + "description": "The ID of the resource" + } + }, + "required": [ + "id" + ], + "description": "Represents a resource ID. For example, for a subnet, it is the resource URL for the subnet.", + "x-ms-azure-resource": true + }, + "ListWorkspaceKeysResult": { + "type": "object", + "properties": { + "userStorageKey": { + "readOnly": true, + "type": "string" + }, + "userStorageResourceId": { + "readOnly": true, + "type": "string" + }, + "appInsightsInstrumentationKey": { + "readOnly": true, + "type": "string" + }, + "containerRegistryCredentials": { + "readOnly": true, + "$ref": "#/definitions/RegistryListCredentialsResult" + }, + "notebookAccessKeys": { + "$ref": "#/definitions/NotebookListCredentialsResult" + } + } + }, + "RegistryListCredentialsResult": { + "type": "object", + "properties": { + "location": { + "readOnly": true, + "type": "string" + }, + "username": { + "readOnly": true, + "type": "string" + }, + "passwords": { + "type": "array", + "items": { + "$ref": "#/definitions/Password" + } + } + } + }, + "Password": { + "type": "object", + "properties": { + "name": { + "readOnly": true, + "type": "string" + }, + "value": { + "readOnly": true, + "type": "string" + } + } + }, + "PaginatedComputeResourcesList": { + "type": "object", + "description": "Paginated list of Machine Learning compute objects wrapped in ARM resource envelope.", + "properties": { + "value": { + "type": "array", + "description": "An array of Machine Learning compute objects wrapped in ARM resource envelope.", + "items": { + "$ref": "#/definitions/ComputeResource" + } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "ComputeResource": { + "type": "object", + "description": "Machine Learning compute object wrapped into ARM resource envelope.", + "allOf": [ + { + "$ref": "#/definitions/Resource" + }, + { + "type": "object", + "properties": { + "properties": { + "description": "Compute properties", + "$ref": "#/definitions/Compute" + } + } + } + ] + }, + "Compute": { + "type": "object", + "description": "Machine Learning compute object.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "computeLocation": { + "description": "Location for the underlying compute", + "type": "string" + }, + "provisioningState": { + "type": "string", + "description": "The provision state of the cluster. Valid values are Unknown, Updating, Provisioning, Succeeded, and Failed.", + "enum": [ + "Unknown", + "Updating", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Canceled" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + }, + "readOnly": true + }, + "description": { + "type": "string", + "description": "The description of the Machine Learning compute." + }, + "createdOn": { + "type": "string", + "description": "The date and time when the compute was created.", + "format": "date-time", + "readOnly": true + }, + "modifiedOn": { + "type": "string", + "description": "The date and time when the compute was last modified.", + "format": "date-time", + "readOnly": true + }, + "resourceId": { + "type": "string", + "description": "ARM resource id of the underlying compute" + }, + "provisioningErrors": { + "type": "array", + "description": "Errors during provisioning", + "items": { + "$ref": "#/definitions/MachineLearningServiceError" + }, + "readOnly": true + }, + "isAttachedCompute": { + "type": "boolean", + "description": "Indicating whether the compute was provisioned by user and brought from outside if true, or machine learning service provisioned it if false.", + "readOnly": true + } + }, + "required": [ + "computeType" + ] + }, + "AKS": { + "description": "A Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "description": "AKS properties", + "properties": { + "clusterFqdn": { + "description": "Cluster full qualified domain name", + "type": "string" + }, + "systemServices": { + "type": "array", + "description": "System services", + "items": { + "$ref": "#/definitions/SystemService" + }, + "readOnly": true + }, + "agentCount": { + "description": "Number of agents", + "type": "integer", + "minimum": 1 + }, + "agentVMSize": { + "description": "Agent virtual machine size", + "type": "string" + }, + "sslConfiguration": { + "description": "SSL configuration", + "$ref": "#/definitions/SslConfiguration" + }, + "aksNetworkingConfiguration": { + "description": "AKS networking configuration for vnet", + "$ref": "#/definitions/AksNetworkingConfiguration" + } + } + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "AmlCompute": { + "description": "An Azure Machine Learning compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "description": "AML Compute properties", + "type": "object", + "properties": { + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "vmPriority": { + "description": "Virtual Machine priority", + "type": "string", + "enum": [ + "Dedicated", + "LowPriority" + ], + "x-ms-enum": { + "name": "VmPriority", + "modelAsString": true + } + }, + "scaleSettings": { + "description": "Scale settings for AML Compute", + "$ref": "#/definitions/ScaleSettings" + }, + "userAccountCredentials": { + "title": "User account credentials.", + "description": "Credentials for an administrator user account that will be created on each compute node.", + "$ref": "#/definitions/UserAccountCredentials" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId" + }, + "remoteLoginPortPublicAccess": { + "type": "string", + "default": "NotSpecified", + "title": "Close remote Login Access Port", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on all nodes of the cluster. Enabled - Indicates that the public ssh port is open on all nodes of the cluster. NotSpecified - Indicates that the public ssh port is closed on all nodes of the cluster if VNet is defined, else is open all public nodes. It can be default only during cluster creation time, after creation it will be either enabled or disabled.", + "enum": [ + "Enabled", + "Disabled", + "NotSpecified" + ], + "x-ms-enum": { + "name": "remoteLoginPortPublicAccess", + "modelAsString": true + } + }, + "allocationState": { + "type": "string", + "readOnly": true, + "title": "Allocation state.", + "description": "Allocation state of the compute. Possible values are: steady - Indicates that the compute is not resizing. There are no changes to the number of compute nodes in the compute in progress. A compute enters this state when it is created and when no operations are being performed on the compute to change the number of compute nodes. resizing - Indicates that the compute is resizing; that is, compute nodes are being added to or removed from the compute.", + "enum": [ + "Steady", + "Resizing" + ], + "x-ms-enum": { + "name": "AllocationState", + "modelAsString": true + } + }, + "allocationStateTransitionTime": { + "type": "string", + "readOnly": true, + "format": "date-time", + "title": "Allocation state transition time.", + "description": "The time at which the compute entered its current allocation state." + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered by various compute nodes during node setup.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineLearningServiceError" + } + }, + "currentNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Current node count.", + "description": "The number of compute nodes currently assigned to the compute." + }, + "targetNodeCount": { + "type": "integer", + "readOnly": true, + "format": "int32", + "title": "Target node count.", + "description": "The target number of compute nodes for the compute. If the allocationState is resizing, this property denotes the target node count for the ongoing resize operation. If the allocationState is steady, this property denotes the target node count for the previous resize operation." + }, + "nodeStateCounts": { + "title": "Node state counts.", + "description": "Counts of various node states on the compute.", + "readOnly": true, + "$ref": "#/definitions/NodeStateCounts" + } + } + } + } + } + ], + "x-ms-discriminator-value": "AmlCompute" + }, + "ComputeInstance": { + "description": "An Azure Machine Learning compute instance.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "description": "Compute Instance properties", + "type": "object", + "properties": { + "vmSize": { + "description": "Virtual Machine Size", + "type": "string" + }, + "subnet": { + "title": "Subnet.", + "description": "Virtual network subnet resource ID the compute nodes belong to.", + "$ref": "#/definitions/ResourceId" + }, + "applicationSharingPolicy": { + "type": "string", + "default": "Shared", + "title": "Sharing policy for applications on this compute instance", + "description": "Policy for sharing applications on this compute instance among users of parent workspace. If Personal, only the creator can access applications on this compute instance. When Shared, any workspace user can access applications on this instance depending on his/her assigned role.", + "enum": [ + "Personal", + "Shared" + ], + "x-ms-enum": { + "name": "applicationSharingPolicy", + "modelAsString": true + } + }, + "sshSettings": { + "description": "Specifies policy and settings for SSH access.", + "$ref": "#/definitions/ComputeInstanceSshSettings" + }, + "connectivityEndpoints": { + "readOnly": true, + "description": "Describes all connectivity endpoints available for this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceConnectivityEndpoints" + }, + "applications": { + "type": "array", + "readOnly": true, + "description": "Describes available applications and their endpoints on this ComputeInstance.", + "items": { + "$ref": "#/definitions/ComputeInstanceApplication" + } + }, + "createdBy": { + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceCreatedBy" + }, + "errors": { + "readOnly": true, + "title": "Errors.", + "description": "Collection of errors encountered on this ComputeInstance.", + "type": "array", + "items": { + "$ref": "#/definitions/MachineLearningServiceError" + } + }, + "state": { + "description": "The current state of this ComputeInstance.", + "$ref": "#/definitions/ComputeInstanceState", + "readOnly": true + } + } + } + } + } + ], + "x-ms-discriminator-value": "ComputeInstance" + }, + "VirtualMachine": { + "description": "A Machine Learning compute based on Azure Virtual Machines.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "virtualMachineSize": { + "description": "Virtual Machine size", + "type": "string" + }, + "sshPort": { + "description": "Port open for ssh connections.", + "type": "integer" + }, + "address": { + "description": "Public IP address of the virtual machine.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for virtual machine", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + } + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "HDInsight": { + "description": "A HDInsight compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "sshPort": { + "description": "Port open for ssh connections on the master node of the cluster.", + "type": "integer" + }, + "address": { + "description": "Public IP address of the master node of the cluster.", + "type": "string" + }, + "administratorAccount": { + "description": "Admin credentials for master node of the cluster", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + } + } + ], + "x-ms-discriminator-value": "HDInsight" + }, + "DataFactory": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + } + ], + "x-ms-discriminator-value": "DataFactory" + }, + "Databricks": { + "description": "A DataFactory compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "databricksAccessToken": { + "description": "Databricks access token", + "type": "string" + } + } + } + } + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "DataLakeAnalytics": { + "description": "A DataLakeAnalytics compute.", + "allOf": [ + { + "$ref": "#/definitions/Compute" + }, + { + "type": "object", + "properties": { + "properties": { + "type": "object", + "properties": { + "dataLakeStoreAccountName": { + "description": "DataLake Store Account Name", + "type": "string" + } + } + } + } + } + ], + "x-ms-discriminator-value": "DataLakeAnalytics" + }, + "ServicePrincipalCredentials": { + "type": "object", + "description": "Service principal credentials.", + "properties": { + "clientId": { + "description": "Client Id", + "type": "string" + }, + "clientSecret": { + "description": "Client secret", + "type": "string" + } + }, + "required": [ + "clientId", + "clientSecret" + ] + }, + "SystemService": { + "type": "object", + "description": "A system service running on a compute.", + "properties": { + "systemServiceType": { + "description": "The type of this system service.", + "readOnly": true, + "type": "string" + }, + "publicIpAddress": { + "type": "string", + "description": "Public IP address", + "readOnly": true + }, + "version": { + "description": "The version for this type.", + "readOnly": true, + "type": "string" + } + } + }, + "SslConfiguration": { + "type": "object", + "description": "The ssl configuration for scoring", + "properties": { + "status": { + "description": "Enable or disable ssl for scoring", + "type": "string", + "enum": [ + "Disabled", + "Enabled" + ] + }, + "cert": { + "description": "Cert data", + "type": "string" + }, + "key": { + "description": "Key data", + "type": "string" + }, + "cname": { + "description": "CNAME of the cert", + "type": "string" + } + } + }, + "AksNetworkingConfiguration": { + "type": "object", + "description": "Advance configuration for AKS networking", + "properties": { + "subnetId": { + "description": "Virtual network subnet resource ID the compute nodes belong to", + "type": "string" + }, + "serviceCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range from which to assign service cluster IPs. It must not overlap with any Subnet IP ranges.", + "type": "string" + }, + "dnsServiceIP": { + "pattern": "^(?:(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)\\.){3}(?:25[0-5]|2[0-4][0-9]|[01]?[0-9][0-9]?)$", + "description": "An IP address assigned to the Kubernetes DNS service. It must be within the Kubernetes service address range specified in serviceCidr.", + "type": "string" + }, + "dockerBridgeCidr": { + "pattern": "^([0-9]{1,3}\\.){3}[0-9]{1,3}(\\/([0-9]|[1-2][0-9]|3[0-2]))?$", + "description": "A CIDR notation IP range assigned to the Docker bridge network. It must not overlap with any Subnet IP ranges or the Kubernetes service address range.", + "type": "string" + } + } + }, + "UserAccountCredentials": { + "properties": { + "adminUserName": { + "type": "string", + "title": "User name.", + "description": "Name of the administrator user account which can be used to SSH to nodes." + }, + "adminUserSshPublicKey": { + "type": "string", + "title": "SSH public key.", + "description": "SSH public key of the administrator user account." + }, + "adminUserPassword": { + "type": "string", + "title": "Password.", + "description": "Password of the administrator user account." + } + }, + "required": [ + "adminUserName" + ], + "description": "Settings for user account that gets created on each on the nodes of a compute." + }, + "ScaleSettings": { + "type": "object", + "description": "scale settings for AML Compute", + "properties": { + "maxNodeCount": { + "description": "Max number of nodes to use", + "type": "integer" + }, + "minNodeCount": { + "description": "Min number of nodes to use", + "type": "integer", + "default": 0 + }, + "nodeIdleTimeBeforeScaleDown": { + "type": "string", + "format": "duration", + "description": "Node Idle Time before scaling down amlCompute" + } + }, + "required": [ + "maxNodeCount" + ] + }, + "NodeStateCounts": { + "properties": { + "idleNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Idle node count.", + "description": "Number of compute nodes in idle state." + }, + "runningNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Running node count.", + "description": "Number of compute nodes which are running jobs." + }, + "preparingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preparing node count.", + "description": "Number of compute nodes which are being prepared." + }, + "unusableNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Unusable node count.", + "description": "Number of compute nodes which are in unusable state." + }, + "leavingNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Leaving node count.", + "description": "Number of compute nodes which are leaving the amlCompute." + }, + "preemptedNodeCount": { + "readOnly": true, + "type": "integer", + "format": "int32", + "title": "Preempted node count.", + "description": "Number of compute nodes which are in preempted state." + } + }, + "description": "Counts of various compute node states on the amlCompute." + }, + "ClusterUpdateProperties": { + "properties": { + "scaleSettings": { + "$ref": "#/definitions/ScaleSettings", + "title": "Scale settings.", + "description": "Desired scale settings for the amlCompute." + } + }, + "description": "The properties of a amlCompute that need to be updated." + }, + "ClusterUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterUpdateProperties", + "description": "The properties of the amlCompute." + } + }, + "description": "AmlCompute update parameters." + }, + "ComputeNodesInformation": { + "type": "object", + "description": "Compute nodes information related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + }, + "nextLink": { + "readOnly": true, + "type": "string", + "description": "The continuation token." + } + }, + "required": [ + "computeType" + ] + }, + "AmlComputeNodesInformation": { + "description": "Compute node information related to a AmlCompute.", + "allOf": [ + { + "$ref": "#/definitions/ComputeNodesInformation" + }, + { + "type": "object", + "properties": { + "nodes": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/AmlComputeNodeInformation" + }, + "description": "The collection of returned AmlCompute nodes details." + } + } + } + ], + "x-ms-discriminator-value": "AmlCompute" + }, + "AmlComputeNodeInformation": { + "description": "Compute node information related to a AmlCompute.", + "properties": { + "nodeId": { + "readOnly": true, + "type": "string", + "title": "Node ID.", + "description": "ID of the compute node." + }, + "privateIpAddress": { + "readOnly": true, + "type": "string", + "title": "Private IP address.", + "description": "Private IP address of the compute node." + }, + "publicIpAddress": { + "readOnly": true, + "type": "string", + "title": "Public IP address.", + "description": "Public IP address of the compute node." + }, + "port": { + "readOnly": true, + "type": "number", + "format": "int32", + "title": "Port.", + "description": "SSH port number of the node." + }, + "nodeState": { + "readOnly": true, + "type": "string", + "enum": [ + "idle", + "running", + "preparing", + "unusable", + "leaving", + "preempted" + ], + "description": "State of the compute node. Values are idle, running, preparing, unusable, leaving and preempted.", + "x-ms-enum": { + "name": "nodeState", + "modelAsString": true + } + }, + "runId": { + "readOnly": true, + "type": "string", + "title": "Run ID.", + "description": "ID of the Experiment running on the node, if any else null." + } + }, + "x-ms-discriminator-value": "AmlCompute" + }, + "VirtualMachineSshCredentials": { + "type": "object", + "description": "Admin credentials for virtual machine", + "properties": { + "username": { + "description": "Username of admin account", + "type": "string" + }, + "password": { + "description": "Password of admin account", + "type": "string" + }, + "publicKeyData": { + "description": "Public key data", + "type": "string" + }, + "privateKeyData": { + "description": "Private key data", + "type": "string" + } + } + }, + "ComputeSecrets": { + "type": "object", + "description": "Secrets related to a Machine Learning compute. Might differ for every type of compute.", + "discriminator": "computeType", + "properties": { + "computeType": { + "description": "The type of compute", + "$ref": "#/definitions/ComputeType" + } + }, + "required": [ + "computeType" + ] + }, + "AksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "userKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "adminKubeConfig": { + "type": "string", + "description": "Content of kubeconfig file that can be used to connect to the Kubernetes cluster." + }, + "imagePullSecretName": { + "type": "string", + "description": "Image registry pull secret." + } + } + } + ], + "x-ms-discriminator-value": "AKS" + }, + "VirtualMachineSecrets": { + "description": "Secrets related to a Machine Learning compute based on AKS.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "administratorAccount": { + "description": "Admin credentials for virtual machine.", + "$ref": "#/definitions/VirtualMachineSshCredentials" + } + } + } + ], + "x-ms-discriminator-value": "VirtualMachine" + }, + "DatabricksComputeSecrets": { + "description": "Secrets related to a Machine Learning compute based on Databricks.", + "allOf": [ + { + "$ref": "#/definitions/ComputeSecrets" + }, + { + "type": "object", + "properties": { + "databricksAccessToken": { + "description": "access token for databricks account.", + "type": "string" + } + } + } + ], + "x-ms-discriminator-value": "Databricks" + }, + "ComputeType": { + "type": "string", + "description": "The type of compute", + "enum": [ + "AKS", + "AmlCompute", + "ComputeInstance", + "DataFactory", + "VirtualMachine", + "HDInsight", + "Databricks", + "DataLakeAnalytics" + ], + "x-ms-enum": { + "name": "ComputeType", + "modelAsString": true + } + }, + "MachineLearningServiceError": { + "type": "object", + "description": "Wrapper for error response to follow ARM guidelines.", + "properties": { + "error": { + "description": "The error response.", + "$ref": "#/definitions/ErrorResponse", + "readOnly": true + } + } + }, + "ErrorResponse": { + "type": "object", + "description": "Error response information.", + "properties": { + "code": { + "type": "string", + "description": "Error code.", + "readOnly": true + }, + "message": { + "type": "string", + "description": "Error message.", + "readOnly": true + }, + "details": { + "type": "array", + "description": "An array of error detail objects.", + "items": { + "$ref": "#/definitions/ErrorDetail" + }, + "readOnly": true + } + } + }, + "ErrorDetail": { + "type": "object", + "description": "Error detail information.", + "properties": { + "code": { + "type": "string", + "description": "Error code." + }, + "message": { + "type": "string", + "description": "Error message." + } + }, + "required": [ + "code", + "message" + ] + }, + "SKUCapability": { + "description": "Features/user capabilities associated with the sku", + "type": "object", + "properties": { + "name": { + "description": "Capability/Feature ID", + "type": "string" + }, + "value": { + "description": "Details about the feature/capability", + "type": "string" + } + } + }, + "ResourceSkuLocationInfo": { + "properties": { + "location": { + "readOnly": true, + "type": "string", + "description": "Location of the SKU" + }, + "zones": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "List of availability zones where the SKU is supported." + }, + "zoneDetails": { + "readOnly": true, + "type": "array", + "items": { + "$ref": "#/definitions/ResourceSkuZoneDetails" + }, + "description": "Details of capabilities available to a SKU in specific zones." + } + } + }, + "ResourceSkuZoneDetails": { + "properties": { + "name": { + "type": "array", + "readOnly": true, + "items": { + "type": "string" + }, + "description": "The set of zones that the SKU is available in with the specified capabilities." + }, + "capabilities": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "description": "A list of capabilities that are available for the SKU in the specified list of zones." + } + }, + "description": "Describes The zonal capabilities of a SKU." + }, + "WorkspaceSku": { + "description": "Describes Workspace Sku details and features", + "type": "object", + "properties": { + "locations": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The set of locations that the SKU is available. This will be supported and registered Azure Geo Regions (e.g. West US, East US, Southeast Asia, etc.)." + }, + "locationInfo": { + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/ResourceSkuLocationInfo" + }, + "description": "A list of locations and availability zones in those locations where the SKU is available." + }, + "tier": { + "description": "Sku Tier like Basic or Enterprise", + "type": "string", + "readOnly": true + }, + "resourceType": { + "type": "string", + "readOnly": true + }, + "name": { + "type": "string", + "readOnly": true + }, + "capabilities": { + "description": "List of features/user capabilities associated with the sku", + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/SKUCapability" + }, + "readOnly": true + }, + "restrictions": { + "type": "array", + "items": { + "$ref": "#/definitions/Restriction" + }, + "description": "The restrictions because of which SKU cannot be used. This is empty if there are no restrictions." + } + } + }, + "Restriction": { + "properties": { + "type": { + "readOnly": true, + "type": "string", + "description": "The type of restrictions. As of now only possible value for this is location." + }, + "values": { + "readOnly": true, + "type": "array", + "items": { + "type": "string" + }, + "description": "The value of restrictions. If the restriction type is set to location. This would be different locations where the SKU is restricted." + }, + "reasonCode": { + "type": "string", + "enum": [ + "NotSpecified", + "NotAvailableForRegion", + "NotAvailableForSubscription" + ], + "x-ms-enum": { + "name": "ReasonCode", + "modelAsString": true + }, + "description": "The reason for the restriction." + } + }, + "description": "The restriction because of which SKU cannot be used." + }, + "SkuListResult": { + "description": "List of skus with features", + "type": "object", + "properties": { + "value": { + "uniqueItems": false, + "type": "array", + "items": { + "$ref": "#/definitions/WorkspaceSku" + } + }, + "nextLink": { + "type": "string", + "description": "The URI to fetch the next page of Workspace Skus. Call ListNext() with this URI to fetch the next page of Workspace Skus" + } + } + }, + "Sku": { + "description": "Sku of the resource", + "type": "object", + "properties": { + "name": { + "description": "Name of the sku", + "type": "string" + }, + "tier": { + "description": "Tier of the sku like Basic or Enterprise", + "type": "string" + } + } + }, + "PrivateEndpointConnection": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateEndpointConnectionProperties", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "The Private Endpoint Connection resource." + }, + "PrivateEndpointConnectionProperties": { + "properties": { + "privateEndpoint": { + "$ref": "#/definitions/PrivateEndpoint", + "description": "The resource of private end point." + }, + "privateLinkServiceConnectionState": { + "$ref": "#/definitions/PrivateLinkServiceConnectionState", + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "provisioningState": { + "$ref": "#/definitions/PrivateEndpointConnectionProvisioningState", + "description": "The provisioning state of the private endpoint connection resource." + } + }, + "required": [ + "privateLinkServiceConnectionState" + ], + "description": "Properties of the PrivateEndpointConnectProperties." + }, + "PrivateEndpoint": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "The ARM identifier for Private Endpoint" + } + }, + "description": "The Private Endpoint resource." + }, + "PrivateLinkServiceConnectionState": { + "properties": { + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + }, + "description": { + "type": "string", + "description": "The reason for approval/rejection of the connection." + }, + "actionsRequired": { + "type": "string", + "description": "A message indicating if changes on the service provider require any updates on the consumer." + } + }, + "description": "A collection of information about the state of the connection between service consumer and provider." + }, + "PrivateEndpointServiceConnectionStatus": { + "type": "string", + "description": "The private endpoint connection status.", + "enum": [ + "Pending", + "Approved", + "Rejected", + "Disconnected", + "Timeout" + ], + "x-ms-enum": { + "name": "PrivateEndpointServiceConnectionStatus", + "modelAsString": true + } + }, + "PrivateEndpointConnectionProvisioningState": { + "type": "string", + "readOnly": true, + "description": "The current provisioning state.", + "enum": [ + "Succeeded", + "Creating", + "Deleting", + "Failed" + ], + "x-ms-enum": { + "name": "PrivateEndpointConnectionProvisioningState", + "modelAsString": true + } + }, + "PrivateLinkResourceListResult": { + "properties": { + "value": { + "type": "array", + "description": "Array of private link resources", + "items": { + "$ref": "#/definitions/PrivateLinkResource" + } + } + }, + "description": "A list of private link resources" + }, + "PrivateLinkResource": { + "properties": { + "properties": { + "$ref": "#/definitions/PrivateLinkResourceProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "A private link resource" + }, + "PrivateLinkResourceProperties": { + "properties": { + "groupId": { + "description": "The private link resource group id.", + "type": "string", + "readOnly": true + }, + "requiredMembers": { + "description": "The private link resource required member names.", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "requiredZoneNames": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The private link resource Private link DNS zone name." + } + }, + "description": "Properties of a private link resource." + }, + "SharedPrivateLinkResource": { + "properties": { + "name": { + "description": "Unique name of the private link.", + "type": "string" + }, + "properties": { + "$ref": "#/definitions/SharedPrivateLinkResourceProperty", + "x-ms-client-flatten": true, + "description": "Resource properties." + } + } + }, + "SharedPrivateLinkResourceProperty": { + "properties": { + "privateLinkResourceId": { + "description": "The resource id that private link links to.", + "type": "string" + }, + "groupId": { + "description": "The private link resource group id.", + "type": "string" + }, + "requestMessage": { + "description": "Request message.", + "type": "string" + }, + "status": { + "$ref": "#/definitions/PrivateEndpointServiceConnectionStatus", + "description": "Indicates whether the connection has been Approved/Rejected/Removed by the owner of the service." + } + }, + "description": "Properties of a shared private link resource." + }, + "EncryptionProperty": { + "properties": { + "status": { + "description": "Indicates whether or not the encryption is enabled for the workspace.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "EncryptionStatus", + "modelAsString": true + } + }, + "keyVaultProperties": { + "$ref": "#/definitions/KeyVaultProperties", + "description": "Customer Key vault properties." + } + }, + "required": [ + "status", + "keyVaultProperties" + ], + "type": "object" + }, + "KeyVaultProperties": { + "properties": { + "keyVaultArmId": { + "description": "The ArmId of the keyVault where the customer owned encryption key is present.", + "type": "string" + }, + "keyIdentifier": { + "description": "Key vault uri to access the encryption key.", + "type": "string" + }, + "identityClientId": { + "description": "For future use - The client id of the identity which will be used to access key vault.", + "type": "string" + } + }, + "required": [ + "keyIdentifier", + "keyVaultArmId" + ], + "type": "object" + }, + "PaginatedWorkspaceConnectionsList": { + "type": "object", + "description": "Paginated list of Workspace connection objects.", + "properties": { + "value": { + "type": "array", + "description": "An array of Workspace connection objects.", + "items": { + "$ref": "#/definitions/WorkspaceConnection" + } + }, + "nextLink": { + "type": "string", + "description": "A continuation link (absolute URI) to the next page of results in the list." + } + } + }, + "WorkspaceConnection": { + "x-ms-azure-resource": true, + "description": "Workspace connection.", + "type": "object", + "properties": { + "id": { + "type": "string", + "description": "ResourceId of the workspace connection.", + "readOnly": true + }, + "name": { + "type": "string", + "description": "Friendly name of the workspace connection.", + "readOnly": true + }, + "type": { + "type": "string", + "description": "Resource type of workspace connection.", + "readOnly": true + }, + "properties": { + "type": "object", + "description": "Properties of workspace connection.", + "$ref": "#/definitions/WorkspaceConnectionProps", + "x-ms-client-flatten": true + } + } + }, + "WorkspaceConnectionDto": { + "type": "object", + "description": "object used for creating workspace connection.", + "properties": { + "name": { + "description": "Friendly name of the workspace connection", + "type": "string" + }, + "properties": { + "type": "object", + "description": "Properties of workspace connection.", + "$ref": "#/definitions/WorkspaceConnectionProps", + "x-ms-client-flatten": true + } + } + }, + "WorkspaceConnectionProps": { + "type": "object", + "description": "Workspace Connection specific properties.", + "properties": { + "category": { + "description": "Category of the workspace connection.", + "type": "string" + }, + "target": { + "description": "Target of the workspace connection.", + "type": "string" + }, + "authType": { + "description": "Authorization type of the workspace connection.", + "type": "string" + }, + "value": { + "description": "Value details of the workspace connection.", + "type": "string" + } + } + }, + "ComputeInstanceSshSettings": { + "type": "object", + "description": "Specifies policy and settings for SSH access.", + "properties": { + "sshPublicAccess": { + "type": "string", + "default": "Disabled", + "title": "Access policy for SSH", + "description": "State of the public SSH port. Possible values are: Disabled - Indicates that the public ssh port is closed on this instance. Enabled - Indicates that the public ssh port is open and accessible according to the VNet/subnet policy if applicable.", + "enum": [ + "Enabled", + "Disabled" + ], + "x-ms-enum": { + "name": "sshPublicAccess", + "modelAsString": true + } + }, + "adminUserName": { + "type": "string", + "readOnly": true, + "description": "Describes the admin user name." + }, + "sshPort": { + "type": "integer", + "format": "int32", + "readOnly": true, + "description": "Describes the port for connecting through SSH." + }, + "adminPublicKey": { + "type": "string", + "description": "Specifies the SSH rsa public key file as a string. Use \"ssh-keygen -t rsa -b 2048\" to generate your SSH key pairs." + } + } + }, + "ComputeInstanceState": { + "type": "string", + "description": "Current state of a ComputeInstance.", + "enum": [ + "Creating", + "CreateFailed", + "Deleting", + "Running", + "Restarting", + "RestartFailed", + "JobRunning", + "SettingUp", + "Starting", + "StartFailed", + "StopFailed", + "Stopped", + "Stopping", + "UserSettingUp", + "Unknown", + "Unusable" + ], + "x-ms-enum": { + "name": "ComputeInstanceState", + "modelAsString": true + } + }, + "ComputeInstanceApplication": { + "type": "object", + "description": "Defines an Aml Instance application and its connectivity endpoint URI.", + "properties": { + "displayName": { + "type": "string", + "description": "Name of the ComputeInstance application." + }, + "endpointUri": { + "type": "string", + "description": "Application' endpoint URI." + } + } + }, + "ComputeInstanceConnectivityEndpoints": { + "type": "object", + "readOnly": true, + "description": "Defines all connectivity endpoints and properties for a ComputeInstance.", + "properties": { + "publicIpAddress": { + "type": "string", + "readOnly": true, + "description": "Public IP Address of this ComputeInstance." + }, + "privateIpAddress": { + "type": "string", + "readOnly": true, + "description": "Private IP Address of this ComputeInstance (local to the VNET in which the compute instance is deployed)." + } + } + }, + "ComputeInstanceCreatedBy": { + "type": "object", + "readOnly": true, + "description": "Describes information on user who created this ComputeInstance.", + "properties": { + "userName": { + "type": "string", + "readOnly": true, + "description": "Name of the user." + }, + "userOrgId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies user' Azure Active Directory organization." + }, + "userId": { + "type": "string", + "readOnly": true, + "description": "Uniquely identifies the user within his/her organization." + } + } + } + } +} diff --git a/specification/machinelearningservices/resource-manager/readme.md b/specification/machinelearningservices/resource-manager/readme.md index 37fb205e426e..05527c6b6b4e 100644 --- a/specification/machinelearningservices/resource-manager/readme.md +++ b/specification/machinelearningservices/resource-manager/readme.md @@ -26,7 +26,16 @@ These are the global settings for the Machine Learning Services API. ``` yaml openapi-type: arm -tag: package-2020-04-01 +tag: package-2020-06-01 +``` + +### Tag: package-2020-06-01 + +These settings apply only when `--tag=package-2020-06` is specified on the command line. + +```yaml $(tag) == 'package-2020-06-01' +input-file: + - Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json ``` ### Tag: package-2020-04-01 @@ -183,6 +192,7 @@ output-folder: $(azure-libraries-for-java-folder)/azure-mgmt-machinelearning/ser ``` yaml $(java) && $(multiapi) batch: + - tag: package-2020-06-01 - tag: package-2020-04-01 - tag: package-2020-03-01 - tag: package-2020-01-01 @@ -195,6 +205,19 @@ batch: - tag: package-2020-02-18-preview - tag: package-2018-03-preview ``` +### Tag: package-2020-06-01 and java + +These settings apply only when `--tag=package-2020-06-01 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-06-01' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.machinelearningservices.v2020_06_01 + output-folder: $(azure-libraries-for-java-folder)/sdk/machinelearningservices/mgmt-v2020_06_01 +regenerate-manager: true +generate-interface: true +``` + ### Tag: package-2020-04-01 and java These settings apply only when `--tag=package-2020-04-01 --java` is specified on the command line. @@ -337,6 +360,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.MachineLearningServices/stable/2020-06-01/machineLearningServices.json - $(this-folder)/Microsoft.MachineLearningServices/stable/2020-04-01/machineLearningServices.json - $(this-folder)/Microsoft.MachineLearningServices/stable/2020-03-01/machineLearningServices.json - $(this-folder)/Microsoft.MachineLearningServices/stable/2020-01-01/machineLearningServices.json From a38ccda84586bb2ed4694801c2667082ab710856 Mon Sep 17 00:00:00 2001 From: aim-for-better Date: Thu, 9 Jul 2020 17:47:29 +0800 Subject: [PATCH 286/318] Remove encryptionAtHost property (#10075) Co-authored-by: Zhenyu Zhou --- .../stable/2018-06-01-preview/cluster.json | 5 ----- 1 file changed, 5 deletions(-) diff --git a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json index f0ca0b010cf4..978002b9d6b0 100644 --- a/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json +++ b/specification/hdinsight/resource-manager/Microsoft.HDInsight/stable/2018-06-01-preview/cluster.json @@ -1518,11 +1518,6 @@ "msiResourceId": { "type": "string", "description": "Resource ID of Managed Identity that is used to access the key vault." - }, - "encryptionAtHost": { - "type": "boolean", - "default": false, - "description": "Indicates whether or not resource disk encryption is enabled." } } }, From 34cb59242dc5a4f060baa7393513db72ab90d1dd Mon Sep 17 00:00:00 2001 From: adgrieve <62692874+adgrieve@users.noreply.github.com> Date: Thu, 9 Jul 2020 17:10:40 +0300 Subject: [PATCH 287/318] Remove all premium firewall policy properties (private preview feature) (#10072) * Remove premium firewall policy properties (private) * Remove premium firewall policy properties (private) --- .../stable/2020-03-01/firewallPolicy.json | 16 --- .../stable/2020-04-01/firewallPolicy.json | 105 ------------------ .../stable/2020-05-01/firewallPolicy.json | 105 ------------------ 3 files changed, 226 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/firewallPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/firewallPolicy.json index 856ee28bbed1..b3f020ae08c8 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/firewallPolicy.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-03-01/firewallPolicy.json @@ -614,10 +614,6 @@ "threatIntelMode": { "description": "The operation mode for Threat Intelligence.", "$ref": "./azureFirewall.json#/definitions/AzureFirewallThreatIntelMode" - }, - "intrusionSystemMode": { - "description": "The operation mode for Intrusion system.", - "$ref": "#/definitions/FirewallPolicyIntrusionSystemMode" } }, "description": "Firewall Policy definition." @@ -1058,18 +1054,6 @@ } }, "description": "Response for ListFirewallPolicyRuleGroups API service call." - }, - "FirewallPolicyIntrusionSystemMode": { - "type": "string", - "description": "The operation mode for Intrusion system mode.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "FirewallPolicyIntrusionSystemMode", - "modelAsString": true - } } } } diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/firewallPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/firewallPolicy.json index e411a402a296..4eee92967be4 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/firewallPolicy.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/firewallPolicy.json @@ -566,10 +566,6 @@ "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." - }, - "identity": { - "$ref": "./network.json#/definitions/ManagedServiceIdentity", - "description": "The identity of the firewall policy." } }, "allOf": [ @@ -622,88 +618,10 @@ "threatIntelWhitelist": { "description": "ThreatIntel Whitelist for Firewall Policy.", "$ref": "#/definitions/FirewallPolicyThreatIntelWhitelist" - }, - "intrusionSystemMode": { - "description": "The operation mode for Intrusion system.", - "$ref": "#/definitions/FirewallPolicyIntrusionSystemMode" - }, - "transportSecurity": { - "description": "TLS Configuration definition.", - "$ref": "#/definitions/FirewallPolicyTransportSecurity" } }, "description": "Firewall Policy definition." }, - "FirewallPolicyTransportSecurity": { - "properties": { - "certificateAuthority": { - "$ref": "#/definitions/FirewallPolicyCertificateAuthority", - "description": "The CA used for intermediate CA generation." - }, - "excludedDomains": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of domains which are excluded from TLS termination." - }, - "trustedRootCertificates": { - "type": "array", - "items": { - "$ref": "#/definitions/FirewallPolicyTrustedRootCertificate", - "description": "A list of certificates which are to be trusted by the firewall." - }, - "description": "Certificates which are to be trusted by the firewall." - } - }, - "description": "Configuration needed to perform TLS termination & initiation." - }, - "FirewallPolicyTrustedRootCertificate": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FirewallPolicyTrustedRootCertificatePropertiesFormat", - "description": "Properties of the trusted root authorities." - }, - "name": { - "type": "string", - "description": "Name of the trusted root certificate that is unique within a firewall policy." - } - }, - "description": "Trusted Root certificates of a firewall policy." - }, - "FirewallPolicyTrustedRootCertificatePropertiesFormat": { - "properties": { - "keyVaultSecretId": { - "type": "string", - "description": "Secret Id of (base-64 encoded unencrypted pfx) the public certificate data stored in KeyVault." - } - }, - "description": "Trusted Root certificates properties for tls." - }, - "FirewallPolicyCertificateAuthority": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FirewallPolicyCertificateAuthorityPropertiesFormat", - "description": "Properties of the certificate authority." - }, - "name": { - "type": "string", - "description": "Name of the CA certificate." - } - }, - "description": "Trusted Root certificates properties for tls." - }, - "FirewallPolicyCertificateAuthorityPropertiesFormat": { - "properties": { - "keyVaultSecretId": { - "type": "string", - "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." - } - }, - "description": "Trusted Root certificates properties for tls." - }, "FirewallPolicyRuleGroup": { "properties": { "properties": { @@ -901,13 +819,6 @@ }, "description": "Array of Application Protocols." }, - "targetUrls": { - "type": "array", - "description": "List of Urls for this rule condition.", - "items": { - "type": "string" - } - }, "targetFqdns": { "type": "array", "description": "List of FQDNs for this rule condition.", @@ -975,10 +886,6 @@ "items": { "type": "string" } - }, - "terminateTLS": { - "type": "boolean", - "description": "Terminate TLS connections for this rule." } } }, @@ -1152,18 +1059,6 @@ }, "description": "Response for ListFirewallPolicyRuleGroups API service call." }, - "FirewallPolicyIntrusionSystemMode": { - "type": "string", - "description": "The operation mode for Intrusion system mode.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "FirewallPolicyIntrusionSystemMode", - "modelAsString": true - } - }, "FirewallPolicyThreatIntelWhitelist": { "description": "ThreatIntel Whitelist for Firewall Policy.", "x-ms-discriminator-value": "FirewallPolicyThreatIntelWhitelist", diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/firewallPolicy.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/firewallPolicy.json index f15fb1e7a7b2..fca251108fb0 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/firewallPolicy.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/firewallPolicy.json @@ -566,10 +566,6 @@ "type": "string", "readOnly": true, "description": "A unique read-only string that changes whenever the resource is updated." - }, - "identity": { - "$ref": "./network.json#/definitions/ManagedServiceIdentity", - "description": "The identity of the firewall policy." } }, "allOf": [ @@ -623,14 +619,6 @@ "description": "ThreatIntel Whitelist for Firewall Policy.", "$ref": "#/definitions/FirewallPolicyThreatIntelWhitelist" }, - "intrusionSystemMode": { - "description": "The operation mode for Intrusion system.", - "$ref": "#/definitions/FirewallPolicyIntrusionSystemMode" - }, - "transportSecurity": { - "description": "TLS Configuration definition.", - "$ref": "#/definitions/FirewallPolicyTransportSecurity" - }, "dnsSettings": { "description": "DNS Proxy Settings definition.", "$ref": "#/definitions/DnsSettings" @@ -638,76 +626,6 @@ }, "description": "Firewall Policy definition." }, - "FirewallPolicyTransportSecurity": { - "properties": { - "certificateAuthority": { - "$ref": "#/definitions/FirewallPolicyCertificateAuthority", - "description": "The CA used for intermediate CA generation." - }, - "excludedDomains": { - "type": "array", - "items": { - "type": "string" - }, - "description": "List of domains which are excluded from TLS termination." - }, - "trustedRootCertificates": { - "type": "array", - "items": { - "$ref": "#/definitions/FirewallPolicyTrustedRootCertificate", - "description": "A list of certificates which are to be trusted by the firewall." - }, - "description": "Certificates which are to be trusted by the firewall." - } - }, - "description": "Configuration needed to perform TLS termination & initiation." - }, - "FirewallPolicyTrustedRootCertificate": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FirewallPolicyTrustedRootCertificatePropertiesFormat", - "description": "Properties of the trusted root authorities." - }, - "name": { - "type": "string", - "description": "Name of the trusted root certificate that is unique within a firewall policy." - } - }, - "description": "Trusted Root certificates of a firewall policy." - }, - "FirewallPolicyTrustedRootCertificatePropertiesFormat": { - "properties": { - "keyVaultSecretId": { - "type": "string", - "description": "Secret Id of (base-64 encoded unencrypted pfx) the public certificate data stored in KeyVault." - } - }, - "description": "Trusted Root certificates properties for tls." - }, - "FirewallPolicyCertificateAuthority": { - "properties": { - "properties": { - "x-ms-client-flatten": true, - "$ref": "#/definitions/FirewallPolicyCertificateAuthorityPropertiesFormat", - "description": "Properties of the certificate authority." - }, - "name": { - "type": "string", - "description": "Name of the CA certificate." - } - }, - "description": "Trusted Root certificates properties for tls." - }, - "FirewallPolicyCertificateAuthorityPropertiesFormat": { - "properties": { - "keyVaultSecretId": { - "type": "string", - "description": "Secret Id of (base-64 encoded unencrypted pfx) 'Secret' or 'Certificate' object stored in KeyVault." - } - }, - "description": "Trusted Root certificates properties for tls." - }, "FirewallPolicyRuleCollectionGroup": { "properties": { "properties": { @@ -900,13 +818,6 @@ }, "description": "Array of Application Protocols." }, - "targetUrls": { - "type": "array", - "description": "List of Urls for this rule condition.", - "items": { - "type": "string" - } - }, "targetFqdns": { "type": "array", "description": "List of FQDNs for this rule.", @@ -927,10 +838,6 @@ "items": { "type": "string" } - }, - "terminateTLS": { - "type": "boolean", - "description": "Terminate TLS connections for this rule." } }, "description": "Rule of type application." @@ -1166,18 +1073,6 @@ }, "description": "Response for ListFirewallPolicyRuleCollectionGroups API service call." }, - "FirewallPolicyIntrusionSystemMode": { - "type": "string", - "description": "The operation mode for Intrusion system mode.", - "enum": [ - "Enabled", - "Disabled" - ], - "x-ms-enum": { - "name": "FirewallPolicyIntrusionSystemMode", - "modelAsString": true - } - }, "FirewallPolicyThreatIntelWhitelist": { "description": "ThreatIntel Whitelist for Firewall Policy.", "x-ms-discriminator-value": "FirewallPolicyThreatIntelWhitelist", From a4b5848c84dc53ea345cab2199c92fa0ce231bdb Mon Sep 17 00:00:00 2001 From: astauben Date: Fri, 10 Jul 2020 06:29:32 +0300 Subject: [PATCH 288/318] Kusto 2020-06-14 API version (#9929) * adding 2020-06-14 * Update readme.md * Update readme.go.md * Update custom-words.txt * remove dataconnectionvalidationasync * update example * Delete KustoDataConnectionValidationAsync.json * Update kusto.json * prettier-fix for kusto.json * Update custom-words.txt * Update custom-words.txt --- custom-words.txt | 3 + ...dDatabaseConfigurationsCreateOrUpdate.json | 61 + ...oAttachedDatabaseConfigurationsDelete.json | 14 + ...ustoAttachedDatabaseConfigurationsGet.json | 25 + ...edDatabaseConfigurationsListByCluster.json | 40 + .../KustoClusterAddLanguageExtensions.json | 22 + .../KustoClusterDetachFollowerDatabases.json | 16 + .../KustoClusterListFollowerDatabases.json | 26 + .../KustoClusterListLanguageExtensions.json | 22 + ...cipalAssignmentsCheckNameAvailability.json | 21 + ...terPrincipalAssignmentsCreateOrUpdate.json | 51 + ...ustoClusterPrincipalAssignmentsDelete.json | 14 + .../KustoClusterPrincipalAssignmentsGet.json | 27 + .../KustoClusterPrincipalAssignmentsList.json | 45 + .../KustoClusterRemoveLanguageExtensions.json | 22 + .../KustoClustersCheckNameAvailability.json | 20 + .../examples/KustoClustersCreateOrUpdate.json | 86 + .../examples/KustoClustersDelete.json | 13 + .../KustoClustersDiagnoseVirtualNetwork.json | 18 + .../2020-06-14/examples/KustoClustersGet.json | 39 + .../examples/KustoClustersList.json | 47 + .../KustoClustersListByResourceGroup.json | 48 + .../KustoClustersListResourceSkus.json | 68 + .../examples/KustoClustersListSkus.json | 103 + .../examples/KustoClustersStart.json | 12 + .../examples/KustoClustersStop.json | 12 + .../examples/KustoClustersUpdate.json | 107 + .../KustoDataConnectionValidation.json | 30 + ...oDataConnectionsCheckNameAvailability.json | 23 + .../KustoDataConnectionsCreateOrUpdate.json | 59 + .../examples/KustoDataConnectionsDelete.json | 15 + .../examples/KustoDataConnectionsGet.json | 25 + .../KustoDataConnectionsListByDatabase.json | 39 + .../examples/KustoDataConnectionsUpdate.json | 59 + .../examples/KustoDatabaseAddPrincipals.json | 69 + .../examples/KustoDatabaseListPrincipals.json | 41 + ...cipalAssignmentsCheckNameAvailability.json | 22 + ...asePrincipalAssignmentsCreateOrUpdate.json | 52 + ...stoDatabasePrincipalAssignmentsDelete.json | 15 + .../KustoDatabasePrincipalAssignmentsGet.json | 28 + ...KustoDatabasePrincipalAssignmentsList.json | 45 + .../KustoDatabaseRemovePrincipals.json | 69 + .../KustoDatabasesCheckNameAvailability.json | 21 + .../KustoDatabasesCreateOrUpdate.json | 56 + .../examples/KustoDatabasesDelete.json | 14 + .../examples/KustoDatabasesGet.json | 24 + .../examples/KustoDatabasesListByCluster.json | 36 + .../examples/KustoDatabasesUpdate.json | 55 + .../examples/KustoOperationsList.json | 22 + .../stable/2020-06-14/kusto.json | 4281 +++++++++++++++++ .../azure-kusto/resource-manager/readme.go.md | 10 + .../azure-kusto/resource-manager/readme.md | 12 +- 52 files changed, 6103 insertions(+), 1 deletion(-) create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsDelete.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsGet.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsListByCluster.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterAddLanguageExtensions.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterDetachFollowerDatabases.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListFollowerDatabases.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListLanguageExtensions.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsDelete.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsGet.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsList.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterRemoveLanguageExtensions.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCheckNameAvailability.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCreateOrUpdate.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDelete.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDiagnoseVirtualNetwork.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersGet.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersList.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListByResourceGroup.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListResourceSkus.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListSkus.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStart.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStop.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersUpdate.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionValidation.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCheckNameAvailability.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCreateOrUpdate.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsDelete.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsGet.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsListByDatabase.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsUpdate.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseAddPrincipals.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseListPrincipals.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsDelete.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsGet.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsList.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseRemovePrincipals.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCheckNameAvailability.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCreateOrUpdate.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesDelete.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesGet.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesListByCluster.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesUpdate.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoOperationsList.json create mode 100644 specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/kusto.json diff --git a/custom-words.txt b/custom-words.txt index ec49c03b070a..8dd85b9a6ed8 100644 --- a/custom-words.txt +++ b/custom-words.txt @@ -57,6 +57,7 @@ Annotatable anomalydetector anomalyfinder APAC +APACHEAVRO API's apim apimanagement @@ -285,6 +286,7 @@ clientgroup clientlib clipart CLIs +CLOGFILE Cloneability Cloneable closedlist @@ -1729,6 +1731,7 @@ vsphere VSTS VSTSRM VXLAN +W3CLOGFILE waagent WADL waitforjobcompletion diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json new file mode 100644 index 000000000000..e7dfbc89d475 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json @@ -0,0 +1,61 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", + "api-version": "2020-06-14", + "parameters": { + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "kustodatabase", + "defaultPrincipalsModificationKind": "Union" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Creating" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/attachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Creating" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsDelete.json new file mode 100644 index 000000000000..dd57033e26c5 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsGet.json new file mode 100644 index 000000000000..55e7468e060b --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "attachedDatabaseConfigurationName": "attachedDatabaseConfigurations1", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/attachedDatabaseConfigurations1", + "name": "KustoClusterRPTest4/attachedDatabaseConfigurations1", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "databaseName": "*", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsListByCluster.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsListByCluster.json new file mode 100644 index 000000000000..d03ad4e69fc1 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoAttachedDatabaseConfigurationsListByCluster.json @@ -0,0 +1,40 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/AttachedDatabaseConfigurations/KustoDatabase9", + "name": "KustoClusterRPTest4/KustoDatabase9", + "type": "Microsoft.Kusto/Clusters/AttachedDatabaseConfigurations", + "location": "westus", + "properties": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterLeader", + "databaseName": "db1", + "defaultPrincipalsModificationKind": "Union", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterAddLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterAddLanguageExtensions.json new file mode 100644 index 000000000000..714b2de30e42 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterAddLanguageExtensions.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14", + "languageExtensionsToAdd": { + "value": [ + { + "languageExtensionName": "PYTHON" + }, + { + "languageExtensionName": "R" + } + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterDetachFollowerDatabases.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterDetachFollowerDatabases.json new file mode 100644 index 000000000000..f45bcf4f54b3 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterDetachFollowerDatabases.json @@ -0,0 +1,16 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14", + "followerDatabaseToRemove": { + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/leader4", + "attachedDatabaseConfigurationName": "myAttachedDatabaseConfiguration" + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListFollowerDatabases.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListFollowerDatabases.json new file mode 100644 index 000000000000..372ed1fed327 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListFollowerDatabases.json @@ -0,0 +1,26 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "attachedDatabaseConfigurationName": "attachedDbConfiguration", + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower1", + "databaseName": "*" + }, + { + "attachedDatabaseConfigurationName": "attachedDbConfiguration2", + "clusterResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/clusters/follower4", + "databaseName": "db1" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListLanguageExtensions.json new file mode 100644 index 000000000000..6581203981d9 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterListLanguageExtensions.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "languageExtensionName": "PYTHON" + }, + { + "languageExtensionName": "R" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json new file mode 100644 index 000000000000..c86831b19e09 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": { + "name": "kustoprincipal1", + "type": "Microsoft.Kusto/clusters/principalAssignments" + }, + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "name": "kustoprincipal1", + "nameAvailable": false, + "message": "Name 'kustoprincipal1' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json new file mode 100644 index 000000000000..5be64e6e3e46 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json @@ -0,0 +1,51 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14", + "parameters": { + "properties": { + "role": "AllDatabasesAdmin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsDelete.json new file mode 100644 index 000000000000..eec31255f447 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsGet.json new file mode 100644 index 000000000000..13737e053f15 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsGet.json @@ -0,0 +1,27 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsList.json new file mode 100644 index 000000000000..b1b71083aa78 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterPrincipalAssignmentsList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterRemoveLanguageExtensions.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterRemoveLanguageExtensions.json new file mode 100644 index 000000000000..b66521becf23 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClusterRemoveLanguageExtensions.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14", + "languageExtensionsToRemove": { + "value": [ + { + "languageExtensionName": "PYTHON" + }, + { + "languageExtensionName": "R" + } + ] + } + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCheckNameAvailability.json new file mode 100644 index 000000000000..29f8da9d1654 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCheckNameAvailability.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2020-06-14", + "location": "wus", + "clusterName": { + "name": "kustoclusterrptest4", + "type": "Microsoft.Kusto/clusters" + } + }, + "responses": { + "200": { + "body": { + "name": "kuskusprod", + "nameAvailable": false, + "message": "Name 'kuskusprod' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCreateOrUpdate.json new file mode 100644 index 000000000000..5065c3af67e8 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersCreateOrUpdate.json @@ -0,0 +1,86 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14", + "parameters": { + "location": "westus", + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "enableStreamingIngest": true, + "enablePurge": true, + "enableDoubleEncryption": false + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "enableDoubleEncryption": false, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "enableDoubleEncryption": false, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDelete.json new file mode 100644 index 000000000000..635552d1cbc1 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDiagnoseVirtualNetwork.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDiagnoseVirtualNetwork.json new file mode 100644 index 000000000000..197a3f05f496 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersDiagnoseVirtualNetwork.json @@ -0,0 +1,18 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "findings": [ + "Outbound dependency 'Storage:443' might not be satisfied (Outbound)" + ] + } + }, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersGet.json new file mode 100644 index 000000000000..44892ca5acf3 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersGet.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": false, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersList.json new file mode 100644 index 000000000000..88284a960b25 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersList.json @@ -0,0 +1,47 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", + "name": "KustoClusterRPTest3", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListByResourceGroup.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListByResourceGroup.json new file mode 100644 index 000000000000..0108b9372831 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListByResourceGroup.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest3", + "name": "KustoClusterRPTest3", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded" + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListResourceSkus.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListResourceSkus.json new file mode 100644 index 000000000000..44ade5876d50 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListResourceSkus.json @@ -0,0 +1,68 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "resourceType": "clusters", + "sku": { + "name": "Standard_D13_v2", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "Standard_D14_v2", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "Standard_L8s", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + }, + { + "resourceType": "clusters", + "sku": { + "name": "Standard_L16s", + "tier": "Standard" + }, + "capacity": { + "minimum": 2, + "maximum": 100, + "default": 2, + "scaleType": "automatic" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListSkus.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListSkus.json new file mode 100644 index 000000000000..9c44eecbf557 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersListSkus.json @@ -0,0 +1,103 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Standard_D13_v2", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + }, + { + "name": "Standard_D14_v2", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + }, + { + "name": "L8", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + }, + { + "name": "L16", + "tier": "Standard", + "locations": [ + "West US", + "West Europe" + ], + "locationInfo": [ + { + "location": "West US", + "zones": [ + "1", + "2", + "3" + ] + }, + { + "location": "West Europe", + "zones": [] + } + ] + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStart.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStart.json new file mode 100644 index 000000000000..13eb4ac881c3 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStart.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStop.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStop.json new file mode 100644 index 000000000000..13eb4ac881c3 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersStop.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersUpdate.json new file mode 100644 index 000000000000..3c5d33b762f3 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoClustersUpdate.json @@ -0,0 +1,107 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14", + "parameters": { + "location": "westus" + }, + "identity": { + "type": "SystemAssigned" + }, + "properties": { + "enableStreamingIngest": true, + "enablePurge": true, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true, + "keyVaultProperties": { + "keyVaultUri": "https://dummy.keyvault.com", + "keyName": "keyName", + "keyVersion": "keyVersion" + } + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4", + "name": "KustoClusterRPTest4", + "type": "Microsoft.Kusto/Clusters", + "location": "westus", + "properties": { + "provisioningState": "Succeeded", + "enableStreamingIngest": true, + "enablePurge": true + }, + "sku": { + "name": "Standard_L8s", + "capacity": 2, + "tier": "Standard" + }, + "identity": { + "type": "SystemAssigned", + "tenantId": "b932977f-6277-4ab7-a2cd-5bd21f07aaf4", + "principalId": "faabad1f-4876-463c-af9d-6ba2d2d2394c", + "userAssignedIdentities": {} + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionValidation.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionValidation.json new file mode 100644 index 000000000000..0cc43d24d15d --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionValidation.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "parameters": { + "dataConnectionName": "DataConnections8", + "properties": { + "kind": "EventHub", + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": [ + { + "errorMessage": "Event hub's namespace does not exist" + }, + { + "errorMessage": "Database does not exist" + } + ] + }, + "202": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCheckNameAvailability.json new file mode 100644 index 000000000000..874c7fb9a8de --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCheckNameAvailability.json @@ -0,0 +1,23 @@ +{ + "parameters": { + "api-version": "2020-06-14", + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "dataConnectionName": { + "name": "DataConnections8", + "type": "Microsoft.Kusto/clusters/databases/dataConnections" + } + }, + "responses": { + "200": { + "body": { + "name": "DataConnections8", + "nameAvailable": false, + "message": "Name 'DataConnections8' is already taken. Please specify a different name.", + "reason": "AlreadyExists" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCreateOrUpdate.json new file mode 100644 index 000000000000..d8f408b09135 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsCreateOrUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "dataConnectionName": "DataConnections8", + "parameters": { + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsDelete.json new file mode 100644 index 000000000000..d8e12541ac64 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "dataConnectionName": "kustoeventhubconnection1" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsGet.json new file mode 100644 index 000000000000..4b6e6fc20dbe --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "dataConnectionName": "DataConnections8" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsListByDatabase.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsListByDatabase.json new file mode 100644 index 000000000000..ae066afb7e08 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsListByDatabase.json @@ -0,0 +1,39 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/KustoDataConnection8", + "name": "KustoClusterRPTest4/KustoDatabase8/KustoDataConnection8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9/DataConnections/KustoDataConnection9", + "name": "KustoClusterRPTest4/KustoDatabase9/KustoDataConnection9", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns2/eventhubs/eventhubTest2", + "consumerGroup": "testConsumerGroup2" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsUpdate.json new file mode 100644 index 000000000000..d8f408b09135 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDataConnectionsUpdate.json @@ -0,0 +1,59 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "dataConnectionName": "DataConnections8", + "parameters": { + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8/DataConnections/DataConnections8", + "name": "KustoClusterRPTest4/KustoDatabase8/DataConnections8", + "type": "Microsoft.Kusto/Clusters/Databases/DataConnections", + "location": "westus", + "kind": "EventHub", + "properties": { + "eventHubResourceId": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.EventHub/namespaces/eventhubTestns1/eventhubs/eventhubTest1", + "consumerGroup": "testConsumerGroup1" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseAddPrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseAddPrincipals.json new file mode 100644 index 000000000000..76782e424a77 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseAddPrincipals.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "databasePrincipalsToAdd": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseListPrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseListPrincipals.json new file mode 100644 index 000000000000..30ce44d15ecf --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseListPrincipals.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json new file mode 100644 index 000000000000..786337cdc34d --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": { + "name": "kustoprincipal1", + "type": "Microsoft.Kusto/clusters/databases/principalAssignments" + }, + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "name": "kustoprincipal1", + "nameAvailable": false, + "message": "Name 'kustoprincipal1' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json new file mode 100644 index 000000000000..3c805dbfde19 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json @@ -0,0 +1,52 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14", + "parameters": { + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsDelete.json new file mode 100644 index 000000000000..cac1fe662991 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsDelete.json @@ -0,0 +1,15 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsGet.json new file mode 100644 index 000000000000..f68b3ef7496d --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsGet.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "principalAssignmentName": "kustoprincipal1", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsList.json new file mode 100644 index 000000000000..b1b71083aa78 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasePrincipalAssignmentsList.json @@ -0,0 +1,45 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "Kustodatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal1", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/kustoclusterrptest4/Databases/Kustodatabase8/PrincipalAssignments/kustoprincipal1", + "name": "kustoclusterrptest4/Kustodatabase8/kustoprincipal2", + "type": "Microsoft.Kusto/Clusters/Databases/PrincipalAssignments", + "properties": { + "role": "Admin", + "principalId": "87654321-1234-1234-1234-123456789123", + "principalType": "App", + "tenantId": "12345678-1234-1234-1234-123456789123", + "tenantName": "tenantName", + "principalName": "TestApp", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseRemovePrincipals.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseRemovePrincipals.json new file mode 100644 index 000000000000..f4082621bcaf --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabaseRemovePrincipals.json @@ -0,0 +1,69 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "databasePrincipalsToRemove": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Some User", + "role": "Admin", + "type": "User", + "fqn": "aaduser=some_guid", + "email": "user@microsoft.com", + "appId": "" + }, + { + "name": "Kusto", + "role": "Viewer", + "type": "Group", + "fqn": "aadgroup=some_guid", + "email": "kusto@microsoft.com", + "appId": "" + }, + { + "name": "SomeApp", + "role": "Admin", + "type": "App", + "fqn": "aadapp=some_guid_app_id", + "email": "", + "appId": "some_guid_app_id" + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCheckNameAvailability.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCheckNameAvailability.json new file mode 100644 index 000000000000..5726470601bb --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCheckNameAvailability.json @@ -0,0 +1,21 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "api-version": "2020-06-14", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "resourceName": { + "name": "kustoresourcename1", + "type": "Microsoft.Kusto/clusters/databases" + } + }, + "responses": { + "200": { + "body": { + "name": "kustoresourcename1", + "nameAvailable": false, + "message": "Name 'kuskus' is already taken. Please specify a different name" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCreateOrUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCreateOrUpdate.json new file mode 100644 index 000000000000..f25f772e9597 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesCreateOrUpdate.json @@ -0,0 +1,56 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "parameters": { + "location": "westus", + "properties": { + "softDeletePeriod": "P1D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "kind": "ReadWrite", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "kind": "ReadWrite", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesDelete.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesDelete.json new file mode 100644 index 000000000000..566a505547e7 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesDelete.json @@ -0,0 +1,14 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": {}, + "202": {}, + "204": {} + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesGet.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesGet.json new file mode 100644 index 000000000000..34b4e866b585 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesGet.json @@ -0,0 +1,24 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesListByCluster.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesListByCluster.json new file mode 100644 index 000000000000..0d43e6b33f66 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesListByCluster.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + }, + { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase9", + "name": "KustoClusterRPTest4/KustoDatabase9", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesUpdate.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesUpdate.json new file mode 100644 index 000000000000..4c36dd0a6038 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoDatabasesUpdate.json @@ -0,0 +1,55 @@ +{ + "parameters": { + "subscriptionId": "12345678-1234-1234-1234-123456789098", + "resourceGroupName": "kustorptest", + "clusterName": "kustoclusterrptest4", + "databaseName": "KustoDatabase8", + "api-version": "2020-06-14", + "parameters": { + "properties": { + "softDeletePeriod": "P1D" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "kind": "ReadWrite", + "location": "westus", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + }, + "202": { + "body": { + "id": "/subscriptions/12345678-1234-1234-1234-123456789098/resourceGroups/kustorptest/providers/Microsoft.Kusto/Clusters/KustoClusterRPTest4/Databases/KustoDatabase8", + "name": "KustoClusterRPTest4/KustoDatabase8", + "type": "Microsoft.Kusto/Clusters/Databases", + "location": "westus", + "kind": "ReadWrite", + "properties": { + "softDeletePeriod": "P1D", + "provisioningState": "Succeeded" + } + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoOperationsList.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoOperationsList.json new file mode 100644 index 000000000000..36ea112ce353 --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/examples/KustoOperationsList.json @@ -0,0 +1,22 @@ +{ + "parameters": { + "api-version": "2020-06-14" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "operationName", + "display": { + "provider": "providerName", + "resource": "resourceName", + "operation": "operationName", + "description": "operation description" + } + } + ] + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/kusto.json b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/kusto.json new file mode 100644 index 000000000000..31bd2dd2c57b --- /dev/null +++ b/specification/azure-kusto/resource-manager/Microsoft.Kusto/stable/2020-06-14/kusto.json @@ -0,0 +1,4281 @@ +{ + "swagger": "2.0", + "info": { + "title": "KustoManagementClient", + "version": "2020-06-14" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Get", + "x-ms-examples": { + "KustoClustersGet": { + "$ref": "./examples/KustoClustersGet.json" + } + }, + "description": "Gets a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Kusto cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_CreateOrUpdate", + "x-ms-examples": { + "KustoClustersCreateOrUpdate": { + "$ref": "./examples/KustoClustersCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Create or update a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Cluster" + }, + "description": "The Kusto cluster parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the Cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Successfully created the cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Update", + "x-ms-examples": { + "KustoClustersUpdate": { + "$ref": "./examples/KustoClustersUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Update a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterUpdate" + }, + "description": "The Kusto cluster parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the Cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "201": { + "description": "Successfully updated the cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "202": { + "description": "Successfully updated the cluster.", + "schema": { + "$ref": "#/definitions/Cluster" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Delete", + "x-ms-examples": { + "KustoClustersDelete": { + "$ref": "./examples/KustoClustersDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- cluster deleted successfully." + }, + "202": { + "description": "Accepted the delete cluster request." + }, + "204": { + "description": "NoContent -- cluster does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/stop": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Stop", + "x-ms-examples": { + "KustoClustersStop": { + "$ref": "./examples/KustoClustersStop.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Stops a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/start": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_Start", + "x-ms-examples": { + "KustoClustersStart": { + "$ref": "./examples/KustoClustersStart.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Starts a Kusto cluster.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkPrincipalAssignmentNameAvailability": { + "post": { + "tags": [ + "ClusterPrincipalAssignments" + ], + "operationId": "ClusterPrincipalAssignments_CheckNameAvailability", + "x-ms-examples": { + "KustoClusterPrincipalAssignmentsCheckNameAvailability": { + "$ref": "./examples/KustoClusterPrincipalAssignmentsCheckNameAvailability.json" + } + }, + "description": "Checks that the principal assignment name is valid and is not already in use.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "principalAssignmentName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPrincipalAssignmentCheckNameRequest" + }, + "description": "The name of the principal assignment." + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the kusto resource name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments/{principalAssignmentName}": { + "get": { + "tags": [ + "ClusterPrincipalAssignments" + ], + "operationId": "ClusterPrincipalAssignments_Get", + "x-ms-examples": { + "KustoClusterPrincipalAssignmentsGet": { + "$ref": "./examples/KustoClusterPrincipalAssignmentsGet.json" + } + }, + "description": "Gets a Kusto cluster principalAssignment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PrincipalAssignmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Kusto cluster principal assignment object.", + "schema": { + "$ref": "#/definitions/ClusterPrincipalAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "ClusterPrincipalAssignments" + ], + "operationId": "ClusterPrincipalAssignments_CreateOrUpdate", + "x-ms-examples": { + "KustoClusterPrincipalAssignmentsCreateOrUpdate": { + "$ref": "./examples/KustoClusterPrincipalAssignmentsCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Create a Kusto cluster principalAssignment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PrincipalAssignmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterPrincipalAssignment" + }, + "description": "The Kusto cluster principalAssignment's parameters supplied for the operation." + } + ], + "responses": { + "200": { + "description": "Successfully updated the PrincipalAssignment.", + "schema": { + "$ref": "#/definitions/ClusterPrincipalAssignment" + } + }, + "201": { + "description": "Successfully created the principalAssignment.", + "schema": { + "$ref": "#/definitions/ClusterPrincipalAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ClusterPrincipalAssignments" + ], + "operationId": "ClusterPrincipalAssignments_Delete", + "x-ms-examples": { + "KustoClusterPrincipalAssignmentsDelete": { + "$ref": "./examples/KustoClusterPrincipalAssignmentsDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes a Kusto cluster principalAssignment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/PrincipalAssignmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- principalAssignments deleted successfully." + }, + "202": { + "description": "Accepted the delete principalAssignments request." + }, + "204": { + "description": "NoContent -- principalAssignments does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/principalAssignments": { + "get": { + "tags": [ + "ClusterPrincipalAssignments" + ], + "operationId": "ClusterPrincipalAssignments_List", + "x-ms-examples": { + "KustoPrincipalAssignmentsList": { + "$ref": "./examples/KustoClusterPrincipalAssignmentsList.json" + } + }, + "description": "Lists all Kusto cluster principalAssignments.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ClusterPrincipalAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listFollowerDatabases": { + "post": { + "tags": [ + "Clusters" + ], + "description": "Returns a list of databases that are owned by this cluster and were followed by another cluster.", + "operationId": "Clusters_ListFollowerDatabases", + "x-ms-examples": { + "KustoClusterListFollowerDatabases": { + "$ref": "./examples/KustoClusterListFollowerDatabases.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of followed databases.", + "schema": { + "$ref": "#/definitions/FollowerDatabaseListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/detachFollowerDatabases": { + "post": { + "tags": [ + "Clusters" + ], + "description": "Detaches all followers of a database owned by this cluster.", + "operationId": "Clusters_DetachFollowerDatabases", + "x-ms-examples": { + "KustoClusterDetachFollowerDatabases": { + "$ref": "./examples/KustoClusterDetachFollowerDatabases.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "followerDatabaseToRemove", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/FollowerDatabaseDefinition" + }, + "description": "The follower databases properties to remove." + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/diagnoseVirtualNetwork": { + "post": { + "tags": [ + "Clusters" + ], + "description": "Diagnoses network connectivity status for external resources on which the service is dependent on.", + "operationId": "Clusters_DiagnoseVirtualNetwork", + "x-ms-examples": { + "KustoClusterDiagnoseVirtualNetwork": { + "$ref": "./examples/KustoClustersDiagnoseVirtualNetwork.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DiagnoseVirtualNetworkResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListByResourceGroup", + "x-ms-examples": { + "KustoClustersListByResourceGroup": { + "$ref": "./examples/KustoClustersListByResourceGroup.json" + } + }, + "description": "Lists all Kusto clusters within a resource group.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/clusters": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_List", + "x-ms-examples": { + "KustoClustersList": { + "$ref": "./examples/KustoClustersList.json" + } + }, + "description": "Lists all Kusto clusters within a subscription.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ClusterListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/skus": { + "get": { + "description": "Lists eligible SKUs for Kusto resource provider.", + "x-ms-examples": { + "KustoClustersListSkus": { + "$ref": "./examples/KustoClustersListSkus.json" + } + }, + "operationId": "Clusters_ListSkus", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/SkuDescriptionList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.Kusto/locations/{location}/checkNameAvailability": { + "post": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_CheckNameAvailability", + "x-ms-examples": { + "KustoClustersCheckNameAvailability": { + "$ref": "./examples/KustoClustersCheckNameAvailability.json" + } + }, + "description": "Checks that the cluster name is valid and is not already in use.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "location", + "in": "path", + "description": "Azure location.", + "required": true, + "type": "string" + }, + { + "name": "clusterName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ClusterCheckNameRequest" + }, + "description": "The name of the cluster." + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the kusto resource name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/checkNameAvailability": { + "post": { + "tags": [ + "Databases" + ], + "operationId": "Databases_CheckNameAvailability", + "x-ms-examples": { + "KustoDatabaseCheckNameAvailability": { + "$ref": "./examples/KustoDatabasesCheckNameAvailability.json" + } + }, + "description": "Checks that the database name is valid and is not already in use.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "resourceName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/CheckNameRequest" + }, + "description": "The name of the resource." + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the kusto resource name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/skus": { + "get": { + "tags": [ + "Clusters" + ], + "operationId": "Clusters_ListSkusByResource", + "x-ms-examples": { + "KustoClustersListResourceSkus": { + "$ref": "./examples/KustoClustersListResourceSkus.json" + } + }, + "description": "Returns the SKUs available for the provided resource.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/ListResourceSkusResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases": { + "get": { + "tags": [ + "Databases" + ], + "description": "Returns the list of databases of the given Kusto cluster.", + "operationId": "Databases_ListByCluster", + "x-ms-examples": { + "KustoDatabasesListByCluster": { + "$ref": "./examples/KustoDatabasesListByCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of databases.", + "schema": { + "$ref": "#/definitions/DatabaseListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}": { + "get": { + "tags": [ + "Databases" + ], + "description": "Returns a database.", + "operationId": "Databases_Get", + "x-ms-examples": { + "KustoDatabasesGet": { + "$ref": "./examples/KustoDatabasesGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "Databases" + ], + "description": "Creates or updates a database.", + "operationId": "Databases_CreateOrUpdate", + "x-ms-examples": { + "KustoDatabasesCreateOrUpdate": { + "$ref": "./examples/KustoDatabasesCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "The database parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "Successfully created the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "Accepted the create database request.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "Databases" + ], + "description": "Updates a database.", + "operationId": "Databases_Update", + "x-ms-examples": { + "KustoDatabasesUpdate": { + "$ref": "./examples/KustoDatabasesUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/Database" + }, + "description": "The database parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "201": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "202": { + "description": "Accepted the update database request.", + "schema": { + "$ref": "#/definitions/Database" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "Databases" + ], + "description": "Deletes the database with the given name.", + "operationId": "Databases_Delete", + "x-ms-examples": { + "KustoDatabasesDelete": { + "$ref": "./examples/KustoDatabasesDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the database." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "The specified database does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/checkPrincipalAssignmentNameAvailability": { + "post": { + "tags": [ + "DatabasePrincipalAssignments" + ], + "operationId": "DatabasePrincipalAssignments_CheckNameAvailability", + "x-ms-examples": { + "KustoDatabaseCheckNameAvailability": { + "$ref": "./examples/KustoDatabasePrincipalAssignmentsCheckNameAvailability.json" + } + }, + "description": "Checks that the database principal assignment is valid and is not already in use.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "principalAssignmentName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabasePrincipalAssignmentCheckNameRequest" + }, + "description": "The name of the resource." + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the kusto resource name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments/{principalAssignmentName}": { + "get": { + "tags": [ + "DatabasePrincipalAssignments" + ], + "operationId": "DatabasePrincipalAssignments_Get", + "x-ms-examples": { + "KustoDatabasePrincipalAssignmentsGet": { + "$ref": "./examples/KustoDatabasePrincipalAssignmentsGet.json" + } + }, + "description": "Gets a Kusto cluster database principalAssignment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/PrincipalAssignmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The Kusto cluster database principal assignment object.", + "schema": { + "$ref": "#/definitions/DatabasePrincipalAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "DatabasePrincipalAssignments" + ], + "operationId": "DatabasePrincipalAssignments_CreateOrUpdate", + "x-ms-examples": { + "KustoDatabasePrincipalAssignmentsCreateOrUpdate": { + "$ref": "./examples/KustoDatabasePrincipalAssignmentsCreateOrUpdate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Creates a Kusto cluster database principalAssignment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/PrincipalAssignmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabasePrincipalAssignment" + }, + "description": "The Kusto principalAssignments parameters supplied for the operation." + } + ], + "responses": { + "200": { + "description": "Successfully updated the PrincipalAssignments.", + "schema": { + "$ref": "#/definitions/DatabasePrincipalAssignment" + } + }, + "201": { + "description": "Successfully created the principalAssignments.", + "schema": { + "$ref": "#/definitions/DatabasePrincipalAssignment" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "DatabasePrincipalAssignments" + ], + "operationId": "DatabasePrincipalAssignments_Delete", + "x-ms-examples": { + "KustoDatabasePrincipalAssignmentsDelete": { + "$ref": "./examples/KustoDatabasePrincipalAssignmentsDelete.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Deletes a Kusto principalAssignment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/PrincipalAssignmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK -- principalAssignments deleted successfully." + }, + "202": { + "description": "Accepted the delete principalAssignments request." + }, + "204": { + "description": "NoContent -- principalAssignments does not exist in the subscription." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/principalAssignments": { + "get": { + "tags": [ + "DatabasePrincipalAssignments" + ], + "operationId": "DatabasePrincipalAssignments_List", + "x-ms-examples": { + "KustoPrincipalAssignmentsList": { + "$ref": "./examples/KustoDatabasePrincipalAssignmentsList.json" + } + }, + "description": "Lists all Kusto cluster database principalAssignments.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK.", + "schema": { + "$ref": "#/definitions/DatabasePrincipalAssignmentListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/listPrincipals": { + "post": { + "tags": [ + "Databases" + ], + "description": "Returns a list of database principals of the given Kusto cluster and database.", + "operationId": "Databases_ListPrincipals", + "x-ms-examples": { + "KustoDatabaseListPrincipals": { + "$ref": "./examples/KustoDatabaseListPrincipals.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of database principals.", + "schema": { + "$ref": "#/definitions/DatabasePrincipalListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/addPrincipals": { + "post": { + "tags": [ + "Databases" + ], + "operationId": "Databases_AddPrincipals", + "x-ms-examples": { + "KustoDatabaseAddPrincipals": { + "$ref": "./examples/KustoDatabaseAddPrincipals.json" + } + }, + "description": "Add Database principals permissions.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "databasePrincipalsToAdd", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabasePrincipalListRequest" + }, + "description": "List of database principals to add." + } + ], + "responses": { + "200": { + "description": "OK -- Successfully added the list of database principals. Returns the updated list of principals.", + "schema": { + "$ref": "#/definitions/DatabasePrincipalListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations": { + "get": { + "tags": [ + "AttachedDatabaseConfigurations" + ], + "description": "Returns the list of attached database configurations of the given Kusto cluster.", + "operationId": "AttachedDatabaseConfigurations_ListByCluster", + "x-ms-examples": { + "KustoAttachedDatabaseConfigurationsListByCluster": { + "$ref": "./examples/KustoAttachedDatabaseConfigurationsListByCluster.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of attached database configurations.", + "schema": { + "$ref": "#/definitions/AttachedDatabaseConfigurationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/attachedDatabaseConfigurations/{attachedDatabaseConfigurationName}": { + "get": { + "tags": [ + "AttachedDatabaseConfigurations" + ], + "description": "Returns an attached database configuration.", + "operationId": "AttachedDatabaseConfigurations_Get", + "x-ms-examples": { + "AttachedDatabaseConfigurationsGet": { + "$ref": "./examples/KustoAttachedDatabaseConfigurationsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/AttachedDatabaseConfigurationNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified attached database configuration.", + "schema": { + "$ref": "#/definitions/AttachedDatabaseConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "AttachedDatabaseConfigurations" + ], + "description": "Creates or updates an attached database configuration.", + "operationId": "AttachedDatabaseConfigurations_CreateOrUpdate", + "x-ms-examples": { + "AttachedDatabaseConfigurationsCreateOrUpdate": { + "$ref": "./examples/KustoAttachedDatabaseConfigurationsCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/AttachedDatabaseConfigurationNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AttachedDatabaseConfiguration" + }, + "description": "The database parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the database.", + "schema": { + "$ref": "#/definitions/AttachedDatabaseConfiguration" + } + }, + "201": { + "description": "Successfully created the database.", + "schema": { + "$ref": "#/definitions/AttachedDatabaseConfiguration" + } + }, + "202": { + "description": "Accepted the create database request.", + "schema": { + "$ref": "#/definitions/AttachedDatabaseConfiguration" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "AttachedDatabaseConfigurations" + ], + "description": "Deletes the attached database configuration with the given name.", + "operationId": "AttachedDatabaseConfigurations_Delete", + "x-ms-examples": { + "AttachedDatabaseConfigurationsDelete": { + "$ref": "./examples/KustoAttachedDatabaseConfigurationsDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/AttachedDatabaseConfigurationNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the database." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "The specified database does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/removePrincipals": { + "post": { + "tags": [ + "Databases" + ], + "operationId": "Databases_RemovePrincipals", + "x-ms-examples": { + "KustoDatabaseRemovePrincipals": { + "$ref": "./examples/KustoDatabaseRemovePrincipals.json" + } + }, + "description": "Remove Database principals permissions.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "databasePrincipalsToRemove", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DatabasePrincipalListRequest" + }, + "description": "List of database principals to remove." + } + ], + "responses": { + "200": { + "description": "OK -- Successfully removed the list of database principals. Returns the updated list of principals.", + "schema": { + "$ref": "#/definitions/DatabasePrincipalListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections": { + "get": { + "tags": [ + "DataConnections" + ], + "description": "Returns the list of data connections of the given Kusto database.", + "operationId": "DataConnections_ListByDatabase", + "x-ms-examples": { + "KustoDatabasesListByCluster": { + "$ref": "./examples/KustoDataConnectionsListByDatabase.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of data connections.", + "schema": { + "$ref": "#/definitions/DataConnectionListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnectionValidation": { + "post": { + "tags": [ + "DataConnections" + ], + "operationId": "DataConnections_dataConnectionValidation", + "x-ms-examples": { + "KustoDataConnectionValidation": { + "$ref": "./examples/KustoDataConnectionValidation.json" + } + }, + "x-ms-long-running-operation": true, + "x-ms-long-running-operation-options": { + "final-state-via": "location" + }, + "description": "Checks that the data connection parameters are valid.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectionValidation" + }, + "description": "The data connection parameters supplied to the CreateOrUpdate operation." + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the kusto resource name availability was successful.", + "schema": { + "$ref": "#/definitions/DataConnectionValidationListResult" + } + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/checkNameAvailability": { + "post": { + "tags": [ + "DataConnections" + ], + "operationId": "DataConnections_CheckNameAvailability", + "x-ms-examples": { + "KustoDataConnectionsCheckNameAvailability": { + "$ref": "./examples/KustoDataConnectionsCheckNameAvailability.json" + } + }, + "description": "Checks that the data connection name is valid and is not already in use.", + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "name": "dataConnectionName", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnectionCheckNameRequest" + }, + "description": "The name of the data connection." + } + ], + "responses": { + "200": { + "description": "OK -- Operation to check the Kusto resource name availability was successful.", + "schema": { + "$ref": "#/definitions/CheckNameResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/databases/{databaseName}/dataConnections/{dataConnectionName}": { + "get": { + "tags": [ + "DataConnections" + ], + "description": "Returns a data connection.", + "operationId": "DataConnections_Get", + "x-ms-examples": { + "KustoDataConnectionsGet": { + "$ref": "./examples/KustoDataConnectionsGet.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/DataConnectionNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the specified data connection.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "put": { + "tags": [ + "DataConnections" + ], + "description": "Creates or updates a data connection.", + "operationId": "DataConnections_CreateOrUpdate", + "x-ms-examples": { + "KustoDataConnectionsCreateOrUpdate": { + "$ref": "./examples/KustoDataConnectionsCreateOrUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/DataConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnection" + }, + "description": "The data connection parameters supplied to the CreateOrUpdate operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the data connection.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "201": { + "description": "Successfully created the data connection.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "202": { + "description": "Accepted the create data connection request.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "patch": { + "tags": [ + "DataConnections" + ], + "description": "Updates a data connection.", + "operationId": "DataConnections_Update", + "x-ms-examples": { + "KustoDataConnectionsUpdate": { + "$ref": "./examples/KustoDataConnectionsUpdate.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/DataConnectionNameParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/DataConnection" + }, + "description": "The data connection parameters supplied to the Update operation." + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the data connection.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "201": { + "description": "Successfully updated the data connection.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "202": { + "description": "Accepted the update data connection request.", + "schema": { + "$ref": "#/definitions/DataConnection" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + }, + "delete": { + "tags": [ + "DataConnections" + ], + "description": "Deletes the data connection with the given name.", + "operationId": "DataConnections_Delete", + "x-ms-examples": { + "KustoDataConnectionsDelete": { + "$ref": "./examples/KustoDataConnectionsDelete.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/DatabaseNameParameter" + }, + { + "$ref": "#/parameters/DataConnectionNameParameter" + }, + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully deleted the data connection." + }, + "202": { + "description": "Accepted." + }, + "204": { + "description": "The specified data connection does not exist." + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-long-running-operation": true + } + }, + "/providers/Microsoft.Kusto/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "x-ms-examples": { + "KustoOperationsList": { + "$ref": "./examples/KustoOperationsList.json" + } + }, + "description": "Lists available operations for the Microsoft.Kusto provider.", + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The operation was successful. The response contains the list of available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/listLanguageExtensions": { + "post": { + "tags": [ + "Clusters" + ], + "description": "Returns a list of language extensions that can run within KQL queries.", + "operationId": "Clusters_ListLanguageExtensions", + "x-ms-examples": { + "KustoClusterListLanguageExtensions": { + "$ref": "./examples/KustoClusterListLanguageExtensions.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the list of language extensions.", + "schema": { + "$ref": "#/definitions/LanguageExtensionsList" + } + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + }, + "x-ms-pageable": { + "nextLinkName": null + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/addLanguageExtensions": { + "post": { + "tags": [ + "Clusters" + ], + "description": "Add a list of language extensions that can run within KQL queries.", + "operationId": "Clusters_AddLanguageExtensions", + "x-ms-examples": { + "KustoClusterAddLanguageExtensions": { + "$ref": "./examples/KustoClusterAddLanguageExtensions.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "languageExtensionsToAdd", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LanguageExtensionsList" + }, + "description": "The language extensions to add." + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.Kusto/clusters/{clusterName}/removeLanguageExtensions": { + "post": { + "tags": [ + "Clusters" + ], + "description": "Remove a list of language extensions that can run within KQL queries.", + "operationId": "Clusters_RemoveLanguageExtensions", + "x-ms-examples": { + "KustoClusterRemoveLanguageExtensions": { + "$ref": "./examples/KustoClusterRemoveLanguageExtensions.json" + } + }, + "x-ms-long-running-operation": true, + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupParameter" + }, + { + "$ref": "#/parameters/ClusterNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "languageExtensionsToRemove", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/LanguageExtensionsList" + }, + "description": "The language extensions to remove." + } + ], + "responses": { + "200": { + "description": "OK." + }, + "202": { + "description": "Accepted" + }, + "default": { + "description": "Error response describing why the operation failed.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "ClusterProperties": { + "properties": { + "state": { + "type": "string", + "readOnly": true, + "description": "The state of the resource.", + "enum": [ + "Creating", + "Unavailable", + "Running", + "Deleting", + "Deleted", + "Stopping", + "Stopped", + "Starting", + "Updating" + ], + "x-ms-enum": { + "name": "State", + "modelAsString": true + } + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioned state of the resource.", + "enum": [ + "Running", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Moving" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "uri": { + "type": "string", + "readOnly": true, + "description": "The cluster URI." + }, + "dataIngestionUri": { + "type": "string", + "readOnly": true, + "description": "The cluster data ingestion URI." + }, + "stateReason": { + "type": "string", + "readOnly": true, + "description": "The reason for the cluster's current state." + }, + "trustedExternalTenants": { + "type": "array", + "items": { + "$ref": "#/definitions/TrustedExternalTenant" + }, + "description": "The cluster's external tenants." + }, + "optimizedAutoscale": { + "type": "object", + "$ref": "#/definitions/OptimizedAutoscale", + "description": "Optimized auto scale definition." + }, + "enableDiskEncryption": { + "description": "A boolean value that indicates if the cluster's disks are encrypted.", + "type": "boolean" + }, + "enableStreamingIngest": { + "description": "A boolean value that indicates if the streaming ingest is enabled.", + "default": false, + "type": "boolean" + }, + "virtualNetworkConfiguration": { + "type": "object", + "$ref": "#/definitions/VirtualNetworkConfiguration", + "description": "Virtual network definition." + }, + "keyVaultProperties": { + "type": "object", + "$ref": "#/definitions/KeyVaultProperties", + "description": "KeyVault properties for the cluster encryption." + }, + "enablePurge": { + "description": "A boolean value that indicates if the purge operations are enabled.", + "default": false, + "type": "boolean" + }, + "languageExtensions": { + "type": "object", + "$ref": "#/definitions/LanguageExtensionsList", + "readOnly": true, + "description": "List of the cluster's language extensions." + }, + "enableDoubleEncryption": { + "description": "A boolean value that indicates if double encryption is enabled.", + "default": false, + "type": "boolean" + } + }, + "description": "Class representing the Kusto cluster properties." + }, + "TrustedExternalTenant": { + "properties": { + "value": { + "type": "string", + "description": "GUID representing an external tenant." + } + }, + "description": "Represents a tenant ID that is trusted by the cluster." + }, + "AzureResourceSku": { + "properties": { + "resourceType": { + "type": "string", + "description": "Resource Namespace and Type." + }, + "sku": { + "$ref": "#/definitions/AzureSku", + "description": "The SKU details." + }, + "capacity": { + "$ref": "#/definitions/AzureCapacity", + "description": "The number of instances of the cluster." + } + }, + "description": "Azure resource SKU definition." + }, + "AzureCapacity": { + "type": "object", + "required": [ + "minimum", + "maximum", + "default", + "scaleType" + ], + "properties": { + "scaleType": { + "description": "Scale type.", + "type": "string", + "enum": [ + "automatic", + "manual", + "none" + ], + "x-ms-enum": { + "name": "AzureScaleType", + "modelAsString": true + } + }, + "minimum": { + "description": "Minimum allowed capacity.", + "type": "integer" + }, + "maximum": { + "description": "Maximum allowed capacity.", + "type": "integer" + }, + "default": { + "description": "The default capacity that would be used.", + "type": "integer" + } + }, + "description": "Azure capacity definition." + }, + "SkuDescriptionList": { + "description": "The list of the EngagementFabric SKU descriptions", + "type": "object", + "properties": { + "value": { + "description": "SKU descriptions", + "type": "array", + "items": { + "$ref": "#/definitions/SkuDescription" + }, + "readOnly": true + } + } + }, + "SkuDescription": { + "description": "The Kusto SKU description of given resource type", + "type": "object", + "properties": { + "resourceType": { + "description": "The resource type", + "type": "string", + "readOnly": true + }, + "name": { + "description": "The name of the SKU", + "type": "string", + "readOnly": true + }, + "tier": { + "description": "The tier of the SKU", + "type": "string", + "readOnly": true + }, + "locations": { + "description": "The set of locations that the SKU is available", + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true + }, + "locationInfo": { + "description": "Locations and zones", + "type": "array", + "items": { + "$ref": "#/definitions/SkuLocationInfoItem" + }, + "readOnly": true + }, + "restrictions": { + "description": "The restrictions because of which SKU cannot be used", + "type": "array", + "items": { + "type": "object" + }, + "readOnly": true + } + } + }, + "SkuLocationInfoItem": { + "description": "The locations and zones info for SKU.", + "type": "object", + "required": [ + "location" + ], + "properties": { + "location": { + "description": "The available location of the SKU.", + "type": "string" + }, + "zones": { + "description": "The available zone of the SKU.", + "type": "array", + "items": { + "type": "string" + } + } + } + }, + "AzureSku": { + "type": "object", + "required": [ + "name", + "tier" + ], + "properties": { + "name": { + "description": "SKU name.", + "type": "string", + "enum": [ + "Standard_DS13_v2+1TB_PS", + "Standard_DS13_v2+2TB_PS", + "Standard_DS14_v2+3TB_PS", + "Standard_DS14_v2+4TB_PS", + "Standard_D13_v2", + "Standard_D14_v2", + "Standard_L8s", + "Standard_L16s", + "Standard_D11_v2", + "Standard_D12_v2", + "Standard_L4s", + "Dev(No SLA)_Standard_D11_v2", + "Standard_E2a_v4", + "Standard_E4a_v4", + "Standard_E8a_v4", + "Standard_E16a_v4", + "Standard_E8as_v4+1TB_PS", + "Standard_E8as_v4+2TB_PS", + "Standard_E16as_v4+3TB_PS", + "Standard_E16as_v4+4TB_PS", + "Dev(No SLA)_Standard_E2a_v4" + ], + "x-ms-enum": { + "name": "AzureSkuName", + "modelAsString": true + } + }, + "capacity": { + "description": "The number of instances of the cluster.", + "type": "integer" + }, + "tier": { + "description": "SKU tier.", + "type": "string", + "enum": [ + "Basic", + "Standard" + ], + "x-ms-enum": { + "name": "AzureSkuTier", + "modelAsString": true + } + } + }, + "description": "Azure SKU definition." + }, + "Zones": { + "description": "An array represents the availability zones of the cluster.", + "type": "array", + "items": { + "type": "string" + } + }, + "OptimizedAutoscale": { + "type": "object", + "required": [ + "version", + "isEnabled", + "minimum", + "maximum" + ], + "properties": { + "version": { + "description": "The version of the template defined, for instance 1.", + "type": "integer" + }, + "isEnabled": { + "description": "A boolean value that indicate if the optimized autoscale feature is enabled or not.", + "type": "boolean" + }, + "minimum": { + "description": "Minimum allowed instances count.", + "type": "integer" + }, + "maximum": { + "description": "Maximum allowed instances count.", + "type": "integer" + } + }, + "description": "A class that contains the optimized auto scale definition." + }, + "VirtualNetworkConfiguration": { + "type": "object", + "required": [ + "subnetId", + "enginePublicIpId", + "dataManagementPublicIpId" + ], + "properties": { + "subnetId": { + "description": "The subnet resource id.", + "type": "string" + }, + "enginePublicIpId": { + "description": "Engine service's public IP address resource id.", + "type": "string" + }, + "dataManagementPublicIpId": { + "description": "Data management's service public IP address resource id.", + "type": "string" + } + }, + "description": "A class that contains virtual network definition." + }, + "DatabaseStatistics": { + "type": "object", + "readOnly": true, + "properties": { + "size": { + "type": "number", + "description": "The database size - the total size of compressed data and index in bytes." + } + }, + "description": "A class that contains database statistics information." + }, + "AttachedDatabaseConfigurationProperties": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioned state of the resource.", + "enum": [ + "Running", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Moving" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "databaseName": { + "type": "string", + "description": "The name of the database which you would like to attach, use * if you want to follow all current and future databases." + }, + "clusterResourceId": { + "type": "string", + "description": "The resource id of the cluster where the databases you would like to attach reside." + }, + "attachedDatabaseNames": { + "type": "array", + "items": { + "type": "string" + }, + "readOnly": true, + "description": "The list of databases from the clusterResourceId which are currently attached to the cluster." + }, + "defaultPrincipalsModificationKind": { + "type": "string", + "enum": [ + "Union", + "Replace", + "None" + ], + "x-ms-enum": { + "name": "DefaultPrincipalsModificationKind", + "modelAsString": true + }, + "description": "The default principals modification kind" + } + }, + "description": "Class representing the an attached database configuration properties of kind specific.", + "required": [ + "databaseName", + "clusterResourceId", + "defaultPrincipalsModificationKind" + ] + }, + "ReadWriteDatabaseProperties": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioned state of the resource.", + "enum": [ + "Running", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Moving" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "softDeletePeriod": { + "type": "string", + "format": "duration", + "description": "The time the data should be kept before it stops being accessible to queries in TimeSpan." + }, + "hotCachePeriod": { + "type": "string", + "format": "duration", + "description": "The time the data should be kept in cache for fast queries in TimeSpan." + }, + "statistics": { + "$ref": "#/definitions/DatabaseStatistics", + "description": "The statistics of the database." + }, + "isFollowed": { + "type": "boolean", + "readOnly": true, + "description": "Indicates whether the database is followed." + } + }, + "description": "Class representing the Kusto database properties." + }, + "ReadOnlyFollowingDatabaseProperties": { + "properties": { + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioned state of the resource.", + "enum": [ + "Running", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Moving" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "softDeletePeriod": { + "type": "string", + "readOnly": true, + "format": "duration", + "description": "The time the data should be kept before it stops being accessible to queries in TimeSpan." + }, + "hotCachePeriod": { + "type": "string", + "format": "duration", + "description": "The time the data should be kept in cache for fast queries in TimeSpan." + }, + "statistics": { + "$ref": "#/definitions/DatabaseStatistics", + "description": "The statistics of the database." + }, + "leaderClusterResourceId": { + "type": "string", + "readOnly": true, + "description": "The name of the leader cluster" + }, + "attachedDatabaseConfigurationName": { + "type": "string", + "readOnly": true, + "description": "The name of the attached database configuration cluster" + }, + "principalsModificationKind": { + "type": "string", + "readOnly": true, + "enum": [ + "Union", + "Replace", + "None" + ], + "x-ms-enum": { + "name": "PrincipalsModificationKind", + "modelAsString": true + }, + "description": "The principals modification kind of the database" + } + }, + "description": "Class representing the Kusto database properties." + }, + "EventHubConnectionProperties": { + "properties": { + "eventHubResourceId": { + "type": "string", + "description": "The resource ID of the event hub to be used to create a data connection." + }, + "consumerGroup": { + "type": "string", + "description": "The event hub consumer group." + }, + "tableName": { + "type": "string", + "description": "The table where the data should be ingested. Optionally the table information can be added to each message." + }, + "mappingRuleName": { + "type": "string", + "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message." + }, + "dataFormat": { + "$ref": "#/definitions/EventHubDataFormat", + "description": "The data format of the message. Optionally the data format can be added to each message." + }, + "eventSystemProperties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "System properties of the event hub" + }, + "compression": { + "$ref": "#/definitions/Compression", + "description": "The event hub messages compression type" + } + }, + "required": [ + "eventHubResourceId", + "consumerGroup" + ], + "description": "Class representing the Kusto event hub connection properties." + }, + "IotHubConnectionProperties": { + "properties": { + "iotHubResourceId": { + "type": "string", + "description": "The resource ID of the Iot hub to be used to create a data connection." + }, + "consumerGroup": { + "type": "string", + "description": "The iot hub consumer group." + }, + "tableName": { + "type": "string", + "description": "The table where the data should be ingested. Optionally the table information can be added to each message." + }, + "mappingRuleName": { + "type": "string", + "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message." + }, + "dataFormat": { + "$ref": "#/definitions/IotHubDataFormat", + "description": "The data format of the message. Optionally the data format can be added to each message." + }, + "eventSystemProperties": { + "type": "array", + "items": { + "type": "string" + }, + "description": "System properties of the iot hub" + }, + "sharedAccessPolicyName": { + "type": "string", + "description": "The name of the share access policy" + } + }, + "required": [ + "iotHubResourceId", + "consumerGroup", + "sharedAccessPolicyName" + ], + "description": "Class representing the Kusto Iot hub connection properties." + }, + "EventHubDataFormat": { + "description": "The data format of the message. Optionally the data format can be added to each message.", + "type": "string", + "enum": [ + "MULTIJSON", + "JSON", + "CSV", + "TSV", + "SCSV", + "SOHSV", + "PSV", + "TXT", + "RAW", + "SINGLEJSON", + "AVRO", + "TSVE", + "PARQUET", + "ORC", + "APACHEAVRO", + "W3CLOGFILE" + ], + "x-ms-enum": { + "name": "eventHubDataFormat", + "modelAsString": true + } + }, + "IotHubDataFormat": { + "description": "The data format of the message. Optionally the data format can be added to each message.", + "type": "string", + "enum": [ + "MULTIJSON", + "JSON", + "CSV", + "TSV", + "SCSV", + "SOHSV", + "PSV", + "TXT", + "RAW", + "SINGLEJSON", + "AVRO", + "TSVE", + "PARQUET", + "ORC", + "APACHEAVRO", + "W3CLOGFILE" + ], + "x-ms-enum": { + "name": "iotHubDataFormat", + "modelAsString": true + } + }, + "EventGridDataFormat": { + "description": "The data format of the message. Optionally the data format can be added to each message.", + "type": "string", + "enum": [ + "MULTIJSON", + "JSON", + "CSV", + "TSV", + "SCSV", + "SOHSV", + "PSV", + "TXT", + "RAW", + "SINGLEJSON", + "AVRO", + "TSVE", + "PARQUET", + "ORC", + "APACHEAVRO", + "W3CLOGFILE" + ], + "x-ms-enum": { + "name": "eventGridDataFormat", + "modelAsString": true + } + }, + "BlobStorageEventType": { + "description": "The name of blob storage event type to process.", + "type": "string", + "enum": [ + "Microsoft.Storage.BlobCreated", + "Microsoft.Storage.BlobRenamed" + ], + "x-ms-enum": { + "name": "blobStorageEventType", + "modelAsString": true + } + }, + "Compression": { + "description": "The compression type", + "type": "string", + "enum": [ + "None", + "GZip" + ], + "x-ms-enum": { + "name": "compression", + "modelAsString": true + } + }, + "EventGridConnectionProperties": { + "properties": { + "storageAccountResourceId": { + "type": "string", + "description": "The resource ID of the storage account where the data resides." + }, + "eventHubResourceId": { + "type": "string", + "description": "The resource ID where the event grid is configured to send events." + }, + "consumerGroup": { + "type": "string", + "description": "The event hub consumer group." + }, + "tableName": { + "type": "string", + "description": "The table where the data should be ingested. Optionally the table information can be added to each message." + }, + "mappingRuleName": { + "type": "string", + "description": "The mapping rule to be used to ingest the data. Optionally the mapping information can be added to each message." + }, + "dataFormat": { + "$ref": "#/definitions/EventGridDataFormat", + "description": "The data format of the message. Optionally the data format can be added to each message." + }, + "ignoreFirstRecord": { + "type": "boolean", + "description": "A Boolean value that, if set to true, indicates that ingestion should ignore the first record of every file" + }, + "blobStorageEventType": { + "$ref": "#/definitions/BlobStorageEventType", + "description": "The name of blob storage event type to process." + } + }, + "required": [ + "storageAccountResourceId", + "eventHubResourceId", + "consumerGroup" + ], + "description": "Class representing the Kusto event grid connection properties." + }, + "Cluster": { + "required": [ + "sku" + ], + "properties": { + "sku": { + "$ref": "#/definitions/AzureSku", + "description": "The SKU of the cluster." + }, + "zones": { + "$ref": "#/definitions/Zones", + "description": "The availability zones of the cluster." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the cluster, if configured." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterProperties", + "description": "The cluster properties." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/TrackedResource" + } + ], + "description": "Class representing a Kusto cluster." + }, + "ClusterUpdate": { + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "x-ms-mutability": [ + "read", + "create", + "update" + ], + "description": "Resource tags." + }, + "location": { + "type": "string", + "description": "Resource location." + }, + "sku": { + "$ref": "#/definitions/AzureSku", + "description": "The SKU of the cluster." + }, + "identity": { + "$ref": "#/definitions/Identity", + "description": "The identity of the cluster, if configured." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The cluster properties.", + "$ref": "#/definitions/ClusterProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/Resource" + } + ], + "description": "Class representing an update to a Kusto cluster." + }, + "AttachedDatabaseConfigurationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AttachedDatabaseConfiguration" + }, + "description": "The list of attached database configurations." + } + }, + "description": "The list attached database configurations operation response." + }, + "AttachedDatabaseConfiguration": { + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the attached database configuration.", + "$ref": "#/definitions/AttachedDatabaseConfigurationProperties" + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Class representing an attached database configuration." + }, + "Database": { + "required": [ + "kind" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "kind": { + "description": "Kind of the database", + "enum": [ + "ReadWrite", + "ReadOnlyFollowing" + ], + "type": "string", + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Class representing a Kusto database.", + "discriminator": "kind" + }, + "ReadWriteDatabase": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The database properties.", + "$ref": "#/definitions/ReadWriteDatabaseProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Database" + } + ], + "description": "Class representing a read write database.", + "x-ms-discriminator-value": "ReadWrite" + }, + "ReadOnlyFollowingDatabase": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The database properties.", + "$ref": "#/definitions/ReadOnlyFollowingDatabaseProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Database" + } + ], + "description": "Class representing a read only following database.", + "x-ms-discriminator-value": "ReadOnlyFollowing" + }, + "DatabasePrincipal": { + "type": "object", + "required": [ + "name", + "role", + "type" + ], + "properties": { + "role": { + "description": "Database principal role.", + "type": "string", + "enum": [ + "Admin", + "Ingestor", + "Monitor", + "User", + "UnrestrictedViewers", + "Viewer" + ], + "x-ms-enum": { + "name": "DatabasePrincipalRole", + "modelAsString": true + } + }, + "name": { + "description": "Database principal name.", + "type": "string" + }, + "type": { + "description": "Database principal type.", + "type": "string", + "enum": [ + "App", + "Group", + "User" + ], + "x-ms-enum": { + "name": "DatabasePrincipalType", + "modelAsString": true + } + }, + "fqn": { + "description": "Database principal fully qualified name.", + "type": "string" + }, + "email": { + "description": "Database principal email if exists.", + "type": "string" + }, + "appId": { + "description": "Application id - relevant only for application principal type.", + "type": "string" + }, + "tenantName": { + "type": "string", + "readOnly": true, + "description": "The tenant name of the principal" + } + }, + "description": "A class representing database principal entity." + }, + "DatabasePrincipalProperties": { + "type": "object", + "required": [ + "principalId", + "role", + "principalType" + ], + "properties": { + "principalId": { + "description": "The principal ID assigned to the database principal. It can be a user email, application ID, or security group name.", + "type": "string" + }, + "role": { + "description": "Database principal role.", + "type": "string", + "enum": [ + "Admin", + "Ingestor", + "Monitor", + "User", + "UnrestrictedViewers", + "Viewer" + ], + "x-ms-enum": { + "name": "DatabasePrincipalRole", + "modelAsString": true + } + }, + "tenantId": { + "type": "string", + "description": "The tenant id of the principal" + }, + "principalType": { + "description": "Principal type.", + "type": "string", + "enum": [ + "App", + "Group", + "User" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + } + }, + "tenantName": { + "type": "string", + "readOnly": true, + "description": "The tenant name of the principal" + }, + "principalName": { + "type": "string", + "readOnly": true, + "description": "The principal name" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioned state of the resource.", + "enum": [ + "Running", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Moving" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + }, + "description": "A class representing database principal property." + }, + "ClusterPrincipalProperties": { + "type": "object", + "required": [ + "principalId", + "role", + "principalType" + ], + "properties": { + "principalId": { + "description": "The principal ID assigned to the cluster principal. It can be a user email, application ID, or security group name.", + "type": "string" + }, + "role": { + "description": "Cluster principal role.", + "type": "string", + "enum": [ + "AllDatabasesAdmin", + "AllDatabasesViewer" + ], + "x-ms-enum": { + "name": "ClusterPrincipalRole", + "modelAsString": true + } + }, + "tenantId": { + "type": "string", + "description": "The tenant id of the principal" + }, + "principalType": { + "description": "Principal type.", + "type": "string", + "enum": [ + "App", + "Group", + "User" + ], + "x-ms-enum": { + "name": "PrincipalType", + "modelAsString": true + } + }, + "tenantName": { + "type": "string", + "readOnly": true, + "description": "The tenant name of the principal" + }, + "principalName": { + "type": "string", + "readOnly": true, + "description": "The principal name" + }, + "provisioningState": { + "type": "string", + "readOnly": true, + "description": "The provisioned state of the resource.", + "enum": [ + "Running", + "Creating", + "Deleting", + "Succeeded", + "Failed", + "Moving" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + } + }, + "description": "A class representing cluster principal property." + }, + "DatabasePrincipalAssignment": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/DatabasePrincipalProperties", + "description": "The database principal." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Class representing a database principal assignment." + }, + "ClusterPrincipalAssignment": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ClusterPrincipalProperties", + "description": "The cluster principal." + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Class representing a cluster principal assignment." + }, + "ClusterListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Cluster" + }, + "description": "The list of Kusto clusters." + } + }, + "description": "The list Kusto clusters operation response." + }, + "DatabaseListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Database" + }, + "description": "The list of Kusto databases." + } + }, + "description": "The list Kusto databases operation response." + }, + "DatabasePrincipalAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DatabasePrincipalAssignment" + }, + "description": "The list of Kusto database principal assignments." + } + }, + "description": "The list Kusto database principal assignments operation response." + }, + "ClusterPrincipalAssignmentListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ClusterPrincipalAssignment" + }, + "description": "The list of Kusto cluster principal assignments." + } + }, + "description": "The list Kusto cluster principal assignments operation response." + }, + "DatabasePrincipalListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DatabasePrincipal" + }, + "description": "The list of Kusto database principals." + } + }, + "description": "The list Kusto database principals operation response." + }, + "FollowerDatabaseListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/FollowerDatabaseDefinition" + }, + "description": "The list of follower database result." + } + }, + "description": "The list Kusto database principals operation response." + }, + "DataConnection": { + "required": [ + "kind" + ], + "properties": { + "location": { + "type": "string", + "description": "Resource location." + }, + "kind": { + "description": "Kind of the endpoint for the data connection", + "enum": [ + "EventHub", + "EventGrid", + "IotHub" + ], + "type": "string", + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + } + }, + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "description": "Class representing an data connection.", + "discriminator": "kind" + }, + "DataConnectionValidationResult": { + "type": "object", + "properties": { + "errorMessage": { + "type": "string", + "description": "A message which indicates a problem in data connection validation." + } + }, + "description": "The result returned from a data connection validation request." + }, + "DatabasePrincipalListRequest": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DatabasePrincipal" + }, + "description": "The list of Kusto database principals." + } + }, + "description": "The list Kusto database principals operation request." + }, + "FollowerDatabaseDefinition": { + "type": "object", + "required": [ + "clusterResourceId", + "attachedDatabaseConfigurationName" + ], + "properties": { + "clusterResourceId": { + "type": "string", + "description": "Resource id of the cluster that follows a database owned by this cluster." + }, + "attachedDatabaseConfigurationName": { + "type": "string", + "description": "Resource name of the attached database configuration in the follower cluster." + }, + "databaseName": { + "type": "string", + "readOnly": true, + "description": "The database name owned by this cluster that was followed. * in case following all databases." + } + }, + "description": "A class representing follower database request." + }, + "DiagnoseVirtualNetworkResult": { + "properties": { + "findings": { + "type": "array", + "items": { + "type": "string" + }, + "description": "The list of network connectivity diagnostic finding" + } + } + }, + "DataConnectionValidation": { + "properties": { + "dataConnectionName": { + "type": "string", + "description": "The name of the data connection." + }, + "properties": { + "$ref": "#/definitions/DataConnection", + "description": "The data connection properties to validate." + } + }, + "description": "Class representing an data connection validation." + }, + "EventHubDataConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The Event Hub data connection properties to validate.", + "$ref": "#/definitions/EventHubConnectionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DataConnection" + } + ], + "description": "Class representing an event hub data connection.", + "x-ms-discriminator-value": "EventHub" + }, + "IotHubDataConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The Iot Hub data connection properties.", + "$ref": "#/definitions/IotHubConnectionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DataConnection" + } + ], + "description": "Class representing an iot hub data connection.", + "x-ms-discriminator-value": "IotHub" + }, + "EventGridDataConnection": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "description": "The properties of the Event Grid data connection.", + "$ref": "#/definitions/EventGridConnectionProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/DataConnection" + } + ], + "description": "Class representing an Event Grid data connection.", + "x-ms-discriminator-value": "EventGrid" + }, + "DataConnectionValidationListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataConnectionValidationResult" + }, + "description": "The list of Kusto data connection validation errors." + } + }, + "description": "The list Kusto data connection validation result." + }, + "DataConnectionListResult": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/DataConnection" + }, + "description": "The list of Kusto data connections." + } + }, + "description": "The list Kusto data connections operation response." + }, + "CloudError": { + "x-ms-external": true, + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "An error response from Kusto." + } + }, + "description": "An error response from Kusto." + }, + "ClusterCheckNameRequest": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Cluster name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Kusto/clusters" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.Kusto/clusters." + } + }, + "required": [ + "name", + "type" + ], + "description": "The result returned from a cluster check name availability request." + }, + "CheckNameRequest": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Resource name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Kusto/clusters/databases", + "Microsoft.Kusto/clusters/attachedDatabaseConfigurations" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, for instance Microsoft.Kusto/clusters/databases." + } + }, + "required": [ + "name", + "type" + ], + "description": "The result returned from a database check name availability request." + }, + "ClusterPrincipalAssignmentCheckNameRequest": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Principal Assignment resource name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Kusto/clusters/principalAssignments" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.Kusto/clusters/principalAssignments." + } + }, + "required": [ + "name", + "type" + ], + "description": "A principal assignment check name availability request." + }, + "DataConnectionCheckNameRequest": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Data Connection name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Kusto/clusters/databases/dataConnections" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.Kusto/clusters/databases/dataConnections." + } + }, + "required": [ + "name", + "type" + ], + "description": "A data connection check name availability request." + }, + "DatabasePrincipalAssignmentCheckNameRequest": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "Principal Assignment resource name." + }, + "type": { + "type": "string", + "enum": [ + "Microsoft.Kusto/clusters/databases/principalAssignments" + ], + "x-ms-enum": { + "name": "Type", + "modelAsString": false + }, + "description": "The type of resource, Microsoft.Kusto/clusters/databases/principalAssignments." + } + }, + "required": [ + "name", + "type" + ], + "description": "A principal assignment check name availability request." + }, + "CheckNameResult": { + "type": "object", + "properties": { + "nameAvailable": { + "type": "boolean", + "description": "Specifies a Boolean value that indicates if the name is available." + }, + "name": { + "type": "string", + "description": "The name that was checked." + }, + "message": { + "type": "string", + "description": "Message indicating an unavailable name due to a conflict, or a description of the naming rules that are violated." + }, + "reason": { + "type": "string", + "enum": [ + "Invalid", + "AlreadyExists" + ], + "x-ms-enum": { + "name": "reason", + "modelAsString": true + }, + "description": "Message providing the reason why the given name is invalid." + } + }, + "description": "The result returned from a check name availability request." + }, + "ListResourceSkusResult": { + "description": "List of available SKUs for a Kusto Cluster.", + "type": "object", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AzureResourceSku" + }, + "description": "The collection of available SKUs for an existing resource." + } + } + }, + "CloudErrorBody": { + "x-ms-external": true, + "properties": { + "code": { + "type": "string", + "description": "An identifier for the error. Codes are invariant and are intended to be consumed programmatically." + }, + "message": { + "type": "string", + "description": "A message describing the error, intended to be suitable for displaying in a user interface." + }, + "target": { + "type": "string", + "description": "The target of the particular error. For example, the name of the property in error." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody" + }, + "description": "A list of additional details about the error." + } + }, + "description": "An error response from Kusto." + }, + "OperationListResult": { + "title": "Result of the request to list REST API operations. It contains a list of operations and a URL nextLink to get the next set of results.", + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/Operation" + }, + "title": "The list of operations supported by the resource provider." + }, + "nextLink": { + "type": "string", + "title": "The URL to get the next set of operation list results if there are any." + } + } + }, + "Operation": { + "title": "A REST API operation", + "type": "object", + "properties": { + "name": { + "title": "The operation name.", + "description": "This is of the format {provider}/{resource}/{operation}.", + "type": "string" + }, + "display": { + "title": "The object that describes the operation.", + "properties": { + "provider": { + "title": "Friendly name of the resource provider.", + "type": "string" + }, + "operation": { + "title": "The operation type.", + "description": "For example: read, write, delete.", + "type": "string" + }, + "resource": { + "title": "The resource type on which the operation is performed.", + "type": "string" + }, + "description": { + "title": "The friendly name of the operation.", + "type": "string" + } + } + }, + "origin": { + "title": "The intended executor of the operation.", + "type": "string" + }, + "properties": { + "title": "Properties of the operation.", + "type": "object", + "x-ms-client-flatten": true + } + } + }, + "Identity": { + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal ID of resource identity." + }, + "tenantId": { + "readOnly": true, + "type": "string", + "description": "The tenant ID of resource." + }, + "type": { + "type": "string", + "description": "The identity type.", + "enum": [ + "None", + "SystemAssigned" + ], + "x-ms-enum": { + "name": "IdentityType", + "modelAsString": false + } + }, + "userAssignedIdentities": { + "type": "object", + "additionalProperties": { + "type": "object", + "properties": { + "principalId": { + "readOnly": true, + "type": "string", + "description": "The principal id of user assigned identity." + }, + "clientId": { + "readOnly": true, + "type": "string", + "description": "The client id of user assigned identity." + } + } + }, + "description": "The list of user identities associated with the Kusto cluster. The user identity dictionary key references will be ARM resource ids in the form: '/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.ManagedIdentity/userAssignedIdentities/{identityName}'." + } + }, + "required": [ + "type" + ], + "description": "Identity for the resource." + }, + "KeyVaultProperties": { + "description": "Properties of the key vault.", + "required": [ + "keyName", + "keyVersion", + "keyVaultUri" + ], + "properties": { + "keyName": { + "type": "string", + "description": "The name of the key vault key.", + "x-ms-client-name": "KeyName" + }, + "keyVersion": { + "type": "string", + "description": "The version of the key vault key.", + "x-ms-client-name": "KeyVersion" + }, + "keyVaultUri": { + "type": "string", + "description": "The Uri of the key vault.", + "x-ms-client-name": "KeyVaultUri" + } + } + }, + "LanguageExtensionName": { + "description": "Language extension that can run within KQL query.", + "type": "string", + "enum": [ + "PYTHON", + "R" + ], + "x-ms-enum": { + "name": "languageExtensionName", + "modelAsString": true + } + }, + "LanguageExtension": { + "type": "object", + "description": "The language extension object.", + "properties": { + "languageExtensionName": { + "$ref": "#/definitions/LanguageExtensionName", + "description": "The language extension name." + } + } + }, + "LanguageExtensionsList": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/LanguageExtension" + }, + "description": "The list of language extensions." + } + }, + "description": "The list of language extension objects." + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "required": true, + "type": "string", + "description": "Gets subscription credentials which uniquely identify Microsoft Azure subscription. The subscription ID forms part of the URI for every service call." + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Client API Version." + }, + "ClusterNameParameter": { + "name": "clusterName", + "in": "path", + "description": "The name of the Kusto cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "AttachedDatabaseConfigurationNameParameter": { + "name": "attachedDatabaseConfigurationName", + "in": "path", + "description": "The name of the attached database configuration.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "ResourceGroupParameter": { + "name": "resourceGroupName", + "in": "path", + "description": "The name of the resource group containing the Kusto cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DatabaseNameParameter": { + "name": "databaseName", + "in": "path", + "description": "The name of the database in the Kusto cluster.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "DataConnectionNameParameter": { + "name": "dataConnectionName", + "in": "path", + "description": "The name of the data connection.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + }, + "PrincipalAssignmentNameParameter": { + "name": "principalAssignmentName", + "in": "path", + "description": "The name of the Kusto principalAssignment.", + "required": true, + "type": "string", + "x-ms-parameter-location": "method" + } + }, + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + } +} diff --git a/specification/azure-kusto/resource-manager/readme.go.md b/specification/azure-kusto/resource-manager/readme.go.md index 15474d8a5833..ed01044bbc85 100644 --- a/specification/azure-kusto/resource-manager/readme.go.md +++ b/specification/azure-kusto/resource-manager/readme.go.md @@ -19,6 +19,7 @@ batch: - tag: package-2019-09-07 - tag: package-2019-11-09 - tag: package-2020-02-15 + - tag: package-2020-06-14 ``` ### Tag: package-2018-09-07-preview and go @@ -74,3 +75,12 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag) == 'package-2020-06-14' && $(go) +output-folder: $(go-sdk-folder)/services/$(namespace)/mgmt/2020-06-14/$(namespace) +``` diff --git a/specification/azure-kusto/resource-manager/readme.md b/specification/azure-kusto/resource-manager/readme.md index ef252e846aa8..e3f5ff1a8f3a 100644 --- a/specification/azure-kusto/resource-manager/readme.md +++ b/specification/azure-kusto/resource-manager/readme.md @@ -28,7 +28,16 @@ These are the global settings for the Kusto API. title: KustoManagementClient description: 'The Azure Kusto management API provides a RESTful set of web services that interact with Azure Kusto services to manage your clusters and databases. The API enables you to create, update, and delete clusters and databases.' openapi-type: arm -tag: package-2020-02-15 +tag: package-2020-06-14 +``` + +### Tag: package-2020-06-14 + +These settings apply only when `--tag=package-2020-06-14` is specified on the command line. + +```yaml $(tag) == 'package-2020-06-14' +input-file: + - Microsoft.Kusto/stable/2020-06-14/kusto.json ``` ### Tag: package-2020-02-15 @@ -195,6 +204,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.Kusto/stable/2020-06-14/kusto.json - $(this-folder)/Microsoft.Kusto/stable/2020-02-15/kusto.json - $(this-folder)/Microsoft.Kusto/stable/2019-11-09/kusto.json - $(this-folder)/Microsoft.Kusto/stable/2019-09-07/kusto.json From 080cb8884f41cb172e3639b1e2ef09f2c4f3dd9a Mon Sep 17 00:00:00 2001 From: Sanjai Ganesh Jeenagiri Date: Thu, 9 Jul 2020 20:33:32 -0700 Subject: [PATCH 289/318] build and push to DF ACR as well (#10084) Co-authored-by: Sanjai Ganesh --- .azure-pipelines/azure-pipelines-data-container.yml | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/.azure-pipelines/azure-pipelines-data-container.yml b/.azure-pipelines/azure-pipelines-data-container.yml index e3d3f4956006..97877b083e77 100644 --- a/.azure-pipelines/azure-pipelines-data-container.yml +++ b/.azure-pipelines/azure-pipelines-data-container.yml @@ -14,12 +14,17 @@ variables: steps: - task: Docker@2 - displayName: Login to ACR + displayName: Login to production ACR inputs: command: login - Dockerfile: scripts/datacontainer/Dockerfile containerRegistry: $(CONTAINER_REGISTRY_SERVICE_CONNECTION) +- task: Docker@2 + displayName: Login to dogfood ACR + inputs: + command: login + containerRegistry: $(DOGFOOD_CONTAINER_REGISTRY_SERVICE_CONNECTION) + - task: CopyFiles@2 inputs: SourceFolder: $(Build.SourcesDirectory) @@ -31,7 +36,6 @@ steps: inputs: command: buildAndPush Dockerfile: scripts/datacontainer/Dockerfile - containerRegistry: $(CONTAINER_REGISTRY_SERVICE_CONNECTION) repository: $(CONTAINER_REGISTRY_REPOSITORY_NAME) tags: | latest From c4a4ea23217cafbc716358c0bd35a745e9f767df Mon Sep 17 00:00:00 2001 From: ayeletshpigelman Date: Fri, 10 Jul 2020 08:55:49 +0300 Subject: [PATCH 290/318] Add new api version for SecurityAlertPolicies for Orcas (#9573) * Add my sql apis * remove version 2017 * Fix build errors * fixes * fixes after prettier check * fixes in swagger * Fix API version * foxes version 2017 * fix readme * Add postgres version 2020-01-01 * Add mariadb version 2020 * fix readme * Add suppression for resource privder name pascal case * Add System Metadata * Remove description * move systemData after properties * Remove creationTime --- .../ServerSecurityAlertPolicies.json | 242 ++++++++++++++++ .../stable/2018-06-01/mariadb.json | 199 ------------- .../ServerSecurityAlertPolicies.json | 262 ++++++++++++++++++ .../examples/ServerSecurityAlertsCreate.json | 35 +++ .../examples/ServerSecurityAlertsGet.json | 29 ++ .../ServerSecurityAlertsListByServer.json | 32 +++ .../mariadb/resource-manager/readme.md | 13 + .../ServerSecurityAlertPolicies.json | 242 ++++++++++++++++ .../stable/2017-12-01/mysql.json | 199 ------------- .../ServerSecurityAlertPolicies.json | 262 ++++++++++++++++++ .../examples/ServerSecurityAlertsCreate.json | 35 +++ .../examples/ServerSecurityAlertsGet.json | 29 ++ .../ServerSecurityAlertsListByServer.json | 32 +++ .../mysql/resource-manager/readme.md | 13 + .../ServerSecurityAlertPolicies.json | 242 ++++++++++++++++ .../stable/2017-12-01/postgresql.json | 199 ------------- .../ServerSecurityAlertPolicies.json | 262 ++++++++++++++++++ .../examples/ServerSecurityAlertsCreate.json | 35 +++ .../examples/ServerSecurityAlertsGet.json | 29 ++ .../ServerSecurityAlertsListByServer.json | 32 +++ .../postgresql/resource-manager/readme.md | 12 + 21 files changed, 1838 insertions(+), 597 deletions(-) create mode 100644 specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/ServerSecurityAlertPolicies.json create mode 100644 specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/ServerSecurityAlertPolicies.json create mode 100644 specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json create mode 100644 specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsGet.json create mode 100644 specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/ServerSecurityAlertPolicies.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/ServerSecurityAlertPolicies.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsGet.json create mode 100644 specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/ServerSecurityAlertPolicies.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsGet.json create mode 100644 specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/ServerSecurityAlertPolicies.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/ServerSecurityAlertPolicies.json new file mode 100644 index 000000000000..3d1caf70844a --- /dev/null +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/ServerSecurityAlertPolicies.json @@ -0,0 +1,242 @@ +{ + "swagger": "2.0", + "info": { + "version": "2018-06-01", + "title": "MariaDBManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MariaDB resources including servers, databases, firewall rules, VNET rules, security alert policies, log files, encryption keys, active directory administrator and configurations." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get a server's security alert policy.", + "operationId": "ServerSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "Error response describing why the operation of getting security alert policies failed." + } + }, + "x-ms-examples": { + "Get a server's threat detection policy": { + "$ref": "./examples/ServerSecurityAlertsGet.json" + } + } + }, + "put": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Creates or updates a threat detection policy.", + "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the threat detection policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "Error response describing why the operation of setting security alert policies failed." + }, + "202": { + "description": "Created request to set the server threat detection policy." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's threat detection policy with all parameters": { + "$ref": "./examples/ServerSecurityAlertsCreateMax.json" + }, + "Update a server's threat detection policy with minimal parameters": { + "$ref": "./examples/ServerSecurityAlertsCreateMin.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerSecurityAlertPolicyState", + "modelAsString": false + } + }, + "disabledAlerts": { + "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAddresses": { + "description": "Specifies an array of e-mail addresses to which the alert is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAccountAdmins": { + "description": "Specifies that the alert is sent to the account administrators.", + "type": "boolean" + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the Threat Detection audit storage account.", + "type": "string" + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the Threat Detection audit logs.", + "type": "integer" + } + } + }, + "ServerSecurityAlertPolicy": { + "description": "A server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + }, + "SecurityAlertPolicyNameParameter": { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json index 505dddb7cf92..e407fd52c132 100644 --- a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json @@ -1147,126 +1147,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { - "get": { - "tags": [ - "ServerSecurityAlertPolicies" - ], - "description": "Get a server's security alert policy.", - "operationId": "ServerSecurityAlertPolicies_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "securityAlertPolicyName", - "in": "path", - "description": "The name of the security alert policy.", - "required": true, - "type": "string", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "SecurityAlertPolicyName", - "modelAsString": true - } - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the server threat detection policy.", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - "default": { - "description": "Error response describing why the operation of getting security alert policies failed." - } - }, - "x-ms-examples": { - "Get a server's threat detection policy": { - "$ref": "./examples/ServerSecurityAlertsGet.json" - } - } - }, - "put": { - "tags": [ - "ServerSecurityAlertPolicies" - ], - "description": "Creates or updates a threat detection policy.", - "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "securityAlertPolicyName", - "in": "path", - "description": "The name of the threat detection policy.", - "required": true, - "type": "string", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "SecurityAlertPolicyName", - "modelAsString": true - } - }, - { - "name": "parameters", - "in": "body", - "description": "The server security alert policy.", - "required": true, - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the threat detection policy.", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - "default": { - "description": "Error response describing why the operation of setting security alert policies failed." - }, - "202": { - "description": "Created request to set the server threat detection policy." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update a server's threat detection policy with all parameters": { - "$ref": "./examples/ServerSecurityAlertsCreateMax.json" - }, - "Update a server's threat detection policy with minimal parameters": { - "$ref": "./examples/ServerSecurityAlertsCreateMin.json" - } - } - } - }, "/providers/Microsoft.DBforMariaDB/operations": { "get": { "tags": [ @@ -2283,74 +2163,6 @@ }, "description": "Represents a resource name availability." }, - "SecurityAlertPolicyProperties": { - "description": "Properties of a security alert policy.", - "required": [ - "state" - ], - "type": "object", - "properties": { - "state": { - "description": "Specifies the state of the policy, whether it is enabled or disabled.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "ServerSecurityAlertPolicyState", - "modelAsString": false - } - }, - "disabledAlerts": { - "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly", - "type": "array", - "items": { - "type": "string" - } - }, - "emailAddresses": { - "description": "Specifies an array of e-mail addresses to which the alert is sent.", - "type": "array", - "items": { - "type": "string" - } - }, - "emailAccountAdmins": { - "description": "Specifies that the alert is sent to the account administrators.", - "type": "boolean" - }, - "storageEndpoint": { - "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", - "type": "string" - }, - "storageAccountAccessKey": { - "description": "Specifies the identifier key of the Threat Detection audit storage account.", - "type": "string" - }, - "retentionDays": { - "format": "int32", - "description": "Specifies the number of days to keep in the Threat Detection audit logs.", - "type": "integer" - } - } - }, - "ServerSecurityAlertPolicy": { - "description": "A server security alert policy.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SecurityAlertPolicyProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - }, "CloudError": { "x-ms-external": true, "properties": { @@ -2409,17 +2221,6 @@ "type": "string", "description": "The name of the location.", "x-ms-parameter-location": "method" - }, - "SecurityAlertPolicyNameParameter": { - "name": "securityAlertPolicyName", - "in": "path", - "description": "The name of the security alert policy.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-parameter-location": "method" } } } diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/ServerSecurityAlertPolicies.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/ServerSecurityAlertPolicies.json new file mode 100644 index 000000000000..a91f25d78599 --- /dev/null +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/ServerSecurityAlertPolicies.json @@ -0,0 +1,262 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-01-01", + "title": "MariaDBManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MariaDB resources including servers, databases, firewall rules, VNET rules, security alert policies, log files, encryption keys, active directory administrator and configurations." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get a server's security alert policy.", + "operationId": "ServerSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-examples": { + "Get a server's threat detection policy": { + "$ref": "./examples/ServerSecurityAlertsGet.json" + } + } + }, + "put": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Creates or updates a threat detection policy.", + "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later" + }, + "202": { + "description": "Created request to set the server threat detection policy." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's threat detection policy with minimal parameters": { + "$ref": "./examples/ServerSecurityAlertsCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMariaDB/servers/{serverName}/securityAlertPolicies": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get the server's threat detection policies.", + "operationId": "ServerSecurityAlertPolicies_ListByServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policies.", + "schema": { + "$ref": "#/definitions/LogicalServerSecurityAlertPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the server's threat detection policies": { + "$ref": "./examples/ServerSecurityAlertsListByServer.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertsPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerSecurityAlertPolicyState", + "modelAsString": false + } + } + } + }, + "ServerSecurityAlertPolicy": { + "description": "A server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertsPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "LogicalServerSecurityAlertPolicyListResult": { + "description": "A list of the server's security alert policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json new file mode 100644 index 000000000000..48703816639f --- /dev/null +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2020-01-01", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.DBforMariaDB/servers/securityalert-6440", + "name": "Default", + "type": "Microsoft.DBforMariaDB/servers/securityAlertPolicies", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled" + } + } + }, + "202": {} + } +} diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsGet.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsGet.json new file mode 100644 index 000000000000..68e1444fb074 --- /dev/null +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2020-01-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.DBforMariaDB/servers/securityalert-6440", + "name": "Default", + "type": "Microsoft.DBforMariaDB/servers/securityAlertPolicies", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Disabled" + } + } + } + } +} diff --git a/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json new file mode 100644 index 000000000000..29a92039a7b6 --- /dev/null +++ b/specification/mariadb/resource-manager/Microsoft.DBforMariaDB/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "api-version": "2020-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.DBforMariaDB/servers/securityalert-6440/securityAlertPolicies", + "name": "Default", + "type": "Microsoft.DBforMariaDB/servers/securityAlertPolicies", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/mariadb/resource-manager/readme.md b/specification/mariadb/resource-manager/readme.md index 509479004dc0..129157c55673 100644 --- a/specification/mariadb/resource-manager/readme.md +++ b/specification/mariadb/resource-manager/readme.md @@ -52,6 +52,7 @@ input-file: - Microsoft.DBforMariaDB/stable/2018-06-01/PerformanceRecommendations.json - Microsoft.DBforMariaDB/stable/2018-06-01/PrivateEndpointConnections.json - Microsoft.DBforMariaDB/stable/2018-06-01/PrivateLinkResources.json +- Microsoft.DBforMariaDB/stable/2018-06-01/ServerSecurityAlertPolicies.json ``` @@ -76,6 +77,16 @@ input-file: - Microsoft.DBforMariaDB/preview/2020-01-01-privatepreview/DataEncryptionKeys.json ``` + +### Tag: package-2020-01-01 + +These settings apply only when `--tag=package-2020-01-01` is specified on the command line. + +``` yaml $(tag) == 'package-2020-01-01' +input-file: +- Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json +- Microsoft.DBforMariaDB/stable/2020-01-01/ServerSecurityAlertPolicies.json + --- # Code Generation @@ -160,6 +171,7 @@ require: $(this-folder)/../../../profiles/readme.md input-file: - $(this-folder)/Microsoft.DBforMariaDB/preview/2018-06-01-preview/mariadb.json - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json + - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/ServerSecurityAlertPolicies.json - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/QueryPerformanceInsights.json - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/PerformanceRecommendations.json - $(this-folder)/Microsoft.DBforMariaDB/stable/2018-06-01/PrivateEndpointConnections.json @@ -168,6 +180,7 @@ input-file: - $(this-folder)/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json - $(this-folder)/Microsoft.DBforMariaDB/preview/2018-06-01-privatepreview/PrivateLinkResources.json - $(this-folder)/Microsoft.DBforMariaDB/preview/2020-01-01-privatepreview/DataEncryptionKeys.json + - $(this-folder)/Microsoft.DBforMariaDB/stable/2020-01-01/ServerSecurityAlertPolicies.json ``` diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/ServerSecurityAlertPolicies.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/ServerSecurityAlertPolicies.json new file mode 100644 index 000000000000..3e7848ff5ee7 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/ServerSecurityAlertPolicies.json @@ -0,0 +1,242 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-12-01", + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files, encryption keys, active directory administrator and configurations." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get a server's security alert policy.", + "operationId": "ServerSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "Error response describing why the operation of getting security alert policies failed." + } + }, + "x-ms-examples": { + "Get a server's threat detection policy": { + "$ref": "./examples/ServerSecurityAlertsGet.json" + } + } + }, + "put": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Creates or updates a threat detection policy.", + "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the threat detection policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "Error response describing why the operation of setting security alert policies failed." + }, + "202": { + "description": "Created request to set the server threat detection policy." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's threat detection policy with all parameters": { + "$ref": "./examples/ServerSecurityAlertsCreateMax.json" + }, + "Update a server's threat detection policy with minimal parameters": { + "$ref": "./examples/ServerSecurityAlertsCreateMin.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerSecurityAlertPolicyState", + "modelAsString": false + } + }, + "disabledAlerts": { + "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAddresses": { + "description": "Specifies an array of e-mail addresses to which the alert is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAccountAdmins": { + "description": "Specifies that the alert is sent to the account administrators.", + "type": "boolean" + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the Threat Detection audit storage account.", + "type": "string" + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the Threat Detection audit logs.", + "type": "integer" + } + } + }, + "ServerSecurityAlertPolicy": { + "description": "A server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + }, + "SecurityAlertPolicyNameParameter": { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json index 355fccb1b110..ea7d518cec52 100644 --- a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json @@ -1334,126 +1334,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { - "get": { - "tags": [ - "ServerSecurityAlertPolicies" - ], - "description": "Get a server's security alert policy.", - "operationId": "ServerSecurityAlertPolicies_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "securityAlertPolicyName", - "in": "path", - "description": "The name of the security alert policy.", - "required": true, - "type": "string", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "SecurityAlertPolicyName", - "modelAsString": true - } - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the server threat detection policy.", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - "default": { - "description": "Error response describing why the operation of getting security alert policies failed." - } - }, - "x-ms-examples": { - "Get a server's threat detection policy": { - "$ref": "./examples/ServerSecurityAlertsGet.json" - } - } - }, - "put": { - "tags": [ - "ServerSecurityAlertPolicies" - ], - "description": "Creates or updates a threat detection policy.", - "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "securityAlertPolicyName", - "in": "path", - "description": "The name of the threat detection policy.", - "required": true, - "type": "string", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "SecurityAlertPolicyName", - "modelAsString": true - } - }, - { - "name": "parameters", - "in": "body", - "description": "The server security alert policy.", - "required": true, - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the threat detection policy.", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - "default": { - "description": "Error response describing why the operation of setting security alert policies failed." - }, - "202": { - "description": "Created request to set the server threat detection policy." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update a server's threat detection policy with all parameters": { - "$ref": "./examples/ServerSecurityAlertsCreateMax.json" - }, - "Update a server's threat detection policy with minimal parameters": { - "$ref": "./examples/ServerSecurityAlertsCreateMin.json" - } - } - } - }, "/providers/Microsoft.DBforMySQL/operations": { "get": { "tags": [ @@ -2568,74 +2448,6 @@ }, "description": "Represents a resource name availability." }, - "SecurityAlertPolicyProperties": { - "description": "Properties of a security alert policy.", - "required": [ - "state" - ], - "type": "object", - "properties": { - "state": { - "description": "Specifies the state of the policy, whether it is enabled or disabled.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "ServerSecurityAlertPolicyState", - "modelAsString": false - } - }, - "disabledAlerts": { - "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly", - "type": "array", - "items": { - "type": "string" - } - }, - "emailAddresses": { - "description": "Specifies an array of e-mail addresses to which the alert is sent.", - "type": "array", - "items": { - "type": "string" - } - }, - "emailAccountAdmins": { - "description": "Specifies that the alert is sent to the account administrators.", - "type": "boolean" - }, - "storageEndpoint": { - "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", - "type": "string" - }, - "storageAccountAccessKey": { - "description": "Specifies the identifier key of the Threat Detection audit storage account.", - "type": "string" - }, - "retentionDays": { - "format": "int32", - "description": "Specifies the number of days to keep in the Threat Detection audit logs.", - "type": "integer" - } - } - }, - "ServerSecurityAlertPolicy": { - "description": "A server security alert policy.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SecurityAlertPolicyProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - }, "CloudError": { "x-ms-external": true, "properties": { @@ -2756,17 +2568,6 @@ "type": "string", "description": "The name of the location.", "x-ms-parameter-location": "method" - }, - "SecurityAlertPolicyNameParameter": { - "name": "securityAlertPolicyName", - "in": "path", - "description": "The name of the security alert policy.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-parameter-location": "method" } } } diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/ServerSecurityAlertPolicies.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/ServerSecurityAlertPolicies.json new file mode 100644 index 000000000000..f06f99236f47 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/ServerSecurityAlertPolicies.json @@ -0,0 +1,262 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-01-01", + "title": "MySQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure MySQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files, encryption keys, active directory administrator and configurations." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get a server's security alert policy.", + "operationId": "ServerSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-examples": { + "Get a server's threat detection policy": { + "$ref": "./examples/ServerSecurityAlertsGet.json" + } + } + }, + "put": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Creates or updates a threat detection policy.", + "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later" + }, + "202": { + "description": "Created request to set the server threat detection policy." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's threat detection policy with minimal parameters": { + "$ref": "./examples/ServerSecurityAlertsCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforMySQL/servers/{serverName}/securityAlertPolicies": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get the server's threat detection policies.", + "operationId": "ServerSecurityAlertPolicies_ListByServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policies.", + "schema": { + "$ref": "#/definitions/LogicalServerSecurityAlertPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the server's threat detection policies": { + "$ref": "./examples/ServerSecurityAlertsListByServer.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertsPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerSecurityAlertPolicyState", + "modelAsString": false + } + } + } + }, + "ServerSecurityAlertPolicy": { + "description": "A server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertsPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "LogicalServerSecurityAlertPolicyListResult": { + "description": "A list of the server's security alert policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json new file mode 100644 index 000000000000..3c886e6a21f4 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2020-01-01", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.DBforMySQL/servers/securityalert-6440", + "name": "Default", + "type": "Microsoft.DBforMySQL/servers/securityAlertPolicies", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled" + } + } + }, + "202": {} + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsGet.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsGet.json new file mode 100644 index 000000000000..35cb2d49f5e2 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2020-01-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.DBforMySQL/servers/securityalert-6440", + "name": "Default", + "type": "Microsoft.DBforMySQL/servers/securityAlertPolicies", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Disabled" + } + } + } + } +} diff --git a/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json new file mode 100644 index 000000000000..628dbd5cd7f0 --- /dev/null +++ b/specification/mysql/resource-manager/Microsoft.DBforMySQL/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "api-version": "2020-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.DBforMySQL/servers/securityalert-6440/securityAlertPolicies", + "name": "Default", + "type": "Microsoft.DBforMySQL/servers/securityAlertPolicies", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/mysql/resource-manager/readme.md b/specification/mysql/resource-manager/readme.md index eff821babee7..694d8d0926e7 100644 --- a/specification/mysql/resource-manager/readme.md +++ b/specification/mysql/resource-manager/readme.md @@ -49,6 +49,7 @@ These settings apply only when `--tag=package-2017-12-01` is specified on the co ``` yaml $(tag) == 'package-2017-12-01' input-file: - Microsoft.DBforMySQL/stable/2017-12-01/mysql.json +- Microsoft.DBforMySQL/stable/2017-12-01/ServerSecurityAlertPolicies.json ``` @@ -71,6 +72,7 @@ These settings apply only when `--tag=package-2018-06-01` is specified on the co ``` yaml $(tag) == 'package-2018-06-01' input-file: - Microsoft.DBforMySQL/stable/2017-12-01/mysql.json +- Microsoft.DBforMySQL/stable/2017-12-01/ServerSecurityAlertPolicies.json - Microsoft.DBforMySQL/stable/2018-06-01/QueryPerformanceInsights.json - Microsoft.DBforMySQL/stable/2018-06-01/PerformanceRecommendations.json - Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json @@ -99,6 +101,15 @@ input-file: - Microsoft.DBforMySQL/stable/2018-06-01/PrivateEndpointConnections.json - Microsoft.DBforMySQL/stable/2018-06-01/PrivateLinkResources.json - Microsoft.DBforMySQL/stable/2020-01-01/DataEncryptionKeys.json +- Microsoft.DBforMySQL/stable/2020-01-01/ServerSecurityAlertPolicies.json +``` + +## Suppression +``` yaml +directive: + - suppress: PathResourceProviderNamePascalCase + from: ServerSecurityAlertPolicies.json + reason: The name of the provider is Microsoft.DBforMySQL ``` --- @@ -185,6 +196,7 @@ require: $(this-folder)/../../../profiles/readme.md input-file: - $(this-folder)/Microsoft.DBforMySQL/preview/2017-12-01-preview/mysql.json - $(this-folder)/Microsoft.DBforMySQL/stable/2017-12-01/mysql.json + - $(this-folder)/Microsoft.DBforMySQL/stable/2017-12-01/ServerSecurityAlertPolicies.json - $(this-folder)/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/mysql.json - $(this-folder)/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json - $(this-folder)/Microsoft.DBforMySQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json @@ -194,6 +206,7 @@ input-file: - $(this-folder)/Microsoft.DBforMySQL/stable/2018-06-01/PrivateLinkResources.json - $(this-folder)/Microsoft.DBforMySQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json - $(this-folder)/Microsoft.DBforMySQL/stable/2020-01-01/DataEncryptionKeys.json + - $(this-folder)/Microsoft.DBforMySQL/stable/2020-01-01/ServerSecurityAlertPolicies.json ``` diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json new file mode 100644 index 000000000000..e67b54dacf08 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json @@ -0,0 +1,242 @@ +{ + "swagger": "2.0", + "info": { + "version": "2017-12-01", + "title": "PostgreSQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files, encryption keys, active directory administrator and configurations." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get a server's security alert policy.", + "operationId": "ServerSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "Error response describing why the operation of getting security alert policies failed." + } + }, + "x-ms-examples": { + "Get a server's threat detection policy": { + "$ref": "./examples/ServerSecurityAlertsGet.json" + } + } + }, + "put": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Creates or updates a threat detection policy.", + "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the threat detection policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "Error response describing why the operation of setting security alert policies failed." + }, + "202": { + "description": "Created request to set the server threat detection policy." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's threat detection policy with all parameters": { + "$ref": "./examples/ServerSecurityAlertsCreateMax.json" + }, + "Update a server's threat detection policy with minimal parameters": { + "$ref": "./examples/ServerSecurityAlertsCreateMin.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerSecurityAlertPolicyState", + "modelAsString": false + } + }, + "disabledAlerts": { + "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAddresses": { + "description": "Specifies an array of e-mail addresses to which the alert is sent.", + "type": "array", + "items": { + "type": "string" + } + }, + "emailAccountAdmins": { + "description": "Specifies that the alert is sent to the account administrators.", + "type": "boolean" + }, + "storageEndpoint": { + "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", + "type": "string" + }, + "storageAccountAccessKey": { + "description": "Specifies the identifier key of the Threat Detection audit storage account.", + "type": "string" + }, + "retentionDays": { + "format": "int32", + "description": "Specifies the number of days to keep in the Threat Detection audit logs.", + "type": "integer" + } + } + }, + "ServerSecurityAlertPolicy": { + "description": "A server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + } + } + } + }, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + }, + "SecurityAlertPolicyNameParameter": { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "default" + ], + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json index 8c229dbd192f..fe4e44f77321 100644 --- a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json @@ -1334,126 +1334,6 @@ } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { - "get": { - "tags": [ - "ServerSecurityAlertPolicies" - ], - "description": "Get a server's security alert policy.", - "operationId": "ServerSecurityAlertPolicies_Get", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "securityAlertPolicyName", - "in": "path", - "description": "The name of the security alert policy.", - "required": true, - "type": "string", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "SecurityAlertPolicyName", - "modelAsString": true - } - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully retrieved the server threat detection policy.", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - "default": { - "description": "Error response describing why the operation of getting security alert policies failed." - } - }, - "x-ms-examples": { - "Get a server's threat detection policy": { - "$ref": "./examples/ServerSecurityAlertsGet.json" - } - } - }, - "put": { - "tags": [ - "ServerSecurityAlertPolicies" - ], - "description": "Creates or updates a threat detection policy.", - "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", - "parameters": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" - }, - { - "$ref": "#/parameters/ServerNameParameter" - }, - { - "name": "securityAlertPolicyName", - "in": "path", - "description": "The name of the threat detection policy.", - "required": true, - "type": "string", - "enum": [ - "Default" - ], - "x-ms-enum": { - "name": "SecurityAlertPolicyName", - "modelAsString": true - } - }, - { - "name": "parameters", - "in": "body", - "description": "The server security alert policy.", - "required": true, - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" - }, - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" - } - ], - "responses": { - "200": { - "description": "Successfully updated the threat detection policy.", - "schema": { - "$ref": "#/definitions/ServerSecurityAlertPolicy" - } - }, - "default": { - "description": "Error response describing why the operation of setting security alert policies failed." - }, - "202": { - "description": "Created request to set the server threat detection policy." - } - }, - "x-ms-long-running-operation": true, - "x-ms-examples": { - "Update a server's threat detection policy with all parameters": { - "$ref": "./examples/ServerSecurityAlertsCreateMax.json" - }, - "Update a server's threat detection policy with minimal parameters": { - "$ref": "./examples/ServerSecurityAlertsCreateMin.json" - } - } - } - }, "/providers/Microsoft.DBforPostgreSQL/operations": { "get": { "tags": [ @@ -2571,74 +2451,6 @@ }, "description": "Represents a resource name availability." }, - "SecurityAlertPolicyProperties": { - "description": "Properties of a security alert policy.", - "required": [ - "state" - ], - "type": "object", - "properties": { - "state": { - "description": "Specifies the state of the policy, whether it is enabled or disabled.", - "enum": [ - "Enabled", - "Disabled" - ], - "type": "string", - "x-ms-enum": { - "name": "ServerSecurityAlertPolicyState", - "modelAsString": false - } - }, - "disabledAlerts": { - "description": "Specifies an array of alerts that are disabled. Allowed values are: Sql_Injection, Sql_Injection_Vulnerability, Access_Anomaly", - "type": "array", - "items": { - "type": "string" - } - }, - "emailAddresses": { - "description": "Specifies an array of e-mail addresses to which the alert is sent.", - "type": "array", - "items": { - "type": "string" - } - }, - "emailAccountAdmins": { - "description": "Specifies that the alert is sent to the account administrators.", - "type": "boolean" - }, - "storageEndpoint": { - "description": "Specifies the blob storage endpoint (e.g. https://MyAccount.blob.core.windows.net). This blob storage will hold all Threat Detection audit logs.", - "type": "string" - }, - "storageAccountAccessKey": { - "description": "Specifies the identifier key of the Threat Detection audit storage account.", - "type": "string" - }, - "retentionDays": { - "format": "int32", - "description": "Specifies the number of days to keep in the Threat Detection audit logs.", - "type": "integer" - } - } - }, - "ServerSecurityAlertPolicy": { - "description": "A server security alert policy.", - "type": "object", - "allOf": [ - { - "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SecurityAlertPolicyProperties", - "description": "Resource properties.", - "x-ms-client-flatten": true - } - } - }, "CloudError": { "x-ms-external": true, "properties": { @@ -2759,17 +2571,6 @@ "type": "string", "description": "The name of the location.", "x-ms-parameter-location": "method" - }, - "SecurityAlertPolicyNameParameter": { - "name": "securityAlertPolicyName", - "in": "path", - "description": "The name of the security alert policy.", - "required": true, - "type": "string", - "enum": [ - "default" - ], - "x-ms-parameter-location": "method" } } } diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/ServerSecurityAlertPolicies.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/ServerSecurityAlertPolicies.json new file mode 100644 index 000000000000..a8742e8b677c --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/ServerSecurityAlertPolicies.json @@ -0,0 +1,262 @@ +{ + "swagger": "2.0", + "info": { + "version": "2020-01-01", + "title": "PostgreSQLManagementClient", + "description": "The Microsoft Azure management API provides create, read, update, and delete functionality for Azure PostgreSQL resources including servers, databases, firewall rules, VNET rules, security alert policies, log files, encryption keys, active directory administrator and configurations." + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "paths": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/securityAlertPolicies/{securityAlertPolicyName}": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get a server's security alert policy.", + "operationId": "ServerSecurityAlertPolicies_Get", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-examples": { + "Get a server's threat detection policy": { + "$ref": "./examples/ServerSecurityAlertsGet.json" + } + } + }, + "put": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Creates or updates a threat detection policy.", + "operationId": "ServerSecurityAlertPolicies_CreateOrUpdate", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "name": "securityAlertPolicyName", + "in": "path", + "description": "The name of the security alert policy.", + "required": true, + "type": "string", + "enum": [ + "Default" + ], + "x-ms-enum": { + "name": "SecurityAlertPolicyName", + "modelAsString": true + } + }, + { + "name": "parameters", + "in": "body", + "description": "The server security alert policy.", + "required": true, + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully updated the threat detection policy.", + "schema": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later" + }, + "202": { + "description": "Created request to set the server threat detection policy." + } + }, + "x-ms-long-running-operation": true, + "x-ms-examples": { + "Update a server's threat detection policy with minimal parameters": { + "$ref": "./examples/ServerSecurityAlertsCreate.json" + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.DBforPostgreSQL/servers/{serverName}/securityAlertPolicies": { + "get": { + "tags": [ + "ServerSecurityAlertPolicies" + ], + "description": "Get the server's threat detection policies.", + "operationId": "ServerSecurityAlertPolicies_ListByServer", + "parameters": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ServerNameParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully retrieved the server threat detection policies.", + "schema": { + "$ref": "#/definitions/LogicalServerSecurityAlertPolicyListResult" + } + }, + "default": { + "description": "*** Error Responses: ***\n\n * 400 InvalidServerSecurityAlertPolicyCreateRequest - The create server Threat Detection security alert policy request does not exist or has no properties object.\n\n * 400 DataSecurityInvalidUserSuppliedParameter - An invalid parameter value was provided by the client.\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 400 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 404 SubscriptionDoesNotHaveServer - The requested server was not found\n\n * 404 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 409 ServerSecurityAlertPolicyInProgress - Set server security alert policy is already in progress\n\n * 409 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 DatabaseIsUnavailable - Loading failed. Please try again later.\n\n * 500 UpsertServerSecurityAlertPolicyFailed - An error has occurred while saving Threat detection settings, please try again later\n\n * 500 GetServerSecurityAlertPolicyFailed - Failed to get Threat Detection settings" + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + }, + "x-ms-examples": { + "List the server's threat detection policies": { + "$ref": "./examples/ServerSecurityAlertsListByServer.json" + } + } + } + } + }, + "definitions": { + "SecurityAlertsPolicyProperties": { + "description": "Properties of a security alert policy.", + "required": [ + "state" + ], + "type": "object", + "properties": { + "state": { + "description": "Specifies the state of the policy, whether it is enabled or disabled.", + "enum": [ + "Enabled", + "Disabled" + ], + "type": "string", + "x-ms-enum": { + "name": "ServerSecurityAlertPolicyState", + "modelAsString": false + } + } + } + }, + "ServerSecurityAlertPolicy": { + "description": "A server security alert policy.", + "type": "object", + "allOf": [ + { + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ProxyResource" + } + ], + "properties": { + "properties": { + "$ref": "#/definitions/SecurityAlertsPolicyProperties", + "description": "Resource properties.", + "x-ms-client-flatten": true + }, + "systemData": { + "readOnly": true, + "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/systemData" + } + } + }, + "LogicalServerSecurityAlertPolicyListResult": { + "description": "A list of the server's security alert policies.", + "type": "object", + "properties": { + "value": { + "description": "Array of results.", + "type": "array", + "items": { + "$ref": "#/definitions/ServerSecurityAlertPolicy" + }, + "readOnly": true + }, + "nextLink": { + "description": "Link to retrieve next page of results.", + "type": "string", + "readOnly": true + } + } + } + }, + "parameters": { + "ServerNameParameter": { + "name": "serverName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the server.", + "x-ms-parameter-location": "method" + } + }, + "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" + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json new file mode 100644 index 000000000000..9ad08e9934f2 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsCreate.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2020-01-01", + "parameters": { + "properties": { + "state": "Enabled" + } + } + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.DBforPostgreSQL/servers/securityalert-6440", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/servers/securityAlertPolicies", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled" + } + } + }, + "202": {} + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsGet.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsGet.json new file mode 100644 index 000000000000..74ce4ba9fd46 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsGet.json @@ -0,0 +1,29 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "securityAlertPolicyName": "Default", + "api-version": "2020-01-01" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.DBforPostgreSQL/servers/securityalert-6440", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/servers/securityAlertPolicies", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Disabled" + } + } + } + } +} diff --git a/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json new file mode 100644 index 000000000000..7dccedbb8957 --- /dev/null +++ b/specification/postgresql/resource-manager/Microsoft.DBforPostgreSQL/stable/2020-01-01/examples/ServerSecurityAlertsListByServer.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "00000000-1111-2222-3333-444444444444", + "resourceGroupName": "securityalert-4799", + "serverName": "securityalert-6440", + "api-version": "2020-01-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/securityalert-4799/providers/Microsoft.DBforPostgreSQL/servers/securityalert-6440/securityAlertPolicies", + "name": "Default", + "type": "Microsoft.DBforPostgreSQL/servers/securityAlertPolicies", + "systemData": { + "createdBy": "string", + "createdByType": "User", + "createdAt": "2020-04-03T04:41:33.937Z", + "lastModifiedBy": "string", + "lastModifiedByType": "User", + "lastModifiedAt": "2020-04-03T04:41:33.937Z" + }, + "properties": { + "state": "Enabled" + } + } + ] + } + } + } +} diff --git a/specification/postgresql/resource-manager/readme.md b/specification/postgresql/resource-manager/readme.md index 115fef7db845..f66689491fc6 100644 --- a/specification/postgresql/resource-manager/readme.md +++ b/specification/postgresql/resource-manager/readme.md @@ -53,6 +53,7 @@ input-file: - Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateEndpointConnections.json - Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateLinkResources.json - Microsoft.DBforPostgreSQL/stable/2020-01-01/DataEncryptionKeys.json +- Microsoft.DBforPostgreSQL/stable/2020-01-01/ServerSecurityAlertPolicies.json ``` @@ -75,6 +76,7 @@ These settings apply only when `--tag=package-2018-06-01` is specified on the co ``` yaml $(tag) == 'package-2018-06-01' input-file: - Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json +- Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json - Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateEndpointConnections.json - Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateLinkResources.json ``` @@ -98,8 +100,16 @@ These settings apply only when `--tag=package-2017-12-01` is specified on the co ``` yaml $(tag) == 'package-2017-12-01' input-file: - Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json +- Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json ``` +## Suppression +``` yaml +directive: + - suppress: PathResourceProviderNamePascalCase + from: ServerSecurityAlertPolicies.json + reason: The name of the provider is DBforPostgreSQL +``` --- # Code Generation @@ -184,9 +194,11 @@ require: $(this-folder)/../../../profiles/readme.md input-file: - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2020-01-01-privatepreview/DataEncryptionKeys.json - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2017-12-01/postgresql.json + - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2017-12-01/ServerSecurityAlertPolicies.json - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateEndpointConnections.json - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2018-06-01/PrivateLinkResources.json - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2020-01-01/DataEncryptionKeys.json + - $(this-folder)/Microsoft.DBforPostgreSQL/stable/2020-01-01/ServerSecurityAlertPolicies.json - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateEndpointConnections.json - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2018-06-01-privatepreview/PrivateLinkResources.json - $(this-folder)/Microsoft.DBforPostgreSQL/preview/2017-12-01-preview/postgresql.json From ff9aaaeb7196111365a10afad3e3951dd09894c9 Mon Sep 17 00:00:00 2001 From: lapradh <66009265+lapradh@users.noreply.github.com> Date: Fri, 10 Jul 2020 12:18:17 +0530 Subject: [PATCH 291/318] Added new field for KPI health (#10068) --- .../stable/2019-06-15/bms.json | 50 +++++++++++++++++++ 1 file changed, 50 insertions(+) diff --git a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json index e097d62a7f07..95ce71d92a45 100644 --- a/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json +++ b/specification/recoveryservicesbackup/resource-manager/Microsoft.RecoveryServices/stable/2019-06-15/bms.json @@ -1311,6 +1311,13 @@ "description": "Timestamp of the last backup operation on this backup item.", "type": "string" }, + "kpisHealths": { + "description": "Health details of different KPIs", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KPIResourceHealthDetails" + } + }, "extendedInfo": { "$ref": "#/definitions/AzureFileshareProtectedItemExtendedInfo", "description": "Additional information with this backup item." @@ -1831,6 +1838,13 @@ "$ref": "#/definitions/AzureIaaSVMHealthDetails" } }, + "kpisHealths": { + "description": "Health details of different KPIs", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KPIResourceHealthDetails" + } + }, "lastBackupStatus": { "description": "Last backup operation status.", "type": "string" @@ -2180,6 +2194,13 @@ "extendedInfo": { "$ref": "#/definitions/AzureVmWorkloadProtectedItemExtendedInfo", "description": "Additional information for this backup item." + }, + "kpisHealths": { + "description": "Health details of different KPIs", + "type": "object", + "additionalProperties": { + "$ref": "#/definitions/KPIResourceHealthDetails" + } } }, "x-ms-discriminator-value": "AzureVmWorkloadProtectedItem" @@ -4036,6 +4057,35 @@ }, "discriminator": "objectType" }, + "KPIResourceHealthDetails": { + "description": "KPI Resource Health Details", + "type": "object", + "properties": { + "resourceHealthStatus": { + "description": "Resource Health Status", + "enum": [ + "Healthy", + "TransientDegraded", + "PersistentDegraded", + "TransientUnhealthy", + "PersistentUnhealthy", + "Invalid" + ], + "type": "string", + "x-ms-enum": { + "name": "ResourceHealthStatus", + "modelAsString": true + } + }, + "resourceHealthDetails": { + "description": "Resource Health Status", + "type": "array", + "items": { + "$ref": "#/definitions/ResourceHealthDetails" + } + } + } + }, "OperationResultInfoBaseResource": { "description": "Base class for operation result info.", "allOf": [ From d0cb147aa2da61b68be026d2058bb0963dde371e Mon Sep 17 00:00:00 2001 From: kavskalyan Date: Thu, 9 Jul 2020 23:51:28 -0700 Subject: [PATCH 292/318] [CosmosDB] Unflattening DatabaseAccountCreateUpdateParameters in 2020-06-01-Preview version (#10047) * First draft changes for adding PITR workflow APIs * Adding examples * Minor changes to examples * Fixing the example and restore params * Fixing format and readme * Adding the restorable database account API * Adding default responses for new APIs * Fixing error response format * Add Managed Service Identity(MSI) support for ARM Template for Cosmos DB * Fixing format * Adding databases to restore and PR suggestions * Fixing the type at incorrect location * Fix ManagedServiceIdentityType as suggested * Adding the restorable database api without the location input * Managed Service Identity Fix * Renaming restoreParams to restoreParameters * Addressing PR suggestions * Fixing the error response * msi comment fix * fix msi enum type * Unflattening the database create update parameters Co-authored-by: xujin-zhang --- .../preview/2020-06-01-preview/cosmos-db.json | 2 -- specification/cosmos-db/resource-manager/readme.md | 2 +- 2 files changed, 1 insertion(+), 3 deletions(-) diff --git a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json index a73db2e85162..978944c453d6 100644 --- a/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json +++ b/specification/cosmos-db/resource-manager/Microsoft.DocumentDB/preview/2020-06-01-preview/cosmos-db.json @@ -4485,7 +4485,6 @@ }, "ErrorResponseUpdatedFormat": { "description": "An error response from the service.", - "x-ms-external": true, "properties": { "error": { "$ref": "../../../../../common-types/resource-management/v1/types.json#/definitions/ErrorResponse" @@ -5500,7 +5499,6 @@ } }, "properties": { - "x-ms-client-flatten": true, "$ref": "#/definitions/DatabaseAccountCreateUpdateProperties" } }, diff --git a/specification/cosmos-db/resource-manager/readme.md b/specification/cosmos-db/resource-manager/readme.md index 49a88ce16881..4d1ab2248832 100644 --- a/specification/cosmos-db/resource-manager/readme.md +++ b/specification/cosmos-db/resource-manager/readme.md @@ -27,7 +27,7 @@ These are the global settings for the Cosmos-DB API. ``` yaml title: CosmosDBManagementClient openapi-type: arm -tag: package-2020-04 +tag: package-2020-06-preview ``` ### Tag: package-2020-06-preview From f37e28a0741579a9b937e9ffe5229410bd3f66ab Mon Sep 17 00:00:00 2001 From: Naveed Aziz Date: Fri, 10 Jul 2020 00:00:33 -0700 Subject: [PATCH 293/318] Update CODEOWNERS (#10083) Adding App Service control plane team. Removing people no longer with team --- CODEOWNERS | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/CODEOWNERS b/CODEOWNERS index a003a61b4135..0eb67c38edaa 100644 --- a/CODEOWNERS +++ b/CODEOWNERS @@ -74,5 +74,5 @@ /specification/subscriptions/ @navysingla /specification/timeseriesinsights/ @sandshadow /specification/trafficmanager/ @allencal @hrkulkarmsft -/specification/web/ @lukaszstem @naveedaz @nking92 +/specification/web/ @naveedaz @Azure/azure-app-service-control-plane /profile/ @shahabhijeet From 298533595ae3574db4436cbc67eef38323c1a970 Mon Sep 17 00:00:00 2001 From: Phoenix He Date: Fri, 10 Jul 2020 15:27:43 +0800 Subject: [PATCH 294/318] Fix dependency (#10087) --- .azure-pipelines-preproduction/package-lock.json | 6 +++--- .azure-pipelines-preproduction/package.json | 3 ++- 2 files changed, 5 insertions(+), 4 deletions(-) diff --git a/.azure-pipelines-preproduction/package-lock.json b/.azure-pipelines-preproduction/package-lock.json index 5a137fd25979..578861591245 100644 --- a/.azure-pipelines-preproduction/package-lock.json +++ b/.azure-pipelines-preproduction/package-lock.json @@ -3633,9 +3633,9 @@ } }, "minimist": { - "version": "1.2.0", - "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.0.tgz", - "integrity": "sha1-o1AIsg9BOD7sH7kU9M1d95omQoQ=", + "version": "1.2.5", + "resolved": "https://registry.npmjs.org/minimist/-/minimist-1.2.5.tgz", + "integrity": "sha512-FM9nNUYrRBAELZQT3xeZQ7fmMOBg6nWNmJKTcgsJeaLstP/UODVpGsr5OhXhhXg6f+qtJ8uiZ+PUxkDWcgIXLw==", "dev": true }, "mixin-deep": { diff --git a/.azure-pipelines-preproduction/package.json b/.azure-pipelines-preproduction/package.json index e7d2d90308ab..ecc81e883361 100644 --- a/.azure-pipelines-preproduction/package.json +++ b/.azure-pipelines-preproduction/package.json @@ -25,7 +25,8 @@ "ts-node": "^8.1.0", "tslib": "^1.10.0", "typescript": "3.5.3", - "prettier": "^1.18.2" + "prettier": "^1.18.2", + "minimist": "^1.2.3" }, "homepage": "https://github.com/azure/azure-rest-api-specs", "repository": { From d2ee593a3e9709b528799f819394d224dba4be52 Mon Sep 17 00:00:00 2001 From: Jingshu923 <52914166+Jingshu923@users.noreply.github.com> Date: Fri, 10 Jul 2020 16:44:53 +0800 Subject: [PATCH 295/318] [DataFactory]Add QuickBooks connectionProperties property (#10054) * Add QuickBooks connectionProperties property * Update a spell error --- .../2018-06-01/entityTypes/LinkedService.json | 14 +++++--------- 1 file changed, 5 insertions(+), 9 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 317fec827901..37c6b2fb59d2 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -4337,6 +4337,10 @@ "QuickBooksLinkedServiceTypeProperties": { "description": "QuickBooks server linked service properties.", "properties": { + "connectionProperties": { + "description": "Properties used to connect to QuickBooks. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, "endpoint": { "description": "The endpoint of the QuickBooks server. (i.e. quickbooks.api.intuit.com)", "type": "object" @@ -4369,15 +4373,7 @@ "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } - }, - "required": [ - "endpoint", - "companyId", - "consumerKey", - "consumerSecret", - "accessToken", - "accessTokenSecret" - ] + } }, "ServiceNowLinkedService": { "x-ms-discriminator-value": "ServiceNow", From 87314e542d5904b1eb5c5e79982db98540c80d93 Mon Sep 17 00:00:00 2001 From: Jingshu923 <52914166+Jingshu923@users.noreply.github.com> Date: Fri, 10 Jul 2020 16:45:27 +0800 Subject: [PATCH 296/318] [DataFactory]SFMarketCloud add connectionProperties property (#10052) * SFMarketCloud add connectionProperties property * Remove clientId required --- .../stable/2018-06-01/entityTypes/LinkedService.json | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 37c6b2fb59d2..1e4ea9414b9d 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -4885,6 +4885,10 @@ "SalesforceMarketingCloudLinkedServiceTypeProperties": { "description": "Salesforce Marketing Cloud linked service properties.", "properties": { + "connectionProperties": { + "description": "Properties used to connect to Salesforce Marketing Cloud. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, "clientId": { "description": "The client ID associated with the Salesforce Marketing Cloud application. Type: string (or Expression with resultType string).", "type": "object" @@ -4909,10 +4913,7 @@ "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } - }, - "required": [ - "clientId" - ] + } }, "HDInsightOnDemandLinkedService": { "x-ms-discriminator-value": "HDInsightOnDemand", From 14f1a1ed4ca3b55782acf8314b42b76ec503aac0 Mon Sep 17 00:00:00 2001 From: Jingshu923 <52914166+Jingshu923@users.noreply.github.com> Date: Fri, 10 Jul 2020 16:46:56 +0800 Subject: [PATCH 297/318] [DataFactory] Xero add connectionProperties property (#10056) --- .../stable/2018-06-01/entityTypes/LinkedService.json | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 1e4ea9414b9d..7e8ab8ff2ebd 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -4703,6 +4703,10 @@ "XeroLinkedServiceTypeProperties": { "description": "Xero Service linked service properties.", "properties": { + "connectionProperties": { + "description": "Properties used to connect to Xero. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, "host": { "description": "The endpoint of the Xero server. (i.e. api.xero.com)", "type": "object" @@ -4731,10 +4735,7 @@ "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } - }, - "required": [ - "host" - ] + } }, "ZohoLinkedService": { "x-ms-discriminator-value": "Zoho", From 90528a1de3de2cb6669eb431f6ac02986ce936d9 Mon Sep 17 00:00:00 2001 From: Jingshu923 <52914166+Jingshu923@users.noreply.github.com> Date: Fri, 10 Jul 2020 16:49:09 +0800 Subject: [PATCH 298/318] [DataFactory]Zoho add connectionProperties property (#10057) --- .../stable/2018-06-01/entityTypes/LinkedService.json | 9 +++++---- 1 file changed, 5 insertions(+), 4 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index 7e8ab8ff2ebd..b3bd70ab2051 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -4760,6 +4760,10 @@ "ZohoLinkedServiceTypeProperties": { "description": "Zoho server linked service properties.", "properties": { + "connectionProperties": { + "description": "Properties used to connect to Zoho. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, "endpoint": { "description": "The endpoint of the Zoho server. (i.e. crm.zoho.com/crm/private)", "type": "object" @@ -4784,10 +4788,7 @@ "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } - }, - "required": [ - "endpoint" - ] + } }, "VerticaLinkedService": { "x-ms-discriminator-value": "Vertica", From 55235375bed1e58edf26607937861893853ffb60 Mon Sep 17 00:00:00 2001 From: ankushbindlish2 <34896519+ankushbindlish2@users.noreply.github.com> Date: Fri, 10 Jul 2020 02:57:26 -0700 Subject: [PATCH 299/318] Update storagesync.json (#10088) --- .../Microsoft.StorageSync/stable/2020-03-01/storagesync.json | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/storagesync.json b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/storagesync.json index 15d0e9160781..a665e00b1c48 100644 --- a/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/storagesync.json +++ b/specification/storagesync/resource-manager/Microsoft.StorageSync/stable/2020-03-01/storagesync.json @@ -4496,7 +4496,7 @@ ], "x-ms-enum": { "name": "LocalCacheMode", - "modelAsString": false + "modelAsString": true } }, "InitialDownloadPolicy": { @@ -4509,7 +4509,7 @@ ], "x-ms-enum": { "name": "InitialDownloadPolicy", - "modelAsString": false + "modelAsString": true } }, "ServerEndpointSyncHealthState": { From af6cd68d8066ef807b3a8548e437ba3cd5aa6949 Mon Sep 17 00:00:00 2001 From: Landon Smith Date: Fri, 10 Jul 2020 05:35:43 -0700 Subject: [PATCH 300/318] Update CDN default api version to 2020-04-15. (#10026) * Update CDN default api version to 2020-04-15 * Add missing CDN x-ms-enum fields for url signing. --- .../Microsoft.Cdn/stable/2020-04-15/cdn.json | 12 ++++++++++-- specification/cdn/resource-manager/readme.md | 2 +- 2 files changed, 11 insertions(+), 3 deletions(-) diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json index 5e9ebacd260b..31b6d8b79da1 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json @@ -3885,7 +3885,11 @@ "type": "string", "enum": [ "SHA256" - ] + ], + "x-ms-enum": { + "name": "algorithm", + "modelAsString": true + } }, "parameterNameOverride": { "description": "Defines which query string parameters in the url to be considered for expires, key id etc. ", @@ -3917,7 +3921,11 @@ "expires", "keyId", "signature" - ] + ], + "x-ms-enum": { + "name": "paramIndicator", + "modelAsString": true + } }, "paramName": { "description": "Parameter name", diff --git a/specification/cdn/resource-manager/readme.md b/specification/cdn/resource-manager/readme.md index 58ca149dc55d..25bcc654b0cc 100644 --- a/specification/cdn/resource-manager/readme.md +++ b/specification/cdn/resource-manager/readme.md @@ -28,7 +28,7 @@ These are the global settings for the Cdn API. title: CdnManagementClient description: Cdn Management Client openapi-type: arm -tag: package-2019-06 +tag: package-2020-04 ``` ### Tag: package-2020-04 From 7d2e192d501af0c00e8a13eca5792ab02efcfede Mon Sep 17 00:00:00 2001 From: Jorge Baca <58745759+jorgbaca@users.noreply.github.com> Date: Fri, 10 Jul 2020 05:45:32 -0700 Subject: [PATCH 301/318] Remove obsolete azuredata resources (#10008) * Removing Microsoft.AzureData/sqlInstances * Removing Microsoft.AzureData/hybridDataManagers * Removed sqlInstance example file. --- .../preview/2019-07-24-preview/azuredata.json | 905 +++--------------- .../CreateOrUpdateHybridDataManager.json | 41 - .../examples/CreateOrUpdateSqlInstance.json | 41 - .../examples/DeleteHybridDataManager.json | 12 - .../examples/DeleteSqlInstance.json | 12 - .../examples/GetHybridDataManager.json | 22 - .../examples/GetSqlInstance.json | 22 - .../ListByResourceGroupHybridDataManager.json | 35 - .../ListByResourceGroupSqlInstance.json | 35 - .../ListSubscriptionHybridDataManager.json | 34 - .../ListSubscriptionSqlIInstance.json | 34 - .../examples/UpdateHybridDataManager.json | 27 - .../examples/UpdateSqlInstance.json | 24 - 13 files changed, 115 insertions(+), 1129 deletions(-) delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateHybridDataManager.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlInstance.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteHybridDataManager.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlInstance.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetHybridDataManager.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlInstance.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupHybridDataManager.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlInstance.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionHybridDataManager.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlIInstance.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateHybridDataManager.json delete mode 100644 specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlInstance.json diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json index 9d1a0f4d63c8..4aa726754db2 100644 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json +++ b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/azuredata.json @@ -856,294 +856,6 @@ } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/sqlInstances": { - "get": { - "tags": [ - "SqlInstances" - ], - "operationId": "SqlInstances_List", - "summary": "List sqlInstance resources in the subscription", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlInstanceListResult" - } - }, - "default": { - "description": "*** Error Responses: ***\n\n * 400 InvalidParameterValue - An invalid value was given to parameter.\n\n * 400 InvalidCrossSubscriptionVmMove - Invalid cross subscription move of resource.\n\n * 404 ResourceNotFound - The requested resource was not found.", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL Instance in a subscription.": { - "$ref": "./examples/ListSubscriptionSqlIInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlInstances": { - "get": { - "tags": [ - "SqlInstances" - ], - "operationId": "SqlInstances_ListByResourceGroup", - "description": "Gets all sqlInstances in a resource group.", - "summary": "List sqlInstance resources in the resource group", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlInstanceListResult" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all SQL Instance in a resource group.": { - "$ref": "./examples/ListByResourceGroupSqlInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/sqlInstances/{sqlInstanceName}": { - "get": { - "tags": [ - "SqlInstances" - ], - "operationId": "SqlInstances_Get", - "description": "Retrieves a SQL Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "sqlInstanceName", - "description": "Name of SQL Instance", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Updates a SQL Instance tags.": { - "$ref": "./examples/GetSqlInstance.json" - } - } - }, - "put": { - "tags": [ - "SqlInstances" - ], - "operationId": "SqlInstances_Create", - "description": "Creates or replaces a SQL Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "sqlInstanceName", - "description": "The name of SQL Instances", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "name": "parameters", - "in": "body", - "description": "The SQL Instance to be created or updated.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlInstance" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlInstance" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/SqlInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Updates a SQL Instance tags.": { - "$ref": "./examples/CreateOrUpdateSqlInstance.json" - } - } - }, - "delete": { - "tags": [ - "SqlInstances" - ], - "operationId": "SqlInstances_Delete", - "description": "Deletes a SQL Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "sqlInstanceName", - "description": "The name of Sql Instances", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the SQL Instance." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "204": { - "description": "The specified SQL Instance does not exist." - } - }, - "x-ms-examples": { - "Delete a SQL Instance.": { - "$ref": "./examples/DeleteSqlInstance.json" - } - } - }, - "patch": { - "tags": [ - "SqlInstances" - ], - "operationId": "SqlInstances_Update", - "description": "Updates a SQL Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "sqlInstanceName", - "description": "Name of sqlInstance", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "name": "parameters", - "in": "body", - "description": "The SQL Instance.", - "required": true, - "schema": { - "$ref": "#/definitions/SqlInstanceUpdate" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/SqlInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Updates a sql Instance tags.": { - "$ref": "./examples/UpdateSqlInstance.json" - } - } - } - }, "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/sqlServerInstances": { "get": { "tags": [ @@ -1541,293 +1253,10 @@ } ], "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PostgresInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Gets a postgres Instances.": { - "$ref": "./examples/GetPostgresInstance.json" - } - } - }, - "put": { - "tags": [ - "PostgresInstances" - ], - "operationId": "PostgresInstances_Create", - "description": "Creates or replaces a postgres Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "postgresInstanceName", - "description": "Name of PostgresInstance", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PostgresInstance" - } - }, - "201": { - "description": "Created", - "schema": { - "$ref": "#/definitions/PostgresInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Creates or updates a postgres Instance.": { - "$ref": "./examples/CreateOrUpdatePostgresInstance.json" - } - } - }, - "delete": { - "tags": [ - "PostgresInstances" - ], - "operationId": "PostgresInstances_Delete", - "description": "Deletes a postgres Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "postgresInstanceName", - "description": "Name of Postgres Instance", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "Successfully deleted the Postgres Instance." - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - }, - "204": { - "description": "The specified Postgres Instance does not exist." - } - }, - "x-ms-examples": { - "Deletes a PostgresInstances.": { - "$ref": "./examples/DeletePostgresInstance.json" - } - } - }, - "patch": { - "tags": [ - "PostgresInstances" - ], - "operationId": "PostgresInstances_Update", - "description": "Updates a postgres Instance resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "postgresInstanceName", - "description": "Name of Postgres Instance", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "name": "parameters", - "in": "body", - "description": "The Postgres Instance.", - "required": true, - "schema": { - "$ref": "#/definitions/PostgresInstanceUpdate" - } - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PostgresInstance" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-examples": { - "Updates a postgres Instances tags.": { - "$ref": "./examples/UpdatePostgresInstance.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/dataControllers": { - "get": { - "tags": [ - "DataControllers" - ], - "operationId": "DataControllers_ListInSubscription", - "summary": "List dataController resources in the subscription", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PageOfDataControllerResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all dataControllers in a subscription.": { - "$ref": "./examples/ListSubscriptionDataController.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/dataControllers": { - "get": { - "tags": [ - "DataControllers" - ], - "operationId": "DataControllers_ListInGroup", - "summary": "List dataController resources in the resource group", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/PageOfDataControllerResource" - } - }, - "default": { - "description": "*** Error Responses: ***", - "schema": { - "$ref": "#/definitions/CloudError" - } - } - }, - "x-ms-pageable": { - "nextLinkName": "nextLink" - }, - "x-ms-examples": { - "Gets all dataControllers in a resource group.": { - "$ref": "./examples/ListByResourceGroupDataController.json" - } - } - } - }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/dataControllers/{dataControllerName}": { - "put": { - "tags": [ - "DataControllers" - ], - "operationId": "DataControllers_PutDataController", - "description": "Creates or replaces a dataController resource", - "parameters": [ - { - "$ref": "#/parameters/subscriptionId" - }, - { - "$ref": "#/parameters/resourceGroupName" - }, - { - "name": "dataControllerName", - "in": "path", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, - { - "$ref": "#/parameters/apiVersion" - } - ], - "responses": { - "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DataControllerResource" - } - }, - "201": { - "description": "Created", + "200": { + "description": "OK", "schema": { - "$ref": "#/definitions/DataControllerResource" + "$ref": "#/definitions/PostgresInstance" } }, "default": { @@ -1838,17 +1267,17 @@ } }, "x-ms-examples": { - "Updates a dataControllers tags.": { - "$ref": "./examples/CreateOrUpdateDataController.json" + "Gets a postgres Instances.": { + "$ref": "./examples/GetPostgresInstance.json" } } }, - "delete": { + "put": { "tags": [ - "DataControllers" + "PostgresInstances" ], - "operationId": "DataControllers_DeleteDataController", - "description": "Deletes a dataController resource", + "operationId": "PostgresInstances_Create", + "description": "Creates or replaces a postgres Instance resource", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1857,7 +1286,8 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "dataControllerName", + "name": "postgresInstanceName", + "description": "Name of PostgresInstance", "in": "path", "required": true, "type": "string", @@ -1869,30 +1299,36 @@ ], "responses": { "200": { - "description": "Successfully deleted the DataController." + "description": "OK", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } + }, + "201": { + "description": "Created", + "schema": { + "$ref": "#/definitions/PostgresInstance" + } }, "default": { "description": "*** Error Responses: ***", "schema": { "$ref": "#/definitions/CloudError" } - }, - "204": { - "description": "The specified DataController does not exist." } }, "x-ms-examples": { - "Delete a dataController.": { - "$ref": "./examples/DeleteDataController.json" + "Creates or updates a postgres Instance.": { + "$ref": "./examples/CreateOrUpdatePostgresInstance.json" } } }, - "get": { + "delete": { "tags": [ - "DataControllers" + "PostgresInstances" ], - "operationId": "DataControllers_GetDataController", - "description": "Retrieves a dataController resource", + "operationId": "PostgresInstances_Delete", + "description": "Deletes a postgres Instance resource", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1901,7 +1337,8 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "dataControllerName", + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", "in": "path", "required": true, "type": "string", @@ -1913,30 +1350,30 @@ ], "responses": { "200": { - "description": "OK", - "schema": { - "$ref": "#/definitions/DataControllerResource" - } + "description": "Successfully deleted the Postgres Instance." }, "default": { "description": "*** Error Responses: ***", "schema": { "$ref": "#/definitions/CloudError" } + }, + "204": { + "description": "The specified Postgres Instance does not exist." } }, "x-ms-examples": { - "Updates a dataController tags.": { - "$ref": "./examples/GetDataController.json" + "Deletes a PostgresInstances.": { + "$ref": "./examples/DeletePostgresInstance.json" } } }, "patch": { "tags": [ - "DataControllers" + "PostgresInstances" ], - "operationId": "DataControllers_PatchDataController", - "description": "Updates a dataController resource", + "operationId": "PostgresInstances_Update", + "description": "Updates a postgres Instance resource", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1945,12 +1382,22 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "dataControllerName", + "name": "postgresInstanceName", + "description": "Name of Postgres Instance", "in": "path", "required": true, "type": "string", "x-ms-parameter-location": "method" }, + { + "name": "parameters", + "in": "body", + "description": "The Postgres Instance.", + "required": true, + "schema": { + "$ref": "#/definitions/PostgresInstanceUpdate" + } + }, { "$ref": "#/parameters/apiVersion" } @@ -1959,7 +1406,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/DataControllerResource" + "$ref": "#/definitions/PostgresInstance" } }, "default": { @@ -1970,19 +1417,19 @@ } }, "x-ms-examples": { - "Updates a dataController tags.": { - "$ref": "./examples/UpdateDataController.json" + "Updates a postgres Instances tags.": { + "$ref": "./examples/UpdatePostgresInstance.json" } } } }, - "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/hybridDataManagers": { + "/subscriptions/{subscriptionId}/providers/Microsoft.AzureData/dataControllers": { "get": { "tags": [ - "HybridDataManagers" + "DataControllers" ], - "operationId": "HybridDataManagers_List", - "summary": "List hybridDataManager resources in the subscription", + "operationId": "DataControllers_ListInSubscription", + "summary": "List dataController resources in the subscription", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -1995,7 +1442,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridDataManagerListResult" + "$ref": "#/definitions/PageOfDataControllerResource" } }, "default": { @@ -2009,20 +1456,19 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Gets all hybridDataManagers in a subscription.": { - "$ref": "./examples/ListSubscriptionHybridDataManager.json" + "Gets all dataControllers in a subscription.": { + "$ref": "./examples/ListSubscriptionDataController.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/hybridDataManagers": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/dataControllers": { "get": { "tags": [ - "HybridDataManagers" + "DataControllers" ], - "operationId": "HybridDataManagers_ListByResourceGroup", - "summary": "List hybridDataManager resources in the resource group", - "description": "Get a hybridDataManager list by Resource group name.", + "operationId": "DataControllers_ListInGroup", + "summary": "List dataController resources in the resource group", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2038,7 +1484,7 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridDataManagerListResult" + "$ref": "#/definitions/PageOfDataControllerResource" } }, "default": { @@ -2052,19 +1498,19 @@ "nextLinkName": "nextLink" }, "x-ms-examples": { - "Gets all hybridDataManagers in a resource group.": { - "$ref": "./examples/ListByResourceGroupHybridDataManager.json" + "Gets all dataControllers in a resource group.": { + "$ref": "./examples/ListByResourceGroupDataController.json" } } } }, - "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/hybridDataManagers/{hybridDataManagerName}": { + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.AzureData/dataControllers/{dataControllerName}": { "put": { "tags": [ - "HybridDataManagers" + "DataControllers" ], - "operationId": "HybridDataManagers_Create", - "description": "Creates or replaces a hybridDataManager resource", + "operationId": "DataControllers_PutDataController", + "description": "Creates or replaces a dataController resource", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2073,8 +1519,7 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "hybridDataManagerName", - "description": "Name of HybridDataManagerName", + "name": "dataControllerName", "in": "path", "required": true, "type": "string", @@ -2088,28 +1533,34 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridDataManager" + "$ref": "#/definitions/DataControllerResource" } }, "201": { "description": "Created", "schema": { - "$ref": "#/definitions/HybridDataManager" + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { - "Updates a hybridDataManager tags.": { - "$ref": "./examples/CreateOrUpdateHybridDataManager.json" + "Updates a dataControllers tags.": { + "$ref": "./examples/CreateOrUpdateDataController.json" } } }, "delete": { "tags": [ - "HybridDataManagers" + "DataControllers" ], - "operationId": "HybridDataManagers_Delete", - "description": "Deletes a hybridDataManager resource", + "operationId": "DataControllers_DeleteDataController", + "description": "Deletes a dataController resource", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2118,8 +1569,7 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "hybridDataManagerName", - "description": "Name of HybridDataManager", + "name": "dataControllerName", "in": "path", "required": true, "type": "string", @@ -2131,7 +1581,7 @@ ], "responses": { "200": { - "description": "Successfully deleted the HybridDataManager." + "description": "Successfully deleted the DataController." }, "default": { "description": "*** Error Responses: ***", @@ -2140,21 +1590,21 @@ } }, "204": { - "description": "The specified HybridDataManager does not exist." + "description": "The specified DataController does not exist." } }, "x-ms-examples": { - "Delete a HybridDataManagers.": { - "$ref": "./examples/DeleteHybridDataManager.json" + "Delete a dataController.": { + "$ref": "./examples/DeleteDataController.json" } } }, "get": { "tags": [ - "HybridDataManagers" + "DataControllers" ], - "operationId": "HybridDataManagers_Get", - "description": "Retrieves a hybridDataManager resource", + "operationId": "DataControllers_GetDataController", + "description": "Retrieves a dataController resource", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2163,8 +1613,7 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "hybridDataManagerName", - "description": "Name of HybridDataManager", + "name": "dataControllerName", "in": "path", "required": true, "type": "string", @@ -2178,22 +1627,28 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridDataManager" + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { - "Updates a hybridDataManager tags.": { - "$ref": "./examples/GetHybridDataManager.json" + "Updates a dataController tags.": { + "$ref": "./examples/GetDataController.json" } } }, "patch": { "tags": [ - "HybridDataManagers" + "DataControllers" ], - "operationId": "HybridDataManagers_Update", - "description": "Updates a hybridDataManager resource", + "operationId": "DataControllers_PatchDataController", + "description": "Updates a dataController resource", "parameters": [ { "$ref": "#/parameters/subscriptionId" @@ -2202,22 +1657,12 @@ "$ref": "#/parameters/resourceGroupName" }, { - "name": "hybridDataManagerName", - "description": "Name of HybridDataManager", + "name": "dataControllerName", "in": "path", "required": true, "type": "string", "x-ms-parameter-location": "method" }, - { - "name": "parameters", - "in": "body", - "description": "The HybridDataManager.", - "required": true, - "schema": { - "$ref": "#/definitions/HybridDataManagerUpdate" - } - }, { "$ref": "#/parameters/apiVersion" } @@ -2226,13 +1671,19 @@ "200": { "description": "OK", "schema": { - "$ref": "#/definitions/HybridDataManager" + "$ref": "#/definitions/DataControllerResource" + } + }, + "default": { + "description": "*** Error Responses: ***", + "schema": { + "$ref": "#/definitions/CloudError" } } }, "x-ms-examples": { - "Updates a hybridDataManager tags.": { - "$ref": "./examples/UpdateHybridDataManager.json" + "Updates a dataController tags.": { + "$ref": "./examples/UpdateDataController.json" } } } @@ -3022,16 +2473,6 @@ } } }, - "SqlInstanceProperties": { - "description": "Properties of PostgresInstance.", - "type": "object", - "properties": { - "hybridDataManagerId": { - "type": "string", - "description": "null" - } - } - }, "SqlManagedInstanceProperties": { "description": "Properties of sqlManagedInstance.", "type": "object", @@ -3042,22 +2483,6 @@ } } }, - "SqlInstance": { - "description": "A SqlInstance.", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/SqlInstanceProperties", - "description": "null", - "x-ms-client-flatten": true - } - } - }, "SqlManagedInstance": { "description": "A SqlManagedInstance.", "type": "object", @@ -3074,19 +2499,6 @@ } } }, - "SqlInstanceUpdate": { - "description": "An update to a SQL Instance.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, "SqlManagedInstanceUpdate": { "description": "An update to a SQL Managed Instance.", "type": "object", @@ -3100,25 +2512,6 @@ } } }, - "SqlInstanceListResult": { - "description": "A list of SqlInstance.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/SqlInstance" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, "SqlManagedInstanceListResult": { "description": "A list of SqlManagedInstance.", "type": "object", @@ -3229,58 +2622,6 @@ } } }, - "HybridDataManagerProperties": { - "description": "Hybrid data manager properties", - "type": "object" - }, - "HybridDataManager": { - "description": "Hybrid data manager resource", - "type": "object", - "allOf": [ - { - "$ref": "#/definitions/TrackedResource" - } - ], - "properties": { - "properties": { - "$ref": "#/definitions/HybridDataManagerProperties", - "description": "null", - "x-ms-client-flatten": true - } - } - }, - "HybridDataManagerUpdate": { - "description": "An update to a HybridDataManager.", - "type": "object", - "properties": { - "tags": { - "description": "Resource tags.", - "type": "object", - "additionalProperties": { - "type": "string" - } - } - } - }, - "HybridDataManagerListResult": { - "description": "A list of HybridDataManager.", - "type": "object", - "properties": { - "value": { - "description": "Array of results.", - "type": "array", - "items": { - "$ref": "#/definitions/HybridDataManager" - }, - "readOnly": true - }, - "nextLink": { - "description": "Link to retrieve next page of results.", - "type": "string", - "readOnly": true - } - } - }, "CloudError": { "x-ms-external": true, "properties": { @@ -3421,14 +2762,6 @@ "type": "string", "x-ms-parameter-location": "method" }, - "SqlInstanceNameParameter": { - "in": "path", - "name": "sqlInstanceName", - "description": "The name of the resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" - }, "SqlManagedInstanceNameParameter": { "in": "path", "name": "sqlManagedInstanceName", @@ -3444,14 +2777,6 @@ "required": true, "type": "string", "x-ms-parameter-location": "method" - }, - "HybridDataManagerNameParameter": { - "in": "path", - "name": "hybridDataManagerName", - "description": "The name of the resource.", - "required": true, - "type": "string", - "x-ms-parameter-location": "method" } }, "securityDefinitions": { diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateHybridDataManager.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateHybridDataManager.json deleted file mode 100644 index 34e7096538bb..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateHybridDataManager.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "hybridDataManagerName": "testhybridDataManager", - "api-version": "2017-07-24", - "parameters": { - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "properties": {} - } - }, - "responses": { - "200": { - "body": { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/hybridDataManager/testhybridDataManager", - "name": "testhybridDataManager", - "type": "Microsoft.AzureData/HybridDataManager" - } - }, - "201": { - "body": { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/hybridDataManager/testhybridDataManager", - "name": "testhybridDataManager", - "type": "Microsoft.AzureData/HybridDataManager" - } - } - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlInstance.json deleted file mode 100644 index f7c281cc1050..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/CreateOrUpdateSqlInstance.json +++ /dev/null @@ -1,41 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlInstanceName": "testsqlInstance", - "api-version": "2017-07-24", - "parameters": { - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "properties": {} - } - }, - "responses": { - "200": { - "body": { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlInstances/testsqlInstance", - "name": "testsqlInstance", - "type": "Microsoft.AzureData/SqlInstances" - } - }, - "201": { - "body": { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlInstances/testsqlInstance", - "name": "testsqlInstance", - "type": "Microsoft.AzureData/SqlInstances" - } - } - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteHybridDataManager.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteHybridDataManager.json deleted file mode 100644 index 351de7e6d66c..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteHybridDataManager.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "hybridDataManagerName": "testhybridDataManager", - "api-version": "2017-07-24" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlInstance.json deleted file mode 100644 index 90575fe29180..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/DeleteSqlInstance.json +++ /dev/null @@ -1,12 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlInstanceName": "testsqlInstance", - "api-version": "2017-07-24" - }, - "responses": { - "200": {}, - "204": {} - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetHybridDataManager.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetHybridDataManager.json deleted file mode 100644 index 9219639c7e8d..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetHybridDataManager.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "hybridDataManagerName": "testhybridDataManager", - "api-version": "2017-07-24" - }, - "responses": { - "200": { - "body": { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/HybridDataManager/testhybridDataManager", - "name": "testhybridDataManager", - "type": "Microsoft.AzureData/HybridDataManager" - } - } - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlInstance.json deleted file mode 100644 index 232173e7724f..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/GetSqlInstance.json +++ /dev/null @@ -1,22 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlInstanceName": "testsqlInstance", - "api-version": "2017-07-24" - }, - "responses": { - "200": { - "body": { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlInstances/testsqlInstance", - "name": "testsqlInstance", - "type": "Microsoft.AzureData/SqlInstance" - } - } - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupHybridDataManager.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupHybridDataManager.json deleted file mode 100644 index 67ad06ab5ced..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupHybridDataManager.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "api-version": "2017-07-24" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/HybirdDataManager/testhybirdDataManager1", - "name": "testhybirdDataManager1", - "type": "Microsoft.AzureData/HybirdDataManager" - }, - { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/HybirdDataManager/testhybirdDataManager2", - "name": "testhybirdDataManager2", - "type": "Microsoft.AzureData/HybirdDataManager" - } - ] - } - } - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlInstance.json deleted file mode 100644 index f1e70c820ef6..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListByResourceGroupSqlInstance.json +++ /dev/null @@ -1,35 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "api-version": "2017-07-24" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlInstances/sqlInstance1", - "name": "sqlInstances1", - "type": "Microsoft.AzureData/SqlInstance" - }, - { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlInstances/sqlInstance2", - "name": "sqlInstances2", - "type": "Microsoft.AzureData/SqlInstance" - } - ] - } - } - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionHybridDataManager.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionHybridDataManager.json deleted file mode 100644 index 0a1dd3aaf4c1..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionHybridDataManager.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "api-version": "2017-07-24" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/HybirdDataManager/testhybirdDataManager1", - "name": "testhybirdDataManager1", - "type": "Microsoft.AzureData/HybirdDataManager" - }, - { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/HybirdDataManager/testhybirdDataManager2", - "name": "testhybirdDataManager2", - "type": "Microsoft.AzureData/HybirdDataManager" - } - ] - } - } - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlIInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlIInstance.json deleted file mode 100644 index 1305f494cd38..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/ListSubscriptionSqlIInstance.json +++ /dev/null @@ -1,34 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "api-version": "2017-07-24" - }, - "responses": { - "200": { - "body": { - "value": [ - { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlInstances/sqlInstance1", - "name": "sqlInstances1", - "type": "Microsoft.AzureData/SqlInstance" - }, - { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlInstances/sqlInstance2", - "name": "sqlInstances2", - "type": "Microsoft.AzureData/SqlInstance" - } - ] - } - } - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateHybridDataManager.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateHybridDataManager.json deleted file mode 100644 index 2ef5ef8d2110..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateHybridDataManager.json +++ /dev/null @@ -1,27 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "hybridDataManagerName": "testhybirdDataManager1", - "api-version": "2019-07-24", - "parameters": { - "tags": { - "mytag": "myval" - } - } - }, - "responses": { - "200": { - "body": { - "properties": {}, - "location": "northeurope", - "tags": { - "mytag": "myval" - }, - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/HybirdDataManager/testhybirdDataManager1", - "name": "testhybirdDataManager1", - "type": "Microsoft.AzureData/HybirdDataManager" - } - } - } -} diff --git a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlInstance.json b/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlInstance.json deleted file mode 100644 index d3b432528e56..000000000000 --- a/specification/azuredata/resource-manager/Microsoft.AzureData/preview/2019-07-24-preview/examples/UpdateSqlInstance.json +++ /dev/null @@ -1,24 +0,0 @@ -{ - "parameters": { - "subscriptionId": "00000000-1111-2222-3333-444444444444", - "resourceGroupName": "testrg", - "sqlInstanceName": "testsqlInstance", - "api-version": "2017-07-24", - "parameters": { - "tags": { - "mytag": "myval" - } - } - }, - "responses": { - "200": { - "body": { - "properties": {}, - "location": "northeurope", - "id": "/subscriptions/00000000-1111-2222-3333-444444444444/resourceGroups/testrg/providers/Microsoft.AzureData/SqlInstances/testsqlInstance", - "name": "testsqlInstance", - "type": "Microsoft.AzureData/SqlInstances" - } - } - } -} From b3446f62368c3f4082c59a74fae265f25f851248 Mon Sep 17 00:00:00 2001 From: Richard Wydrowski <53485603+richwyd@users.noreply.github.com> Date: Fri, 10 Jul 2020 11:51:12 -0700 Subject: [PATCH 302/318] Change Guid IDs to case-sensitive string IDs (#10078) Co-authored-by: Richard Wydrowski --- .../timeseriesinsights.json | 37 +++++++------------ 1 file changed, 13 insertions(+), 24 deletions(-) diff --git a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json index a52536af3c7c..687811357947 100644 --- a/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json +++ b/specification/timeseriesinsights/data-plane/Microsoft.TimeSeriesInsights/preview/2018-11-01-preview/timeseriesinsights.json @@ -1512,8 +1512,7 @@ }, "typeId": { "description": "This represents the type that this instance belongs to. Never null.", - "type": "string", - "format": "uuid" + "type": "string" }, "name": { "description": "Optional name of the instance which is unique in an environment. Names acts as a mutable alias or display name of the time series instance. Mutable, may be null.", @@ -1527,8 +1526,7 @@ "description": "Set of time series hierarchy IDs that the instance belong to. May be null.", "type": "array", "items": { - "type": "string", - "format": "uuid" + "type": "string" } }, "instanceFields": { @@ -1670,9 +1668,8 @@ "type": "object", "properties": { "id": { - "description": "Unique type identifier that is immutable. Can be null on create or update requests, and then server generates the ID. Not null on get and delete operations.", - "type": "string", - "format": "uuid" + "description": "Case-sensitive unique type identifier that is immutable. Can be null on create or update requests, and then server generates the ID. Not null on get and delete operations.", + "type": "string" }, "name": { "description": "User-given unique name for the type. Mutable, not null.", @@ -1723,8 +1720,7 @@ "description": "List of IDs of time series types to return or delete.", "type": "array", "items": { - "type": "string", - "format": "uuid" + "type": "string" } }, "names": { @@ -1808,9 +1804,8 @@ "type": "object", "properties": { "id": { - "description": "Unique hierarchy identifier that is a immutable GUID. Can be null while creating hierarchy objects and then server generates the id, not null on get and delete operations.", - "type": "string", - "format": "uuid" + "description": "Case-sensitive unique hierarchy identifier. Can be null while creating hierarchy objects and then server generates the id, not null on get and delete operations.", + "type": "string" }, "name": { "description": "User-given unique name for the type. It is mutable and not null.", @@ -1864,8 +1859,7 @@ "description": "List of hierarchy IDs.", "type": "array", "items": { - "type": "string", - "format": "uuid" + "type": "string" } }, "names": { @@ -1951,8 +1945,7 @@ "defaultTypeId": { "description": "Default type ID of the model that new time series instances will automatically belong to.", "readOnly": true, - "type": "string", - "format": "uuid" + "type": "string" } } }, @@ -1997,8 +1990,7 @@ }, "defaultTypeId": { "description": "Default type id of the model that new instances will automatically belong to.", - "type": "string", - "format": "uuid" + "type": "string" } } }, @@ -2217,16 +2209,14 @@ "typeId": { "description": "Represents the type that time series instance which matched the search request belongs to. Never null.", "readOnly": true, - "type": "string", - "format": "uuid" + "type": "string" }, "hierarchyIds": { "description": "List of time series hierarchy IDs that time series instance which matched the search request belongs to. Cannot be used to lookup hierarchies. May be null.", "readOnly": true, "type": "array", "items": { - "type": "string", - "format": "uuid" + "type": "string" } }, "highlights": { @@ -2262,8 +2252,7 @@ "readOnly": true, "type": "array", "items": { - "type": "string", - "format": "uuid" + "type": "string" } }, "hierarchyNames": { From d822f30884018b60cd0574f6faf69c52dd51efd4 Mon Sep 17 00:00:00 2001 From: Sanjai Ganesh Jeenagiri Date: Fri, 10 Jul 2020 16:48:24 -0700 Subject: [PATCH 303/318] mkdir (#10094) Co-authored-by: Sanjai Ganesh --- scripts/datacontainer/run.sh | 1 + 1 file changed, 1 insertion(+) diff --git a/scripts/datacontainer/run.sh b/scripts/datacontainer/run.sh index b83512783af3..86d4a119ff36 100644 --- a/scripts/datacontainer/run.sh +++ b/scripts/datacontainer/run.sh @@ -3,6 +3,7 @@ timestamp=`date +%Y/%m/%d-%H:%M:%S` echo "[$timestamp] Copying files to /usr/data/openapispecs" +mkdir -p /usr/data/openapispecs/.git cp -R /usr/data/specrepo/.git/* /usr/data/openapispecs/.git/ timestamp=`date +%Y/%m/%d-%H:%M:%S` From 1b0aea3799a17f2f88b345d8389ab2b5a5e897c7 Mon Sep 17 00:00:00 2001 From: shreyanshn Date: Fri, 10 Jul 2020 18:32:08 -0700 Subject: [PATCH 304/318] Check Resource Name added to swagger (#9185) * Check Resource Name added to swagger * spellcheck and prettier check fixed * fixes * prettier check and x-ms fixes * added schema for resource name * fixes * description added to resourcename * added changes to all api versions * default response added * prettier checl * default response changed * removed 2016-06-01 api * override errors * file moved to examples * single override * reverting * override policyclient Co-authored-by: Shreyansh Nawlakha --- .../examples/CheckResourceName.json | 20 ++++ .../stable/2015-11-01/subscriptions.json | 113 ++++++++++++++++++ .../examples/CheckResourceName.json | 20 ++++ .../stable/2016-06-01/subscriptions.json | 113 ++++++++++++++++++ .../examples/CheckResourceName.json | 20 ++++ .../stable/2018-06-01/subscriptions.json | 113 ++++++++++++++++++ .../examples/CheckResourceName.json | 20 ++++ .../stable/2019-06-01/subscriptions.json | 113 ++++++++++++++++++ .../examples/CheckResourceName.json | 20 ++++ .../stable/2019-11-01/subscriptions.json | 113 ++++++++++++++++++ .../examples/CheckResourceName.json | 20 ++++ .../stable/2020-01-01/subscriptions.json | 113 ++++++++++++++++++ .../resources/resource-manager/readme.md | 3 + 13 files changed, 801 insertions(+) create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/examples/CheckResourceName.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/examples/CheckResourceName.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/examples/CheckResourceName.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2019-06-01/examples/CheckResourceName.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2019-11-01/examples/CheckResourceName.json create mode 100644 specification/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/examples/CheckResourceName.json diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/examples/CheckResourceName.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/examples/CheckResourceName.json new file mode 100644 index 000000000000..77e33c4ba8f2 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/examples/CheckResourceName.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "body": [ + { + "Name": "isxbox", + "Type": "ResourceProviderTestHost/TestResourceType" + } + ], + "api-version": "2015-11-01" + }, + "responses": { + "200": { + "body": { + "name": "isxbox", + "type": "ResourceProviderTestHost/TestResourceType", + "status": "Allowed" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/subscriptions.json index 32846f6b7326..81e1db96161e 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/subscriptions.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2015-11-01/subscriptions.json @@ -145,6 +145,46 @@ "nextLinkName": "nextLink" } } + }, + "/providers/Microsoft.Resources/checkResourceName": { + "post": { + "tags": [ + "Tenants" + ], + "operationId": "checkResourceName", + "description": "A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word", + "summary": "Checks resource name validity", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/CheckResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns status as allowed or not.", + "schema": { + "$ref": "#/definitions/CheckResourceNameResult" + } + }, + "default": { + "description": "Error response saying resource name is invalid", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check validity for a resource name.": { + "$ref": "./examples/CheckResourceName.json" + } + } + } } }, "definitions": { @@ -277,9 +317,82 @@ "nextLink" ], "description": "Tenant Ids information." + }, + "ResourceName": { + "description": "Name and Type of the Resource", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of the resource" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error description and code explaining why resource name is invalid.", + "properties": { + "message": { + "type": "string", + "description": "Description of the error." + }, + "code": { + "type": "string", + "description": "Code of the error." + } + } + }, + "CheckResourceNameResult": { + "properties": { + "name": { + "description": "Name of Resource", + "type": "string" + }, + "type": { + "description": "Type of Resource", + "type": "string" + }, + "status": { + "description": "Is the resource name Allowed or Reserved", + "type": "string", + "enum": [ + "Allowed", + "Reserved" + ], + "x-ms-enum": { + "name": "ResourceNameStatus", + "modelAsString": true + } + } + }, + "description": "Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word" } }, "parameters": { + "CheckResourceNameParameter": { + "description": "Resource object with values for resource name and resource type", + "in": "body", + "name": "Resource Name Definition", + "schema": { + "$ref": "#/definitions/ResourceName" + }, + "x-ms-parameter-location": "method" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/examples/CheckResourceName.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/examples/CheckResourceName.json new file mode 100644 index 000000000000..6ee63e4f2ea3 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/examples/CheckResourceName.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "body": [ + { + "Name": "isxbox", + "Type": "ResourceProviderTestHost/TestResourceType" + } + ], + "api-version": "2016-06-01" + }, + "responses": { + "200": { + "body": { + "name": "isxbox", + "type": "ResourceProviderTestHost/TestResourceType", + "status": "Allowed" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json index 0ff278951ee7..7aaee9160c89 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2016-06-01/subscriptions.json @@ -162,6 +162,46 @@ "nextLinkName": "nextLink" } } + }, + "/providers/Microsoft.Resources/checkResourceName": { + "post": { + "tags": [ + "Tenants" + ], + "operationId": "checkResourceName", + "description": "A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word", + "summary": "Checks resource name validity", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/CheckResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns status as allowed or not.", + "schema": { + "$ref": "#/definitions/CheckResourceNameResult" + } + }, + "default": { + "description": "Error response saying resource name is invalid", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check validity for a resource name.": { + "$ref": "./examples/CheckResourceName.json" + } + } + } } }, "definitions": { @@ -338,6 +378,70 @@ ], "description": "Tenant Ids information." }, + "ResourceName": { + "description": "Name and Type of the Resource", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of the resource" + } + } + }, + "CheckResourceNameResult": { + "properties": { + "name": { + "description": "Name of Resource", + "type": "string" + }, + "type": { + "description": "Type of Resource", + "type": "string" + }, + "status": { + "description": "Is the resource name Allowed or Reserved", + "type": "string", + "enum": [ + "Allowed", + "Reserved" + ], + "x-ms-enum": { + "name": "ResourceNameStatus", + "modelAsString": true + } + } + }, + "description": "Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word" + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error description and code explaining why resource name is invalid.", + "properties": { + "message": { + "type": "string", + "description": "Description of the error." + }, + "code": { + "type": "string", + "description": "Code of the error." + } + } + }, "Operation": { "description": "Microsoft.Resources operation", "type": "object", @@ -395,6 +499,15 @@ "description": "The ID of the target subscription.", "x-ms-parameter-location": "method" }, + "CheckResourceNameParameter": { + "description": "Resource object with values for resource name and resource type", + "in": "body", + "name": "Resource Name Definition", + "schema": { + "$ref": "#/definitions/ResourceName" + }, + "x-ms-parameter-location": "method" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/examples/CheckResourceName.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/examples/CheckResourceName.json new file mode 100644 index 000000000000..cd6b51d941f4 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/examples/CheckResourceName.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "body": [ + { + "Name": "isxbox", + "Type": "ResourceProviderTestHost/TestResourceType" + } + ], + "api-version": "2018-06-01" + }, + "responses": { + "200": { + "body": { + "name": "isxbox", + "type": "ResourceProviderTestHost/TestResourceType", + "status": "Allowed" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json index fe7335ec5a3f..99f212f95c48 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2018-06-01/subscriptions.json @@ -162,6 +162,46 @@ "nextLinkName": "nextLink" } } + }, + "/providers/Microsoft.Resources/checkResourceName": { + "post": { + "tags": [ + "Tenants" + ], + "operationId": "checkResourceName", + "description": "A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word", + "summary": "Checks resource name validity", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/CheckResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns status as allowed or not.", + "schema": { + "$ref": "#/definitions/CheckResourceNameResult" + } + }, + "default": { + "description": "Error response saying resource name is invalid", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check validity for a resource name.": { + "$ref": "./examples/CheckResourceName.json" + } + } + } } }, "definitions": { @@ -367,6 +407,70 @@ ], "description": "Tenant Ids information." }, + "ResourceName": { + "description": "Name and Type of the Resource", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of the resource" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error description and code explaining why resource name is invalid.", + "properties": { + "message": { + "type": "string", + "description": "Description of the error." + }, + "code": { + "type": "string", + "description": "Code of the error." + } + } + }, + "CheckResourceNameResult": { + "properties": { + "name": { + "description": "Name of Resource", + "type": "string" + }, + "type": { + "description": "Type of Resource", + "type": "string" + }, + "status": { + "description": "Is the resource name Allowed or Reserved", + "type": "string", + "enum": [ + "Allowed", + "Reserved" + ], + "x-ms-enum": { + "name": "ResourceNameStatus", + "modelAsString": true + } + } + }, + "description": "Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word" + }, "Operation": { "description": "Microsoft.Resources operation", "type": "object", @@ -424,6 +528,15 @@ "description": "The ID of the target subscription.", "x-ms-parameter-location": "method" }, + "CheckResourceNameParameter": { + "description": "Resource object with values for resource name and resource type", + "in": "body", + "name": "Resource Name Definition", + "schema": { + "$ref": "#/definitions/ResourceName" + }, + "x-ms-parameter-location": "method" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-06-01/examples/CheckResourceName.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-06-01/examples/CheckResourceName.json new file mode 100644 index 000000000000..72412b20f92a --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-06-01/examples/CheckResourceName.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "body": [ + { + "Name": "isxbox", + "Type": "ResourceProviderTestHost/TestResourceType" + } + ], + "api-version": "2019-06-01" + }, + "responses": { + "200": { + "body": { + "name": "isxbox", + "type": "ResourceProviderTestHost/TestResourceType", + "status": "Allowed" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-06-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-06-01/subscriptions.json index c64abcc4164a..984bf3ead13f 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-06-01/subscriptions.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-06-01/subscriptions.json @@ -172,6 +172,46 @@ "nextLinkName": "nextLink" } } + }, + "/providers/Microsoft.Resources/checkResourceName": { + "post": { + "tags": [ + "Tenants" + ], + "operationId": "checkResourceName", + "description": "A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word", + "summary": "Checks resource name validity", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/CheckResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns status as allowed or not.", + "schema": { + "$ref": "#/definitions/CheckResourceNameResult" + } + }, + "default": { + "description": "Error response saying resource name is invalid", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check validity for a resource name.": { + "$ref": "./examples/CheckResourceName.json" + } + } + } } }, "definitions": { @@ -408,6 +448,70 @@ ], "description": "Tenant Ids information." }, + "ResourceName": { + "description": "Name and Type of the Resource", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of the resource" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error description and code explaining why resource name is invalid.", + "properties": { + "message": { + "type": "string", + "description": "Description of the error." + }, + "code": { + "type": "string", + "description": "Code of the error." + } + } + }, + "CheckResourceNameResult": { + "properties": { + "name": { + "description": "Name of Resource", + "type": "string" + }, + "type": { + "description": "Type of Resource", + "type": "string" + }, + "status": { + "description": "Is the resource name Allowed or Reserved", + "type": "string", + "enum": [ + "Allowed", + "Reserved" + ], + "x-ms-enum": { + "name": "ResourceNameStatus", + "modelAsString": true + } + } + }, + "description": "Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word" + }, "Operation": { "description": "Microsoft.Resources operation", "type": "object", @@ -465,6 +569,15 @@ "description": "The ID of the target subscription.", "x-ms-parameter-location": "method" }, + "CheckResourceNameParameter": { + "description": "Resource object with values for resource name and resource type", + "in": "body", + "name": "Resource Name Definition", + "schema": { + "$ref": "#/definitions/ResourceName" + }, + "x-ms-parameter-location": "method" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-11-01/examples/CheckResourceName.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-11-01/examples/CheckResourceName.json new file mode 100644 index 000000000000..584176e6f6d6 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-11-01/examples/CheckResourceName.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "body": [ + { + "Name": "isxbox", + "Type": "ResourceProviderTestHost/TestResourceType" + } + ], + "api-version": "2019-11-01" + }, + "responses": { + "200": { + "body": { + "name": "isxbox", + "type": "ResourceProviderTestHost/TestResourceType", + "status": "Allowed" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-11-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-11-01/subscriptions.json index a10bc931ed11..ad98623bf852 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2019-11-01/subscriptions.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2019-11-01/subscriptions.json @@ -177,6 +177,46 @@ "nextLinkName": "nextLink" } } + }, + "/providers/Microsoft.Resources/checkResourceName": { + "post": { + "tags": [ + "Tenants" + ], + "operationId": "checkResourceName", + "description": "A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word", + "summary": "Checks resource name validity", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/CheckResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns status as allowed or not.", + "schema": { + "$ref": "#/definitions/CheckResourceNameResult" + } + }, + "default": { + "description": "Error response saying resource name is invalid", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check validity for a resource name.": { + "$ref": "./examples/CheckResourceName.json" + } + } + } } }, "definitions": { @@ -498,6 +538,70 @@ ], "description": "Tenant Ids information." }, + "ResourceName": { + "description": "Name and Type of the Resource", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of the resource" + } + } + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error description and code explaining why resource name is invalid.", + "properties": { + "message": { + "type": "string", + "description": "Description of the error." + }, + "code": { + "type": "string", + "description": "Code of the error." + } + } + }, + "CheckResourceNameResult": { + "properties": { + "name": { + "description": "Name of Resource", + "type": "string" + }, + "type": { + "description": "Type of Resource", + "type": "string" + }, + "status": { + "description": "Is the resource name Allowed or Reserved", + "type": "string", + "enum": [ + "Allowed", + "Reserved" + ], + "x-ms-enum": { + "name": "ResourceNameStatus", + "modelAsString": true + } + } + }, + "description": "Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word" + }, "Operation": { "description": "Microsoft.Resources operation", "type": "object", @@ -555,6 +659,15 @@ "description": "The ID of the target subscription.", "x-ms-parameter-location": "method" }, + "CheckResourceNameParameter": { + "description": "Resource object with values for resource name and resource type", + "in": "body", + "name": "Resource Name Definition", + "schema": { + "$ref": "#/definitions/ResourceName" + }, + "x-ms-parameter-location": "method" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/examples/CheckResourceName.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/examples/CheckResourceName.json new file mode 100644 index 000000000000..84ec179e05d9 --- /dev/null +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/examples/CheckResourceName.json @@ -0,0 +1,20 @@ +{ + "parameters": { + "body": [ + { + "Name": "isxbox", + "Type": "ResourceProviderTestHost/TestResourceType" + } + ], + "api-version": "2020-01-01" + }, + "responses": { + "200": { + "body": { + "name": "isxbox", + "type": "ResourceProviderTestHost/TestResourceType", + "status": "Allowed" + } + } + } +} diff --git a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/subscriptions.json b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/subscriptions.json index ee5d51274e47..b70ab71ed858 100644 --- a/specification/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/subscriptions.json +++ b/specification/resources/resource-manager/Microsoft.Resources/stable/2020-01-01/subscriptions.json @@ -182,6 +182,46 @@ "nextLinkName": "nextLink" } } + }, + "/providers/Microsoft.Resources/checkResourceName": { + "post": { + "tags": [ + "Tenants" + ], + "operationId": "checkResourceName", + "description": "A resource name is valid if it is not a reserved word, does not contains a reserved word and does not start with a reserved word", + "summary": "Checks resource name validity", + "consumes": [ + "application/json" + ], + "parameters": [ + { + "$ref": "#/parameters/CheckResourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "OK - Returns status as allowed or not.", + "schema": { + "$ref": "#/definitions/CheckResourceNameResult" + } + }, + "default": { + "description": "Error response saying resource name is invalid", + "schema": { + "$ref": "#/definitions/ErrorResponse" + } + } + }, + "x-ms-examples": { + "Check validity for a resource name.": { + "$ref": "./examples/CheckResourceName.json" + } + } + } } }, "definitions": { @@ -518,6 +558,70 @@ ], "description": "Tenant Ids information." }, + "ResourceName": { + "description": "Name and Type of the Resource", + "required": [ + "name", + "type" + ], + "properties": { + "name": { + "description": "Name of the resource", + "type": "string" + }, + "type": { + "type": "string", + "description": "The type of the resource" + } + } + }, + "CheckResourceNameResult": { + "properties": { + "name": { + "description": "Name of Resource", + "type": "string" + }, + "type": { + "description": "Type of Resource", + "type": "string" + }, + "status": { + "description": "Is the resource name Allowed or Reserved", + "type": "string", + "enum": [ + "Allowed", + "Reserved" + ], + "x-ms-enum": { + "name": "ResourceNameStatus", + "modelAsString": true + } + } + }, + "description": "Resource Name valid if not a reserved word, does not contain a reserved word and does not start with a reserved word" + }, + "ErrorResponse": { + "description": "Error response.", + "properties": { + "error": { + "$ref": "#/definitions/ErrorDefinition", + "description": "The error details." + } + } + }, + "ErrorDefinition": { + "description": "Error description and code explaining why resource name is invalid.", + "properties": { + "message": { + "type": "string", + "description": "Description of the error." + }, + "code": { + "type": "string", + "description": "Code of the error." + } + } + }, "Operation": { "description": "Microsoft.Resources operation", "type": "object", @@ -575,6 +679,15 @@ "description": "The ID of the target subscription.", "x-ms-parameter-location": "method" }, + "CheckResourceNameParameter": { + "description": "Resource object with values for resource name and resource type", + "in": "body", + "name": "Resource Name Definition", + "schema": { + "$ref": "#/definitions/ResourceName" + }, + "x-ms-parameter-location": "method" + }, "ApiVersionParameter": { "name": "api-version", "in": "query", diff --git a/specification/resources/resource-manager/readme.md b/specification/resources/resource-manager/readme.md index b09c755b4088..90a7ddc9e204 100644 --- a/specification/resources/resource-manager/readme.md +++ b/specification/resources/resource-manager/readme.md @@ -661,6 +661,9 @@ input-file: - Microsoft.Authorization/stable/2016-12-01/policyAssignments.json - Microsoft.Resources/stable/2016-06-01/subscriptions.json - Microsoft.Resources/stable/2018-05-01/resources.json + +override-info: + title: PolicyClient ``` ## Multi-API/Profile support for AutoRest v3 generators From 8bff672a779bcdc33e475dd623be060966debe4d Mon Sep 17 00:00:00 2001 From: Jingshu923 <52914166+Jingshu923@users.noreply.github.com> Date: Mon, 13 Jul 2020 09:59:45 +0800 Subject: [PATCH 305/318] Square add connectionProperties property (#10055) --- .../stable/2018-06-01/entityTypes/LinkedService.json | 11 +++++------ 1 file changed, 5 insertions(+), 6 deletions(-) diff --git a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json index b3bd70ab2051..8e8356c82b5c 100644 --- a/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json +++ b/specification/datafactory/resource-manager/Microsoft.DataFactory/stable/2018-06-01/entityTypes/LinkedService.json @@ -4641,6 +4641,10 @@ "SquareLinkedServiceTypeProperties": { "description": "Square Service linked service properties.", "properties": { + "connectionProperties": { + "description": "Properties used to connect to Square. It is mutually exclusive with any other properties in the linked service. Type: object.", + "type": "object" + }, "host": { "description": "The URL of the Square instance. (i.e. mystore.mysquare.com)", "type": "object" @@ -4673,12 +4677,7 @@ "description": "The encrypted credential used for authentication. Credentials are encrypted using the integration runtime credential manager. Type: string (or Expression with resultType string).", "type": "object" } - }, - "required": [ - "host", - "clientId", - "redirectUri" - ] + } }, "XeroLinkedService": { "x-ms-discriminator-value": "Xero", From 58eea31e892bf96dc30932e0629ea2a5f0ec3018 Mon Sep 17 00:00:00 2001 From: ityankel <47292630+ityankel@users.noreply.github.com> Date: Mon, 13 Jul 2020 07:46:14 +0300 Subject: [PATCH 306/318] Add subscriptionId field to AzureResource model (#10042) * Add subscriptionId field to AzureResource entity * wip --- .../preview/2019-01-01-preview/SecurityInsights.json | 5 +++++ .../examples/entities/GetAzureResourceEntityById.json | 3 ++- 2 files changed, 7 insertions(+), 1 deletion(-) diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json index 0bfdb0305304..b31e37a057d8 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json @@ -4061,6 +4061,11 @@ "description": "The azure resource id of the resource", "readOnly": true, "type": "string" + }, + "subscriptionId": { + "description": "The subscription id of the resource", + "readOnly": true, + "type": "string" } }, "type": "object" diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetAzureResourceEntityById.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetAzureResourceEntityById.json index d630c9f4f3ec..e4e589b66489 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetAzureResourceEntityById.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/examples/entities/GetAzureResourceEntityById.json @@ -16,7 +16,8 @@ "kind": "AzureResource", "properties": { "friendlyName": "vm1", - "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1" + "resourceId": "/subscriptions/d0cfe6b2-9ac0-4464-9919-dccaee2e48c0/resourceGroups/myRg/providers/Microsoft.Compute/virtualMachines/vm1", + "subscriptionId": "d0cfe6b2-9ac0-4464-9919-dccaee2e48c0" } } } From ef1a9a245015ed4677515a06bd7165feacd5da0f Mon Sep 17 00:00:00 2001 From: sashahdo <64434373+sashahdo@users.noreply.github.com> Date: Sun, 12 Jul 2020 23:22:57 -0700 Subject: [PATCH 307/318] [Hub Generated] Review request for Microsoft.Consumption to add version stable/2019-10-01 (#9927) * fixed examples and BudgetCategory as PM suggested * fixed circularly dependent BudgetFilter * Set theme jekyll-theme-hacker * fixed missing property errors * refactored with better name * added period * fixed examples and BudgetCategory as PM suggested * fixed circularly dependent BudgetFilter * fixed missing property errors * refactored with better name * added period * Revert "Set theme jekyll-theme-hacker" This reverts commit 787aea392435c49be8626663789b7b5cc5c19a2a. * fixed prettier issue * removed unnecessary object attribute --- .../stable/2019-10-01/consumption.json | 17 +++++++++++++++-- 1 file changed, 15 insertions(+), 2 deletions(-) diff --git a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json index 7a1a4c264a8e..071d5f14e011 100644 --- a/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json +++ b/specification/consumption/resource-manager/Microsoft.Consumption/stable/2019-10-01/consumption.json @@ -3871,14 +3871,27 @@ "description": "The logical \"AND\" expression. Must have at least 2 items.", "type": "array", "items": { - "$ref": "#/definitions/BudgetFilter" + "$ref": "#/definitions/BudgetFilterProperties" }, "minItems": 2 }, "not": { "description": "The logical \"NOT\" expression.", - "$ref": "#/definitions/BudgetFilter" + "$ref": "#/definitions/BudgetFilterProperties" + }, + "dimensions": { + "description": "Has comparison expression for a dimension", + "$ref": "#/definitions/BudgetComparisonExpression" }, + "tags": { + "description": "Has comparison expression for a tag", + "$ref": "#/definitions/BudgetComparisonExpression" + } + } + }, + "BudgetFilterProperties": { + "description": "The Dimensions or Tags to filter a budget by.", + "properties": { "dimensions": { "description": "Has comparison expression for a dimension", "$ref": "#/definitions/BudgetComparisonExpression" From 7f1b65db7aa74b4668d000eb27c1c0ffd8d91334 Mon Sep 17 00:00:00 2001 From: Lei Ni <7233663+leni-msft@users.noreply.github.com> Date: Mon, 13 Jul 2020 16:35:56 +0800 Subject: [PATCH 308/318] fix readme syntax error (#10103) --- specification/mariadb/resource-manager/readme.md | 1 + 1 file changed, 1 insertion(+) diff --git a/specification/mariadb/resource-manager/readme.md b/specification/mariadb/resource-manager/readme.md index 129157c55673..fb7d252ad882 100644 --- a/specification/mariadb/resource-manager/readme.md +++ b/specification/mariadb/resource-manager/readme.md @@ -86,6 +86,7 @@ These settings apply only when `--tag=package-2020-01-01` is specified on the co input-file: - Microsoft.DBforMariaDB/stable/2018-06-01/mariadb.json - Microsoft.DBforMariaDB/stable/2020-01-01/ServerSecurityAlertPolicies.json +``` --- # Code Generation From e8cc80ff277d3ef81677fa48832529205db219eb Mon Sep 17 00:00:00 2001 From: Dania Etienne Date: Mon, 13 Jul 2020 21:15:43 -0400 Subject: [PATCH 309/318] Daetienn/python readme update for latest sdk generation (#10118) * package-templatespecs-2019-06-preview tag added * Fixed SDK generation * removed extra deployment scripts tag * Fixed SDK Generation * Spelling err * Output folder for templatespecs generation has been fixed * Reverted Co-authored-by: Dania Etienne --- specification/resources/resource-manager/readme.python.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/specification/resources/resource-manager/readme.python.md b/specification/resources/resource-manager/readme.python.md index e21a9796e1f3..6371fe633fa0 100644 --- a/specification/resources/resource-manager/readme.python.md +++ b/specification/resources/resource-manager/readme.python.md @@ -560,9 +560,9 @@ These settings apply only when `--tag=package-templatespecs-2019-06-preview` is Please also specify `--python-sdks-folder=`. ``` yaml $(tag) == 'package-templatespecs-2019-06-preview' -namespace: azure.mgmt.resource.templatespecs.v2019_06_preview -output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/templatespecs/v2019_06_preview +namespace: azure.mgmt.resource.templatespecs.v2019_06_01_preview +output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/templatespecs/v2019_06_01_preview python: - namespace: azure.mgmt.resource.templatespecs.v2019_06_preview - output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/templatespecs/v2019_06_preview + namespace: azure.mgmt.resource.templatespecs.v2019_06_01_preview + output-folder: $(python-sdks-folder)/resources/azure-mgmt-resource/azure/mgmt/resource/templatespecs/v2019_06_01_preview ``` From c2b21fb778285166f03fadc98860623a810affb8 Mon Sep 17 00:00:00 2001 From: Milan Brkic Date: Tue, 14 Jul 2020 03:45:05 +0200 Subject: [PATCH 310/318] [Fix] Microsoft.Azure.Management.SqlManagement readme version fix (#10097) * fix version * fix version in readme Co-authored-by: Milan Brkic --- specification/sql/resource-manager/readme.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/specification/sql/resource-manager/readme.md b/specification/sql/resource-manager/readme.md index 135eea154e63..bb93264ff82f 100644 --- a/specification/sql/resource-manager/readme.md +++ b/specification/sql/resource-manager/readme.md @@ -135,12 +135,12 @@ input-file: - Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceLongTermRetentionPolicies.json - Microsoft.Sql/preview/2019-06-01-preview/WorkloadGroups.json - Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json -- Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json - Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json - Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json - Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json - Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json - Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json +- Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json # Needed when there is more than one input file override-info: @@ -238,11 +238,11 @@ input-file: - Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceLongTermRetentionPolicies.json - Microsoft.Sql/preview/2019-06-01-preview/WorkloadGroups.json - Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json -- Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json - Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json - Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json - Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json - Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json +- Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json # Needed when there is more than one input file override-info: @@ -329,11 +329,11 @@ input-file: - Microsoft.Sql/preview/2018-06-01-preview/ManagedInstanceLongTermRetentionPolicies.json - Microsoft.Sql/preview/2019-06-01-preview/WorkloadGroups.json - Microsoft.Sql/preview/2019-06-01-preview/WorkloadClassifiers.json -- Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json - Microsoft.Sql/preview/2019-06-01-preview/ServerAzureADAdministrators.json - Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json - Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json - Microsoft.Sql/preview/2019-06-01-preview/FailoverManagedInstance.json +- Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json # Needed when there is more than one input file override-info: @@ -897,6 +897,7 @@ input-file: - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/managedInstanceOperations.json - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/syncGroups.json - $(this-folder)/Microsoft.Sql/preview/2019-06-01-preview/syncMembers.json + - $(this-folder)/Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json - $(this-folder)/Microsoft.Sql/stable/2014-04-01/capabilities.json - $(this-folder)/Microsoft.Sql/stable/2014-04-01/databases.json - $(this-folder)/Microsoft.Sql/stable/2014-04-01/elasticPools.json @@ -914,6 +915,7 @@ input-file: - $(this-folder)/Microsoft.Sql/stable/2014-04-01/restorePoints.json - $(this-folder)/Microsoft.Sql/stable/2015-05-01/capabilities.json - $(this-folder)/Microsoft.Sql/preview/2015-05-01-preview/blobAuditing.json + - $(this-folder)/./Microsoft.Sql/preview/2020-02-02-preview/managedDatabases.json - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/databases.json - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/managedDatabases.json - $(this-folder)/./Microsoft.Sql/preview/2019-06-01-preview/serverOperations.json From 09477058dede72467bd1f67cf75e4a600c660fb3 Mon Sep 17 00:00:00 2001 From: Amir Keren Date: Tue, 14 Jul 2020 05:40:03 +0300 Subject: [PATCH 311/318] Add resourceIdentifiers to securityAlertArmModel (#10079) Co-authored-by: Amir Keren --- .../preview/2019-01-01-preview/SecurityInsights.json | 8 ++++++++ 1 file changed, 8 insertions(+) diff --git a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json index b31e37a057d8..b7c7afad2beb 100644 --- a/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json +++ b/specification/securityinsights/resource-manager/Microsoft.SecurityInsights/preview/2019-01-01-preview/SecurityInsights.json @@ -7829,6 +7829,14 @@ "description": "The uri link of the alert.", "readOnly": true, "type": "string" + }, + "resourceIdentifiers": { + "description": "The list of resource identifiers of the alert.", + "items": { + "type": "object" + }, + "readOnly": true, + "type": "array" } }, "type": "object" From 69cbad3b1bedf7c9e05a5c3a159fa412d85a2eeb Mon Sep 17 00:00:00 2001 From: Arthur Ning <57385816+akning-ms@users.noreply.github.com> Date: Tue, 14 Jul 2020 11:20:01 +0800 Subject: [PATCH 312/318] Update example to fix secret scan issue Update example to fix secret scan issue by remove password string --- .../stable/2014-04-01/examples/ServerCreateMax.json | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ServerCreateMax.json b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ServerCreateMax.json index 0aa9a485433a..dd83d0701e23 100644 --- a/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ServerCreateMax.json +++ b/specification/sql/resource-manager/Microsoft.Sql/stable/2014-04-01/examples/ServerCreateMax.json @@ -12,7 +12,7 @@ "properties": { "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net", "administratorLogin": "dummylogin", - "administratorLoginPassword": "Un53cuRE!", + "administratorLoginPassword": "dummy", "version": "12.0", "state": "Ready" } @@ -32,7 +32,7 @@ "properties": { "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net", "administratorLogin": "dummylogin", - "administratorLoginPassword": "Un53cuRE!", + "administratorLoginPassword": "dummy", "externalAdministratorLogin": null, "externalAdministratorSid": null, "version": "12.0", @@ -53,7 +53,7 @@ "properties": { "fullyQualifiedDomainName": "sqlcrudtest-4645.database.windows.net", "administratorLogin": "dummylogin", - "administratorLoginPassword": "Un53cuRE!", + "administratorLoginPassword": "dummy", "externalAdministratorLogin": null, "externalAdministratorSid": null, "version": "12.0", From 5e4f3618b867bda05421cd8250454374bde88680 Mon Sep 17 00:00:00 2001 From: Zhenglai Zhang Date: Tue, 14 Jul 2020 12:03:04 +0800 Subject: [PATCH 313/318] update breaking change process in PULL_REQUEST_TEMPLATE.md (#10106) * update breaking change process in PULL_REQUEST_TEMPLATE.md * update breaking change url --- .github/PULL_REQUEST_TEMPLATE.md | 26 +++++++++++++++++--------- 1 file changed, 17 insertions(+), 9 deletions(-) diff --git a/.github/PULL_REQUEST_TEMPLATE.md b/.github/PULL_REQUEST_TEMPLATE.md index b8293d9af7b5..3c2cfcde11b6 100644 --- a/.github/PULL_REQUEST_TEMPLATE.md +++ b/.github/PULL_REQUEST_TEMPLATE.md @@ -2,19 +2,27 @@ ### Contribution checklist: +- [ ] I commit to follow the [Breaking Change Policy](http://aka.ms/bcforapi) of “no breaking changes - [ ] I have reviewed the [documentation](https://aka.ms/ameonboard) for the workflow. -- [ ] [Validation tools](https://aka.ms/swaggertools) were run on swagger spec(s) and have all been fixed in this PR. [How to fix?](https://aka.ms/ci-fix) +- [ ] [Validation tools](https://aka.ms/swaggertools) were run on swagger spec(s) and errors have all been fixed in this PR. [How to fix?](https://aka.ms/ci-fix) If any further question about AME onboarding or validation tools, please view the [FAQ](https://aka.ms/faqinprreview). ### ARM API Review Checklist -- [ ] Service team MUST add the "**WaitForARMFeedback**" label if the management plane API changes fall into one of the below categories. - - adding/removing APIs. - - adding/removing properties. - - adding/removing API-version. - - adding a new service in Azure. +- [ ] Ensure to check this box if one of the following scenarios meet updates in the PR, so that label “WaitForARMFeedback” will be added automatically to involve ARM API Review. Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs, all “removals” and “adding a new property” no more require ARM API review. + - Adding new API(s) + - Adding a new API version + - Adding a new service -Failure to comply may result in delays for manifest application. Note this does not apply to data plane APIs. +- [ ] If you are blocked on ARM review and want to get the PR merged with urgency, please get the ARM oncall for reviews (*RP Manifest Approvers* team under Azure Resource Manager service) from IcM and reach out to them. -- [ ] If you are blocked on ARM review and want to get the PR merged urgently, please get the ARM oncall for reviews (RP Manifest Approvers team under Azure Resource Manager service) from IcM and reach out to them. -Please follow the link to find more details on [API review process](https://aka.ms/SwaggerPRReview). +### Breaking Change Review Checklist +If there are following updates in the PR, ensure to request an approval from API Review Board as defined in the [Breaking Change Policy](http://aka.ms/bcforapi). + +- [ ] Removing API(s) in stable version +- [ ] Removing properties in stable version +- [ ] Removing API version(s) in stable version +- [ ] Updating API in stable version with Breaking Change Validation errors +- [ ] Updating API(s) in preview over 1 year + +Please follow the link to find more details on [PR review process](https://aka.ms/SwaggerPRReview). \ No newline at end of file From 00ac1cbffba123ba5e30cb324935100495d0700d Mon Sep 17 00:00:00 2001 From: Richard Li Date: Mon, 13 Jul 2020 23:18:17 -0700 Subject: [PATCH 314/318] set readonly for id, name, type. (#9948) * set readonly for id, name, type. * set x-ms-azure-resource Co-authored-by: Richard Li --- .../2020-04-01-preview/machineLearningServices.json | 10 +++++++--- 1 file changed, 7 insertions(+), 3 deletions(-) diff --git a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json index 7e5360f90b5d..3df91cd7198e 100644 --- a/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json +++ b/specification/machinelearningservices/resource-manager/Microsoft.MachineLearningServices/preview/2020-04-01-preview/machineLearningServices.json @@ -3547,18 +3547,22 @@ "LinkedWorkspace": { "description": "Linked workspace.", "type": "object", + "x-ms-azure-resource": true, "properties": { "id": { "type": "string", - "description": "ResourceId of the link of the linked workspace." + "description": "ResourceId of the link of the linked workspace.", + "readOnly": true }, "name": { "type": "string", - "description": "Friendly name of the linked workspace." + "description": "Friendly name of the linked workspace.", + "readOnly": true }, "type": { "type": "string", - "description": "Resource type of linked workspace." + "description": "Resource type of linked workspace.", + "readOnly": true }, "properties": { "$ref": "#/definitions/LinkedWorkspaceProps" From 4d7a4424bf14aaf73fcca5a3158336305c3d7ac1 Mon Sep 17 00:00:00 2001 From: Ric Serradas Date: Tue, 14 Jul 2020 18:58:46 -0700 Subject: [PATCH 315/318] Adding the TSI GA api-version (2020-05-15) (#9974) * First draft of the changes * Minor fixes before publishing the PR * Adding 2020-05-15 to readme * Removing examples that are not referenced anywhere * Adding the suppressions * Removing EnvironmentsGetExpandStatus.json * Adding 2020-05-15 in places it was missing in readme.md --- .../examples/AccessPoliciesCreate.json | 48 + .../examples/AccessPoliciesDelete.json | 13 + .../examples/AccessPoliciesGet.json | 25 + .../AccessPoliciesListByEnvironment.json | 28 + .../examples/AccessPoliciesPatchRoles.json | 33 + .../examples/EnvironmentsCreate.json | 66 + .../examples/EnvironmentsDelete.json | 12 + .../2020-05-15/examples/EnvironmentsGet.json | 35 + .../EnvironmentsListByResourceGroup.json | 32 + .../EnvironmentsListBySubscription.json | 31 + .../examples/EnvironmentsPatchTags.json | 36 + .../examples/EventSourcesCreateEventHub.json | 62 + .../examples/EventSourcesDelete.json | 13 + .../examples/EventSourcesGetEventHub.json | 30 + .../EventSourcesListByEnvironment.json | 33 + .../examples/EventSourcesPatchTags.json | 38 + .../2020-05-15/examples/Operation_List.json | 130 + .../examples/ReferenceDataSetsCreate.json | 72 + .../examples/ReferenceDataSetsDelete.json | 13 + .../examples/ReferenceDataSetsGet.json | 34 + .../ReferenceDataSetsListByEnvironment.json | 37 + .../examples/ReferenceDataSetsPatchTags.json | 41 + .../stable/2020-05-15/timeseriesinsights.json | 2546 +++++++++++++++++ .../resource-manager/readme.go.md | 10 + .../resource-manager/readme.md | 30 +- 25 files changed, 3447 insertions(+), 1 deletion(-) create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesCreate.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesDelete.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesGet.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesListByEnvironment.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesPatchRoles.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsCreate.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsDelete.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsGet.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsListByResourceGroup.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsListBySubscription.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsPatchTags.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHub.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesDelete.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesPatchTags.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/Operation_List.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsCreate.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsDelete.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsGet.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsListByEnvironment.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsPatchTags.json create mode 100644 specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesCreate.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesCreate.json new file mode 100644 index 000000000000..745db3d2b2b0 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesCreate.json @@ -0,0 +1,48 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "parameters": { + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + }, + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesDelete.json new file mode 100644 index 000000000000..0c6c00026616 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "api-version": "2020-05-15" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesGet.json new file mode 100644 index 000000000000..36b5f2ce55a1 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesGet.json @@ -0,0 +1,25 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesListByEnvironment.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesListByEnvironment.json new file mode 100644 index 000000000000..7943ee75b9e5 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesListByEnvironment.json @@ -0,0 +1,28 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesPatchRoles.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesPatchRoles.json new file mode 100644 index 000000000000..eee7eca6b48c --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/AccessPoliciesPatchRoles.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "accessPolicyName": "ap1", + "accessPolicyUpdateParameters": { + "properties": { + "roles": [ + "Reader", + "Contributor" + ] + } + }, + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/accessPolicies/ap1", + "name": "ap1", + "type": "Microsoft.TimeSeriesInsights/Environments/AccessPolicies", + "properties": { + "principalObjectId": "aGuid", + "roles": [ + "Reader" + ], + "description": "some description" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsCreate.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsCreate.json new file mode 100644 index 000000000000..395ac06f9a74 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsCreate.json @@ -0,0 +1,66 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "parameters": { + "location": "West US", + "kind": "Gen1", + "sku": { + "name": "S1", + "capacity": 1 + }, + "properties": { + "dataRetentionTime": "P31D", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ] + } + }, + "api-version": "2020-05-15" + }, + "responses": { + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Creating", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + }, + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + }, + "404": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsDelete.json new file mode 100644 index 000000000000..9a3fc3cf043c --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsDelete.json @@ -0,0 +1,12 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2020-05-15" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsGet.json new file mode 100644 index 000000000000..0a0ab15646cc --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsGet.json @@ -0,0 +1,35 @@ +{ + "parameters": { + "subscriptionId": "subid", + "environmentName": "env1", + "resourceGroupName": "rg1", + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "partitionKeyProperties": [ + { + "name": "DeviceId1", + "type": "String" + } + ] + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsListByResourceGroup.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsListByResourceGroup.json new file mode 100644 index 000000000000..3128b3942bff --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsListByResourceGroup.json @@ -0,0 +1,32 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsListBySubscription.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsListBySubscription.json new file mode 100644 index 000000000000..f43ba6e3e416 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsListBySubscription.json @@ -0,0 +1,31 @@ +{ + "parameters": { + "subscriptionId": "subid", + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": {}, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 1 + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsPatchTags.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsPatchTags.json new file mode 100644 index 000000000000..12857c98008c --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EnvironmentsPatchTags.json @@ -0,0 +1,36 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "environmentUpdateParameters": { + "tags": { + "someTag": "someTagValue" + } + }, + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1", + "location": "West US", + "name": "env1", + "type": "Microsoft.TimeSeriesInsights/Environments", + "kind": "Gen1", + "tags": { + "someTag": "someTagValue" + }, + "properties": { + "dataRetentionTime": "P31D", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + }, + "sku": { + "name": "S1", + "capacity": 10 + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHub.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHub.json new file mode 100644 index 000000000000..70ada05d2e07 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesCreateEventHub.json @@ -0,0 +1,62 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "parameters": { + "location": "West US", + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "sharedAccessKey": "someSecretvalue", + "timestampPropertyName": "someTimestampProperty" + } + }, + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesDelete.json new file mode 100644 index 000000000000..04610f52f691 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "api-version": "2020-05-15" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json new file mode 100644 index 000000000000..610270bd8d01 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesGetEventHub.json @@ -0,0 +1,30 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json new file mode 100644 index 000000000000..09aae4112733 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesListByEnvironment.json @@ -0,0 +1,33 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": {}, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesPatchTags.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesPatchTags.json new file mode 100644 index 000000000000..0473904851c2 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/EventSourcesPatchTags.json @@ -0,0 +1,38 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "eventSourceName": "es1", + "eventSourceUpdateParameters": { + "tags": { + "someKey": "someValue" + } + }, + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/eventSources/es1", + "location": "West US", + "name": "es1", + "type": "Microsoft.TimeSeriesInsights/Environments/EventSources", + "tags": { + "someKey": "someValue" + }, + "kind": "Microsoft.EventHub", + "properties": { + "eventSourceResourceId": "somePathInArm", + "serviceBusNamespace": "sbn", + "consumerGroupName": "cgn", + "eventHubName": "ehn", + "keyName": "managementKey", + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z", + "timestampPropertyName": "someOtherTimestampProperty" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/Operation_List.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/Operation_List.json new file mode 100644 index 000000000000..a418b7799b6d --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/Operation_List.json @@ -0,0 +1,130 @@ +{ + "parameters": { + "api-version": "2016-03-01" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "name": "Microsoft.TimeSeriesInsights/register/action", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Time Series Insights Resource Provider", + "operation": "Registers the Time Series Insights Resource Provider", + "description": "Registers the subscription for the Time Series Insights resource provider and enables the creation of Time Series Insights environments." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Read Environment", + "description": "Get the properties of an environment." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Create or Update Environment", + "description": "Creates a new environment, or updates an existing environment." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Environment", + "operation": "Delete Environment", + "description": "Deletes the environment." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Read Event Source", + "description": "Get the properties of an event source." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Create or Update Event Source", + "description": "Creates a new event source for an environment, or updates an existing event source." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/eventsources/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Event Source", + "operation": "Delete Event Source", + "description": "Deletes the event source." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Reference Data Set", + "operation": "Read Reference Data Set", + "description": "Get the properties of a reference data set." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Reference Data Set", + "operation": "Create or Update Reference Data Set", + "description": "Creates a new reference data set for an environment, or updates an existing reference data set." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/referencedatasets/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Reference Data Set", + "operation": "Delete Reference Data Set", + "description": "Deletes the reference data set." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/read", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Access Policy", + "operation": "Read Access Policy", + "description": "Get the properties of an access policy." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/write", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Access Policy", + "operation": "Create or Update Access Policy", + "description": "Creates a new access policy for an environment, or updates an existing access policy." + } + }, + { + "name": "Microsoft.TimeSeriesInsights/environments/accesspolicies/delete", + "display": { + "provider": "Microsoft Time Series Insights", + "resource": "Access Policy", + "operation": "Delete Access Policy", + "description": "Deletes the access policy." + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsCreate.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsCreate.json new file mode 100644 index 000000000000..f72dc4f835fa --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsCreate.json @@ -0,0 +1,72 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "parameters": { + "location": "West US", + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ] + } + }, + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + }, + "201": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsDelete.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsDelete.json new file mode 100644 index 000000000000..86b29fdc002d --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsDelete.json @@ -0,0 +1,13 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "api-version": "2020-05-15" + }, + "responses": { + "200": {}, + "204": {} + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsGet.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsGet.json new file mode 100644 index 000000000000..6442a481f421 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsGet.json @@ -0,0 +1,34 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsListByEnvironment.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsListByEnvironment.json new file mode 100644 index 000000000000..ed583ffd4752 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsListByEnvironment.json @@ -0,0 +1,37 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "value": [ + { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": {}, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + ] + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsPatchTags.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsPatchTags.json new file mode 100644 index 000000000000..89531e16c2a7 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/examples/ReferenceDataSetsPatchTags.json @@ -0,0 +1,41 @@ +{ + "parameters": { + "subscriptionId": "subid", + "resourceGroupName": "rg1", + "environmentName": "env1", + "referenceDataSetName": "rds1", + "referenceDataSetUpdateParameters": { + "tags": { + "someKey": "someValue" + } + }, + "api-version": "2020-05-15" + }, + "responses": { + "200": { + "body": { + "id": "/subscriptions/subid/resourceGroups/rg1/providers/Microsoft.TimeSeriesInsights/Environments/env1/referenceDataSets/rds1", + "location": "West US", + "name": "rds1", + "type": "Microsoft.TimeSeriesInsights/Environments/ReferenceDataSets", + "tags": { + "someKey": "someValue" + }, + "properties": { + "keyProperties": [ + { + "name": "DeviceId1", + "type": "String" + }, + { + "name": "DeviceFloor", + "type": "Double" + } + ], + "provisioningState": "Succeeded", + "creationTime": "2017-04-18T19:20:33.2288820Z" + } + } + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json new file mode 100644 index 000000000000..6cd1256aee02 --- /dev/null +++ b/specification/timeseriesinsights/resource-manager/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json @@ -0,0 +1,2546 @@ +{ + "swagger": "2.0", + "info": { + "title": "TimeSeriesInsightsClient", + "description": "Time Series Insights client", + "version": "2020-05-15" + }, + "host": "management.azure.com", + "schemes": [ + "https" + ], + "consumes": [ + "application/json" + ], + "produces": [ + "application/json" + ], + "security": [ + { + "azure_auth": [ + "user_impersonation" + ] + } + ], + "securityDefinitions": { + "azure_auth": { + "type": "oauth2", + "authorizationUrl": "https://login.microsoftonline.com/common/oauth2/authorize", + "flow": "implicit", + "description": "Azure Active Directory OAuth2 Flow", + "scopes": { + "user_impersonation": "impersonate your user account" + } + } + }, + "paths": { + "/providers/Microsoft.TimeSeriesInsights/operations": { + "get": { + "tags": [ + "Operations" + ], + "operationId": "Operations_List", + "description": "Lists all of the available Time Series Insights related operations.", + "x-ms-examples": { + "List available operations for the Time Series Insights resource provider": { + "$ref": "./examples/Operation_List.json" + } + }, + "parameters": [ + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Successfully listed the available operations.", + "schema": { + "$ref": "#/definitions/OperationListResult" + } + } + }, + "x-ms-pageable": { + "nextLinkName": "nextLink" + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}": { + "put": { + "tags": [ + "Environments" + ], + "operationId": "Environments_CreateOrUpdate", + "x-ms-examples": { + "EnvironmentsCreate": { + "$ref": "./examples/EnvironmentsCreate.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Create or update an environment in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "name": "environmentName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "description": "Name of the environment" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentCreateOrUpdateParameters" + }, + "description": "Parameters for creating an environment resource." + } + ], + "responses": { + "200": { + "description": "The existing environment definition was successfully updated.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "201": { + "description": "The environment create request was accepted. Environment provisioning is an asynchronous operation. You can periodically get your environment definition and monitor progress via the provisioningState property.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "404": { + "description": "The subscription or resource group could not be found." + }, + "default": { + "description": "HTTP 400 (Bad Request): The given environment request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "Environments" + ], + "operationId": "Environments_Get", + "x-ms-examples": { + "EnvironmentsGet": { + "$ref": "./examples/EnvironmentsGet.json" + } + }, + "description": "Gets the environment with the specified name in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ExpandParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The environment definition was successfully retrieved and is in the response. If you are polling for the completion of a provisioning or scale operation, you can check its status via the provisioningState property.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "Environments" + ], + "operationId": "Environments_Update", + "x-ms-examples": { + "EnvironmentsUpdate": { + "$ref": "./examples/EnvironmentsPatchTags.json" + } + }, + "x-ms-long-running-operation": true, + "description": "Updates the environment with the specified name in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "environmentUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EnvironmentUpdateParameters" + }, + "description": "Request object that contains the updated information for the environment." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The environment definition was successfully updated and is in the response. If the environment was updated synchronously, the response will include a provisioningState value of \"Succeeded\". If the environment was updated asynchronously, the response will include a provisioningState value of \"Updating\". You can periodically get your environment definition and monitor progress of the update via the provisioningState property.", + "schema": { + "$ref": "#/definitions/EnvironmentResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "Environments" + ], + "operationId": "Environments_Delete", + "x-ms-examples": { + "EnvironmentsDelete": { + "$ref": "./examples/EnvironmentsDelete.json" + } + }, + "description": "Deletes the environment with the specified name in the specified subscription and resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The environment was successfully deleted." + }, + "204": { + "description": "The environment was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments": { + "get": { + "tags": [ + "Environments" + ], + "operationId": "Environments_ListByResourceGroup", + "x-ms-examples": { + "EnvironmentsByResourceGroup": { + "$ref": "./examples/EnvironmentsListByResourceGroup.json" + } + }, + "description": "Lists all the available environments associated with the subscription and within the specified resource group.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Environments returned successfully.", + "schema": { + "$ref": "#/definitions/EnvironmentListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, or resource group could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/providers/Microsoft.TimeSeriesInsights/environments": { + "get": { + "tags": [ + "Environments" + ], + "operationId": "Environments_ListBySubscription", + "x-ms-examples": { + "EnvironmentsBySubscription": { + "$ref": "./examples/EnvironmentsListBySubscription.json" + } + }, + "description": "Lists all the available environments within a subscription, irrespective of the resource groups.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Environments returned successfully.", + "schema": { + "$ref": "#/definitions/EnvironmentListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources/{eventSourceName}": { + "put": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_CreateOrUpdate", + "x-ms-examples": { + "CreateEventHubEventSource": { + "$ref": "./examples/EventSourcesCreateEventHub.json" + } + }, + "description": "Create or update an event source under the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "eventSourceName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "description": "Name of the event source." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EventSourceCreateOrUpdateParameters" + }, + "description": "Parameters for creating an event source resource." + } + ], + "responses": { + "200": { + "description": "The existing event source definition was successfully updated.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "201": { + "description": "The event source was successfully created.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given event source request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_Get", + "x-ms-examples": { + "GetEventHubEventSource": { + "$ref": "./examples/EventSourcesGetEventHub.json" + } + }, + "description": "Gets the event source with the specified name in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EventSourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The event source definition was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_Update", + "x-ms-examples": { + "UpdateEventSource": { + "$ref": "./examples/EventSourcesPatchTags.json" + } + }, + "description": "Updates the event source with the specified name in the specified subscription, resource group, and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EventSourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "eventSourceUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/EventSourceUpdateParameters" + }, + "description": "Request object that contains the updated information for the event source." + } + ], + "responses": { + "200": { + "description": "The event source definition was successfully updated and is in the response.", + "schema": { + "$ref": "#/definitions/EventSourceResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_Delete", + "x-ms-examples": { + "DeleteEventSource": { + "$ref": "./examples/EventSourcesDelete.json" + } + }, + "description": "Deletes the event source with the specified name in the specified subscription, resource group, and environment", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/EventSourceNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The event source was successfully deleted." + }, + "204": { + "description": "The event source was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or event source could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/eventSources": { + "get": { + "tags": [ + "EventSources" + ], + "operationId": "EventSources_ListByEnvironment", + "x-ms-examples": { + "ListEventSourcesByEnvironment": { + "$ref": "./examples/EventSourcesListByEnvironment.json" + } + }, + "description": "Lists all the available event sources associated with the subscription and within the specified resource group and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Environments returned successfully.", + "schema": { + "$ref": "#/definitions/EventSourceListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets/{referenceDataSetName}": { + "put": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_CreateOrUpdate", + "x-ms-examples": { + "ReferenceDataSetsCreate": { + "$ref": "./examples/ReferenceDataSetsCreate.json" + } + }, + "description": "Create or update a reference data set in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "referenceDataSetName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[A-Za-z0-9]", + "minLength": 3, + "maxLength": 63, + "description": "Name of the reference data set." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReferenceDataSetCreateOrUpdateParameters" + }, + "description": "Parameters for creating a reference data set." + } + ], + "responses": { + "200": { + "description": "The existing reference data set definition was successfully updated.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "201": { + "description": "The reference data set was successfully created.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given reference data set request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_Get", + "x-ms-examples": { + "ReferenceDataSetsGet": { + "$ref": "./examples/ReferenceDataSetsGet.json" + } + }, + "description": "Gets the reference data set with the specified name in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ReferenceDataSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The reference data set definition was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_Update", + "x-ms-examples": { + "ReferenceDataSetsUpdate": { + "$ref": "./examples/ReferenceDataSetsPatchTags.json" + } + }, + "description": "Updates the reference data set with the specified name in the specified subscription, resource group, and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ReferenceDataSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "referenceDataSetUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/ReferenceDataSetUpdateParameters" + }, + "description": "Request object that contains the updated information for the reference data set." + } + ], + "responses": { + "200": { + "description": "The reference data set definition was successfully updated and is in the response.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_Delete", + "x-ms-examples": { + "ReferenceDataSetsDelete": { + "$ref": "./examples/ReferenceDataSetsDelete.json" + } + }, + "description": "Deletes the reference data set with the specified name in the specified subscription, resource group, and environment", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ReferenceDataSetNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The reference data set was successfully deleted." + }, + "204": { + "description": "The reference data set was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or reference data set could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/referenceDataSets": { + "get": { + "tags": [ + "ReferenceDataSets" + ], + "operationId": "ReferenceDataSets_ListByEnvironment", + "x-ms-examples": { + "ReferenceDataSetsListByEnvironment": { + "$ref": "./examples/ReferenceDataSetsListByEnvironment.json" + } + }, + "description": "Lists all the available reference data sets associated with the subscription and within the specified resource group and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "Reference data sets returned successfully.", + "schema": { + "$ref": "#/definitions/ReferenceDataSetListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies/{accessPolicyName}": { + "put": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_CreateOrUpdate", + "x-ms-examples": { + "AccessPoliciesCreate": { + "$ref": "./examples/AccessPoliciesCreate.json" + } + }, + "description": "Create or update an access policy in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "name": "accessPolicyName", + "in": "path", + "required": true, + "type": "string", + "pattern": "^[-\\w\\._\\(\\)]+$", + "minLength": 1, + "maxLength": 90, + "description": "Name of the access policy." + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "parameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessPolicyCreateOrUpdateParameters" + }, + "description": "Parameters for creating an access policy." + } + ], + "responses": { + "200": { + "description": "The existing access policy definition was successfully updated.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "201": { + "description": "The access policy was successfully created.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "default": { + "description": "HTTP 400 (Bad Request): The given access policy request body is invalid; See the error code and message in the response for details.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "get": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_Get", + "x-ms-examples": { + "AccessPoliciesGet": { + "$ref": "./examples/AccessPoliciesGet.json" + } + }, + "description": "Gets the access policy with the specified name in the specified environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The access policy definition was successfully retrieved and is in the response.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "patch": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_Update", + "x-ms-examples": { + "AccessPoliciesUpdate": { + "$ref": "./examples/AccessPoliciesPatchRoles.json" + } + }, + "description": "Updates the access policy with the specified name in the specified subscription, resource group, and environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + }, + { + "name": "accessPolicyUpdateParameters", + "in": "body", + "required": true, + "schema": { + "$ref": "#/definitions/AccessPolicyUpdateParameters" + }, + "description": "Request object that contains the updated information for the access policy." + } + ], + "responses": { + "200": { + "description": "The access policy definition was successfully updated and is in the response.", + "schema": { + "$ref": "#/definitions/AccessPolicyResource" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + }, + "delete": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_Delete", + "x-ms-examples": { + "AccessPoliciesDelete": { + "$ref": "./examples/AccessPoliciesDelete.json" + } + }, + "description": "Deletes the access policy with the specified name in the specified subscription, resource group, and environment", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/AccessPolicyNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "The access policy was successfully deleted." + }, + "204": { + "description": "The access policy was successfully deleted." + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, environment, or access policy could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + }, + "/subscriptions/{subscriptionId}/resourceGroups/{resourceGroupName}/providers/Microsoft.TimeSeriesInsights/environments/{environmentName}/accessPolicies": { + "get": { + "tags": [ + "AccessPolicies" + ], + "operationId": "AccessPolicies_ListByEnvironment", + "x-ms-examples": { + "AccessPoliciesByEnvironment": { + "$ref": "./examples/AccessPoliciesListByEnvironment.json" + } + }, + "description": "Lists all the available access policies associated with the environment.", + "parameters": [ + { + "$ref": "#/parameters/SubscriptionIdParameter" + }, + { + "$ref": "#/parameters/ResourceGroupNameParameter" + }, + { + "$ref": "#/parameters/EnvironmentNameParameter" + }, + { + "$ref": "#/parameters/ApiVersionParameter" + } + ], + "responses": { + "200": { + "description": "access policies returned successfully.", + "schema": { + "$ref": "#/definitions/AccessPolicyListResponse" + } + }, + "default": { + "description": "HTTP 404 (Not Found): The subscription, resource group, or environment could not be found.", + "schema": { + "$ref": "#/definitions/CloudError" + } + } + } + } + } + }, + "definitions": { + "OperationListResult": { + "description": "Result of the request to list Time Series Insights operations. It contains a list of operations and a URL link to get the next set of results.", + "properties": { + "value": { + "description": "List of Time Series Insights operations supported by the Microsoft.TimeSeriesInsights resource provider.", + "type": "array", + "readOnly": true, + "items": { + "$ref": "#/definitions/Operation" + } + }, + "nextLink": { + "description": "URL to get the next set of operation list results if there are any.", + "type": "string", + "readOnly": true + } + } + }, + "Operation": { + "description": "A Time Series Insights REST API operation", + "type": "object", + "properties": { + "name": { + "description": "The name of the operation being performed on this particular object.", + "type": "string", + "readOnly": true + }, + "display": { + "description": "Contains the localized display information for this particular operation / action.", + "readOnly": true, + "properties": { + "provider": { + "description": "The localized friendly form of the resource provider name.", + "type": "string", + "readOnly": true + }, + "resource": { + "description": "The localized friendly form of the resource type related to this action/operation.", + "type": "string", + "readOnly": true + }, + "operation": { + "description": "The localized friendly name for the operation.", + "type": "string", + "readOnly": true + }, + "description": { + "description": "The localized friendly description for the operation.", + "type": "string", + "readOnly": true + } + } + } + } + }, + "Resource": { + "properties": { + "id": { + "readOnly": true, + "type": "string", + "description": "Resource Id" + }, + "name": { + "readOnly": true, + "type": "string", + "description": "Resource name" + }, + "type": { + "readOnly": true, + "type": "string", + "description": "Resource type" + } + }, + "description": "Time Series Insights resource", + "x-ms-azure-resource": true + }, + "TrackedResource": { + "properties": { + "location": { + "type": "string", + "description": "Resource location", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Resource tags" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "required": [ + "location" + ], + "description": "Time Series Insights resource that is tracked by Azure Resource Manager." + }, + "ResourceProperties": { + "properties": { + "provisioningState": { + "$ref": "#/definitions/ProvisioningState", + "description": "Provisioning state of the resource." + }, + "creationTime": { + "readOnly": true, + "type": "string", + "format": "date-time", + "description": "The time the resource was created." + } + }, + "description": "Properties that are common to all tracked resources." + }, + "ProvisioningState": { + "readOnly": true, + "type": "string", + "description": "Provisioning state of the resource.", + "enum": [ + "Accepted", + "Creating", + "Updating", + "Succeeded", + "Failed", + "Deleting" + ], + "x-ms-enum": { + "name": "ProvisioningState", + "modelAsString": true + } + }, + "Sku": { + "type": "object", + "properties": { + "name": { + "type": "string", + "description": "The name of this SKU.", + "enum": [ + "S1", + "S2", + "P1", + "L1" + ], + "x-ms-enum": { + "name": "SkuName", + "modelAsString": true + } + }, + "capacity": { + "format": "int32", + "type": "integer", + "description": "The capacity of the sku. For Gen1 environments, this value can be changed to support scale out of environments after they have been created.", + "minimum": 1, + "maximum": 10 + } + }, + "required": [ + "name", + "capacity" + ], + "description": "The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate." + }, + "WarmStoreConfigurationProperties": { + "type": "object", + "properties": { + "dataRetention": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying the number of days the environment's events will be available for query from the warm store." + } + }, + "required": [ + "dataRetention" + ], + "description": "The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query." + }, + "Gen2StorageConfigurationInput": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the storage account that will hold the environment's Gen2 data." + }, + "managementKey": { + "type": "string", + "description": "The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses." + } + }, + "required": [ + "accountName", + "managementKey" + ], + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "Gen2StorageConfigurationOutput": { + "type": "object", + "properties": { + "accountName": { + "type": "string", + "description": "The name of the storage account that will hold the environment's Gen2 data." + } + }, + "required": [ + "accountName" + ], + "description": "The storage configuration provides the non-secret connection details about the customer storage account that is used to store the environment's data." + }, + "Gen2StorageConfigurationMutableProperties": { + "type": "object", + "properties": { + "managementKey": { + "type": "string", + "description": "The value of the management key that grants the Time Series Insights service write access to the storage account. This property is not shown in environment responses." + } + }, + "required": [ + "managementKey" + ], + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "CreateOrUpdateTrackedResourceProperties": { + "properties": { + "location": { + "type": "string", + "description": "The location of the resource.", + "x-ms-mutability": [ + "read", + "create" + ] + }, + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the resource." + } + }, + "required": [ + "location" + ], + "description": "Properties required to create any resource tracked by Azure Resource Manager." + }, + "EnvironmentCreateOrUpdateParameters": { + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the environment.", + "enum": [ + "Gen1", + "Gen2" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate." + } + }, + "required": [ + "kind", + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/CreateOrUpdateTrackedResourceProperties" + } + ], + "description": "Parameters supplied to the CreateOrUpdate Environment operation." + }, + "Gen1EnvironmentCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Gen1", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen1EnvironmentCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Environment operation for a Gen1 environment." + }, + "Gen2EnvironmentCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Gen2", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen2EnvironmentCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Environment operation for a Gen2 environment." + }, + "EnvironmentUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the environment." + } + }, + "description": "Parameters supplied to the Update Environment operation." + }, + "Gen1EnvironmentUpdateParameters": { + "type": "object", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku of the environment." + }, + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen1EnvironmentMutableProperties", + "description": "Properties of the Gen1 environment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EnvironmentUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Environment operation to update a Gen1 environment." + }, + "Gen2EnvironmentUpdateParameters": { + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen2EnvironmentMutableProperties", + "description": "Properties of the Gen2 environment." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EnvironmentUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Environment operation to update a Gen2 environment." + }, + "EnvironmentListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EnvironmentResource" + }, + "description": "Result of the List Environments operation." + } + }, + "description": "The response of the List Environments operation." + }, + "EnvironmentResource": { + "type": "object", + "discriminator": "kind", + "properties": { + "sku": { + "$ref": "#/definitions/Sku", + "description": "The sku determines the type of environment, either Gen1 (S1 or S2) or Gen2 (L1). For Gen1 environments the sku determines the capacity of the environment, the ingress rate, and the billing rate." + }, + "kind": { + "type": "string", + "description": "The kind of the environment.", + "enum": [ + "Gen1", + "Gen2" + ] + } + }, + "required": [ + "kind", + "sku" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource." + }, + "Gen1EnvironmentResource": { + "x-ms-discriminator-value": "Gen1", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen1EnvironmentResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentResource" + } + ], + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen1 environments have data retention limits." + }, + "Gen2EnvironmentResource": { + "x-ms-discriminator-value": "Gen2", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/Gen2EnvironmentResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentResource" + } + ], + "description": "An environment is a set of time-series data available for query, and is the top level Azure Time Series Insights resource. Gen2 environments do not have set data retention limits." + }, + "Gen1EnvironmentCreationProperties": { + "properties": { + "dataRetentionTime": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying the minimum number of days the environment's events will be available for query." + }, + "storageLimitExceededBehavior": { + "type": "string", + "description": "The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If \"PauseIngress\" is specified, new events will not be read from the event source. If \"PurgeOldData\" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.", + "enum": [ + "PurgeOldData", + "PauseIngress" + ], + "x-ms-enum": { + "name": "StorageLimitExceededBehavior", + "modelAsString": true + } + }, + "partitionKeyProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to partition data in the environment. Currently, only a single partition key property is supported." + } + }, + "required": [ + "dataRetentionTime" + ], + "description": "Properties used to create a Gen1 environment." + }, + "Gen2EnvironmentCreationProperties": { + "properties": { + "timeSeriesIdProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to define the environment's time series id." + }, + "storageConfiguration": { + "$ref": "#/definitions/Gen2StorageConfigurationInput", + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "warmStoreConfiguration": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/WarmStoreConfigurationProperties", + "description": "The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query." + } + }, + "required": [ + "timeSeriesIdProperties", + "storageConfiguration" + ], + "description": "Properties used to create a Gen2 environment." + }, + "EnvironmentResourceProperties": { + "properties": { + "dataAccessId": { + "readOnly": true, + "type": "string", + "format": "uuid", + "description": "An id used to access the environment data, e.g. to query the environment's events or upload reference data for the environment." + }, + "dataAccessFqdn": { + "readOnly": true, + "type": "string", + "description": "The fully qualified domain name used to access the environment data, e.g. to query the environment's events or upload reference data for the environment." + }, + "status": { + "$ref": "#/definitions/EnvironmentStatus", + "description": "An object that represents the status of the environment, and its internal state in the Time Series Insights service." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "description": "Properties of the environment." + }, + "Gen1EnvironmentResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/Gen1EnvironmentCreationProperties" + }, + { + "$ref": "#/definitions/EnvironmentResourceProperties" + }, + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "required": [ + "dataRetentionTime" + ], + "description": "Properties of the Gen1 environment." + }, + "Gen2EnvironmentResourceProperties": { + "properties": { + "timeSeriesIdProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/TimeSeriesIdProperty" + }, + "description": "The list of event properties which will be used to define the environment's time series id." + }, + "storageConfiguration": { + "$ref": "#/definitions/Gen2StorageConfigurationOutput", + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "warmStoreConfiguration": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/WarmStoreConfigurationProperties", + "description": "The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query." + } + }, + "required": [ + "timeSeriesIdProperties", + "storageConfiguration" + ], + "allOf": [ + { + "$ref": "#/definitions/EnvironmentResourceProperties" + }, + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "description": "Properties of the Gen2 environment." + }, + "Gen1EnvironmentMutableProperties": { + "description": "An object that represents a set of mutable Gen1 environment resource properties.", + "type": "object", + "properties": { + "dataRetentionTime": { + "type": "string", + "format": "duration", + "description": "ISO8601 timespan specifying the minimum number of days the environment's events will be available for query." + }, + "storageLimitExceededBehavior": { + "type": "string", + "description": "The behavior the Time Series Insights service should take when the environment's capacity has been exceeded. If \"PauseIngress\" is specified, new events will not be read from the event source. If \"PurgeOldData\" is specified, new events will continue to be read and old events will be deleted from the environment. The default behavior is PurgeOldData.", + "enum": [ + "PurgeOldData", + "PauseIngress" + ], + "x-ms-enum": { + "name": "StorageLimitExceededBehavior", + "modelAsString": true + } + } + } + }, + "Gen2EnvironmentMutableProperties": { + "description": "An object that represents a set of mutable Gen2 environment resource properties.", + "type": "object", + "properties": { + "storageConfiguration": { + "$ref": "#/definitions/Gen2StorageConfigurationMutableProperties", + "description": "The storage configuration provides the connection details that allows the Time Series Insights service to connect to the customer storage account that is used to store the environment's data." + }, + "warmStoreConfiguration": { + "x-ms-client-flatten": false, + "$ref": "#/definitions/WarmStoreConfigurationProperties", + "description": "The warm store configuration provides the details to create a warm store cache that will retain a copy of the environment's data available for faster query." + } + } + }, + "TimeSeriesIdProperty": { + "properties": { + "name": { + "type": "string", + "description": "The name of the property." + }, + "type": { + "type": "string", + "description": "The type of the property.", + "enum": [ + "String" + ], + "x-ms-enum": { + "name": "PropertyType", + "modelAsString": true + } + } + }, + "description": "The structure of the property that a time series id can have. An environment can have multiple such properties." + }, + "EnvironmentStatus": { + "readOnly": true, + "type": "object", + "description": "An object that represents the status of the environment, and its internal state in the Time Series Insights service.", + "properties": { + "ingress": { + "$ref": "#/definitions/IngressEnvironmentStatus", + "description": "An object that represents the status of ingress on an environment." + }, + "warmStorage": { + "$ref": "#/definitions/WarmStorageEnvironmentStatus", + "description": "An object that represents the status of warm storage on an environment." + } + } + }, + "IngressEnvironmentStatus": { + "readOnly": true, + "type": "object", + "description": "An object that represents the status of ingress on an environment.", + "properties": { + "state": { + "type": "string", + "description": "This string represents the state of ingress operations on an environment. It can be \"Disabled\", \"Ready\", \"Running\", \"Paused\" or \"Unknown\"", + "enum": [ + "Disabled", + "Ready", + "Running", + "Paused", + "Unknown" + ], + "x-ms-enum": { + "name": "IngressState", + "modelAsString": true + } + }, + "stateDetails": { + "$ref": "#/definitions/EnvironmentStateDetails", + "description": "An object that contains the details about an environment's state." + } + } + }, + "EnvironmentStateDetails": { + "readOnly": true, + "type": "object", + "description": "An object that contains the details about an environment's state.", + "properties": { + "code": { + "type": "string", + "description": "Contains the code that represents the reason of an environment being in a particular state. Can be used to programmatically handle specific cases." + }, + "message": { + "type": "string", + "description": "A message that describes the state in detail." + } + } + }, + "WarmStorageEnvironmentStatus": { + "readOnly": true, + "type": "object", + "description": "An object that represents the status of warm storage on an environment.", + "properties": { + "propertiesUsage": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WarmStoragePropertiesUsage", + "description": "An object that contains the status of warm storage properties usage." + } + } + }, + "WarmStoragePropertiesUsage": { + "readOnly": true, + "type": "object", + "description": "An object that contains the status of warm storage properties usage.", + "properties": { + "state": { + "type": "string", + "description": "This string represents the state of warm storage properties usage. It can be \"Ok\", \"Error\", \"Unknown\".", + "enum": [ + "Ok", + "Error", + "Unknown" + ], + "x-ms-enum": { + "name": "WarmStoragePropertiesState", + "modelAsString": true + } + }, + "stateDetails": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/WarmStoragePropertiesUsageStateDetails", + "description": "An object that contains the details about warm storage properties usage state." + } + } + }, + "WarmStoragePropertiesUsageStateDetails": { + "readOnly": true, + "type": "object", + "description": "An object that contains the details about warm storage properties usage state.", + "properties": { + "currentCount": { + "format": "int32", + "type": "integer", + "description": "A value that represents the number of properties used by the environment for S1/S2 SKU and number of properties used by Warm Store for PAYG SKU", + "minimum": 1, + "maximum": 10 + }, + "maxCount": { + "format": "int32", + "type": "integer", + "description": "A value that represents the maximum number of properties used allowed by the environment for S1/S2 SKU and maximum number of properties allowed by Warm Store for PAYG SKU.", + "minimum": 1, + "maximum": 10 + } + } + }, + "EventSourceCreateOrUpdateParameters": { + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the event source.", + "enum": [ + "Microsoft.EventHub", + "Microsoft.IoTHub" + ], + "x-ms-enum": { + "name": "Kind", + "modelAsString": true + } + }, + "localTimestamp": { + "$ref": "#/definitions/LocalTimestamp", + "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events." + } + }, + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "#/definitions/CreateOrUpdateTrackedResourceProperties" + } + ], + "description": "Parameters supplied to the Create or Update Event Source operation." + }, + "EventHubEventSourceCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Microsoft.EventHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EventHubEventSourceCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Event Source operation for an EventHub event source." + }, + "IoTHubEventSourceCreateOrUpdateParameters": { + "x-ms-discriminator-value": "Microsoft.IoTHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IoTHubEventSourceCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceCreateOrUpdateParameters" + } + ], + "description": "Parameters supplied to the Create or Update Event Source operation for an IoTHub event source." + }, + "EventSourceUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the event source." + } + }, + "description": "Parameters supplied to the Update Event Source operation." + }, + "EventHubEventSourceUpdateParameters": { + "type": "object", + "x-ms-discriminator-value": "Microsoft.EventHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EventHubEventSourceMutableProperties", + "description": "Properties of the EventHub event source." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Event Source operation to update an EventHub event source." + }, + "IoTHubEventSourceUpdateParameters": { + "x-ms-discriminator-value": "Microsoft.IoTHub", + "type": "object", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IoTHubEventSourceMutableProperties", + "description": "Properties of the IoTHub event source." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceUpdateParameters" + } + ], + "description": "Parameters supplied to the Update Event Source operation to update an IoTHub event source." + }, + "EventSourceListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/EventSourceResource" + }, + "description": "Result of the List EventSources operation." + } + }, + "description": "The response of the List EventSources operation." + }, + "EventSourceResource": { + "type": "object", + "discriminator": "kind", + "properties": { + "kind": { + "type": "string", + "description": "The kind of the event source.", + "enum": [ + "Microsoft.EventHub", + "Microsoft.IoTHub" + ] + } + }, + "required": [ + "kind" + ], + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "An environment receives data from one or more event sources. Each event source has associated connection info that allows the Time Series Insights ingress pipeline to connect to and pull data from the event source" + }, + "EventHubEventSourceResource": { + "x-ms-discriminator-value": "Microsoft.EventHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/EventHubEventSourceResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceResource" + } + ], + "description": "An event source that receives its data from an Azure EventHub." + }, + "IoTHubEventSourceResource": { + "x-ms-discriminator-value": "Microsoft.IoTHub", + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/IoTHubEventSourceResourceProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/EventSourceResource" + } + ], + "description": "An event source that receives its data from an Azure IoTHub." + }, + "EventSourceCommonProperties": { + "properties": { + "timestampPropertyName": { + "type": "string", + "description": "The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used." + } + }, + "allOf": [ + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "description": "Properties of the event source." + }, + "AzureEventSourceProperties": { + "properties": { + "eventSourceResourceId": { + "type": "string", + "description": "The resource id of the event source in Azure Resource Manager." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceCommonProperties" + } + ], + "required": [ + "eventSourceResourceId" + ], + "description": "Properties of an event source that reads events from an event broker in Azure." + }, + "EventHubEventSourceCommonProperties": { + "properties": { + "serviceBusNamespace": { + "type": "string", + "description": "The name of the service bus that contains the event hub." + }, + "eventHubName": { + "type": "string", + "description": "The name of the event hub." + }, + "consumerGroupName": { + "type": "string", + "description": "The name of the event hub's consumer group that holds the partitions from which events will be read." + }, + "keyName": { + "type": "string", + "description": "The name of the SAS key that grants the Time Series Insights service access to the event hub. The shared access policies for this key must grant 'Listen' permissions to the event hub." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureEventSourceProperties" + } + ], + "required": [ + "serviceBusNamespace", + "eventHubName", + "consumerGroupName", + "keyName" + ], + "description": "Properties of the EventHub event source." + }, + "EventHubEventSourceCreationProperties": { + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventHubEventSourceCommonProperties" + } + ], + "required": [ + "sharedAccessKey" + ], + "description": "Properties of the EventHub event source that are required on create or update requests." + }, + "EventHubEventSourceResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/EventHubEventSourceCommonProperties" + } + ], + "description": "Properties of the EventHub event source resource." + }, + "IoTHubEventSourceCommonProperties": { + "properties": { + "iotHubName": { + "type": "string", + "description": "The name of the iot hub." + }, + "consumerGroupName": { + "type": "string", + "description": "The name of the iot hub's consumer group that holds the partitions from which events will be read." + }, + "keyName": { + "type": "string", + "description": "The name of the Shared Access Policy key that grants the Time Series Insights service access to the iot hub. This shared access policy key must grant 'service connect' permissions to the iot hub." + } + }, + "allOf": [ + { + "$ref": "#/definitions/AzureEventSourceProperties" + } + ], + "required": [ + "iotHubName", + "consumerGroupName", + "keyName" + ], + "description": "Properties of the IoTHub event source." + }, + "IoTHubEventSourceCreationProperties": { + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the Shared Access Policy key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/IoTHubEventSourceCommonProperties" + } + ], + "required": [ + "sharedAccessKey" + ], + "description": "Properties of the IoTHub event source that are required on create or update requests." + }, + "IoTHubEventSourceResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/IoTHubEventSourceCommonProperties" + } + ], + "description": "Properties of the IoTHub event source resource." + }, + "LocalTimestamp": { + "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events.", + "type": "object", + "properties": { + "format": { + "description": "An enum that represents the format of the local timestamp property that needs to be set.", + "type": "string", + "enum": [ + "Embedded" + ], + "x-ms-enum": { + "name": "LocalTimestampFormat", + "modelAsString": true + } + }, + "timeZoneOffset": { + "description": "An object that represents the offset information for the local timestamp format specified. Should not be specified for LocalTimestampFormat - Embedded.", + "type": "object", + "properties": { + "propertyName": { + "type": "string", + "description": "The event property that will be contain the offset information to calculate the local timestamp. When the LocalTimestampFormat is Iana, the property name will contain the name of the column which contains IANA Timezone Name (eg: Americas/Los Angeles). When LocalTimestampFormat is Timespan, it contains the name of property which contains values representing the offset (eg: P1D or 1.00:00:00)" + } + } + } + } + }, + "EventSourceMutableProperties": { + "description": "An object that represents a set of mutable event source resource properties.", + "type": "object", + "properties": { + "timestampPropertyName": { + "type": "string", + "description": "The event property that will be used as the event source's timestamp. If a value isn't specified for timestampPropertyName, or if null or empty-string is specified, the event creation time will be used." + }, + "localTimestamp": { + "$ref": "#/definitions/LocalTimestamp", + "description": "An object that represents the local timestamp property. It contains the format of local timestamp that needs to be used and the corresponding timezone offset information. If a value isn't specified for localTimestamp, or if null, then the local timestamp will not be ingressed with the events." + } + } + }, + "EventHubEventSourceMutableProperties": { + "description": "An object that represents a set of mutable EventHub event source resource properties.", + "type": "object", + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the shared access key that grants the Time Series Insights service read access to the event hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceMutableProperties" + } + ] + }, + "IoTHubEventSourceMutableProperties": { + "description": "An object that represents a set of mutable IoTHub event source resource properties.", + "type": "object", + "properties": { + "sharedAccessKey": { + "type": "string", + "description": "The value of the shared access key that grants the Time Series Insights service read access to the iot hub. This property is not shown in event source responses." + } + }, + "allOf": [ + { + "$ref": "#/definitions/EventSourceMutableProperties" + } + ] + }, + "ReferenceDataSetCreateOrUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReferenceDataSetCreationProperties" + } + }, + "required": [ + "properties" + ], + "allOf": [ + { + "$ref": "#/definitions/CreateOrUpdateTrackedResourceProperties" + } + ] + }, + "ReferenceDataSetUpdateParameters": { + "type": "object", + "properties": { + "tags": { + "type": "object", + "additionalProperties": { + "type": "string" + }, + "description": "Key-value pairs of additional properties for the reference data set." + } + }, + "description": "Parameters supplied to the Update Reference Data Set operation." + }, + "ReferenceDataSetListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/ReferenceDataSetResource" + }, + "description": "Result of the List Reference Data Sets operation." + } + }, + "description": "The response of the List Reference Data Sets operation." + }, + "ReferenceDataSetResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/ReferenceDataSetResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/TrackedResource" + } + ], + "description": "A reference data set provides metadata about the events in an environment. Metadata in the reference data set will be joined with events as they are read from event sources. The metadata that makes up the reference data set is uploaded or modified through the Time Series Insights data plane APIs." + }, + "ReferenceDataSetCreationProperties": { + "properties": { + "keyProperties": { + "type": "array", + "items": { + "$ref": "#/definitions/ReferenceDataSetKeyProperty" + }, + "description": "The list of key properties for the reference data set." + }, + "dataStringComparisonBehavior": { + "type": "string", + "description": "The reference data set key comparison behavior can be set using this property. By default, the value is 'Ordinal' - which means case sensitive key comparison will be performed while joining reference data with events or while adding new reference data. When 'OrdinalIgnoreCase' is set, case insensitive comparison will be used.", + "enum": [ + "Ordinal", + "OrdinalIgnoreCase" + ], + "x-ms-enum": { + "name": "DataStringComparisonBehavior", + "modelAsString": true + } + } + }, + "required": [ + "keyProperties" + ], + "description": "Properties used to create a reference data set." + }, + "ReferenceDataSetResourceProperties": { + "allOf": [ + { + "$ref": "#/definitions/ReferenceDataSetCreationProperties" + }, + { + "$ref": "#/definitions/ResourceProperties" + } + ], + "required": [ + "keyProperties" + ], + "description": "Properties of the reference data set." + }, + "ReferenceDataSetKeyProperty": { + "properties": { + "name": { + "type": "string", + "description": "The name of the key property." + }, + "type": { + "type": "string", + "description": "The type of the key property.", + "enum": [ + "String", + "Double", + "Bool", + "DateTime" + ], + "x-ms-enum": { + "name": "ReferenceDataKeyPropertyType", + "modelAsString": true + } + } + }, + "description": "A key property for the reference data set. A reference data set can have multiple key properties." + }, + "AccessPolicyCreateOrUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessPolicyResourceProperties" + } + }, + "required": [ + "properties" + ] + }, + "AccessPolicyUpdateParameters": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessPolicyMutableProperties" + } + } + }, + "AccessPolicyListResponse": { + "properties": { + "value": { + "type": "array", + "items": { + "$ref": "#/definitions/AccessPolicyResource" + }, + "description": "Result of the List access policies operation." + } + }, + "description": "The response of the List access policies operation." + }, + "AccessPolicyResource": { + "properties": { + "properties": { + "x-ms-client-flatten": true, + "$ref": "#/definitions/AccessPolicyResourceProperties" + } + }, + "allOf": [ + { + "$ref": "#/definitions/Resource" + } + ], + "description": "An access policy is used to grant users and applications access to the environment. Roles are assigned to service principals in Azure Active Directory. These roles define the actions the principal can perform through the Time Series Insights data plane APIs." + }, + "AccessPolicyResourceProperties": { + "properties": { + "principalObjectId": { + "type": "string", + "description": "The objectId of the principal in Azure Active Directory." + }, + "description": { + "type": "string", + "description": "An description of the access policy." + }, + "roles": { + "type": "array", + "items": { + "type": "string", + "description": "A role defining the data plane operations that a principal can perform on a Time Series Insights client.", + "enum": [ + "Reader", + "Contributor" + ], + "x-ms-enum": { + "name": "AccessPolicyRole", + "modelAsString": true + } + }, + "description": "The list of roles the principal is assigned on the environment." + } + } + }, + "AccessPolicyMutableProperties": { + "description": "An object that represents a set of mutable access policy resource properties.", + "type": "object", + "properties": { + "description": { + "type": "string", + "description": "An description of the access policy." + }, + "roles": { + "type": "array", + "items": { + "type": "string", + "description": "A role defining the data plane operations that a principal can perform on a Time Series Insights client.", + "enum": [ + "Reader", + "Contributor" + ], + "x-ms-enum": { + "name": "AccessPolicyRole", + "modelAsString": true + } + }, + "description": "The list of roles the principal is assigned on the environment." + } + } + }, + "CloudError": { + "type": "object", + "properties": { + "error": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Describes a particular API error with an error code and a message." + } + }, + "description": "Contains information about an API error.", + "x-ms-external": true + }, + "CloudErrorBody": { + "type": "object", + "description": "Describes a particular API error with an error code and a message.", + "properties": { + "code": { + "type": "string", + "description": "An error code that describes the error condition more precisely than an HTTP status code. Can be used to programmatically handle specific error cases." + }, + "message": { + "type": "string", + "description": "A message that describes the error in detail and provides debugging information." + }, + "target": { + "type": "string", + "description": "The target of the particular error (for example, the name of the property in error)." + }, + "details": { + "type": "array", + "items": { + "$ref": "#/definitions/CloudErrorBody", + "description": "Describes a particular API error with an error code and a message." + }, + "description": "Contains nested errors that are related to this error." + } + }, + "x-ms-external": true + } + }, + "parameters": { + "SubscriptionIdParameter": { + "name": "subscriptionId", + "in": "path", + "description": "Azure Subscription ID.", + "required": true, + "type": "string" + }, + "ApiVersionParameter": { + "name": "api-version", + "in": "query", + "required": true, + "type": "string", + "description": "Version of the API to be used with the client request." + }, + "ExpandParameter": { + "name": "$expand", + "in": "query", + "required": false, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Setting $expand=status will include the status of the internal services of the environment in the Time Series Insights service." + }, + "ResourceGroupNameParameter": { + "name": "resourceGroupName", + "in": "path", + "required": true, + "type": "string", + "x-ms-parameter-location": "method", + "description": "Name of an Azure Resource group." + }, + "EnvironmentNameParameter": { + "name": "environmentName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights environment associated with the specified resource group.", + "x-ms-parameter-location": "method" + }, + "EventSourceNameParameter": { + "name": "eventSourceName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights event source associated with the specified environment.", + "x-ms-parameter-location": "method" + }, + "ReferenceDataSetNameParameter": { + "name": "referenceDataSetName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights reference data set associated with the specified environment.", + "x-ms-parameter-location": "method" + }, + "AccessPolicyNameParameter": { + "name": "accessPolicyName", + "in": "path", + "required": true, + "type": "string", + "description": "The name of the Time Series Insights access policy associated with the specified environment.", + "x-ms-parameter-location": "method" + } + } +} diff --git a/specification/timeseriesinsights/resource-manager/readme.go.md b/specification/timeseriesinsights/resource-manager/readme.go.md index 6a179450c62c..cf66c104efd4 100644 --- a/specification/timeseriesinsights/resource-manager/readme.go.md +++ b/specification/timeseriesinsights/resource-manager/readme.go.md @@ -16,6 +16,7 @@ batch: - tag: package-2017-11-15 - tag: package-2017-02-preview - tag: package-2018-08-preview + - tag: package-2020-05-15 ``` ### Tag: package-2017-11-15 and go @@ -43,4 +44,13 @@ Please also specify `--go-sdk-folder=`. + +``` yaml $(tag)=='package-2020-05-15' && $(go) +output-folder: $(go-sdk-folder)/services/stable/$(namespace)/mgmt/2020-05-15$(namespace) ``` \ No newline at end of file diff --git a/specification/timeseriesinsights/resource-manager/readme.md b/specification/timeseriesinsights/resource-manager/readme.md index ba285f75085e..3bc5dbc887e1 100644 --- a/specification/timeseriesinsights/resource-manager/readme.md +++ b/specification/timeseriesinsights/resource-manager/readme.md @@ -25,7 +25,16 @@ These are the global settings for the TimeSeriesInsights API. ``` yaml openapi-type: arm -tag: package-2018-08-preview +tag: package-2020-05-15 +``` + +### Tag: package-2020-05-15 + +These settings apply only when `--tag=package-2020-05-15` is specified on the command line. + +``` yaml $(tag) == 'package-2020-05-15' +input-file: +- Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json ``` ### Tag: package-2018-08-preview @@ -65,6 +74,8 @@ directive: - $.definitions.LongTermEnvironmentResource - $.definitions.EventHubEventSourceResource - $.definitions.IoTHubEventSourceResource + - $.definitions.Gen1EnvironmentResource + - $.definitions.Gen2EnvironmentResource from: timeseriesinsights.json reason: These violations are false positives. The EventSources_Get operation returns an EventSourceResource, and both EventHubEventSourceResource and IoTHubEventSourceResource inherit from EventSourceResource. Similarly, the Environments_Get operation returns an EnvironmentResource, from which both StandardEnvironmentResource and LongTermEnvironmentResource inherit. @@ -74,6 +85,8 @@ directive: - $.definitions.LongTermEnvironmentResource - $.definitions.EventHubEventSourceResource - $.definitions.IoTHubEventSourceResource + - $.definitions.Gen1EnvironmentResource + - $.definitions.Gen2EnvironmentResource from: timeseriesinsights.json reason: These violations are false positives. The EventSources_Update operation takes an EventSourceUpdateParameters as the body, and EventHubEventSourceUpdateParameters and IoTHubEventSourceUpdateParameters both inherit from EventSourceUpdateParameters. Similarly, the Environments_Update operation takes an EnvironmentUpdateParameters as the body, and both StandardEnvironmentUpdateParameters and LongTermEnvironmentUpdateParameters inherit from EnvironmentUpdateParameters. These definitions can be used to update mutable properties of the event source, including the Tags collection. ``` @@ -124,6 +137,7 @@ batch: - tag: package-2017-11-15 - tag: package-2017-02-preview - tag: package-2018-08-preview + - tag: package-2020-05-15 ``` ### Tag: package-2017-11-15 and java @@ -165,6 +179,19 @@ regenerate-manager: true generate-interface: true ``` +### Tag: package-2020-05-15 and java + +These settings apply only when `--tag=package-2020-05-15 --java` is specified on the command line. +Please also specify `--azure-libraries-for-java=`. + +``` yaml $(tag) == 'package-2020-05-15' && $(java) && $(multiapi) +java: + namespace: com.microsoft.azure.management.timeseriesinsights.v2020_05_15 + output-folder: $(azure-libraries-for-java-folder)/sdk/timeseriesinsights/mgmt-v2020_05_15 +regenerate-manager: true +generate-interface: true +``` + ## Multi-API/Profile support for AutoRest v3 generators AutoRest V3 generators require the use of `--tag=all-api-versions` to select api files. @@ -177,6 +204,7 @@ require: $(this-folder)/../../../profiles/readme.md # all the input files across all versions input-file: + - $(this-folder)/Microsoft.TimeSeriesInsights/stable/2020-05-15/timeseriesinsights.json - $(this-folder)/Microsoft.TimeSeriesInsights/preview/2018-08-15-preview/timeseriesinsights.json - $(this-folder)/Microsoft.TimeSeriesInsights/stable/2017-11-15/timeseriesinsights.json - $(this-folder)/Microsoft.TimeSeriesInsights/preview/2017-02-28-preview/timeseriesinsights.json From 115dee0d25929469490cd314f24349ebeff4ea89 Mon Sep 17 00:00:00 2001 From: gubalasu <59630928+gubalasu@users.noreply.github.com> Date: Tue, 14 Jul 2020 19:20:31 -0700 Subject: [PATCH 316/318] Start enum values with uppercase like it is actually defined in RP (#10138) --- .../Microsoft.Cdn/stable/2020-03-31/cdn.json | 6 +++--- .../Microsoft.Cdn/stable/2020-04-15/cdn.json | 6 +++--- 2 files changed, 6 insertions(+), 6 deletions(-) diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json index 6c41c103a962..3fe6e8897763 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-03-31/cdn.json @@ -3914,9 +3914,9 @@ "description": "Indicates the purpose of the parameter", "type": "string", "enum": [ - "expires", - "keyId", - "signature" + "Expires", + "KeyId", + "Signature" ] }, "paramName": { diff --git a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json index 31b6d8b79da1..fe78dbacaf73 100644 --- a/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json +++ b/specification/cdn/resource-manager/Microsoft.Cdn/stable/2020-04-15/cdn.json @@ -3918,9 +3918,9 @@ "description": "Indicates the purpose of the parameter", "type": "string", "enum": [ - "expires", - "keyId", - "signature" + "Expires", + "KeyId", + "Signature" ], "x-ms-enum": { "name": "paramIndicator", From 4476048a9a08752756e9f4f812c9b1c0b074c23e Mon Sep 17 00:00:00 2001 From: Xin Huang Date: Tue, 14 Jul 2020 20:49:43 -0700 Subject: [PATCH 317/318] Update blob.json (#10061) --- .../Microsoft.Storage/stable/2019-06-01/blob.json | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/blob.json b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/blob.json index 57ebabb6a0b9..616bf20c1e20 100644 --- a/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/blob.json +++ b/specification/storage/resource-manager/Microsoft.Storage/stable/2019-06-01/blob.json @@ -607,7 +607,7 @@ "$ref": "./examples/BlobContainersDeleteImmutabilityPolicy.json" } }, - "description": "Aborts an unlocked immutability policy. The response of delete has immutabilityPeriodSinceCreationInDays set to 0. ETag in If-Match is required for this operation. Deleting a locked immutability policy is not allowed, only way is to delete the container after deleting all blobs inside the container.", + "description": "Aborts an unlocked immutability policy. The response of delete has immutabilityPeriodSinceCreationInDays set to 0. ETag in If-Match is required for this operation. Deleting a locked immutability policy is not allowed, the only way is to delete the container after deleting all expired blobs inside the policy locked container.", "parameters": [ { "$ref": "./storage.json#/parameters/ResourceGroupName" From 7f47ff0225bf88c069f07addfa9b3c4708a30dad Mon Sep 17 00:00:00 2001 From: dhruvsawhney Date: Tue, 14 Jul 2020 22:20:41 -0700 Subject: [PATCH 318/318] Update LoadBalancer BackendAddress Properties (#10131) * remove LBBackendAddressPoolWithBackendAddressesPutWithNICIPConfiguration.json from both dirs * updates * updates Co-authored-by: Dhruv Sawhney --- .../stable/2020-04-01/loadBalancer.json | 14 +++++++------- .../stable/2020-05-01/loadBalancer.json | 14 +++++++------- 2 files changed, 14 insertions(+), 14 deletions(-) diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/loadBalancer.json index 01905101e2e3..34d350384587 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/loadBalancer.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-04-01/loadBalancer.json @@ -1524,20 +1524,20 @@ }, "BackendAddressPoolPropertiesFormat": { "properties": { - "backendIPConfigurations": { - "readOnly": true, + "loadBalancerBackendAddresses": { "type": "array", "items": { - "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + "$ref": "#/definitions/LoadBalancerBackendAddress" }, - "description": "An array of references to IP addresses defined in network interfaces." + "description": "An array of backend addresses." }, - "loadBalancerBackendAddresses": { + "backendIPConfigurations": { + "readOnly": true, "type": "array", "items": { - "$ref": "#/definitions/LoadBalancerBackendAddress" + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" }, - "description": "An array of backend addresses." + "description": "An array of references to IP addresses defined in network interfaces." }, "loadBalancingRules": { "readOnly": true, diff --git a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json index 956b50a92d18..3cd051c520ef 100644 --- a/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json +++ b/specification/network/resource-manager/Microsoft.Network/stable/2020-05-01/loadBalancer.json @@ -1524,20 +1524,20 @@ }, "BackendAddressPoolPropertiesFormat": { "properties": { - "backendIPConfigurations": { - "readOnly": true, + "loadBalancerBackendAddresses": { "type": "array", "items": { - "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" + "$ref": "#/definitions/LoadBalancerBackendAddress" }, - "description": "An array of references to IP addresses defined in network interfaces." + "description": "An array of backend addresses." }, - "loadBalancerBackendAddresses": { + "backendIPConfigurations": { + "readOnly": true, "type": "array", "items": { - "$ref": "#/definitions/LoadBalancerBackendAddress" + "$ref": "./networkInterface.json#/definitions/NetworkInterfaceIPConfiguration" }, - "description": "An array of backend addresses." + "description": "An array of references to IP addresses defined in network interfaces." }, "loadBalancingRules": { "readOnly": true,